Lua functions

GetSpawn

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

Historical signature: GetSpawn(spawn, spawn_id)

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

Function: GetSpawn(spawn, spawn_id)

Description: Gets a spawn object by the spawn_id in the area. The spawn value references the area to search.

Parameters:

  • spawn (Spawn) - Spawn object representing spawn.
  • spawn_id (uint32) - Integer value spawn_id. 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.

whelp = GetSpawn(NPC, id)

Evidence: server/SpawnScripts/Butcherblock/qsttalvraesbowl.lua:27; binding EQ2Emu_lua_GetSpawn.

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