Skip to content

Exports

Name Description Return
addMonster Adds a Monster to a trainer's party or storage. Returns true if the Monster was successfully added.
createMonster Creates a Monster that is not spawned. The unique ID of the created Monster.
despawnMonster Removes a spawned Monster from the world. nil
getMonsterByEntity Finds the Monster ID based on the given entity from the trainer's team. Returns the Monster ID if found in the trainer's team, or nil otherwise.
getMonsterEntity Returns the entity associated with a Monster in the trainer's team. Returns the entity of the Monster if found in the trainer's team, or nil otherwise.
getMonsterHp Gets monster HP. Returns monster HP.
getMonsterLevel Gets the monster level. Returns monster level.
getMonsterName Gets monster name. Returns monster name.
getMonsterPed Gets monster ped. Returns the monster ped.
getTrainerBySource Gets the trainer ID by the current player source. Returns trainerId.
getTrainerMonster Returns a list of Monster IDs in the current trainer's team. An array containing the IDs of all Monsters in the trainer's team.
hasMonsterMove Check if monster has move. Returns true if the Monster has move.
hasMonsterTool Check if monster has a tool of specific type or any. Returns if monster has a tool for that type.
healTrainerTeam Heal trainer team. nil
isMonsterBussy Check if monster is bussy, for example in battle. Returns if monster is bussy.
isTrainerBusy Check if trainer is bussy, for example in battle. Returns if trainer is bussy.
openTrainerPC Opens the trainer PC. nil
spawnMonster Spawns an existing Monster at the specified coordinates. nil
useMonsterTool Uses a the monster tool with an specific type it returns the boost. Returns the tool boost.
wanderMonster Makes a Monster start wandering around its current position. nil
wanderStopMonster Makes a Monster stop wandering around its current position. nil