WoW:Events/Spell: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Remove singatures made using ~ in main namespace)
m (Move page script moved page Events/Spell to Events/Spell without leaving a redirect)
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC____NOEDITSECTION__{{eventlistheader}}
<!-- DO NOT EDIT. THIS IS AN AUTOMATICALLY GENERATED PAGE. -->
<!-- DO NOT EDIT. THIS IS AN AUTOMATICALLY GENERATED PAGE. -->
<!-- DO NOT EDIT. THIS IS AN AUTOMATICALLY GENERATED PAGE. -->


:{{icon-information}}Note that this page is automatically generated; editing it is pointless. To edit event descriptions, edit the entries in the alphabetical pages, e.g. [[Events/A]], [[Events/B]], etc. Changes there will be copied over to here within a few hours.
== Spell related events ==
{{evt|CURRENT_SPELL_CAST_CHANGED|Spell}}
Fired when the spell being cast is changed.
{{evt|LEARNED_SPELL_IN_TAB|Spell}}
Fired when a new spell/ability is added to the spellbook. e.g. When training a new or a higher level spell/ability.
;arg1: Number of the tab which the spell/ability is added to
{{evt|PLAYER_FARSIGHT_FOCUS_CHANGED|Player,Spell}}
{{evt|SPELLS_CHANGED|Spell}}
{{evt|SPELL_UPDATE_COOLDOWN|Spell}}
This event is fired every three seconds for no apparent reason (correct as of patch 3.3.3).
When a spell that has no cast time is triggered it gets fired twice in quick succession. When a spell that has a cast time is triggered it gets fired at the start of the cast and again at the end of the cast.
{{evt|SPELL_UPDATE_USABLE|Spell}}
This event is fired when a spell becomes useable or unusable. However the definition of useable and unusable is somewhat confusing. Firstly, range is not taken into account. Secondly if a spell requires a valid target and doesn't have one it gets marked as useable. If it requires mana or rage and there isn't enough then it gets marked as unusable. This results in the following behaviour:
Start) Feral druid in bear form out of combat, no target selected.
1) Target enemy. Event is fired as some spells that require rage become marked as unusable. On the action bar the spell is marked in red as unusable.
2) Use Enrage to gain rage. Event is fired as we now have enough rage. On the action bar the spell is marked unusable as out of range.
3) Move into range. Event is not fired. On the action bar the spell is marked usable.
4) Rage runs out. Event is fired as we no longer have enough rage.
5) Remove target. Event is fired and spell is marked as useable on action bar.
It appears that the definition of useable is a little inaccurate and relates more to how it is displayed on the action bar than whether you can use the spell. Also after being attacked the event started firing every two seconds and this continued until well after the attacker was dead. Targetting a fresh enemy seemed to stop it.
{{evt|START_AUTOREPEAT_SPELL|Spell}}
{{evt|STOP_AUTOREPEAT_SPELL|Spell}}
{{evt|UNIT_HEALTH_PREDICTION|Unit Info,Spell}}
Added in 4.0
; arg1 : [[unitId]] receiving the incoming heal
{{evt|UNIT_SPELLCAST_CHANNEL_START|Unit Info,Spell}}
Added in 2.0. Fired when a unit begins channeling in the course of casting a spell. Received for party/raid members as well as the player.
; arg1 : Unit casting the spell
; arg2 : Spell name
; arg3 : Spell rank (deprecated in 4.0)
; arg4 : Spell lineID counter
; arg5 : Spell ID (added in 4.0)
{{evt|UNIT_SPELLCAST_CHANNEL_STOP|Unit Info,Spell}}
Added in 2.0. Fired when a unit stops channeling. Received for party/raid members as well as the player.
; arg1:  Unit casting the spell
; arg2 : Spell name
; arg3 : Spell rank (deprecated in 4.0)
; arg4 : Spell lineID counter
; arg5 : Spell ID (added in 4.0)
{{evt|UNIT_SPELLCAST_CHANNEL_UPDATE|Unit Info,Spell}}
Added in 2.0. Received for party/raid members, as well as the player
; arg1 : Unit casting the spell
; arg2 : Spell name
; arg3 : Spell rank (deprecated in 4.0)
; arg4 : Spell lineID counter
; arg5 : Spell ID (added in 4.0)
{{evt|UNIT_SPELLCAST_DELAYED|Unit Info,Spell}}
Added in 2.0. Fired when a unit's spellcast is delayed, including party/raid members or the player
; arg1 : Unit casting the spell
; arg2 : Spell name
; arg3 : Spell rank (deprecated in 4.0)
; arg4 : Spell lineID counter
; arg5 : Spell ID (added in 4.0)
{{evt|UNIT_SPELLCAST_FAILED|Unit Info,Spell}}
Added in 2.0. Fired when a unit's spellcast fails, including party/raid members or the player
; arg1 : Unit casting the spell
; arg2 : Spell name
; arg3 : Spell rank (deprecated in 4.0)
; arg4 : Spell lineID counter
; arg5 : Spell ID (added in 4.0)
{{evt|UNIT_SPELLCAST_FAILED_QUIET|Unit Info,Spell}}
; arg1 : Unit casting the spell
; arg2 : Spell name
; arg3 : Spell rank (deprecated in 4.0)
; arg4 : Spell lineID counter
; arg5 : Spell ID (added in 4.0)
{{evt|UNIT_SPELLCAST_INTERRUPTED|Unit Info,Spell}}
Added in 2.0. Fired when a unit's spellcast is interrupted, including party/raid members or the player
; arg1 : Unit casting the spell
; arg2 : Spell name
; arg3 : Spell rank (deprecated in 4.0)
; arg4 : Spell lineID counter
; arg5 : Spell ID (added in 4.0)
{{evt|UNIT_SPELLCAST_INTERRUPTIBLE|Unit Info,Spell}}
Added in 3.2 (Had to guess at the args)
; arg1 : Unit casting the spell
; arg2 : Spell name
; arg3 : Spell rank
{{evt|UNIT_SPELLCAST_NOT_INTERRUPTIBLE|Unit Info,Spell}}
Added in 3.2 (guessing at the args)
; arg1 : Unit casting the spell
; arg2 : Spell name
; arg3 : Spell rank
{{evt|UNIT_SPELLCAST_SENT|Unit Info,Spell}}
<Added in '''Patch 2.0'''> Fired when an event is sent to the server. Other messages indicate when the server begins timing or considers the cast successful.
; arg1 : Unit casting the spell
; arg2 : Spell name
; arg3 : Spell rank (deprecated in 4.0)
; arg4 : Spell target
{{evt|UNIT_SPELLCAST_START|Unit Info,Spell}}
Added in 2.0. Fired when a unit begins casting, including party/raid members or the player
; arg1 : Unit casting the spell
; arg2 : Spell name
; arg3 : Spell rank (deprecated in 4.0)
; arg4 : Spell lineID counter
; arg5 : Spell ID (added in 4.0)
{{evt|UNIT_SPELLCAST_STOP|Unit Info,Spell}}
Added in 2.0. Fired when a unit stops casting, including party/raid members or the player
; arg1 : Unit casting the spell
; arg2 : Spell name
; arg3 : Spell rank (deprecated in 4.0)
; arg4 : Spell lineID counter
; arg5 : Spell ID (added in 4.0)
{{evt|UNIT_SPELLCAST_SUCCEEDED|Unit Info,Spell}}
Added in 2.0. Fired when a spell is cast successfully. Event is received even if spell is resisted.
; arg1 : Unit casting the spell
; arg2 : Spell name
; arg3 : Spell rank (deprecated in 4.0)
; arg4 : Spell lineID counter
; arg5 : Spell ID (added in 4.0)

