Lua functions

RemoveProc

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

Historical signature: RemoveProc(spawn, item)

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

Function: RemoveProc(spawn, item)

Description: Remove proc that was applied in a spell script or item script. Will apply to spawn unless item is not specified, then all spell targets are applicable.

Parameters:

  • spawn (Spawn) - Spawn object representing spawn.
  • item (Item) - Item object representing item.

Returns: None.

Spell caster lifetime: When this function reads a spell's caster, it retains that allocation for the native operation. Retirement or callback reentry cannot replace its caster with a different allocation at the same address or runtime ID. A known expired or cleared caster is not rediscovered through a replacement connection. An actor already owned by the active callback remains usable through that callback. See Lua actor lifetime.

Original spell targets: When this function uses a spell's target list, it snapshots references to the originally selected actor allocations. It skips unavailable or departed targets instead of selecting another actor with a reused runtime ID. Accepted actors remain physically retained through the active protected callback, including Lua errors; saved userdata and target records do not keep them alive between callbacks. Explicit Spawn arguments retain their existing selection behavior. See Lua actor lifetime.

Checked example

Active call in a local runtime Lua script. Uses the current spell context when no item is given. This is a contextual call pattern, not a tested standalone script.

RemoveProc()

Evidence: server/Spells/BastensRunesofSurety.lua:26; binding EQ2Emu_lua_RemoveProc.

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