Skip to main content

Pet State Action

Type: pets_state Modifies the state of a specific pet for the player.

Configuration

FieldTypeDefaultDescription
idString""Unique identifier.
petRef<PetDefinition>EmptyThe pet species to affect.
actionEnumACTIVATEAction to perform.

Actions

ActionDescription
ACTIVATESpawn the pet and make it the active companion.
DEACTIVATEDespawn the pet if it is currently active.
HIDEHide the pet (despawn visuals but keep active status).
SHOWShow the pet (spawn visuals if active).
REMOVERemove the pet from the player’s collection entirely.