Skip to content

Commit 5cb55bb

Browse files
Merge pull request #3311 from jasonch35/getguildmember-doc-update
Update `getguildmember` doc following #3310
2 parents bd39f4c + 5d7b34d commit 5cb55bb

File tree

1 file changed

+11
-21
lines changed

1 file changed

+11
-21
lines changed

doc/script_commands.txt

+11-21
Original file line numberDiff line numberDiff line change
@@ -4220,33 +4220,23 @@ Example:
42204220

42214221
---------------------------------------
42224222

4223-
*getguildmember(<guild id>{, <type>});
4223+
*getguildmember(<guild id>, <type>, <array>);
42244224

4225-
This command will find all members of a specified guild and returns their names
4226-
(or character id or account id depending on the value of "type") into an array
4227-
of temporary global variables.
4225+
This command will find all members of a specified <guild_id>, copy their
4226+
names (or character id or account id) depending on the <type> into <array>
4227+
and returns the number of guild members that were found.
42284228

4229-
Upon executing this,
4230-
4231-
$@guildmembername$[] is a global temporary string array which contains all the
4232-
names of these guild members.
4233-
(only set when type is 0 or not specified)
4234-
4235-
$@guildmembercid[] is a global temporary number array which contains the
4236-
character id of these guild members.
4237-
(only set when type is 1)
4238-
4239-
$@guildmemberaid[] is a global temporary number array which contains the
4240-
account id of these guild members.
4241-
(only set when type is 2)
4229+
Valid <type> are:
42424230

4243-
$@guildmembercount is the number of guild members that were found.
4231+
GD_MEMBER_NAME - Guild member names
4232+
GD_MEMBER_CHARID - Guild member character ID
4233+
GD_MEMBER_ACCID - Guild member account ID
42444234

42454235
The guild members will be found regardless of whether they are online or offline.
4246-
Note that the names come in no particular order.
4236+
Note that the results come in no particular order.
42474237

4248-
Be sure to use $@guildmembercount to go through this array, and not
4249-
getarraysize(), because it is not cleared between runs of getguildmember().
4238+
Make sure to use string variable for GD_MEMBER_NAME and
4239+
int variable for GD_MEMBER_CHARID and GD_MEMBER_ACCID
42504240

42514241
For usage examples, see getpartymember().
42524242

0 commit comments

Comments
 (0)