WoW:API GetNumPartyMembers: Difference between revisions

Revision as of 14:18, 20 June 2010

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

Returns number of party members.

partyMembers = GetNumPartyMembers()

partyMembers: Number - The number of party members, excluding the player (0 to 4).

The snippet below adds a message stating the number of people in the player's current party to the default chat frame.

print("There are " .. GetNumPartyMembers() .. " other people in your party.");

While in a battleground, this function returns information about your battleground party. You may retrieve information about your non-battleground party using GetRealNumPartyMembers().

@@ Line 1: / Line 1: @@
 {{wowapi}} __NOTOC__
 Returns number of party members.
-  numberOfPartyMembers = GetNumPartyMembers();
+  partyMembers = GetNumPartyMembers()
-==Parameters==
+==Returns==
-===Returns===
+;partyMembers : Number - The number of party members, excluding the player (0 to 4).
-:;numberOfPartyMembers : Integer - The number of party members - from 0 to 4 (excluding the player).
 ==Example==
- local n = GetNumPartyMembers();
+The snippet below adds a message stating the number of people in the player's current party to the default chat frame.
-  if (n > 0) then
+  print("There are " .. GetNumPartyMembers() .. " other people in your party.");
-  message("There are " .. n .. " other people in your party.");
- end
-===Result===
+==Notes==
-Displays a message stating the number of people in the player's current party.
+* While in a battleground, this function returns information about your battleground party. You may retrieve information about your non-battleground party using {{api|GetRealNumPartyMembers}}().
 ==See Also==
-* [[API GetNumRaidMembers|GetNumRaidMembers]]
+* {{api|GetRealNumPartyMembers}}
-* [[API GetPartyMember|GetPartyMember]]
+* {{api|GetNumRaidMembers}}
+* {{api|GetPartyMember}}