WoW:API GetNumGuildMembers - Revision history

Move page script: Move page script moved page API GetNumGuildMembers to WoW:API GetNumGuildMembers without leaving a redirect

2023-08-15T04:46:12Z

Move page script moved page API GetNumGuildMembers to API GetNumGuildMembers without leaving a redirect

← Older revision

Revision as of 04:46, 15 August 2023

158.39.124.123: Added "numOnlineMaxLevelMembers" to the code examples.

2014-04-14T04:54:17Z

Added "numOnlineMaxLevelMembers" to the code examples.

← Older revision		Revision as of 04:54, 14 April 2014
Line 1:		Line 1:
	{{wowapi}} __NOTOC__		{{wowapi}} __NOTOC__
	Returns the total and online number of guild members.		Returns the total and online number of guild members.
	numTotalMembers, numOnlineMembers = GetNumGuildMembers();		numTotalMembers, numOnlineMaxLevelMembers, numOnlineMembers = GetNumGuildMembers();

	==Parameters==		==Parameters==
	===Returns===		===Returns===
	:;numTotalMembers : Integer - total number of people in the guild, or 0 if player is not in a guild.		:;numTotalMembers
	:;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)		:: 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.		:;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 numTotal, numOnline = GetNumGuildMembers();		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.

WoWWiki>Rturner18: /* Returns */ Update to include MoP api changes

2013-01-17T01:17:25Z

Returns: Update to include MoP api changes

← Older revision		Revision as of 01:17, 17 January 2013
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 ~~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.

WoWWiki>BryghtShadow: Updated for 4.x

2011-02-04T10:49:34Z

Updated for 4.x

@@ Line 1: / Line 1: @@
 {{wowapi}} __NOTOC__
-Returns the number of guild members.
+Returns the total and online number of guild members.
-  numGuildMembers = GetNumGuildMembers([includeOffline]);
+  numTotalMembers, numOnlineMembers = GetNumGuildMembers();
 ==Parameters==
 ===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.
 ==Example==
-  local numOnline, numTotal = (GetNumGuildMembers()), (GetNumGuildMembers(true));
+  local numTotal, numOnline = GetNumGuildMembers();
   DEFAULT_CHAT_FRAME:AddMessage(numTotal .. " guild members: " .. numOnline .. " online, " .. (numTotal - numOnline) .. " offline.");
 ===Result===
@@ Line 17: / Line 16: @@
 ==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.

WoWWiki>Sandmahn: /* Minor code correction */

2009-09-16T19:14:44Z

Minor code correction

