WoW:API GetNumGuildMembers: Difference between revisions

← Older edit

WoW:API GetNumGuildMembers (source)

Revision as of 04:46, 15 August 2023

861 bytes added , 15 August 2023

m

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

Anonymous user

Move page script

@@ Line 1: / Line 1: @@
-<p>Returns the number of guild members</p>
+{{wowapi}} __NOTOC__
-<hr />
+Returns the total and online number of guild members.
-<dl><dt><em>Arguments</em></dt></dl>
+ numTotalMembers, numOnlineMaxLevelMembers, numOnlineMembers = GetNumGuildMembers();
-<dl><dd>None</dd></dl>
-<hr />
+==Parameters==
-<dl><dt><em>Returns</em></dt></dl>
+===Returns===
-<dl><dd>Number of guild members</dd></dl>
+:;numTotalMembers
-<hr />
+:: Integer - total number of people in the guild, or 0 if player is not in a guild.
-<dl><dt><em>Example</em></dt></dl>
+:;numOnlineMaxLevelMembers
-<pre>local numGuildMembers = GetNumGuildMembers();</pre>
+:: 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)
-<hr />
+:;numOnlineMembers
+:: Integer - number of online people in the guild, or 0 if the player is not in a guild.
+==Example==
+ local numTotal, numOnlineMaxLevel, numOnline = GetNumGuildMembers();
+ DEFAULT_CHAT_FRAME:AddMessage(numTotal .. " guild members: " .. numOnline .. " online (" .. numOnlineMaxLevel .. " at maximum level), " .. (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 [[API_GuildRoster|GuildRoster()]] first in order to obtain correct data. May return wrong values immediately after quitting a guild. Maximum returned value is 1000.