WoW:API GetNumGroupMembers: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m (Move page script moved page API GetNumGroupMembers to API GetNumGroupMembers without leaving a redirect)
 
(One intermediate revision by one other user not shown)
Line 4: Line 4:


== Arguments ==
== Arguments ==
;groupType (optional): ({{api|partyCategoryType}}) the type of group.  
;groupType (optional)
: ({{api|partyCategoryType|t=t}}) the type of group.
:* LE_PARTY_CATEGORY_HOME - get the count for a local or manual group. (default)
:* LE_PARTY_CATEGORY_HOME - get the count for a local or manual group. (default)
:* LE_PARTY_CATEGORY_INSTANCE - get the count for a player's automatic group. (default in an instance)
:* LE_PARTY_CATEGORY_INSTANCE - get the count for a player's automatic group. (default in an instance)


== Returns ==
== Returns ==
; members : Number - number of players in your raid or party group, including yourself; or 0 if you are not in a raid or party type group.
; members
: Number - number of players in your raid or party group, including yourself; or 0 if you are not in a raid or party type group.


== Notes ==
== Notes ==
Line 18: Line 20:


* {{api|GetNumPartyMembers}} (removed in 5.0.4)
* {{api|GetNumPartyMembers}} (removed in 5.0.4)
* {{api|GetRealNumRaidMembers}} (removed in 5.0.4)
* {{api|GetRealNumRaidMembers}} (removed in 5.0.4)

Latest revision as of 04:46, 15 August 2023

WoW API < GetNumGroupMembers

Returns the total number of people in your raid or party group.

members = GetNumGroupMembers();

Arguments

groupType (optional)
(partyCategoryType) the type of group.
  • LE_PARTY_CATEGORY_HOME - get the count for a local or manual group. (default)
  • LE_PARTY_CATEGORY_INSTANCE - get the count for a player's automatic group. (default in an instance)

Returns

members
Number - number of players in your raid or party group, including yourself; or 0 if you are not in a raid or party type group.

Notes

  • While in battlegrounds, this function returns the number of people in the battleground raid group. You may both be in a an automatic type (battleground, arena, finder) raid group and in a normal raid or party group at the same time. Note: as of patch 5.0.4 you can no longer use GetRealNumRaidMembers() to retrieve the number of people in the raid.

See Also