WoW API: GetPartyLeaderIndex

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 < GetPartyLeaderIndex

GetPartyLeaderIndex -Documentation by Mikk-

Returns the index of the current party leader (1-4).

 partyLeaderIndex = GetPartyLeaderIndex();

Note: Party members 1-4 does not include yourself. Use IsPartyLeader() to test if you yourself is the party leader.

---

Arguments

None

---

Returns

(Number partyLeaderIndex)

partyLeaderIndex

The index of the current party leader (1-4).

Returns 0 if you are not in a party.

Cases not yet tested

- If you yourself is the party leader (suspect nil)

---

Description

Returns the index of the current party leader (1-4). If the leader is in another party in a raid group, the function returns 0 (not nil).

See Also

• GetNumPartyMembers
• IsPartyLeader