WoW:API UnitInRaid: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m (Move page script moved page API UnitInRaid to API UnitInRaid without leaving a redirect)
 
(2 intermediate revisions by 2 users not shown)
Line 9: Line 9:
== Returns ==
== Returns ==
;raidIndex
;raidIndex
: [[RaidIndex]] of "unit" if she is in your raid group, otherwise nil.
: {{api|raidIndex|t=t}} of "unit" if he is in your raid group, otherwise nil.


== Example ==
== Example ==

Latest revision as of 04:47, 15 August 2023

WoW API < UnitInRaid

Returns a number if the unit is in your raid group, nil otherwise.

raidIndex = UnitInRaid("unit")

Arguments

unit
String - unitId to check.

Returns

raidIndex
raidIndex of "unit" if he is in your raid group, otherwise nil.

Example

print("Your target is " .. (UnitInRaid("target") and "" or "not ") .. "in your raid group.")


Details

  • The return value is the same index used to retrieve information about raid members using API GetRaidRosterInfo.
  • Pets are not considered to be part of your raid group.
  • While in a battleground, this function returns information about your battleground group.

See also