Lua functions

RemoveControlEffect

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

Historical signature: RemoveControlEffect(spawn, type, only_remove_spawn)

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

Function: RemoveControlEffect(spawn, type, only_remove_spawn)

Description: Removes a control effect from the Spawn or from the spell targets of a spell.

Parameters:

  • Spawn (Spawn) - Spawn object reference spawn.
  • type (int32) - Integer value type.
  • only_remove_spawn (int32) - Integer value only_remove_spawn.

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. The only-remove-spawn flag defaults to false. This is a contextual call pattern, not a tested standalone script.

RemoveControlEffect(Target, 3)

Evidence: server/Spells/AA/DazingBash.lua:23; binding EQ2Emu_lua_RemoveControlEffect.

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