WoW:API GetPartyMember: Difference between revisions
Jump to navigation
Jump to search
GetPartyMember
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
<center>'''GetPartyMember'''</center> | <center>'''GetPartyMember'''</center> | ||
memberUnitId = GetPartyMember(index); | |||
Returns the | Returns the [[API TYPE UnitId|unit Id]] of the specified party member if that party member exists, or <tt>nil</tt> otherwise. | ||
---- | ---- | ||
;''Arguments'' | ;''Arguments'' | ||
:( | :(index) | ||
:; | :;index : Number - Which party member to query (1-4) | ||
---- | ---- | ||
;''Returns'' | ;''Returns'' | ||
: | :memberUnitId | ||
:; | :;memberUnitId : Number - If the specified party member exists, returns the id of that member, otherwise returns <tt>nil</tt> | ||
The numbers always translate directly; querying for 1 will return "party1", 2 "party2", etc, as long as that party slot is filled. This is mostly useful for testing for whether the party member in question exists. Though a more straightforward method of accomplishing that is, of course, simply calling [[API GetNumPartyMembers|GetNumPartyMembers()]]. | |||
---- | ---- | ||
| Line 23: | Line 25: | ||
memberCount = 0 | memberCount = 0 | ||
for groupindex = 1, | for groupindex = 1,MAX_PARTY_MEMBERS do | ||
if (GetPartyMember(groupindex)) then | if (GetPartyMember(groupindex)) then | ||
memberCount = memberCount + 1 | memberCount = memberCount + 1 | ||
Revision as of 21:08, 13 May 2006
memberUnitId = GetPartyMember(index);
Returns the unit Id of the specified party member if that party member exists, or nil otherwise.
- Arguments
- (index)
- index
- Number - Which party member to query (1-4)
- Returns
- memberUnitId
- memberUnitId
- Number - If the specified party member exists, returns the id of that member, otherwise returns nil
The numbers always translate directly; querying for 1 will return "party1", 2 "party2", etc, as long as that party slot is filled. This is mostly useful for testing for whether the party member in question exists. Though a more straightforward method of accomplishing that is, of course, simply calling GetNumPartyMembers().
- Example
memberCount = 0
for groupindex = 1,MAX_PARTY_MEMBERS do
if (GetPartyMember(groupindex)) then
memberCount = memberCount + 1
end
end
- Result
- Will count the number of members in the party (not the best way to do that but it's a reasonable example).