Skip to main content

🐶 Pet Module

Main Module for the pets.

GetPets​

Returns all the pets in the players inventory

local Framework = require(path.to.framework).GetServer()
local PetModule = Framework.PetModule

PetModule.GetPets(player)

GetInventoryCapacity​

Returns the max capacity

print(PetModule.GetInventoryCapacity(player))

HasSpaceFor​

Returns a boolean if the player has space for another pet

local hasSpace = PetModule.HasSpaceFor(player)

GetMultiplier​

Gets the players multiplier for all the pets combined.

local multi = PetModule.GetMultiplier(player)

GetEquipped​

Returns all the pets the player has equipped in a table

print(PetModule.GetEquipped(player))

GetEquippedPets​

Returns the number of pets equipped

print(PetModule.GetEquippedPets(player))

GetMaxEquipped​

Returns the maximum pet slots a player has

return PetModule.GetMaxEquipped(player)

EquipBest​

Equips the best pets the player has

PetModule.EquipBest(player)

Equip​

Equips a pet using the index.

PetModule.Equip(player, 10) -- index of the pet they want to equip.

Unequip​

Opposite of Equip.

PetModule.Unequip(player, 10)

GivePet​

Gives the player a pet

The pet must be valid, otherwise you cause data issues.

PetModule.GivePet(player, "Cat")

DeletePets​

Deletes a ton of pets from a table

The value taken in is NOT the pets name, but the index.

PetModule.DeletePets(player, { 1, 5, 10, 4, 9 })