WoW:API GetRaidTargetIndex: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Move page script moved page API GetRaidTargetIndex to API GetRaidTargetIndex without leaving a redirect)
 
(2 intermediate revisions by 2 users not shown)
Line 15: Line 15:
=== Returns ===
=== Returns ===


:;icon : Number - a value from 0 to 8, as follows:
:;icon : Number - a value from 1 to 8, or nil, as follows:
:::0 = no icon
:::nil = no icon
:::1 = Yellow 4-point Star
:::1 = Yellow 4-point Star
:::2 = Orange Circle
:::2 = Orange Circle
Line 31: Line 31:
== Note ==
== Note ==


* Note that (at least during 1.11), GetRaidTargetIndex() will return seemingly-random indexes for units that do not exist. Always test for UnitExists() before doing GetRaidTargetIndex(). --[[User:Mikk|Mikk]] 05:52, 21 July 2006 (EDT)
* Note that (at least during 1.11), GetRaidTargetIndex() will return seemingly-random indexes for units that do not exist. Always test for UnitExists() before doing GetRaidTargetIndex().
: Explicit case: "raid2target" when "raid2" is offline and not targetting anything at all misbehaves.
: Explicit case: "raid2target" when "raid2" is offline and not targetting anything at all misbehaves.

Latest revision as of 04:46, 15 August 2023

WoW API < GetRaidTargetIndex

Get which raid targetting icon is being shown over a mob or raid member.

icon=GetRaidTargetIndex("unit");

In patch 1.11, Blizzard added the ability for a raid/party leader or assistant leader to assign up to 8 different target icons to mobs or players. These icons are visible only to other players within the raid or party.

Parameters[edit]

Arguments[edit]

("unit")
unit
String - The UnitId to examine.

Returns[edit]

icon
Number - a value from 1 to 8, or nil, as follows:
nil = no icon
1 = Yellow 4-point Star
2 = Orange Circle
3 = Purple Diamond
4 = Green Triangle
5 = White Crescent Moon
6 = Blue Square
7 = Red "X" Cross
8 = White Skull

Example[edit]

icon=GetRaidTargetIndex("player");

Note[edit]

  • Note that (at least during 1.11), GetRaidTargetIndex() will return seemingly-random indexes for units that do not exist. Always test for UnitExists() before doing GetRaidTargetIndex().
Explicit case: "raid2target" when "raid2" is offline and not targetting anything at all misbehaves.