summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAnnieRuru <jeankof@ymail.com>2014-09-03 08:40:58 +0800
committerAnnieRuru <jeankof@ymail.com>2014-09-03 08:40:58 +0800
commitc84363d21866adb6d0fc994c0f44cc3fdce87350 (patch)
tree9936c37e5ea4c0139c20c3ab61c0be2aa8dfa081 /doc
parentfa6d3eb080a69ba5b0ee5d73ddfdf67ccf9018a6 (diff)
downloadhercules-c84363d21866adb6d0fc994c0f44cc3fdce87350.tar.gz
hercules-c84363d21866adb6d0fc994c0f44cc3fdce87350.tar.bz2
hercules-c84363d21866adb6d0fc994c0f44cc3fdce87350.tar.xz
hercules-c84363d21866adb6d0fc994c0f44cc3fdce87350.zip
Add *getguildmember script command
its so frustrating that rathena already having this for month, but we don't have =/ https://github.com/rathena/rathena/commit/eba1539
Diffstat (limited to 'doc')
-rw-r--r--doc/script_commands.txt32
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 3a65c86dd..2d92779ec 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -3354,6 +3354,38 @@ Example:
mes "You have "+getmapguildusers("prontera",getcharid(2))+" guild members in Prontera.";
---------------------------------------
+
+*getguildmember <guild id>{,<type>};
+
+This command will find all members of a specified guild and returns their names
+(or character id or account id depending on the value of "type") into an array
+of temporary global variables.
+
+Upon executing this,
+
+$@guildmembername$[] is a global temporary string array which contains all the
+ names of these guild members.
+ (only set when type is 0 or not specified)
+
+$@guildmembercid[] is a global temporary number array which contains the
+ character id of these guild members.
+ (only set when type is 1)
+
+$@guildmemberaid[] is a global temporary number array which contains the
+ account id of these guild members.
+ (only set when type is 2)
+
+$@guildmembercount is the number of guild members that were found.
+
+The guild members will be found regardless of whether they are online or offline.
+Note that the names come in no particular order.
+
+Be sure to use $@guildmembercount to go through this array, and not
+'getarraysize', because it is not cleared between runs of 'getguildmember'.
+
+For usage examples, see 'getpartymember'.
+
+---------------------------------------
//=====================================
2.2 - End of Guild-Related Commands
//=====================================