Electus DocumentationElectus Pets Exports
Exports for integrating Electus Pets with your own FiveM scripts, with parameters and usage.
Client Exports
Delete Pets
Delete all pets outside for the player (not permanently).
exports["electus_pets"]:DeletePets()Get Pets
Get all pets outside
exports["electus_pets"]:GetPets()Returns: table - A list of all pets outside for the player.
Any Pets Outside
Check if the player has any pets outside.
exports["electus_pets"]:AnyPetsOutside()Returns: boolean - true if the player has any pets outside, otherwise false.
Is Riding
Check if the player is riding a pet.
exports["electus_pets"]:IsRiding()Returns: boolean - true if the player is riding a pet, otherwise false.
GivePet
Gives a pet to a source
exports["electus_pets"]:GivePet(source, name, model, startingPoints, variation, sex)| Prop | Description | Type |
|---|---|---|
| src | The source of the player. | number |
| name | The name of the pet. | string |
| model | The model of the pet. | string |
| startingPoints | The starting points of the pet. | number |
| variation | The variation of the pet. | number |
| sex | The sex of the pet. | number |
Returns: boolean - true if the pet was given, otherwise false.