WoW:API GetPartyLeaderIndex: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
(upgraded deprecated template)
Line 1: Line 1:
{{wowapi}}
  <center>'''GetPartyLeaderIndex''' ''-Documentation by Mikk-''</center>
  <center>'''GetPartyLeaderIndex''' ''-Documentation by Mikk-''</center>


Line 32: Line 33:
:* [[API GetNumPartyMembers|GetNumPartyMembers]]
:* [[API GetNumPartyMembers|GetNumPartyMembers]]
:* [[API IsPartyLeader|IsPartyLeader]]
:* [[API IsPartyLeader|IsPartyLeader]]
----
{{Template:WoW API}}

Revision as of 18:14, 6 January 2007

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).
Cases not yet tested
- If you are not in a party (suspect nil)
- 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