Lua functions

SpellHeal

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

Historical signature: SpellHeal(heal_type, min_heal, max_heal, target, crit_mod, no_calcs, custom_spell_name)

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

Function: SpellHeal(heal_type, min_heal, max_heal, target, crit_mod, no_calcs, custom_spell_name)

Description: Heal or Increase Power of a Target inside of a spell script. heal_type is "heal" or "power".

Parameters:

  • heal_type (string) - String value heal_type.
  • min_heal (int32) - Integer value min_heal.
  • max_heal (int32) - Integer value max_heal.
  • target (Spawn) - Spawn object representing target.
  • crit_mod (int32) - Integer value crit_mod.
  • no_calcs (int32) - Integer value no_calcs.
  • custom_spell_name (string) - String custom_spell_name.

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 call uses active spell targets when no explicit target is supplied. This is a contextual call pattern, not a tested standalone script.

SpellHeal("Heal", HoTMin, HoTMax)

Evidence: server/Spells/AA/AncestralChanneling.lua:17; binding EQ2Emu_lua_SpellHeal.

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