Lua functions

GetBoundZoneID

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

Historical signature: GetBoundZoneID(spawn)

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

Function: GetBoundZoneID(spawn)

Description: Gets the zone id the Spawn(Player) is bound in.

Parameters:

  • spawn (Spawn) - Spawn object representing spawn.

Returns: Returns UINT32 of the Zone ID.

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.

if GetBoundZoneID(Caster) == 0 then

Evidence: server/Spells/Commoner/CalltoHome.lua:10; binding EQ2Emu_lua_GetBoundZoneID.

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