Lua functions

CureByControlEffect

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

Historical signature: CureByControlEffect(cure_count, cure_type, cure_name, cure_level, target)

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

Function: CureByControlEffect(cure_count, cure_type, cure_name, cure_level, target)

Description: Cures the control effects. cure_count controls the amount of cures activated, cure_type will be the control effect type. If in a spell script and no target it will apply to all spell targets.

Parameters:

  • cure_count (uint8) - Integer value cure_count.
  • cure_type (uint8) - Integer value cure_type.
  • cure_name (string) - String cure_name.
  • cure_level (uint8) - Integer value cure_level.
  • target (Spawn) - Spawn object representing target.

Returns: None.

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.

CureByControlEffect(1, 1, "Cure", Effect00Value00, Caster)

Evidence: server/Spells/ClassicRefresh/Priest/Cleric/Inquisitor/FerventFocus-2551708.lua:13; binding EQ2Emu_lua_CureByControlEffect.

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