WoW:API GetPartyLeaderIndex: Difference between revisions

Latest revision as of 04:46, 15 August 2023

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

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.

(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.

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).

@@ Line 1: / Line 1: @@
- <center>'''GetPartyLeaderIndex''' ''-Documentation by Mikk-''</center>
+{{wowapi}}
 Returns the index of the current party leader (1-4).
@@ Line 5: / Line 5: @@
    partyLeaderIndex = GetPartyLeaderIndex();
-<i>Note:</i> 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 18: / Line 18: @@
 :;partyLeaderIndex : The index of the current party leader (1-4).
+:: Returns 0 if you are not in a party.
-;''Cases not yet tested''
+:: Also returns 0 if you are the leader.
-:- If you are not in a party (suspect nil)
-:- If you yourself is the party leader (suspect nil)
-:- If the leader is in another party in a raid group (suspect nil)
 ----
 ;''Description''
-: Returns the index of the current party leader (1-4).
+: 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''
-:* [[API GetNumPartyMembers|GetNumPartyMembers]]
-:* [[API IsPartyLeader|IsPartyLeader]]
+==See also==
-----
+* [[API GetNumPartyMembers|GetNumPartyMembers]]
-{{Template:WoW API}}
+* [[API IsPartyLeader|IsPartyLeader]]