WoW:API GetNumGuildMembers: Difference between revisions
Jump to navigation
Jump to search
(Updated for 4.x) |
(→Returns: Update to include MoP api changes) |
||
| Line 6: | Line 6: | ||
===Returns=== | ===Returns=== | ||
:;numTotalMembers : Integer - total number of people in the guild, or 0 if player is not in a guild. | :;numTotalMembers : Integer - total number of people in the guild, or 0 if player is not in a guild. | ||
:;numOnlineMaxLevelMembers : Integer - total number of people in the guild that are at the level cap, or 0 if player is not in a guild. (Does not include remote chat members) | |||
:;numOnlineMembers : Integer - number of online people in the guild, or 0 if the 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. | ||
| Line 15: | Line 16: | ||
==Notes== | ==Notes== | ||
You may need to call [[API_GuildRoster|GuildRoster()]] first in order to obtain correct data. May return wrong values immediately after quitting a guild. Maximum returned value is | You may need to call [[API_GuildRoster|GuildRoster()]] first in order to obtain correct data. May return wrong values immediately after quitting a guild. Maximum returned value is 1000. | ||
Revision as of 01:17, 17 January 2013
← 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.
- numOnlineMaxLevelMembers
- Integer - total number of people in the guild that are at the level cap, or 0 if player is not in a guild. (Does not include remote chat members)
- 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 1000.