Latest revision as of 04:48, 15 August 2023

Event API


"I" iconNote that this page is automatically generated; editing it is pointless. To edit event descriptions, edit the entries in the alphabetical pages, e.g. Events/A, Events/B, etc. Changes there will be copied over to here within a few hours.


Spell related events

"CURRENT_SPELL_CAST_CHANGED"
Category: Spell
 

Fired when the spell being cast is changed.


"LEARNED_SPELL_IN_TAB"
Category: Spell
 

Fired when a new spell/ability is added to the spellbook. e.g. When training a new or a higher level spell/ability.

arg1
Number of the tab which the spell/ability is added to


"PLAYER_FARSIGHT_FOCUS_CHANGED"
Category: Player,Spell
 



"SPELLS_CHANGED"
Category: Spell
 



"SPELL_UPDATE_COOLDOWN"
Category: Spell
 

This event is fired every three seconds for no apparent reason (correct as of patch 3.3.3). When a spell that has no cast time is triggered it gets fired twice in quick succession. When a spell that has a cast time is triggered it gets fired at the start of the cast and again at the end of the cast.


"SPELL_UPDATE_USABLE"
Category: Spell
 

This event is fired when a spell becomes useable or unusable. However the definition of useable and unusable is somewhat confusing. Firstly, range is not taken into account. Secondly if a spell requires a valid target and doesn't have one it gets marked as useable. If it requires mana or rage and there isn't enough then it gets marked as unusable. This results in the following behaviour:

Start) Feral druid in bear form out of combat, no target selected.

1) Target enemy. Event is fired as some spells that require rage become marked as unusable. On the action bar the spell is marked in red as unusable.

2) Use Enrage to gain rage. Event is fired as we now have enough rage. On the action bar the spell is marked unusable as out of range.

3) Move into range. Event is not fired. On the action bar the spell is marked usable.

4) Rage runs out. Event is fired as we no longer have enough rage.

5) Remove target. Event is fired and spell is marked as useable on action bar.

