WoW:API GetPartyLeaderIndex: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Fixing awkward wording)
m (Move page script moved page API GetPartyLeaderIndex to API GetPartyLeaderIndex without leaving a redirect)
 
(No difference)

Latest revision as of 04:46, 15 August 2023

WoW API < GetPartyLeaderIndex

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 are 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.
Also returns 0 if you are the leader.

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