WoW API: UnitIsGroupLeader

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← WoW API < UnitIsGroupLeader

Returns true if the unit is leader party or raid group, false otherwise.

isTrue = UnitIsGroupLeader("unit"[, groupType])

Arguments

unit

(unitId) Unit that should be checked

groupType (optional)

(partyCategoryType) The type of group.

• LE_PARTY_CATEGORY_HOME - get the count for a local or manual group. (default)
• LE_PARTY_CATEGORY_INSTANCE - get the count for a player's automatic group. (default in an instance)

Returns

isTrue

(boolean) true or false

Examples

Call

local targetIsLeader = UnitIsGroupLeader("target")

Result

targetIsLeader == true  - If your target is the leader of their group
targetIsLeader == false - If your target is not the leader of their group

Notes

• Seems to work on players outside of their group.
• As of 5.0.4, passing an unknown unitName, will cause UnitIsGroupLeader to return the name, which may be a bug.

See

• UnitIsGroupAssistant