Electus LogoElectus Documentation

Exports

Integrate Electus Pets to your scripts

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)
PropDescriptionType
srcThe source of the player.number
nameThe name of the pet.string
modelThe model of the pet.string
startingPointsThe starting points of the pet.number
variationThe variation of the pet.number
sexThe sex of the pet.number

Returns: boolean - true if the pet was given, otherwise false.