WoW:API UnitPlayerOrPetInRaid: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
m (Move page script moved page API UnitPlayerOrPetInRaid to API UnitPlayerOrPetInRaid without leaving a redirect)
 
(2 intermediate revisions by 2 users not shown)
Line 5: Line 5:


<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
  isTrue = UnitPlayerOrPetInRaid("arg1")
  isTrue = UnitPlayerOrPetInRaid("unit")


== Parameters ==
== Parameters ==
=== Arguments ===
=== Arguments ===
<!-- List each argument, together with its type -->
<!-- List each argument, together with its type -->
:;arg1 : String - Unit who should be checked
:;"unit" : String - [[unitId]] who should be checked


=== Returns ===
=== Returns ===
<!-- List each return value, together with its type -->
<!-- List each return value, together with its type -->
:;isTrue : 1 or nil
:;isTrue : 1 or nil
Note: returns nil for player and pet as of 3.0.2


== Example ==
== Example ==

Latest revision as of 04:47, 15 August 2023

WoW API < UnitPlayerOrPetInRaid

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

isTrue = UnitPlayerOrPetInRaid("unit")

Parameters[edit]

Arguments[edit]

"unit"
String - unitId who should be checked

Returns[edit]

isTrue
1 or nil

Note: returns nil for player and pet as of 3.0.2

Example[edit]

local TargetInRaid = UnitPlayerOrPetInRaid("target")

Result[edit]

TargetInRaid = 1   - If your target is in your raid group.
TargetInRaid = nil - If your target is not in raid group.