Recent changes Random page
GAMING
Gaming
 
StarCraft Wiki
Super Smash Wiki
Halopedia
Diablo Wiki
FFXIclopedia
Grand Theft Wiki
See more...

Events A-Z (full list)

From WoWWiki

Jump to: navigation, search
Main Menu


This is a full list of all API events compiled on one page. It is aimed at simplifying event finding using the find feature in your browser, looking for a particular word or result. If you know the name of the event and want to know what it returns it might be more useful to use the indexed pages which are simpler to glance at, will load faster and will save the wiki bandwidth.

This page is automatically updated from the sub pages. It does not need to be edited. It may however need to be purged to pull in changes.


A

"ACHIEVEMENT_EARNED"
Category: Achievements
 

(New with patch 3.0)

"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.
"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).

no arguments

"ADDON_ACTION_BLOCKED"
Category: System
 

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

"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.


"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.

"AUCTION_BIDDER_LIST_UPDATE"
Category: Auction
 


"AUCTION_HOUSE_CLOSED"
Category: Auction
 

This event is fired when the auction interface is closed.

Note
It appears to fire twice, but the reason is unknown.
"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_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

B

"BAG_CLOSED"
Category: Item
 

Fired when a bag is (re)moved from its bagslot. Fires both for player bags and bank bags.

arg1 
container ID


"BAG_OPEN"
Category: Item
 