← Older revision		Revision as of 19:14, 16 September 2009
Line 17:		Line 17:
	==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 500.

			There is another problem with the return values as they depend on [[API_SetGuildRosterShowOffline\|SetGuildRosterShowOffline()]] setting. A simple program like

			DEFAULT_CHAT_FRAME:AddMessage("Firing SetGuildRosterShowOffline(false)");
			SetGuildRosterShowOffline(false)
			DEFAULT_CHAT_FRAME:AddMessage("GetNumGuildMembers(): "..tostring(GetNumGuildMembers()));
			DEFAULT_CHAT_FRAME:AddMessage("GetNumGuildMembers(true): "..tostring(GetNumGuildMembers(true)));
			DEFAULT_CHAT_FRAME:AddMessage("Firing SetGuildRosterShowOffline(true)");
			SetGuildRosterShowOffline(true)
			DEFAULT_CHAT_FRAME:AddMessage("GetNumGuildMembers(): "..tostring(GetNumGuildMembers()));
			DEFAULT_CHAT_FRAME:AddMessage("GetNumGuildMembers(true): "..tostring(GetNumGuildMembers(true)));

			will show the difference.

			Only total members is reliable. Online members changes depending on the setting of [[API_GetGuildRosterShowOffline\|GetGuildRosterShowOffline()]]. If set to true, the number of online members is the same as total.

			Take care, if your function called by [[G#GUILD_ROSTER_UPDATE\|GUILD_ROSTER_UPDATE]] event handling wants to set the show offline status via [[API_SetGuildRosterShowOffline\|SetGuildRosterShowOffline()]]. This may cause, due to guild roster updates, a loop, where a user that has opened the guild panel can't switch the status anymore, even if you reset the original status in your function.

			This is because [[API_SetGuildRosterShowOffline\|SetGuildRosterShowOffline()]] fires an [[G#GUILD_ROSTER_UPDATE\|GUILD_ROSTER_UPDATE]] event if changed.

			A function that gets reliable values (after at least one [[G#GUILD_ROSTER_UPDATE\|GUILD_ROSTER_UPDATE]] event happened) would not consider the flag at all and build its count on roster table. It can probably look like this

			-- iterate over guild members list
			local total = GetNumGuildMembers(true)
			local onlineTotal = 0
			local offlineTotal = 0
			for i = 1, total
			do
			-- get info
			local name, rank, rankIndex, level, class, zone, note, officernote, online, status, classFileName = GetGuildRosterInfo(i)
			if online
			then
			onlineTotal = onlineTotal + 1
			else
			offlineTotal = offlineTotal + 1
			end
			end
			return onlineTotal, offlineTotal, total

WoWWiki>Coldfury: typo. was online instead of offline

2007-10-15T07:09:06Z

typo. was online instead of offline

← Older revision		Revision as of 07:09, 15 October 2007
Line 11:		Line 11:
	==Example==		==Example==
	local numOnline, numTotal = (GetNumGuildMembers()), (GetNumGuildMembers(true));		local numOnline, numTotal = (GetNumGuildMembers()), (GetNumGuildMembers(true));
	DEFAULT_CHAT_FRAME:AddMessage(numTotal .. " guild members: " .. numOnline .. " online, " .. (numTotal - numOnline) .. " ~~online~~.");		DEFAULT_CHAT_FRAME:AddMessage(numTotal .. " guild members: " .. numOnline .. " online, " .. (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.

WoWWiki>Starlightblunder: {{wowapi}}, format, example

2006-12-23T19:36:20Z

{{wowapi}}, format, example

@@ Line 1: / Line 1: @@
-<p>Returns the number of guild members</p>
+{{wowapi}} __NOTOC__
-<hr />
+Returns the number of guild members.
-<dl><dt><em>Arguments</em></dt></dl>
+ numGuildMembers = GetNumGuildMembers([includeOffline]);
-{{Template:WoW API}}
+==Parameters==

WoWWiki>Joebwan: Noted that this function is bugged

2006-07-05T16:48:01Z

Noted that this function is bugged

← Older revision		Revision as of 16:48, 5 July 2006
Line 17:		Line 17:
	<dl><dd>This function seems to return 0 if you have not yet opened the guild roster. I suspect that a call to GuildRoster(), before calling this function will cause it to return the proper result.</dd>		<dl><dd>This function seems to return 0 if you have not yet opened the guild roster. I suspect that a call to GuildRoster(), before calling this function will cause it to return the proper result.</dd>
	<dd>This function will return a maximum value of 500.</dd></dl>		<dd>This function will return a maximum value of 500.</dd></dl>
			<hr />
			<dl><dt><em>Warnings</em></dt></dl>
			<dl><dd>If the character is not part of a guild, but has left (/gquit) one, it will still return the number of members of the guild the character was last in. This means that GetNumGuildMembers() is not a reliable way to determine if the character is in a guild or not.</dd>
			</dl>
	<hr />		<hr />

	{{Template:WoW API}}		{{Template:WoW API}}

WoWWiki>TheVedge at 23:46, 26 February 2006

2006-02-26T23:46:50Z

← Older revision		Revision as of 23:46, 26 February 2006
Line 15:		Line 15:
	<hr />		<hr />
	<dl><dt><em>Notes</em></dt></dl>		<dl><dt><em>Notes</em></dt></dl>
	<dl><dd>This function seems to return 0 if you have not yet opened the guild roster. I suspect that a call to GuildRoster(), before calling this function will cause it to return the proper result.</dd></dl>		<dl><dd>This function seems to return 0 if you have not yet opened the guild roster. I suspect that a call to GuildRoster(), before calling this function will cause it to return the proper result.</dd>
			<dd>This function will return a maximum value of 500.</dd></dl>
	<hr />		<hr />

	{{Template:WoW API}}		{{Template:WoW API}}

WoWWiki>Anticrash at 15:33, 4 January 2006

2006-01-04T15:33:47Z

← Older revision		Revision as of 15:33, 4 January 2006
Line 18:		Line 18:
	<hr />		<hr />

	~~[[Category~~:API ~~Functions\|GetNumGuildMembers]]~~		{{Template:WoW API}}
	~~[[Category:API Guild Functions\|GetNumGuildMembers]]~~