WoW:UnitId - Revision history

Move page script: Move page script moved page UnitId to WoW:UnitId without leaving a redirect

2023-08-15T04:49:08Z

Move page script moved page UnitId to UnitId without leaving a redirect

← Older revision	Revision as of 04:49, 15 August 2023
(No difference)

Bear: Celess22 moved page UnitId to API TYPE UnitId

2020-05-22T02:22:17Z

Celess22 moved page UnitId to API TYPE UnitId

← Older revision		Revision as of 02:22, 22 May 2020
Line 1:		Line 1:
	~~{{wowapitype}}~~		#REDIRECT [[API TYPE UnitId]]
	Many of the API functions which act on units in the game world (Players, NPCs, 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>"arenapet''N''"</tt> : The pet of the ''N''th opposing arena member (N is 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 {{api\|raidIndex\|t=t}} ''N'' (1,2,3,...,40).~~

	~~; <tt>"raidpet''N''"</tt> : The pet of the raid member with {{api\|raidIndex\|t=t}} ''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.

5.151.35.24: Grammar

2014-12-20T05:12:22Z

Grammar

← Older revision		Revision as of 05:12, 20 December 2014
Line 1:		Line 1:
	{{wowapitype}}		{{wowapitype}}
	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):		Many of the API functions which act on units in the game world (Players, NPCs, 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 ==		== Base Values ==

Bear at 04:59, 6 December 2013

2013-12-06T04:59:18Z

← Older revision		Revision as of 04:59, 6 December 2013
Line 24:		Line 24:
	; <tt>"player"</tt> : The current player.		; <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 {{api\|raidIndex\|t=t}} ''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>"raidpet''N''"</tt> : The pet of the raid member with {{api\|raidIndex\|t=t}} ''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>"target"</tt> : The currently targeted unit. May be overridden in macros by unit specified as a value of respective Secure Button attribute.

WoWWiki>Tda a: /* Base Values */

2011-09-01T10:01:50Z

Base Values

← Older revision		Revision as of 10:01, 1 September 2011
Line 5:		Line 5:

	; <tt>"arena''N''"</tt> : Opposing arena member with index ''N'' (1,2,3,4 or 5).		; <tt>"arena''N''"</tt> : Opposing arena member with index ''N'' (1,2,3,4 or 5).

			; <tt>"arenapet''N''"</tt> : The pet of the ''N''th opposing arena member (N is 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>"boss''N''"</tt> : The active bosses of the current encounter if available ''N'' (1,2,3 or 4). (Added in 3.3.0)

WoWWiki>Silv3rwind: bossN unitids can go up to 4 currently. unified number format in brackets

2010-02-01T03:49:33Z

bossN unitids can go up to 4 currently. unified number format in brackets

← Older revision		Revision as of 03:49, 1 February 2010
Line 4:		Line 4:
	== Base Values ==		== Base Values ==

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

WoWWiki>Guardix at 18:33, 13 January 2010

2010-01-13T18:33:26Z

← Older revision		Revision as of 18:33, 13 January 2010
Line 5:		Line 5:

	; <tt>"arena''N''"</tt> : Opposing arena member with index ''N'' (1,2,3,4,5).		; <tt>"arena''N''"</tt> : Opposing arena member with index ''N'' (1,2,3,4,5).

			; <tt>"boss''N''"</tt> : The active bosses of the current encounter if available ''N'' (1,2,3). (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>"focus"</tt> : The current player's focus target as selected by the /focus command. (Added in 2.0.0).

WoWWiki>Egingell: /* Notes */

2009-08-31T20:37:42Z

Notes

← Older revision		Revision as of 20:37, 31 August 2009
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.

WoWWiki>Starlightblunder: kill excessive lead-in vertical spacing.

2009-08-31T18:36:38Z

kill excessive lead-in vertical spacing.

← Older revision		Revision as of 18:36, 31 August 2009
Line 1:		Line 1:
	{{wowapitype}}~~<br>~~		{{wowapitype}}

	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):		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):

WoWWiki>Antiarc: Added arena unit IDs

2009-05-03T05:47:24Z

Added arena unit IDs

← Older revision		Revision as of 05:47, 3 May 2009
Line 20:		Line 20:

	; <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 targetted unit. May be overriden 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.