WoW:API GetNumPartyMembers: Difference between revisions

Revision as of 18:49, 23 December 2006

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.

numberOfPartyMembers = GetNumPartyMembers();

numberOfPartyMembers: Integer - The number of party members - from 0 to 4 (excluding the player).

local n = GetNumPartyMembers();
if (n > 0) then 
 message("There are " .. n .. " other people in your party.");
end

Displays a message stating the number of people in the player's current party.

@@ Line 1: / Line 1: @@
-{{Template:WoW API}}<center>'''GetNumPartyMembers''' ''-Documentation by Sarf-''</center>
+{{wowapi}} __NOTOC__
 Returns number of party members.
+ numberOfPartyMembers = GetNumPartyMembers();
-	numberOfPartyMembers = GetNumPartyMembers();
+==Parameters==
+===Returns===
-----
+:;numberOfPartyMembers : Integer - The number of party members - from 0 to 4 (excluding the player).
-;''Arguments''
-:;None
-----
-;''Returns''
-:(Number numberOfPartyMembers)
-:;numberOfPartyMembers : The number of party members - from 0 to 4 (excluding the player).
-----
-;''Example''
- if ( GetNumPartyMembers() > 0 ) then CastSpellByName("Aura of Retribution"); end
-;''Result''
-Casts Aura of Retribution if player is in a group.
-----
-;''Description''
-: Returns number of party members.
-;''See Also''
+==Example==
+ local n = GetNumPartyMembers();
+ if (n > 0) then
+  message("There are " .. n .. " other people in your party.");
+ end
-:* [[API GetNumRaidMembers|GetNumRaidMembers]]
+===Result===
+Displays a message stating the number of people in the player's current party.
-----
+==See Also==
+* [[API GetNumRaidMembers|GetNumRaidMembers]]