EQ2Emu
Discord Log in

Lua functions

Despawn

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

Historical signature: Despawn(spawn, delay)

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

Function: Despawn(spawn, delay)

Description: Despawns the defined spawn, delay is optional, if provided the Despawn will take place after a delay.

Parameters:

  • spawn (Spawn) - Spawn object representing spawn.
  • delay (uint32) - Integer value delay.

Returns: None.

Checked example

Active call in a local runtime Lua script. The delay defaults to zero. This is a contextual call pattern, not a tested standalone script.

Despawn(Camp1Object)

Evidence: server/SpawnScripts/antonica/afociofdecayA.lua:142; binding EQ2Emu_lua_Despawn.

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