WoW:API GetPartyMember: 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 1 if the specified party member exists, nil otherwise.

memberExists = GetPartyMember(index);

memberExists: Flag - If the specified party member exists, returns 1, otherwise nil.

memberCount = 0
for groupindex = 1,MAX_PARTY_MEMBERS do
 if (GetPartyMember(groupindex)) then
  memberCount = memberCount + 1
 end
end

Will count the number of members in the party (not the best way to do that but it's a reasonable example).

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