Lua functions

ProcDamage

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

Historical signature: ProcDamage(caster, target, name, dmg_type, low_damage, high_damage, success_msg, effect_msg)

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

Function: ProcDamage(caster, target, name, dmg_type, low_damage, high_damage, success_msg, effect_msg)

Description: Conduct proc damage against the target.

Parameters:

  • caster (Spawn) - Spawn object representing caster.
  • target (Spawn) - Spawn object representing target.
  • name (string) - String name.
  • dmg_type (uint8) - Integer value dmg_type.
  • low_damage (uint32) - Integer value low_damage.
  • high_damage (uint32) - Integer value high_damage.
  • success_msg (string) - String success_msg.
  • effect_msg (string) - String effect_msg.

Returns: None.

Checked example

Active call in a local runtime Lua script. Optional success and effect messages default to empty strings. This is a contextual call pattern, not a tested standalone script.

ProcDamage(Caster, Target, "Lash", DDType, DDLow, DDHigh)

Evidence: server/Spells/Mage/Enchanter/Coercer/SpellCurse.lua:19; binding EQ2Emu_lua_ProcDamage.

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