WoW:UnitId: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (bossN unitids can go up to 4 currently. unified number format in brackets)
m (Move page script moved page UnitId to UnitId without leaving a redirect)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{wowapitype}}
#REDIRECT [[API TYPE UnitId]]
Many of the API functions which act on units in the game world (Players, NPC's, Monsters, etc) refer to the unit in question by an identifier that is related to how the player is accessing the unit.  The following values are available (they are '''not''' case sensitive):
 
== Base Values ==
 
; <tt>"arena''N''"</tt> : Opposing arena member with index ''N'' (1,2,3,4 or 5).
 
; <tt>"boss''N''"</tt> : The active bosses of the current encounter if available ''N'' (1,2,3 or 4). (Added in 3.3.0)
 
; <tt>"focus"</tt> : The current player's focus target as selected by the /focus command. (Added in 2.0.0).
 
; <tt>"mouseover"</tt> : The unit which the mouse is currently (or was most recently) hovering over.
 
; <tt>"none"</tt>: A valid unit token that always refers to no unit. [[API_UnitName|UnitName]] will return "Unknown, nil" for this UnitID. Use to force a macro to not auto self-cast ([[Making_a_macro#.5Btarget.3Dunit.5D|/cast [target=none] Healing Wave]]).
 
; <tt>"party''N''"</tt> : The ''N''th party member excluding the player (1,2,3 or 4).
 
; <tt>"partypet''N''"</tt> : The pet of the ''N''th party member (N is 1,2,3, or 4) (Added in 1.5.0).
 
; <tt>"pet"</tt> : The current player's pet.
 
; <tt>"player"</tt> : The current player.
 
; <tt>"raid''N''"</tt> : The raid member with [[raidIndex]] ''N'' (1,2,3,...,40).
 
; <tt>"raidpet''N''"</tt> : The pet of the raid member with [[raidIndex]] ''N'' (1,2,3,...,40)  (Added in 1.5.0)
 
; <tt>"target"</tt> : The currently targeted unit. May be overridden in macros by unit specified as a value of respective Secure Button attribute.
 
; <tt>"vehicle"</tt> : The current player's vehicle.
 
==Others==
The following value also appears in some very specific places (Vendor interactions, for example) or functions.
 
; <tt>"npc"</tt> : The NPC with which the player is currently interacting. You '''must''' be interacting with the NPC for this to work (e.g. the quest, flight path, merchant, gossip, or bank frame is open).
 
; <tt>player name</tt> : As returned by [[API_UnitName|UnitName]], [[API_GetGuildRosterInfo|GetGuildRosterInfo]], [[API_GetFriendInfo|GetFriendInfo]], [[API COMBAT LOG EVENT|COMBAT LOG EVENT]], etc. This must be spelled exactly and will be invalid if the named player is not a part of your party or raid. As with all other UnitIDs, it is not case sensitive.
 
== Targets ==
 
You can append the suffix <tt>target</tt> to any UnitId to get a UnitId which refers to that unit's target (e.g. <tt>"partypet2target"</tt>). This appending can be repeated indefinitely (e.g. <tt>"playertargettarget"</tt>), though you will observe an attendant performance hit if you overdo it, as the game engine has to jump from target to target.
 
If you are using a party or raid member's name as a unit, you need to use hyphens to separate the target chain (e.g. <tt>"Cogwheel-target-target"</tt>).
 
== Notes ==
* Many of the functions which take a UnitId only provide useful results for a subset of ID's. Other functions will only provide information for friendly targets (or those upon which a power is active).
* Some functions return different values if the target is close enough to be 'visible' to your client (not necessarily in line of sight), as can be determined with [[API UnitIsVisible|UnitIsVisible("unit")]], versus farther away.
* Units that are '''not''' available to the current player are (where ''unit'' is not "player"): ''unit''focus and ''unit''mouseover.

Latest revision as of 04:49, 15 August 2023

Redirect to:

Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:UnitId&oldid=20721"