WoW:API UnitInRaid: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
Line 10: Line 10:
=== Arguments ===
=== Arguments ===
<!-- List each argument, together with its type -->
<!-- List each argument, together with its type -->
:;arg1 : String - Unit who should be checked
:;arg1 : String - UnitID or unit name who should be checked


=== Returns ===
=== Returns ===
Line 19: Line 19:
<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
  local TargetInRaid = UnitInRaid("target")
  local TargetInRaid = UnitInRaid("target")
local TargetInRaid = UnitInRaid("Duugu")


====Result====
====Result====

Revision as of 13:22, 24 December 2007

WoW API < UnitInRaid

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

isTrue = UnitInRaid("arg1")

Parameters

Arguments

arg1
String - UnitID or unit name who should be checked

Returns

isTrue
1 or nil

Example

local TargetInRaid = UnitInRaid("target")
local TargetInRaid = UnitInRaid("Duugu")

Result

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

Details

Pets are not considered to be part of your raid group.
The "battleground"-raid/party-members are also not considered to be part of your raid.
Inside "battleground" UnitInRaid("unit") will return a number based on layout position