summaryrefslogtreecommitdiff
path: root/doc/script_commands.txt
diff options
context:
space:
mode:
authorHaru <haru@dotalux.com>2019-06-02 23:38:43 +0200
committerGitHub <noreply@github.com>2019-06-02 23:38:43 +0200
commit6772362cf2f0a08502cc7d910ed761d249d0c025 (patch)
tree33c1b15a80f86375b1060b1fb42d8287618d0c81 /doc/script_commands.txt
parent000433f782f10f49582b8290b543d7e941e5f7a7 (diff)
parentd9b7fa499ab5ecae677e53d43057671e43b32248 (diff)
downloadhercules-6772362cf2f0a08502cc7d910ed761d249d0c025.tar.gz
hercules-6772362cf2f0a08502cc7d910ed761d249d0c025.tar.bz2
hercules-6772362cf2f0a08502cc7d910ed761d249d0c025.tar.xz
hercules-6772362cf2f0a08502cc7d910ed761d249d0c025.zip
Merge pull request #2290 from bWolfie/getguildonline
Adds buildin_getguildonline.
Diffstat (limited to 'doc/script_commands.txt')
-rw-r--r--doc/script_commands.txt12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 4985b0596..251ce563f 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -3801,6 +3801,18 @@ getarraysize(), because it is not cleared between runs of getguildmember().
For usage examples, see getpartymember().
---------------------------------------
+
+*getguildonline(<guild id>{, <type>});
+
+Returns the amount of players online in the specified guild id.
+Returns -1 if the guild was not found.
+
+Valid <type> are:
+ GUILD_ONLINE_ALL Returns the total amount of players online in the guild.
+ GUILD_ONLINE_VENDOR Returns the total amount of vendors online in the guild.
+ GUILD_ONLINE_NO_VENDOR Returns the total amount of non-vendors online in the guild.
+
+---------------------------------------
//=====================================
2.2 - End of Guild-Related Commands
//=====================================