It appears that the definition of useable is a little inaccurate and relates more to how it is displayed on the action bar than whether you can use the spell. Also after being attacked the event started firing every two seconds and this continued until well after the attacker was dead. Targetting a fresh enemy seemed to stop it.


"START_AUTOREPEAT_SPELL"
Category: Spell
 



"STOP_AUTOREPEAT_SPELL"
Category: Spell
 



"UNIT_HEALTH_PREDICTION"
Category: Unit Info,Spell
 

Added in 4.0

arg1
unitId receiving the incoming heal


"UNIT_SPELLCAST_CHANNEL_START"
Category: Unit Info,Spell
 

Added in 2.0. Fired when a unit begins channeling in the course of casting a spell. Received for party/raid members as well as the player.

arg1
Unit casting the spell
arg2
Spell name
arg3
Spell rank (deprecated in 4.0)
arg4
Spell lineID counter
arg5
Spell ID (added in 4.0)


"UNIT_SPELLCAST_CHANNEL_STOP"
Category: Unit Info,Spell
 

Added in 2.0. Fired when a unit stops channeling. Received for party/raid members as well as the player.

arg1
Unit casting the spell
arg2
Spell name
arg3
Spell rank (deprecated in 4.0)
arg4
Spell lineID counter
arg5
Spell ID (added in 4.0)


"UNIT_SPELLCAST_CHANNEL_UPDATE"
Category: Unit Info,Spell
 

Added in 2.0. Received for party/raid members, as well as the player

arg1
Unit casting the spell
arg2
Spell name
arg3
Spell rank (deprecated in 4.0)
arg4
Spell lineID counter
arg5
Spell ID (added in 4.0)


"UNIT_SPELLCAST_DELAYED"
Category: Unit Info,Spell
 

Added in 2.0. Fired when a unit's spellcast is delayed, including party/raid members or the player

arg1
Unit casting the spell
arg2
Spell name
arg3
Spell rank (deprecated in 4.0)
arg4
Spell lineID counter
arg5
Spell ID (added in 4.0)


"UNIT_SPELLCAST_FAILED"
Category: Unit Info,Spell
 

Added in 2.0. Fired when a unit's spellcast fails, including party/raid members or the player

arg1
Unit casting the spell
arg2
Spell name
arg3
Spell rank (deprecated in 4.0)
arg4
Spell lineID counter
arg5
Spell ID (added in 4.0)


"UNIT_SPELLCAST_FAILED_QUIET"
Category: Unit Info,Spell
 
arg1
Unit casting the spell
arg2
Spell name
arg3
Spell rank (deprecated in 4.0)
arg4
Spell lineID counter
arg5
Spell ID (added in 4.0)


"UNIT_SPELLCAST_INTERRUPTED"
Category: Unit Info,Spell
 

Added in 2.0. Fired when a unit's spellcast is interrupted, including party/raid members or the player

arg1
Unit casting the spell
arg2
Spell name
arg3
Spell rank (deprecated in 4.0)
arg4
Spell lineID counter
arg5
Spell ID (added in 4.0)


"UNIT_SPELLCAST_INTERRUPTIBLE"
Category: Unit Info,Spell
 

Added in 3.2 (Had to guess at the args)

arg1
Unit casting the spell
arg2
Spell name
arg3
Spell rank


"UNIT_SPELLCAST_NOT_INTERRUPTIBLE"
Category: Unit Info,Spell
 

Added in 3.2 (guessing at the args)

arg1
Unit casting the spell
arg2
Spell name
arg3
Spell rank


"UNIT_SPELLCAST_SENT"
Category: Unit Info,Spell
 

<Added in Patch 2.0> Fired when an event is sent to the server. Other messages indicate when the server begins timing or considers the cast successful.

arg1
Unit casting the spell
arg2
Spell name
arg3
Spell rank (deprecated in 4.0)
arg4
Spell target


"UNIT_SPELLCAST_START"
Category: Unit Info,Spell
 

Added in 2.0. Fired when a unit begins casting, including party/raid members or the player

arg1
Unit casting the spell
arg2
Spell name
arg3
Spell rank (deprecated in 4.0)
arg4
Spell lineID counter
arg5
Spell ID (added in 4.0)


"UNIT_SPELLCAST_STOP"
Category: Unit Info,Spell
 

Added in 2.0. Fired when a unit stops casting, including party/raid members or the player

arg1
Unit casting the spell
arg2
Spell name
arg3
Spell rank (deprecated in 4.0)
arg4
Spell lineID counter
arg5
Spell ID (added in 4.0)


"UNIT_SPELLCAST_SUCCEEDED"
Category: Unit Info,Spell
 

Added in 2.0. Fired when a spell is cast successfully. Event is received even if spell is resisted.

arg1
Unit casting the spell
arg2
Spell name
arg3
Spell rank (deprecated in 4.0)
arg4
Spell lineID counter
arg5
Spell ID (added in 4.0)