Skip to content

Commit abf15a5

Browse files
committed
Update documentation.
1 parent 9572121 commit abf15a5

4 files changed

Lines changed: 232 additions & 205 deletions

File tree

methods/TrinityCore/AuraMethods.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,9 +169,9 @@ namespace LuaAura
169169
}
170170

171171
/**
172-
* Returns the [ElunaSpellInfo] of the spell that created this [Aura].
172+
* Returns the [SpellInfo] of the spell that created this [Aura].
173173
*
174-
* @return [ElunaSpellInfo] spellInfo
174+
* @return [SpellInfo] spellInfo
175175
*/
176176
int GetSpellInfo(Eluna* E, Aura* aura)
177177
{

methods/TrinityCore/GlobalMethods.h

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1204,10 +1204,32 @@ namespace LuaGlobalFunctions
12041204
* In Multistate mode (default), events are either registered to the WORLD state (-1) or the MAP states (map ID). These events will only ever trigger on their respective state.
12051205
*
12061206
* In Compatibility mode, all events are registered to the WORLD state (-1).
1207-
*
1207+
*
12081208
* @table
12091209
* @columns [ID, Event, State, Parameters, Comment]
1210-
* @values [1, ON_CAST, "MAP", <event: number, spell: Spell, skipCheck: boolean>, ""]
1210+
* @values [1, ON_CAST, "MAP", <event: number, spell: Spell, skipCheck: boolean>, ""]
1211+
* @values [2, ON_AURA_APPLICATION, "MAP", <event: number, aura: Aura, auraEff: AuraEffect, target: Unit, mode: number, apply: boolean>, "Can return true to prevent application"]
1212+
* @values [3, ON_DISPEL, "MAP", <event: number, aura: Aura, dispeller: WorldObject, dispellerSpellId: number, removedCharges: number>, ""]
1213+
* @values [4, ON_PERIODIC_TICK, "MAP", <event: number, aura: Aura, auraEff: AuraEffect, target: Unit>, "Can return true to prevent tick"]
1214+
* @values [5, ON_PERIODIC_UPDATE, "MAP", <event: number, aura: Aura, auraEff: AuraEffect>, ""]
1215+
* @values [6, ON_AURA_CALC_AMOUNT, "MAP", <event: number, aura: Aura, auraEff: AuraEffect, amount: number, canBeRecalculated: boolean>, "Can return amount, canBeRecalculated to override"]
1216+
* @values [7, ON_CALC_PERIODIC, "MAP", <event: number, aura: Aura, auraEff: AuraEffect, isPeriodic: boolean, amplitude: number>, "Can return isPeriodic, amplitude to override"]
1217+
* @values [8, ON_CHECK_PROC, "MAP", <event: number, aura: Aura, procInfo: ElunaProcInfo>, "Can return false to prevent proc"]
1218+
* @values [9, ON_PROC, "MAP", <event: number, aura: Aura, procInfo: ElunaProcInfo>, "Can return true to prevent default proc handling"]
1219+
* @values [10, ON_CHECK_CAST, "MAP", <event: number, spell: Spell>, "Can return SpellCastResult to override cast result"]
1220+
* @values [11, ON_BEFORE_CAST, "MAP", <event: number, spell: Spell>, ""]
1221+
* @values [12, ON_AFTER_CAST, "MAP", <event: number, spell: Spell>, ""]
1222+
* @values [13, ON_OBJECT_AREA_TARGET, "MAP", <event: number, spell: Spell, effIndex: number, targets: table>, "Modify targets table in place to change targets"]
1223+
* @values [14, ON_OBJECT_TARGET, "MAP", <event: number, spell: Spell, effIndex: number, target: WorldObject>, ""]
1224+
* @values [15, ON_DEST_TARGET, "MAP", <event: number, spell: Spell, effIndex: number, mapId: number, x: number, y: number, z: number, orientation: number>, "Can return mapId, x, y, z, orientation to override destination"]
1225+
* @values [16, ON_EFFECT_LAUNCH, "MAP", <event: number, spell: Spell, effIndex: number, mode: number>, "Can return true to prevent default launch handling"]
1226+
* @values [17, ON_EFFECT_LAUNCH_TARGET, "MAP", <event: number, spell: Spell, effIndex: number, mode: number>, "Can return true to prevent default launch target handling"]
1227+
* @values [18, ON_EFFECT_CALC_ABSORB, "MAP", <event: number, spell: Spell, attacker: Unit, victim: Unit, damage: number, absorb: number, resist: number, block: number, schoolMask: number, damageType: number, attackType: number, hitMask: number, resistAmount: number, absorbAmount: number>, "Can return resistAmount, absorbAmount to override"]
1228+
* @values [19, ON_EFFECT_HIT, "MAP", <event: number, spell: Spell, effIndex: number, mode: number>, "Can return true to prevent default hit handling"]
1229+
* @values [20, ON_BEFORE_HIT, "MAP", <event: number, spell: Spell, missInfo: number>, ""]
1230+
* @values [21, ON_EFFECT_HIT_TARGET, "MAP", <event: number, spell: Spell, effIndex: number, mode: number>, "Can return true to prevent default hit target handling"]
1231+
* @values [22, ON_HIT, "MAP", <event: number, spell: Spell>, ""]
1232+
* @values [23, ON_AFTER_HIT, "MAP", <event: number, spell: Spell>, ""]
12111233
*
12121234
* @proto cancel = (entry, event, function)
12131235
* @proto cancel = (entry, event, function, shots)
@@ -3090,10 +3112,10 @@ namespace LuaGlobalFunctions
30903112
}
30913113

30923114
/**
3093-
* Returns the [ElunaSpellInfo] for the given spell ID, or nil if the spell does not exist.
3115+
* Returns the [SpellInfo] for the given spell ID, or nil if the spell does not exist.
30943116
*
30953117
* @param uint32 spellId : the spell ID to look up
3096-
* @return [ElunaSpellInfo] spellInfo
3118+
* @return [SpellInfo] spellInfo
30973119
*/
30983120
int GetSpellInfo(Eluna* E)
30993121
{

0 commit comments

Comments
 (0)