Lua functions

GetSpellDisplayEffect

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

Historical signature: GetSpellDisplayEffect(spell, idx, field)

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

Function: GetSpellDisplayEffect(spell, idx, field)

Description: Gets the spell display effect defined on the spell by its index. Field can represent "description" (return string), "bullet" (return uint32) or "percentage" (return uint32).

Parameters:

  • spell (Spell) - Spell object representing spell.
  • idx (uint32) - Integer value idx.
  • field (string) - String field.

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. Historical explanation: EQ2Emu Lua documentation.