Lua functions

GetDeityPet

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

Historical signature: GetDeityPet(spawn)

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

Function: GetDeityPet(spawn)

Description: Retrieves the deity pet entity belonging to the specified player, if the deity pet is currently summoned.

Parameters:

  • spawn (Spawn) - Spawn object representing spawn.

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.

pet = GetDeityPet(Caster)

Evidence: server/Spells/Commoner/PeacefulVisage.lua:28; binding EQ2Emu_lua_GetDeityPet.

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