Lua functions

RemoveSpell

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

Historical signature: RemoveSpell(…) via current binding

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

Function: RemoveSpell(spawn, spell_id, maintained_spell, reason)

Description:

Removes the selected spell from an entity. Selects its maintained entry when maintained_spell is true; otherwise selects a spell-effect entry. Empty reason defaults to canceled. Invalid spawn, zone or spell ID does nothing.

Parameters:

  • spawn (Spawn) - Entity from which to remove the spell.
  • spell_id (uint32) - Nonzero spell ID to select.
  • maintained_spell (boolean, optional) - Select a maintained entry when true; defaults false.
  • reason (string, optional) - Removal reason; defaults to canceled when empty.

Returns: None.

Checked example

No checked example is published for this function yet. No active script call with the current C++ argument count was found.

Current registration: WorldServer/Lua/LuaInterface.cpp.