WoW:Events/Player: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Updated PLAYER_LEVEL_UP event)
m (Move page script moved page Events/Player to Events/Player without leaving a redirect)
 
(One intermediate revision by one other user 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.
== Player related events ==
{{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|CANCEL_SUMMON|Player}}
{{evt|CHARACTER_POINTS_CHANGED|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)
{{evt|CHAT_MSG_COMBAT_XP_GAIN|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
{{evt|CHAT_MSG_SKILL|Player,Skill}}
Fired when some chat messages about skills are displayed.
; arg1: The content of the chat message.
'''arg1''' formats are found in Blizzard's <tt>GlobalStrings.lua</tt>.  Some possibilities:
* <tt>ERR_SKILL_GAINED_S</tt> (eg. "You have gained the Blacksmithing skill.")
* <tt>ERR_SKILL_UP_SI</tt> (eg. "Your skill in Cooking has increased to 221.")
{{evt|COMBAT_RATING_UPDATE|Player}}
{{evt|CURRENCY_DISPLAY_UPDATE|Player,Misc}}
{{evt|DISABLE_LOW_LEVEL_RAID|Raid,Player}}
Fired when {{api|SetAllowLowLevelRaid}} is used to disable low-level raids on the character.
{{evt|DISABLE_XP_GAIN|Player}}
?
{{evt|ENABLE_LOW_LEVEL_RAID|Raid,Player}}
Fired when {{api|SetAllowLowLevelRaid}} is used to enable low-level raids on the character.
{{evt|ENABLE_XP_GAIN|Player}}
?
{{evt|EQUIPMENT_SWAP_PENDING|Item,Player}}
?
{{evt|KNOWN_TITLES_UPDATE|Player}}
?
{{evt|LEVEL_GRANT_PROPOSED|Player}}
?
{{evt|PLAYER_CAMPING|Player}}
Fired when the player is camping
{{evt|PLAYER_CONTROL_GAINED|Player,Combat}}
Fires after the PLAYER_CONTROL_LOST event, when control has been restored to the player.
{{evt|PLAYER_CONTROL_LOST|Player,Combat}}
Fires whenever the player is unable to control the character.  Examples are when afflicted by fear, mind controlled, or when using a taxi.
{{evt|PLAYER_DIFFICULTY_CHANGED|Player,Raid}}
?
{{evt|PLAYER_ENTERING_BATTLEGROUND|Player}}
?
{{evt|PLAYER_ENTERING_WORLD|System,Player,Instance}}
Fired when the player enters the world, enters/leaves an instance, or respawns at a graveyard.  Also fires any other time the player sees a loading screen.
To check if the player is entering an instance, check [[API_GetPlayerMapPosition|GetPlayerMapPosition]] to see if both X and Y are zero.
Correction on the above comment: When PLAYER_ENTERING_WORLD fires, you'll notice that WORLD_MAP_UPDATE fires just before it. My instincts tell that leaving an instance puts the player in void space momentarily. So for the case that you are entering AND leaving an instance, [[API_GetPlayerMapPosition|GetPlayerMapPosition]] always returns the coordinates <nowiki>[0,0]</nowiki> and hence there is no way to determine using the event PLAYER_ENTERING_WORLD if the player is entering an instance or not. When leaving an instance the following events fire (ignoring party/raid events).
:WORLD_MAP_UPDATE
:PLAYER_ENTERING_WORLD
:WORLD_MAP_UPDATE <--- Player coordinates are non-zero here
Instances do have coordinates for units once the second WORLD_MAP_UPDATE event has fired. For the case of entering a battleground such as WSG, WORLD_MAP_UPDATE won't fire until you leave Silverwing Hold or Warsong Lumber Mill and you are outside. --[[User:Salanex|Salanex]]
{{evt|PLAYER_FARSIGHT_FOCUS_CHANGED|Player,Spell}}
{{evt|PLAYER_FLAGS_CHANGED|Player,Communication}}
This event fires when a Unit's flags change (eg: due to /afk, /dnd, etc.)
; arg1 : The [[API_TYPE_UnitId|UnitId]] affected, eg: "player"
; NOTE : WoW appears to condense simultaneous flag changes into a single event. If you are currently AFK and not(DND) but you type /dnd you'll see two Chat Log messages ("You are no longer AFK" and "You are now DND: Do Not Disturb") but you'll only see a single PLAYER_FLAGS_CHANGED event.
{{evt|PLAYER_EQUIPMENT_CHANGED|Player}}
?
{{evt|PLAYER_GAINS_VEHICLE_DATA|Player,Vehicle}}
{{evt|PLAYER_GUILD_UPDATE|Guild,Player}}
This appears to be fired when a player is gkicked, gquits, etc.
Reference handler in [{{wdnlink|FrameXML/FriendsFrame.lua}} FriendsFrame.lua].
{{evt|PLAYER_LEVEL_UP|Player}}
Fired when a player levels up.
; arg1 : New player level. ''Note that [[API_UnitLevel|UnitLevel]]("player") will most likely return an incorrect value when called in this event handler or shortly after, so use this value.''
; arg2 : Hit points gained from leveling.
; arg3 : Mana points gained from leveling.
; arg4 : Talent points gained from leveling. Should always be 1 unless the player is between levels 1 to 9.
; arg5 : Number of new PvP Talents.
; arg6 - arg9 : Attribute score increases from leveling. Strength (6) / Agility (7) / Stamina (8) / Intellect (9).
{{evt|PLAYER_LOSES_VEHICLE_DATA|Player,Vehicle}}
?
{{evt|PLAYER_MONEY|Player}}
Fired whenever the player gains or loses money.
: To get the amount of money earned/lost, you'll need to save the return value from [[API_GetMoney|GetMoney]]() from the last time PLAYER_MONEY fired and compare it to the new return value from [[API_GetMoney|GetMoney]]().
:: [[User:Egingell/PLAYER_MONEY|Example]]
{{evt|PLAYER_PVP_KILLS_CHANGED|Player,Honor}}
Fired when you slay another player
{{evt|PLAYER_REGEN_DISABLED|Player,Combat}}
Fired whenever you enter combat, as normal regen rates are disabled during combat. This means that either you are in the hate list of a NPC or that you've been taking part in a pvp action (either as attacker or victim).
{{evt|PLAYER_REGEN_ENABLED|Player,Combat}}
Fired after ending combat, as regen rates return to normal.  Useful for determining when a player has left combat. This occurs when you are not on the hate list of any NPC, or a few seconds after the latest pvp attack that you were involved with.
{{evt|PLAYER_SKINNED|Player,Battleground}}
Fired when the player's insignia is removed in a Battleground.
{{evt|PLAYER_TALENT_UPDATE|Player}}
Fired when the player changes between dual talent specs, and possibly when learning or unlearning talents (?).
{{evt|PLAYER_TOTEM_UPDATE|Player}}
This event fires whenever a totem is dropped (cast) or destroyed (either recalled or killed).
; arg1 : The number of the totem slot (1-4) affected by the update.  See for example [[API_GetTotemInfo|GetTotemInfo()]] for the uses of the totem slot number.
{{evt|PLAYER_UPDATE_RESTING|Player}}
Fired when the player starts or stops resting, i.e. when entering/leaving inns/major towns.
{{evt|PLAYER_XP_UPDATE|Player}}
Fired when the player's XP is updated (due quest completion or killing).
; arg1 : The [[API_TYPE_UnitId|UnitId]] affected, eg: "player"
{{evt|PLAYTIME_CHANGED|Player}}
Fired when the playtime state changes.
{{evt|PREVIEW_TALENT_POINTS_CHANGED|Player}}
?
{{evt|RAISED_AS_GHOUL|Player}}
?
{{evt|RECEIVED_ACHIEVEMENT_LIST|Player,Achievements}}
?
{{evt|RUNE_POWER_UPDATE|Player}}
New in 3.x. Fired when a rune's state switches from usable to un-usable or visa-versa.
; arg1 : the rune that it's referencing to
; arg2 : is the rune usable (if usable, it's not cooling, if not usable it's cooling)
{{evt|RUNE_TYPE_UPDATE|Player}}
New in 3.x. Fired when a rune's type is changed / updated.
; arg1 : the rune that it's referencing to
{{evt|TALENTS_INVOLUNTARILY_RESET|Player,Talents}}
?
{{evt|TIME_PLAYED_MSG|Player,System,Communication}}
Fired when the client received a time played message.
; arg1 : Total time
; arg2 : Current time at this level
{{evt|UNIT_ENERGY|Unit Info,Player}}
Fired whenever a units energy is affected. '''Removed in [[Patch 4.0]], use {{api|t=e|UNIT_POWER}} instead.'''
; arg1 : the name of the unit whose energy is affected
Seen unit names:
* player
{{evt|UPDATE_EXHAUSTION|Player}}
Fired when your character's XP exhaustion (i.e. the amount of your character's [[rest|rested bonus]]) changes. Use [[API_GetXPExhaustion|GetXPExhaustion()]] to query the current value.
{{evt|UPDATE_FACTION|Player}}
Fired when your character's reputation of some faction has changed.
{{evt|UPDATE_INVENTORY_ALERTS|Item,Player}}
Fires whenever an item's durability status becomes yellow (low) or red (broken). Signals that the durability frame needs to be updated. May also fire on any durability status change, even if that change doesn't require an update to the durability frame.
{{evt|UPDATE_INVENTORY_DURABILITY|Item,Player}}
Should fire whenever the durability of an item in the character's possession changes. (?)
{{evt|UPDATE_SHAPESHIFT_COOLDOWN|Player,Action Bar}}
{{evt|UPDATE_SHAPESHIFT_USABLE|Player,Action Bar}}
{{evt|WEAR_EQUIPMENT_SET|Player,Item}}
?

Latest revision as of 04:48, 15 August 2023

v • d • e
Events
Events by name
A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z     (Removed)
By category
Achievements · Action Bar · Arena · Auction · Bank · Battle.net · Battleground · Buff · Combat · Communication · Companion · Death · GlueXML · Guild · Honor · Instance · Item · Knowledge Base · Loot · Mail · Map · Misc · Movement · Party · Pet · Player · Quest · Skill · Spell · System · Tooltip · Trade · Tradeskill · Trainer · Unit Info · Vehicle
All events · All names

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


Player related events
"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.
"CANCEL_SUMMON"
 Category: Player
 



"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_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_SKILL"
 Category: Player,Skill
 

Fired when some chat messages about skills are displayed.

arg1
The content of the chat message.

arg1 formats are found in Blizzard's GlobalStrings.lua. Some possibilities:

  • ERR_SKILL_GAINED_S (eg. "You have gained the Blacksmithing skill.")
  • ERR_SKILL_UP_SI (eg. "Your skill in Cooking has increased to 221.")
"COMBAT_RATING_UPDATE"
 Category: Player
 



"CURRENCY_DISPLAY_UPDATE"
 Category: Player,Misc
 



"DISABLE_LOW_LEVEL_RAID"
 Category: Raid,Player
 

Fired when SetAllowLowLevelRaid is used to disable low-level raids on the character.


"DISABLE_XP_GAIN"
 Category: Player
 

?


"ENABLE_LOW_LEVEL_RAID"
 Category: Raid,Player
 

Fired when SetAllowLowLevelRaid is used to enable low-level raids on the character.


"ENABLE_XP_GAIN"
 Category: Player
 

?


"EQUIPMENT_SWAP_PENDING"
 Category: Item,Player
 

?


"KNOWN_TITLES_UPDATE"
 Category: Player
 

?


"LEVEL_GRANT_PROPOSED"
 Category: Player
 

?


"PLAYER_CAMPING"
 Category: Player
 

Fired when the player is camping


"PLAYER_CONTROL_GAINED"
 Category: Player,Combat
 

Fires after the PLAYER_CONTROL_LOST event, when control has been restored to the player.


"PLAYER_CONTROL_LOST"
 Category: Player,Combat
 

Fires whenever the player is unable to control the character. Examples are when afflicted by fear, mind controlled, or when using a taxi.


"PLAYER_DIFFICULTY_CHANGED"
 Category: Player,Raid
 

?


"PLAYER_ENTERING_BATTLEGROUND"
 Category: Player
 

?


"PLAYER_ENTERING_WORLD"
 Category: System,Player,Instance
 

Fired when the player enters the world, enters/leaves an instance, or respawns at a graveyard. Also fires any other time the player sees a loading screen.

To check if the player is entering an instance, check GetPlayerMapPosition to see if both X and Y are zero.

Correction on the above comment: When PLAYER_ENTERING_WORLD fires, you'll notice that WORLD_MAP_UPDATE fires just before it. My instincts tell that leaving an instance puts the player in void space momentarily. So for the case that you are entering AND leaving an instance, GetPlayerMapPosition always returns the coordinates [0,0] and hence there is no way to determine using the event PLAYER_ENTERING_WORLD if the player is entering an instance or not. When leaving an instance the following events fire (ignoring party/raid events).

WORLD_MAP_UPDATE
PLAYER_ENTERING_WORLD
WORLD_MAP_UPDATE <--- Player coordinates are non-zero here

Instances do have coordinates for units once the second WORLD_MAP_UPDATE event has fired. For the case of entering a battleground such as WSG, WORLD_MAP_UPDATE won't fire until you leave Silverwing Hold or Warsong Lumber Mill and you are outside. --Salanex


"PLAYER_FARSIGHT_FOCUS_CHANGED"
 Category: Player,Spell
 



"PLAYER_FLAGS_CHANGED"
 Category: Player,Communication
 

This event fires when a Unit's flags change (eg: due to /afk, /dnd, etc.)

arg1
The UnitId affected, eg: "player"
NOTE
WoW appears to condense simultaneous flag changes into a single event. If you are currently AFK and not(DND) but you type /dnd you'll see two Chat Log messages ("You are no longer AFK" and "You are now DND: Do Not Disturb") but you'll only see a single PLAYER_FLAGS_CHANGED event.
"PLAYER_EQUIPMENT_CHANGED"
 Category: Player
 

?


"PLAYER_GAINS_VEHICLE_DATA"
 Category: Player,Vehicle
 



"PLAYER_GUILD_UPDATE"
 Category: Guild,Player
 

This appears to be fired when a player is gkicked, gquits, etc.

Reference handler in [DEPRECATED http://wowprogramming.com/utils/xmlbrowser/live/FrameXML/FriendsFrame.lua FriendsFrame.lua].


"PLAYER_LEVEL_UP"
 Category: Player
 

Fired when a player levels up.

arg1
New player level. Note that UnitLevel("player") will most likely return an incorrect value when called in this event handler or shortly after, so use this value.
arg2
Hit points gained from leveling.
arg3
Mana points gained from leveling.
arg4
Talent points gained from leveling. Should always be 1 unless the player is between levels 1 to 9.
arg5
Number of new PvP Talents.
arg6 - arg9
Attribute score increases from leveling. Strength (6) / Agility (7) / Stamina (8) / Intellect (9).
"PLAYER_LOSES_VEHICLE_DATA"
 Category: Player,Vehicle
 

?


"PLAYER_MONEY"
 Category: Player
 

Fired whenever the player gains or loses money.

To get the amount of money earned/lost, you'll need to save the return value from GetMoney() from the last time PLAYER_MONEY fired and compare it to the new return value from GetMoney().
Example
"PLAYER_PVP_KILLS_CHANGED"
 Category: Player,Honor
 

Fired when you slay another player


"PLAYER_REGEN_DISABLED"
 Category: Player,Combat
 

Fired whenever you enter combat, as normal regen rates are disabled during combat. This means that either you are in the hate list of a NPC or that you've been taking part in a pvp action (either as attacker or victim).


"PLAYER_REGEN_ENABLED"
 Category: Player,Combat
 

Fired after ending combat, as regen rates return to normal. Useful for determining when a player has left combat. This occurs when you are not on the hate list of any NPC, or a few seconds after the latest pvp attack that you were involved with.


"PLAYER_SKINNED"
 Category: Player,Battleground
 

Fired when the player's insignia is removed in a Battleground.


"PLAYER_TALENT_UPDATE"
 Category: Player
 

Fired when the player changes between dual talent specs, and possibly when learning or unlearning talents (?).


"PLAYER_TOTEM_UPDATE"
 Category: Player
 

This event fires whenever a totem is dropped (cast) or destroyed (either recalled or killed).

arg1
The number of the totem slot (1-4) affected by the update. See for example GetTotemInfo() for the uses of the totem slot number.
"PLAYER_UPDATE_RESTING"
 Category: Player
 

Fired when the player starts or stops resting, i.e. when entering/leaving inns/major towns.


"PLAYER_XP_UPDATE"
 Category: Player
 

Fired when the player's XP is updated (due quest completion or killing).

arg1
The UnitId affected, eg: "player"
"PLAYTIME_CHANGED"
 Category: Player
 

Fired when the playtime state changes.


"PREVIEW_TALENT_POINTS_CHANGED"
 Category: Player
 

?


"RAISED_AS_GHOUL"
 Category: Player
 

?


"RECEIVED_ACHIEVEMENT_LIST"
 Category: Player,Achievements
 

?


"RUNE_POWER_UPDATE"
 Category: Player
 

New in 3.x. Fired when a rune's state switches from usable to un-usable or visa-versa.

arg1
the rune that it's referencing to
arg2
is the rune usable (if usable, it's not cooling, if not usable it's cooling)
"RUNE_TYPE_UPDATE"
 Category: Player
 

New in 3.x. Fired when a rune's type is changed / updated.

arg1
the rune that it's referencing to
"TALENTS_INVOLUNTARILY_RESET"
 Category: Player,Talents
 

?


"TIME_PLAYED_MSG"
 Category: Player,System,Communication
 

Fired when the client received a time played message.

arg1
Total time
arg2
Current time at this level
"UNIT_ENERGY"
 Category: Unit Info,Player
 

Fired whenever a units energy is affected. Removed in Patch 4.0, use UNIT_POWER instead.

arg1
the name of the unit whose energy is affected

Seen unit names:

  • player
"UPDATE_EXHAUSTION"
 Category: Player
 

Fired when your character's XP exhaustion (i.e. the amount of your character's rested bonus) changes. Use GetXPExhaustion() to query the current value.


"UPDATE_FACTION"
 Category: Player
 

Fired when your character's reputation of some faction has changed.


"UPDATE_INVENTORY_ALERTS"
 Category: Item,Player
 

Fires whenever an item's durability status becomes yellow (low) or red (broken). Signals that the durability frame needs to be updated. May also fire on any durability status change, even if that change doesn't require an update to the durability frame.


"UPDATE_INVENTORY_DURABILITY"
 Category: Item,Player
 

Should fire whenever the durability of an item in the character's possession changes. (?)


"UPDATE_SHAPESHIFT_COOLDOWN"
 Category: Player,Action Bar
 



"UPDATE_SHAPESHIFT_USABLE"
 Category: Player,Action Bar
 



"WEAR_EQUIPMENT_SET"
 Category: Player,Item
 

?

Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:Events/Player&oldid=20313"