Fired when a bag (NOTE: This is NOT fired for player containers, it's for those bag-like objects that you can remove items from but not put items into) is opened.

arg1 
container ID
"BAG_UPDATE"
Category: Item
 

Fired when a bags inventory changes. Bag zero, the sixteen slot default backpack, may not fire on login. Upon login (or reloading the console) this event fires even for bank bags. When moving an item in your inventory, this fires multiple times: once each for the source and destination bag. If the bag involved is the default backpack, this event will also fire with a container ID of "-2" (twice if you are moving the item inside the same bag).

arg1 
container ID


"BAG_UPDATE_COOLDOWN"
Category: Item
 

Fired when a cooldown update call is sent to a bag

arg1 
container ID (may also be nil, 00:47, 15 January 2007 (EST))


"BANKFRAME_CLOSED"
Category: Bank
 

Fired twice when the bank window is closed.

Only at the first one of them the bank data is still available (GetNumBankSlots(), GetContainerItemLink(), ...)

"BANKFRAME_OPENED"
Category: Bank
 

Fired when the bank frame is opened


"BATTLEFIELDS_CLOSED"
Category: Battleground
 

Fired when the battlegrounds signup window is closed.


"BATTLEFIELDS_SHOW"
Category: Battleground
 

Fired when the battlegrounds signup window is opened.

"BILLING_NAG_DIALOG"
Category: Misc
 


"BIND_ENCHANT"
Category: Item
 

Fired when Enchanting an unbound item.

C

"CANCEL_LOOT_ROLL"
Category: Loot
 

Fired when a player cancels a roll on an item

arg1 : rollID
"CANCEL_SUMMON"
Category: Player
 
"CHANNEL_COUNT_UPDATE"
Category: Misc
 

Fired when number of players in a channel changes but only if this channel is visible in ChannelFrame (it mustn't be hidden by a collapsed category header)

arg1 
channel id (item number in Blizzards ChannelFrame -> quod vide API GetChannelDisplayInfo)
arg2 
number of players in channel
"CHANNEL_FLAGS_UPDATED"
Category: Misc
 

Fired when user changes selected channel in Blizzards ChannelFrame

arg1 
channel id (item number in Blizzards ChannelFrame -> quod vide API GetChannelDisplayInfo)
"CHANNEL_PASSWORD_REQUEST"
Category: Misc
 

Fired when user is asked for a password (normally after trying to join a channel without a password or with a wrong one)

arg1 
channel name
"CHANNEL_ROSTER_UPDATE"
Category: Misc
 

Fired when user changes selected channel in Blizzards ChannelFrame or number of players in currently selected channel changes

arg1 
channel id (item number in Blizzards ChannelFrame -> quod vide API GetChannelDisplayInfo)
arg2 
number of players in channel
"CHANNEL_UI_UPDATE"
Category: Misc
 

Fired when Channel UI should change (e.g. joining / leaving a channel causes this event to fire)

"CHANNEL_VOICE_UPDATE"
Category: Misc
 
arg1 
unknown
arg2 
unknown
arg3 
unknown
"CHARACTER_POINTS_CHANGED"
Category: Player
 

Fired when the player's available talent points change

arg1 
indicates number of talent points changed: -1 indicates one used (learning a talent), 1 indicates one gained (leveling)
"CHAT_MSG_ADDON"
Category: Communication
 

(new with patch 1.12)

Fired when the client receives a message from SendAddonMessage

arg1 
prefix
arg2 
message
arg3 
distribution type ("PARTY", "RAID", "GUILD", "BATTLEGROUND" or "WHISPER")
arg4 
sender


"CHAT_MSG_AFK"
Category: Communication
 

Fired when the client receives an AFK auto-response

arg1 
AFK response message
arg2 
author
"CHAT_MSG_BATTLEGROUND"
Category: Communication,Battleground
 

(new with patch 1.12)

Fired when a message is received through the battleground group channel

arg1 
chat message
arg2 
author
arg3 
language


"CHAT_MSG_BATTLEGROUND_LEADER"
Category: Communication,Battleground
 

(new with patch 1.12)

Fired when a message is received from the leader of the battleground group

arg1 
chat message
arg2 
author
arg3 
language
"CHAT_MSG_BG_SYSTEM_ALLIANCE"
Category: Communication,Battleground
 

Fired for alliance specific events in the battleground such as assaulting a graveyard.

arg1 
Battleground Message (eg. "The Alliance has taken the Blacksmith!")


"CHAT_MSG_BG_SYSTEM_HORDE"
Category: Communication,Battleground
 

Fired for horde specific events in the battleground such as assaulting a graveyard.

arg1 
Battleground Message (eg. "The Horde has taken the Blacksmith!")


"CHAT_MSG_BG_SYSTEM_NEUTRAL"
Category: Communication,Battleground
 

Fired for non faction specific events in the battlegrounds such as the battle start announcement.

arg1 
Battleground Message (eg. "Let the battle for Warsong Gulch begin.")
"CHAT_MSG_CHANNEL"
Category: Communication
 

Fired when the client receives a channel message.

arg1 
chat message
arg2 
author
arg3 
language
arg4 
channel name with number ex: "1. General - Stormwind City"
  • zone is always current zone even if not the same as the channel name
arg5 
target
  • second player name when two users are passed for a CHANNEL_NOTICE_USER (E.G. x kicked y)
arg6 
AFK/DND/GM "CHAT_FLAG_"..arg6 flags
arg7 
zone ID used for generic system channels (1 for General, 2 for Trade, 22 for LocalDefense, 23 for WorldDefense and 26 for LFG)
  • not used for custom channels or if you joined an Out-Of-Zone channel ex: "General - Stormwind City"
arg8 
channel number
arg9 
channel name without number (this is _sometimes_ in lowercase)
  • zone is always current zone even if not the same as the channel name
"CHAT_MSG_CHANNEL_JOIN"
Category: Communication
 

Fired when someone joins a chat channel you are in

arg1 
seems to be empty
arg2 
Name of the player that joined
arg3 
seems to be empty again
arg4 
Number and name of the channel (e.g. "5. MyOwnChannel")
arg8 
Channel number
arg9 
channel name without number (this is sometimes in lowercase)
"CHAT_MSG_CHANNEL_LEAVE"
Category: Communication
 

Fired when a player leaves a channel that you are currently inside.

arg1 
Appears to be left blank
arg2 
Player name that left
arg4 
Channel name with number
arg7 
Appears to be left zero and no longer the channel number
arg8 
Channel number
arg9 
Channel name without number
"CHAT_MSG_CHANNEL_LIST"
Category: Communication
 

Fired when ListChannels() or ListChannelByName() is called, and the message is displayed in the chat frame.

arg1
The list of values displayed by ListChannels() or ListChannelByName() in one string.
arg4
The number and name of the channel the message came from. ie: "1. General"


"CHAT_MSG_CHANNEL_NOTICE"
Category: Communication
 

Fired when you enter or leave a chat channel (or a channel was recently throttled)

arg1 
type ( "YOU_JOINED" if you joined a channel, or "YOU_LEFT" if you left, or "THROTTLED" if channel was throttled )
arg4 
Channel name with number (e.g. "6. TestChannel")
arg7 
Channel Type (e.g. 0 for any user channel, 1 for system-channel "General", 2 for "Trade")
arg8 
Channel Number
arg9 
Channel name without number
"CHAT_MSG_CHANNEL_NOTICE_USER"
Category: Communication
 

Fired when something changes in the channel like moderation enabled, user is kicked, announcements changed and so on.

CHAT_*_NOTICE in GlobalStrings.lua has a full list of available types.

arg1 
type ("ANNOUNCEMENTS_OFF", "ANNOUNCEMENTS_ON", "BANNED", "CHANNEL_OWNER", "INVALID_NAME", "INVITE", "MODERATION_OFF", "MODERATION_ON", "MUTED", "NOT_MEMBER", "NOT_MODERATED" )
arg2 
If arg5 has a value then this is the user affected ( eg: "Player Foo has been kicked by Bar" ), if arg5 has no value then it's the person who caused the event ( eg: "Channel Moderation has been enabled by Bar" )
arg4 
Channel name with number
arg5 
Player that caused the event (eg "Player Foo has been kicked by Bar" )
"CHAT_MSG_COMBAT_CREATURE_VS_CREATURE_HITS"
Category: Obsolete Events
 
Replaced in 2.4.0 with COMBAT_LOG_EVENT

Fired when a creature hits another creature. Note that this can fire for players if the server is out of sync.

arg1 
chat message


"CHAT_MSG_COMBAT_CREATURE_VS_CREATURE_MISSES"
Category: Obsolete Events
 
Replaced in 2.4.0 with COMBAT_LOG_EVENT

Fired when a creature misses another creature. Note that this can fire for players if the server is out of sync.

arg1 
chat message


"CHAT_MSG_COMBAT_CREATURE_VS_PARTY_HITS"
Category: Obsolete Events
 
Replaced in 2.4.0 with COMBAT_LOG_EVENT

Fired when a creature hits a party member

arg1 
chat message
"CHAT_MSG_COMBAT_CREATURE_VS_PARTY_MISSES"
Category: Obsolete Events
 
Replaced in 2.4.0 with COMBAT_LOG_EVENT

Fired when a creature misses a party member

arg1 
chat message


"CHAT_MSG_COMBAT_CREATURE_VS_SELF_HITS"
Category: Obsolete Events
 
Replaced in 2.4.0 with COMBAT_LOG_EVENT

Fired when a creature hits you or your pet

arg1 
chat message


"CHAT_MSG_COMBAT_CREATURE_VS_SELF_MISSES"
Category: Obsolete Events
 
Replaced in 2.4.0 with COMBAT_LOG_EVENT

Fired when a creature misses you or your pet

arg1 
chat message
"CHAT_MSG_COMBAT_ERROR"
Category: Obsolete Events
 
Replaced in 2.4.0 with COMBAT_LOG_EVENT
"CHAT_MSG_COMBAT_FACTION_CHANGE"
Category: Combat
 

Fires when player's faction changes. ie: "Your reputation with Timbermaw Hold has very slightly increased." -- NEW 1.9


"CHAT_MSG_COMBAT_FRIENDLYPLAYER_HITS"
Category: Obsolete Events
 
Replaced in 2.4.0 with COMBAT_LOG_EVENT
"CHAT_MSG_COMBAT_FRIENDLYPLAYER_MISSES"
Category: Obsolete Events
 
Replaced in 2.4.0 with COMBAT_LOG_EVENT
"CHAT_MSG_COMBAT_FRIENDLY_DEATH"
Category: Obsolete Events
 
Replaced in 2.4.0 with COMBAT_LOG_EVENT

Fired when a friendly player dies

arg1 
chat message (format: "%s dies")
"CHAT_MSG_COMBAT_HONOR_GAIN"
Category: Honor,Combat
 

Fired when the player gains any amount of honor, anything from an honorable kill to bonus honor awarded.

arg1 
chat message (format: "%s dies, honorable kill Rank: %s (Estimated Honor Points: %d)" or "You have been awarded %d honor.")
"CHAT_MSG_COMBAT_HOSTILEPLAYER_HITS"
Category: Obsolete Events
 
Replaced in 2.4.0 with COMBAT_LOG_EVENT
"CHAT_MSG_COMBAT_HOSTILEPLAYER_MISSES"
Category: Obsolete Events
 
Replaced in 2.4.0 with COMBAT_LOG_EVENT
"CHAT_MSG_COMBAT_HOSTILE_DEATH"
Category: Obsolete Events
 
Replaced in 2.4.0 with COMBAT_LOG_EVENT

If you provide the killing blow, you may or may not get a 'unit dies' event but you will get a 'slain unit' event, the 'slain unit' event is fired before the 'unit dies' message is, if you do not provide the killing blow you will get a 'unit dies'.

Fired when any hostile NPC or player dies near you.

arg1 
Message (eg: "Snowshow Rabbit dies." )


Fired when you are the killing blow against any NPC or player

arg1 
Message (eg: "You have slain Snowshow Rabbit!")
"CHAT_MSG_COMBAT_MISC_INFO"
Category: Misc
 

Fires when your equipment takes durability loss from death, and likely other situations as well.(no longer fires on reputation changes as of 1.9)

"CHAT_MSG_COMBAT_PARTY_HITS"
Category: Obsolete Events
 
Replaced in 2.4.0 with COMBAT_LOG_EVENT
"CHAT_MSG_COMBAT_PARTY_MISSES"
Category: Obsolete Events
 
Replaced in 2.4.0 with COMBAT_LOG_EVENT
"CHAT_MSG_COMBAT_PET_HITS"
Category: Obsolete Events
 
Replaced in 2.4.0 with COMBAT_LOG_EVENT
"CHAT_MSG_COMBAT_PET_MISSES"
Category: Obsolete Events
 
Replaced in 2.4.0 with COMBAT_LOG_EVENT
"CHAT_MSG_COMBAT_SELF_HITS"
Category: Obsolete Events
 
Replaced in 2.4.0 with COMBAT_LOG_EVENT

Fired when a you hit a creature. Also called when you hurt yourself by falling, drowning or burning on a campfire.

arg1 
chat message


"CHAT_MSG_COMBAT_SELF_MISSES"
Category: Obsolete Events
 
Replaced in 2.4.0 with COMBAT_LOG_EVENT

Fired when a you miss a creature

arg1 
chat message
"CHAT_MSG_COMBAT_XP_GAIN"
Category: Player
 

Fired when you gain xp from killing a creature or finishing a quest. Does not fire if you gain no xp from killing a creature.

arg1 
chat message


"CHAT_MSG_DND"
Category: Communication
 

Fired when the client receives a Do-Not-Disturb auto-response

arg1 
DND response message
arg2 
author


"CHAT_MSG_EMOTE"
Category: Communication
 

Fired on sending or revicing a custom emote (one used by /e, /emote or a send chat message command with the emote flag)

arg1 
Message that was sent/received
arg2 
Name of the player who sent the message
"CHAT_MSG_GUILD"
Category: Communication,Guild
 

Fired when a message is sent or received in the Guild channel.

arg1 
Message that was sent
arg2 
Author
arg3 
Language that the message was sent in


"CHAT_MSG_GUILD_ACHIEVEMENT"
Category: Communication,Guild,Achievment
 

Fired when a guild member reaches an achievment

arg1 
Message describing which player reaches which achievment
arg2 
Name of player
arg5 
Name of player
arg11 
Some integer that (but not the achievment Id, nor the total achievment points of player, seems to increment if two consecutive achievments are posted (needs to be verified))


"CHAT_MSG_IGNORED"
Category: Communication
 

Fired when you whisper a player that is ignoring you

When testing this event the character name is sent twice as arg1 and arg2, Blizzard appears to use arg2 and ignores arg1.

arg1 
Character name of who you tried to message
arg2 
Character name of who you tried to message


"CHAT_MSG_LOOT"
Category: Loot
 

Fired when loot text is sent to the chat window (someone selects need, greed, passes, rolls, receives)

arg1 
Chat message
"CHAT_MSG_MONEY"
Category: Loot
 

Fired when a unit loots money.

arg1 
Chat message