From 61bc24f818699b9c74397c9ff269c8906e60ea7a Mon Sep 17 00:00:00 2001 From: gumi Date: Fri, 15 Jun 2018 12:10:22 -0400 Subject: standardize the multi-form buildin definitions --- doc/script_commands.txt | 54 ++++++++++++++++++++++++++----------------------- 1 file changed, 29 insertions(+), 25 deletions(-) (limited to 'doc') diff --git a/doc/script_commands.txt b/doc/script_commands.txt index 36c4da35a..10a0352f4 100644 --- a/doc/script_commands.txt +++ b/doc/script_commands.txt @@ -2756,7 +2756,9 @@ save points. Available information types are: --------------------------------------- -*getcharip({""||}) +*getcharip({""}) +*getcharip({}) +*getcharip({}) This function will return the IP address of the invoking character, or, if a player is specified, of that character. A blank string is returned if no @@ -3413,7 +3415,8 @@ behave specially when talked to by GMs. --------------------------------------- -*setgroupid({, ""|}) +*setgroupid({, ""}) +*setgroupid({, }) This function will temporary adjust the id of player group the account to which the player specified if the new group id is available. @@ -4372,7 +4375,7 @@ offline in the mean time, attachrid() returns false, otherwise true. --------------------------------------- -*rid2name() +*rid2name() Converts rid to name. Note: The player/monster/NPC must be online/enabled. Good for PCKillEvent where you can convert 'killedrid' to the name of the @@ -4616,13 +4619,12 @@ effects. --------------------------------------- -*recovery() -*recovery() +*recovery({}) *recovery(""{, , , , }) -In its first form, this command will revive and restore full HP and SP to all -characters currently connected to the server. In its second form, it will only -affect the target player. In its third form it will affect a whole map or area. +This command will revive and restore full HP and SP to all characters currently +connected to the server. If an account id is supplied, it will instead only +affect this character. If a map is supplied it will affect a whole map or area. --------------------------------------- @@ -5138,8 +5140,10 @@ Example: close(); --------------------------------------- -*getnameditem(, ) -*getnameditem("", ) +*getnameditem(, "") +*getnameditem(, ) +*getnameditem("", "") +*getnameditem("", ) Create an item signed with the given character's name. @@ -5303,7 +5307,7 @@ Check getitem2() to understand the arguments of the function. --------------------------------------- -*groupranditem() +*groupranditem() Returns the item_id of a random item picked from the item container specified. There are different item containers and they are specified in 'db/(pre-)re/item_group.conf'. @@ -5313,7 +5317,7 @@ Example: --------------------------------------- -*getrandgroupitem(, ) +*getrandgroupitem(, ) Similar to the above example, this command allows players to obtain the specified quantity of a random item from the container. The different containers @@ -6195,7 +6199,7 @@ Examples: @ /!\ This command is deprecated @ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ -Prevents the player from moving when the option != 0, and 0 enables the +Prevents the player from moving when the option != 0, and 0 enables the player to move again. The player has to be the account ID of a character, and will run for the attached player if zero is supplied. @@ -6823,12 +6827,12 @@ valid for gettimer() are: --------------------------------------- -*initnpctimer({ "" {, } } | - { "" | }) -*stopnpctimer({ "" {, } } | - { "" | }) -*startnpctimer({ "" {, } } | - { "" | }) +*initnpctimer({""{, }}) +*initnpctimer({}) +*stopnpctimer({""{, }}) +*stopnpctimer({}}) +*startnpctimer({""{, }}) +*startnpctimer({}) *setnpctimer({, ""}) *getnpctimer({, ""}) *attachnpctimer({""}) @@ -9369,19 +9373,19 @@ Add quest of the to the the quest log, and the state is "active". --------------------------------------- -*questprogress({, PLAYTIME|HUNTING}) +*questprogress({, }) If no additional argument supplied, return the state of the quest: 0 = Quest not started (not in quest log) 1 = Quest has been given 2 = Quest completed -If parameter PLAYTIME is supplied: +If PLAYTIME is supplied: 0 = Quest not started (not in quest log) 1 = The time limit has not yet been reached 2 = The time limit has been reached -If parameter HUNTING is supplied: +If HUNTING is supplied: 0 = Quest not started (not in quest log) 1 = Player hasn't killed all of the target monsters 2 = Player has killed all of the target monsters @@ -10023,7 +10027,7 @@ returns 1 on success, 0 on failure. //===================================== --------------------------------------- -*join_clan({,}) +*join_clan({, }) Joins a player into the given clan. If no RID is given, will run with the current attached player. @@ -10032,7 +10036,7 @@ returns true on success, false on failure. --------------------------------------- -*clan_leave({}) +*clan_leave({}) Removes a player from its clan. If no RID is given, will run with the current attached player. @@ -10068,4 +10072,4 @@ the available flags are: Opens the styling shop on client ---------------------------------------- \ No newline at end of file +--------------------------------------- -- cgit v1.2.3-60-g2f50