From c6350bb83d2b7ebfabd9eb99d67cfd6360a4f60a Mon Sep 17 00:00:00 2001 From: gumi Date: Sun, 20 Oct 2019 13:19:26 -0400 Subject: add documentation for buildin_getguildinfo --- doc/script_commands.txt | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) (limited to 'doc') diff --git a/doc/script_commands.txt b/doc/script_commands.txt index db853d267..47ad19191 100644 --- a/doc/script_commands.txt +++ b/doc/script_commands.txt @@ -3704,6 +3704,32 @@ You need to put a 'close' after that yourself. //===================================== --------------------------------------- +*getguildinfo({, }) +*getguildinfo({, ""}) + +This command returns misc info about the guild of the attached player. If a +guild id or guild name is specified it will be used instead. If the target guild +does not exist it returns an empty string or -1 depending on whether a string +or an integer was requested. + +Valid are: + GUILDINFO_NAME - guild name + GUILDINFO_ID - guild id + GUILDINFO_LEVEL - current level + GUILDINFO_EXP - current exp + GUILDINFO_NEXT_EXP - exp required to reach the next level + GUILDINFO_SKILL_POINTS - available skill points + GUILDINFO_ONLINE - number of online members + GUILDINFO_AV_LEVEL - average member level + GUILDINFO_MAX_MEMBERS - guild capacity + GUILDINFO_MASTER_NAME - name of the guild master + GUILDINFO_MASTER_CID - char id of the guild master + +Example: + getguildinfo(GUILDINFO_MASTER_NAME, getcharid(CHAR_ID_GUILD, "Haru")) + +--------------------------------------- + *getguildname() This function returns a guild's name given an ID number. If there is no -- cgit v1.2.3-70-g09d2