summaryrefslogtreecommitdiff
path: root/doc/script_commands.txt
diff options
context:
space:
mode:
authorEyesOfAHawk <blackoutro2006@gmail.com>2018-10-18 23:44:02 +1300
committerHaru <haru@dotalux.com>2019-06-02 22:49:54 +0200
commitd9b7fa499ab5ecae677e53d43057671e43b32248 (patch)
treecc7e8b3f2fe24f73b45d697b837ddca5c04fd572 /doc/script_commands.txt
parent20b1d37e3bdfd465543e91dde0519201a3e1b0fc (diff)
downloadhercules-d9b7fa499ab5ecae677e53d43057671e43b32248.tar.gz
hercules-d9b7fa499ab5ecae677e53d43057671e43b32248.tar.bz2
hercules-d9b7fa499ab5ecae677e53d43057671e43b32248.tar.xz
hercules-d9b7fa499ab5ecae677e53d43057671e43b32248.zip
Adds buildin_getguildonline.
Signed-off-by: Haru <haru@dotalux.com>
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
//=====================================