Changes: API GetPartyMember

Revision as of 22:28, 23 December 2006

Returns the unit Id of the specified party member if that party member exists, or nil otherwise.

memberUnitId = GetPartyMember(index);

Parameters

Arguments

index: Number - Which party member to query (1-4)

Returns

memberUnitId: Number - If the specified party member exists, returns the id of that member, otherwise returns nil

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

Notes

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

@@ Line 1: / Line 1: @@
+{{wowapi}} __NOTOC__
-<center>'''GetPartyMember'''</center>
+Returns the [[API TYPE UnitId|unit Id]] of the specified party member if that party member exists, or <tt>nil</tt> otherwise.
  memberUnitId = GetPartyMember(index);
+==Parameters==
-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>
+==Example==
-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()]].
+ memberCount = 0
+ for groupindex = 1,MAX_PARTY_MEMBERS do
-----
+  if (GetPartyMember(groupindex)) then
-;''Example''
+   memberCount = memberCount + 1
-<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
-  memberCount = 0
-  for groupindex = 1,MAX_PARTY_MEMBERS do
-    if (GetPartyMember(groupindex)) then
-      memberCount = memberCount + 1
-    end
   end
+ end
-;''Result''
+===Result===
+Will count the number of members in the party (not the best way to do that but it's a reasonable example).
+==Notes==
-:Will count the number of members in the party (not the best way to do that but it's a reasonable example).
+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()]].
-----
-{{Template:WoW API}}