FelisDevelopment/fd-pets-support

Companions / Pets system

Custom pets resource, designed to work as standalone resource or be dynamic to be able to adapt it to any framework.

Support

Any issues / Bugs or Suggestions has to be reported in this repository issues. Please refer to: Issues

Purchase / Preview

System can be purchased at Tebex Preview of this resource can be found on Youtube

QBCore

If you use QBCore for your server, you can find this system simple adaption for free at repository. (fd-pets is still needed as a dependency)

Documentation

NOTE: Sorry for any grammar mistakes.

Config explanation

Translations explanation

Exports

Client

Setters

Export	Description	Parameter(s)
SpawnPet	Spawn pet	string
OverrideMethod	Without going to main dependency, you can override various utility methods	string, function
AddOrOverrideCustomMethod	Add or override existing custom actions	string, function
ForceCloseMenu	Forcefully close pet actions menu

Getters

Export	Description	Return Type
DoesPetExist	Check if client has a pet spawned and it exists and is alive	bool or int
IsMenuOpen	Check if pet actions menu is open	bool

Server

Setters

Export	Description	Parameter(s)
OverrideMethod	Without going to main dependency, you can override various utility methods	string, function

Getters

Export	Description	Return Type
HasActivePet	Check if client has a pet active pet	bool or int

Events

Client

Event	Description
fd-pets:actions:spawnpet	Pet can be spawned with this event

Subscribable events

You can subscribe to these events if you want to something after they're triggered.

Server

Event	Description
fd-pets:server:entityDead	When triggered, it means pet / entity doesn't exist anymore, is out of scope or died
fd-pets:server:recallPet	When triggered, it means pet is being recalled

Adding new animation to menus. Refer to: AddNewAnimation

Adding new custom action to menus. Refer to: AddCustomAction