WoW:API UnitInRaid: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
mNo edit summary
m (Move page script moved page API UnitInRaid to API UnitInRaid without leaving a redirect)
 
(11 intermediate revisions by 11 users not shown)
Line 1: Line 1:
Returns True(1) if the unit is in your raid group.
{{wowapi}} __NOTOC__
Returns a number if the unit is in your raid group, nil otherwise.
raidIndex = UnitInRaid("unit")


[[Category:API Functions|UnitInRaid]]
== Arguments ==
[[Category:API Raid Functions|UnitInRaid]]
;unit
[[Category:API Unit Functions|UnitInRaid]]
: String - [[unitId]] to check.
 
== Returns ==
;raidIndex
: {{api|raidIndex|t=t}} 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==
* [[API UnitInParty]]
* [[API GetRaidRosterInfo]]

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[edit]

unit
String - unitId to check.

Returns[edit]

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

Example[edit]

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


Details[edit]

  • 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[edit]