Lua functions

DismissPet

Registered in this checkout as EQ2Emu_lua_DismissPet; implementation found at WorldServer/Lua/LuaFunctions.cpp:6505.

Historical signature: DismissPet(Spawn)

Parameter and behavior details in the historical explanation are under review against the current implementation.

Function: DismissPet(Spawn)

Description: Dismisses (despawns) the specified player’s active pet. This works for combat pets, cosmetic pets, deity pets, etc., causing them to vanish as if the player dismissed them manually.

Parameters:

  • spawn (Spawn) - Spawn object representing spawn.

Returns: None.

Checked example

Active call in a local runtime Lua script. Argument count matches current fixed C++ readers. This is a contextual call pattern, not a tested standalone script.

DismissPet(pet)

Evidence: server/Spells/AA/SummonAnimatedTome.lua:21; binding EQ2Emu_lua_DismissPet.

Current registration: WorldServer/Lua/LuaInterface.cpp. Historical explanation: EQ2Emu Lua documentation.