WoW:UnitId: Difference between revisions

187 bytes added ,  31 August 2009
m
(kill excessive lead-in vertical spacing.)
Line 4: Line 4:
== Base Values ==
== Base Values ==


; <tt>"focus"</tt> : The current player's focus target as selected by the /focus command. (Added in 2.0.0)
; <tt>"arena''N''"</tt> : Opposing arena member with index ''N'' (1,2,3,4,5).
 
; <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>"player"</tt> : The current player.
; <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>"pet"</tt> : The current player's pet
; <tt>"party''N''"</tt> : The ''N''th party member excluding the player (1,2,3 or 4).


; <tt>"vehicle"</tt> : The current player's vehicle
; <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>"party''N''"</tt> : The ''N''th party member excluding the player (1,2,3 or 4)
; <tt>"pet"</tt> : The current player's pet.


; <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>"player"</tt> : The current player.


; <tt>"raid''N''"</tt> : The raid member with [[raidIndex]] ''N'' (1,2,3,...,40).
; <tt>"raid''N''"</tt> : The raid member with [[raidIndex]] ''N'' (1,2,3,...,40).
Line 20: Line 24:
; <tt>"raidpet''N''"</tt> : The pet of the raid member with [[raidIndex]] ''N'' (1,2,3,...,40)  (Added in 1.5.0)
; <tt>"raidpet''N''"</tt> : The pet of the raid member with [[raidIndex]] ''N'' (1,2,3,...,40)  (Added in 1.5.0)


; <tt>"arena''N''"</tt> : Opposing arena member with index ''N'' (1,2,3,4,5).
; <tt>"target"</tt> : The currently targeted unit. May be overridden in macros by unit specified as a value of respective Secure Button attribute.


; <tt>"target"</tt> : The currently targetted unit. May be overriden in macros by unit specified as a value of respective Secure Button attribute.
; <tt>"vehicle"</tt> : The current player's vehicle.
 
; <tt>"playertarget"</tt> : The currently targetted unit. Always.
 
; <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.


==Others==
==Others==
Line 44: Line 42:


== Notes ==
== 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).
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.
Also, 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.
Anonymous user