Waypoint Scripts
  • Waypoint Scripts
  • Store
  • Support Discord
  • Scripts
    • 🚑Waypoint AI EMS
      • 📝Setup
      • 🖥️Code Snippets
      • ❔FAQ
      • 📃Exports / Events
      • 🔢Telemetry
    • 🚕Waypoint AI Taxi
      • 📝Setup
      • 🖥️Code Snippets
      • 📃Exports / Events
      • 🔢Telemetry
    • 🎆Waypoint Fireworks
      • 📝Setup
    • 💡Waypoint Neons
      • 📝Setup
    • 🐕Waypoint Animals
      • 📝Setup
      • ❔FAQ
  • Free Scripts
    • 🚚Waypoint Tow / Hauling
    • 🛠️Waypoint Placeables
    • 🚦Waypoint Traffic Lights
    • 🧘‍♂️Waypoint Yogamats
    • 🖨️Waypoint Printer
    • 🚲Waypoint Pocket Bikes
    • 👻Waypoint Smoke Monster
    • 🪑Waypoint Seats
Powered by GitBook
On this page
  • Features
  • Performance
  • Dependencies
  • Credit
  • Gallery
  1. Scripts

Waypoint Animals

Overview of the Waypoint Animals Script and how to configure.

PreviousSetupNextSetup

Last updated 8 days ago

Waypoint Animals is a script that lets players bring their animal/pet companions into the world and expand their creative opportunities. Players can interact with their animals in a variety of ways, such as petting, holding them, playing fetch, playing animations, having them follow you around on foot or in a vehicle. Animals can be fully customized, choosing from the color of their fur/skin, collars, and accessorizing with a variety of props that can be placed however the user likes.

Features

  • Comes with 20 animals to choose from by default. Can easily be expanded by adding your own custom animal models.

  • No limit to the number of animals that can be controlled at the same time

  • Full customization of your pets (fur/skin color, collars, accessorize with prop customization)

  • Interact with animals in a variety of ways (petting, holding, playing fetch, playing animations, having them follow you around on foot or in a vehicle)

  • Control animals with the following actions: follow, stay, go to point, get in/out vehicle, wander in the area, attack (configurable via a config flag)

  • A simple store UI is provided to purchase animals from and retrieve lost animals from "the pound"

  • Animals can be placed and picked up by anyone.

  • Animals are stored as items in your inventory, simply use the item to place it into the world.

  • Interact with animals through the target system as well as through the /animals menu.

  • Synchronized across all clients

Performance

  • Idle / Following / Actions / Fetch: 0.00ms

  • Store UI / Hold / : 0.01ms

  • Raycast Actions (Go to point, get in vehicle, etc): 0.03ms - 0.07ms

  • Prop Customization: 0.01ms - 0.10ms (only while quickly cycling through and moving props)

Dependencies

  • Framework: QBCore, Qbox, ESX

  • Notify: QB, ESX, OX, or similar

  • Target: QB, OX, or similar

  • Progressbar: QB, OX, or similar

  • Inventory: QB, OX, or similar (must have support for item metadata)

  • SQL database

    • We use menuv for the menu system for controlling, customizing and animating the animals.

All framework / external script dependencies are configurable within the framework.lua file and can be easily changed to fit your server's needs. Additionally all files for the store (web and client) and menu code are open source.

Credit

  • DonHulieo for providing insipiration and examples for structuring the framework.lua file.

Gallery

Zone: or OX (used just for detecting when you are in the store)

for custom hold animations

Project Error -

🐕
PolyZone
menuV
MissySnowie
fivem-react-boilerplate-lua
Purchase Here
CFX Post