WoW:API GetPartyLeaderIndex: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m (Move page script moved page API GetPartyLeaderIndex to API GetPartyLeaderIndex without leaving a redirect)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{wowapi}}
{{wowapi}}
<center>'''GetPartyLeaderIndex''' ''-Documentation by Mikk-''</center>


Returns the index of the current party leader (1-4).
Returns the index of the current party leader (1-4).
Line 6: Line 5:
   partyLeaderIndex = GetPartyLeaderIndex();
   partyLeaderIndex = GetPartyLeaderIndex();


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


----
----
Line 20: Line 19:
:;partyLeaderIndex : The index of the current party leader (1-4).
:;partyLeaderIndex : The index of the current party leader (1-4).
:: Returns 0 if you are not in a party.
:: Returns 0 if you are not in a party.
 
:: Also returns 0 if you are the leader.
;''Cases not yet tested''
:- If you yourself is the party leader (suspect nil)


----
----
Line 29: Line 26:
: 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).
: 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''
==See also==


:* [[API GetNumPartyMembers|GetNumPartyMembers]]
* [[API GetNumPartyMembers|GetNumPartyMembers]]
:* [[API IsPartyLeader|IsPartyLeader]]
* [[API IsPartyLeader|IsPartyLeader]]

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]