Navigation menu

WoW:API GetNumGuildMembers: Difference between revisions

Jump to navigation Jump to search

WoW:API GetNumGuildMembers (source)

Revision as of 04:46, 15 August 2023

248 bytes added ,  15 August 2023
m
Move page script moved page API GetNumGuildMembers to WoW:API GetNumGuildMembers without leaving a redirect
(typo. was online instead of offline)
m (Move page script moved page API GetNumGuildMembers to WoW:API GetNumGuildMembers without leaving a redirect)
 
(4 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi}} __NOTOC__
Returns the number of guild members.
Returns the total and online number of guild members.
  numGuildMembers = GetNumGuildMembers([includeOffline]);
  numTotalMembers, numOnlineMaxLevelMembers, numOnlineMembers = GetNumGuildMembers();


==Parameters==
==Parameters==
===Arguments===
:;includeOffline : Boolean - include offline players in the headcount?
===Returns===
===Returns===
:;numGuildMembers : Integer - number of people in the guild (online / both online and offline) or 0 if the 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.


==Example==
==Example==
  local numOnline, numTotal = (GetNumGuildMembers()), (GetNumGuildMembers(true));
  local numTotal, numOnlineMaxLevel, numOnline = GetNumGuildMembers();
  DEFAULT_CHAT_FRAME:AddMessage(numTotal .. " guild members: " .. numOnline .. " online, " .. (numTotal - numOnline) .. " offline.");
  DEFAULT_CHAT_FRAME:AddMessage(numTotal .. " guild members: " .. numOnline .. " online (" .. numOnlineMaxLevel .. " at maximum level), " .. (numTotal - numOnline) .. " offline.");
===Result===
===Result===
Displays the number of people online, offline, and the total headcount of your guild in the default chat frame.
Displays the number of people online, offline, and the total headcount of your guild in the default chat frame.


==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 500.
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.
Anonymous user
Retrieved from "https://addonstudio.org/wiki/Special:MobileDiff/9743...9748"