WoW:API GetPartyLeaderIndex: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
No edit summary
Line 20: Line 20:
:;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)


----
----

Revision as of 23:41, 22 June 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).
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