WoW API: GetNumGuildMembers

From AddOn Studio
Revision as of 10:49, 4 February 2011 by WoWWiki>BryghtShadow (Updated for 4.x)
Jump to navigation Jump to search

WoW API < GetNumGuildMembers

Returns the total and online number of guild members.

numTotalMembers, numOnlineMembers = GetNumGuildMembers();

Parameters

Returns

numTotalMembers
Integer - total number of people in the guild, or 0 if player is not in a guild.
numOnlineMembers
Integer - number of online people in the guild, or 0 if the player is not in a guild.

Example

local numTotal, numOnline = GetNumGuildMembers();
DEFAULT_CHAT_FRAME:AddMessage(numTotal .. " guild members: " .. numOnline .. " online, " .. (numTotal - numOnline) .. " offline.");

Result

Displays the number of people online, offline, and the total headcount of your guild in the default chat frame.

Notes

You may need to call GuildRoster() first in order to obtain correct data. May return wrong values immediately after quitting a guild. Maximum returned value is 500.