WoW:Events/A: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(+3.3.3)
m (Move page script moved page Events/A to Events/A without leaving a redirect)
 
(4 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<noinclude>{{eventlistheader}}</noinclude>
<!-- WARNING: do NOT edit with Visual editor turned on!!! -->
|}
===== =====
{|
{{evt|ACHIEVEMENT_EARNED|Achievements}}
Fired when an achievement is gained.
('''New with patch 3.0''')


; arg1 : The id of the achievement gained.
{{evt|ACTIONBAR_HIDEGRID|Action Bar}}
Fired when the actionbar numbers disappear, typically when you finish dragging something to the actionbar
; arg1 : the mouse button used to click the button. Known values: "LeftButton", "RightButton"
; arg2 : true or false for unknown reason.
{{evt|ACTIONBAR_PAGE_CHANGED|Action Bar}}
Fired when the actionbar page changes, typically when you press the pageup or pagedown button.
; arg1 : the mouse button used to click the button. Known values: "LeftButton", "RightButton"
; arg2 : true or false for unknown reason.
{{evt|ACTIONBAR_SHOWGRID|Action Bar}}
Fired when the actionbar numbers appear, typically when you drag a spell to the actionbar.
'''no arguments'''
{{evt|ACTIONBAR_SLOT_CHANGED|Action Bar}}
Fired when any actionbar slot's contents change; typically the picking up and dropping of buttons.
On 4/24/2006, [[Slouken]] stated "ACTIONBAR_SLOT_CHANGED is also sent whenever something changes whether or not the button should be dimmed. The first argument is the slot which changed." This means actions that affect the internal fields of action bar buttons also generate this event for the affected button(s). Examples include the Start and End of casting channeled spells, casting a new buff on yourself, and the cancellation or expiration of a buff on yourself.
; arg1 : the number of the slot that changed
; arg2 : true or false for unknown reason.
|}
===== =====
{|
{{evt|ACTIONBAR_UPDATE_COOLDOWN|Action Bar}}
Fired when the cooldown for an actionbar or inventory slot starts or stops. Also fires when you log into a new area.
; arg1 : if the cooldown is starting, the mouse button used to click the button. Known values: "leftButton"
:        if the cooldown is stopping or you are logging into a new zone, this is nil
{{evt|ACTIONBAR_UPDATE_STATE|Action Bar}}
Fired when the state of anything on the actionbar changes. This includes cooldown and disabling.
; arg1 : the mouse button used to click the button. Known values: "LeftButton", "RightButton"
:        can also be nil
{{evt|ACTIONBAR_UPDATE_USABLE|Action Bar}}
Fired when something in the actionbar or your inventory becomes usable (after eating or drinking a potion, or entering/leaving stealth; for example). This is affected by rage/mana/energy available, but not by range.
'''no arguments'''
{{evt|ACTIVE_TALENT_GROUP_CHANGED|Player}}
Fired when a player switches changes which talent group (dual specialization) is active.
; arg1 : Number - Index of the talent group that is now active.
|}
===== =====
{|
{{evt|ADDON_ACTION_BLOCKED|System}}
(this event doesn't seem to be used anymore, use ADDON_ACTION_FORBIDDEN instead)
===== =====
{{evt|ADDON_ACTION_FORBIDDEN|System}}
Fires when an AddOn tries use actions that are always forbidden (movement, targeting, etc.).
'''If called from an AddOn'''
----
; arg1 : Name of the AddOn that was last involved in the execution path.
; arg2 : The protected function that was called.
; Notes : It's very possible that arg1 will not be the name of the addon that tried to call the protected function.
'''If called from the chat prompt (/script [[API_CastSpellByName|CastSpellByName]]("Attack"))'''
----
; arg1 : The protected function that was called.
|}
===== =====
{|
{{evt|ADDON_LOADED|System}}
This event fires whenever an AddOn is loaded (fires once for each AddOn loaded if multiple AddOns are being loaded), whether that is during the inital Loading Phase or when an AddOn is loaded using the LoadAddOn("addonname") or UIParentLoadAddon("addonname") function.  This event always fires after SavedVariables of the AddOn have been loaded from disk and its OnLoad function has been executed.
; arg1 : name of the AddOn that was just loaded
{{evt|AREA_SPIRIT_HEALER_IN_RANGE|Death}}
{{evt|AREA_SPIRIT_HEALER_OUT_OF_RANGE|Death}}
{{evt|ARENA_TEAM_INVITE_REQUEST|Arena}}
{{evt|ARENA_TEAM_ROSTER_UPDATE|Arena}}
This event fires whenever an arena team is opened in the character sheet.  It also fires (3 times) when an arena member leaves, joins, or gets kicked.  It does NOT fire when an arena team member logs in or out. 
{{evt|ARENA_TEAM_UPDATE|Arena}}
This does NOT fire when an arena member joins the team, leaves, gets kicked, logs in/out.  Still unsure when this actually fires.
{{evt|ARENA_OPPONENT_UPDATE|Arena}}
?
{{evt|ARENA_SEASON_WORLD_STATE|Arena}}
?
{{evt|AUCTION_BIDDER_LIST_UPDATE|Auction}}
{{evt|AUCTION_HOUSE_CLOSED|Auction}}
This event is fired when the auction interface is closed.
;Note: This event fires twice; once while auction information is still available and once when it is not.
{{evt|AUCTION_HOUSE_DISABLED|Auction}}
Fired when the auction house is not operational.
{{evt|AUCTION_HOUSE_SHOW|Auction}}
This event is fired when the auction interface is first displayed. This is generally done by right-clicking an auctioneer in a major city.
{{evt|AUCTION_ITEM_LIST_UPDATE|Auction}}
This event is fired when the Auction list is updated.
Note that this is not only the case, if the list is completely changed but also if it is sorted (i.e. SortAuctionItems() is called).
{{evt|AUCTION_MULTISELL_FAILURE|Auction}}
Fired when listing of multiple stacks fails (or is aborted?).
{{evt|AUCTION_MULTISELL_START|Auction}}
Fired when the client begins listing of multiple stacks.
; arg1 : Number - total number of stacks the client has to list.
{{evt|AUCTION_MULTISELL_UPDATE|Auction}}
Fired when the client lists a stack as part of listing multiple stacks.
; arg1 : Number - number of stacks listed so far.
; arg2 : Number - total number of stacks in the current mass-listing operation.
|}
===== =====
{|
{{evt|AUCTION_OWNED_LIST_UPDATE|Auction}}
{{evt|AUTOEQUIP_BIND_CONFIRM|Item,Loot}}
Fired when the game attempts to autobind bind-on-equip items.
{{evt|AUTOFOLLOW_BEGIN|Movement}}
Fired when you begin automatically following an ally.
;arg1: The unit you are following.  Not necessarily your target (in case of right-clicking a group member's portrait or using the "/follow" command).
{{evt|AUTOFOLLOW_END|Movement}}
Fired when the player ceases following an ally

Latest revision as of 04:48, 15 August 2023

Event API


[edit]
"ACHIEVEMENT_EARNED"
Category: Achievements
 

Fired when an achievement is gained. (New with patch 3.0)

arg1
The id of the achievement gained.
"ACTIONBAR_HIDEGRID"
Category: Action Bar
 

Fired when the actionbar numbers disappear, typically when you finish dragging something to the actionbar

arg1
the mouse button used to click the button. Known values: "LeftButton", "RightButton"
arg2
true or false for unknown reason.


"ACTIONBAR_PAGE_CHANGED"
Category: Action Bar
 

Fired when the actionbar page changes, typically when you press the pageup or pagedown button.

arg1
the mouse button used to click the button. Known values: "LeftButton", "RightButton"
arg2
true or false for unknown reason.


"ACTIONBAR_SHOWGRID"
Category: Action Bar
 

Fired when the actionbar numbers appear, typically when you drag a spell to the actionbar.

no arguments


"ACTIONBAR_SLOT_CHANGED"
Category: Action Bar
 

Fired when any actionbar slot's contents change; typically the picking up and dropping of buttons.

On 4/24/2006, Slouken stated "ACTIONBAR_SLOT_CHANGED is also sent whenever something changes whether or not the button should be dimmed. The first argument is the slot which changed." This means actions that affect the internal fields of action bar buttons also generate this event for the affected button(s). Examples include the Start and End of casting channeled spells, casting a new buff on yourself, and the cancellation or expiration of a buff on yourself.

arg1
the number of the slot that changed
arg2
true or false for unknown reason.
[edit]
"ACTIONBAR_UPDATE_COOLDOWN"
Category: Action Bar
 

Fired when the cooldown for an actionbar or inventory slot starts or stops. Also fires when you log into a new area.

arg1
if the cooldown is starting, the mouse button used to click the button. Known values: "leftButton"
if the cooldown is stopping or you are logging into a new zone, this is nil


"ACTIONBAR_UPDATE_STATE"
Category: Action Bar
 

Fired when the state of anything on the actionbar changes. This includes cooldown and disabling.

arg1
the mouse button used to click the button. Known values: "LeftButton", "RightButton"
can also be nil


"ACTIONBAR_UPDATE_USABLE"
Category: Action Bar
 

Fired when something in the actionbar or your inventory becomes usable (after eating or drinking a potion, or entering/leaving stealth; for example). This is affected by rage/mana/energy available, but not by range.

no arguments

"ACTIVE_TALENT_GROUP_CHANGED"
Category: Player
 

Fired when a player switches changes which talent group (dual specialization) is active.

arg1
Number - Index of the talent group that is now active.
[edit]
"ADDON_ACTION_BLOCKED"
Category: System
 

(this event doesn't seem to be used anymore, use ADDON_ACTION_FORBIDDEN instead)

[edit]
"ADDON_ACTION_FORBIDDEN"
Category: System
 

Fires when an AddOn tries use actions that are always forbidden (movement, targeting, etc.).

If called from an AddOn


arg1
Name of the AddOn that was last involved in the execution path.
arg2
The protected function that was called.
Notes
It's very possible that arg1 will not be the name of the addon that tried to call the protected function.

If called from the chat prompt (/script CastSpellByName("Attack"))


arg1
The protected function that was called.


[edit]
"ADDON_LOADED"
Category: System
 

This event fires whenever an AddOn is loaded (fires once for each AddOn loaded if multiple AddOns are being loaded), whether that is during the inital Loading Phase or when an AddOn is loaded using the LoadAddOn("addonname") or UIParentLoadAddon("addonname") function. This event always fires after SavedVariables of the AddOn have been loaded from disk and its OnLoad function has been executed.

arg1
name of the AddOn that was just loaded


"AREA_SPIRIT_HEALER_IN_RANGE"
Category: Death
 


"AREA_SPIRIT_HEALER_OUT_OF_RANGE"
Category: Death
 


"ARENA_TEAM_INVITE_REQUEST"
Category: Arena
 
"ARENA_TEAM_ROSTER_UPDATE"
Category: Arena
 

This event fires whenever an arena team is opened in the character sheet. It also fires (3 times) when an arena member leaves, joins, or gets kicked. It does NOT fire when an arena team member logs in or out.

"ARENA_TEAM_UPDATE"
Category: Arena
 

This does NOT fire when an arena member joins the team, leaves, gets kicked, logs in/out. Still unsure when this actually fires.

"ARENA_OPPONENT_UPDATE"
Category: Arena
 

?

"ARENA_SEASON_WORLD_STATE"
Category: Arena
 

?

"AUCTION_BIDDER_LIST_UPDATE"
Category: Auction
 


"AUCTION_HOUSE_CLOSED"
Category: Auction
 

This event is fired when the auction interface is closed.

Note
This event fires twice; once while auction information is still available and once when it is not.
"AUCTION_HOUSE_DISABLED"
Category: Auction
 

Fired when the auction house is not operational.

"AUCTION_HOUSE_SHOW"
Category: Auction
 

This event is fired when the auction interface is first displayed. This is generally done by right-clicking an auctioneer in a major city.


"AUCTION_ITEM_LIST_UPDATE"
Category: Auction
 

This event is fired when the Auction list is updated. Note that this is not only the case, if the list is completely changed but also if it is sorted (i.e. SortAuctionItems() is called).

"AUCTION_MULTISELL_FAILURE"
Category: Auction
 

Fired when listing of multiple stacks fails (or is aborted?).

"AUCTION_MULTISELL_START"
Category: Auction
 

Fired when the client begins listing of multiple stacks.

arg1
Number - total number of stacks the client has to list.
"AUCTION_MULTISELL_UPDATE"
Category: Auction
 

Fired when the client lists a stack as part of listing multiple stacks.

arg1
Number - number of stacks listed so far.
arg2
Number - total number of stacks in the current mass-listing operation.
[edit]
"AUCTION_OWNED_LIST_UPDATE"
Category: Auction
 


"AUTOEQUIP_BIND_CONFIRM"
Category: Item,Loot
 

Fired when the game attempts to autobind bind-on-equip items.


"AUTOFOLLOW_BEGIN"
Category: Movement
 

Fired when you begin automatically following an ally.

arg1
The unit you are following. Not necessarily your target (in case of right-clicking a group member's portrait or using the "/follow" command).


"AUTOFOLLOW_END"
Category: Movement
 

Fired when the player ceases following an ally