Lua functions

GetRandomSpawnByID

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

Historical signature: GetRandomSpawnByID(spawnref, spawn_id)

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

Function: GetRandomSpawnByID(spawnref, spawn_id)

Description: Gets a random spawn by spawn_id where spawnref is located (zone area).

Parameters:

  • spawnref (Spawn) - Spawn object representing spawnref.
  • spawn_id (uint32) - Integer value spawn_id.

Returns: Spawn object reference matching the spawn_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.

vim = GetRandomSpawnByID(NPC, 270007)

Evidence: server/SpawnScripts/FarJourneyFreeport/Ingrid.lua:310; binding EQ2Emu_lua_GetRandomSpawnByID.

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