dog-leashedAnimal Ped Support

isAnimal.lua

This module provides logic to detect if a Ped or model is an animal and classify it into specific categories (cat, dog, coyote, etc.). Useful for wildlife, animal roles, or pet systems.

circle-info

At player load in, it automaticallyattempts to get what kind of ped/animal you are but there are functions to double check in scripts

circle-exclamation

Global flags:

  • isCat, isDog, isBigDog, isSmallDog, isCoyote, isAnimal — used to store classification of the player's current ped.

isPedAnimal(ped?)

Checks if a ped is an animal based on predefined animal models.

Sets global isAnimal to true if matched.

Example:

local isPlayerAnimal = isPedAnimal()
local isOtherPedAnimal = isPedAnimal(GetPedInVehicleSeat(vehicle, -1))

isCat(ped)

Returns true if the ped model matches a cat.

Example:


isDog(ped)

Returns two values:

  • true, true — if ped is a big dog

  • true, false — if ped is a small dog

  • false, nil — if not a dog

Example:


getAnimalModels()

Returns a flat list of all registered animal model hashes.

circle-info

Can be used to check ped models against

Example:


getAnimalAnims(ped)

Returns the animation set defined for the given animal model.

Example:


Last updated