From 0f130e615463dfa6150d097c72a4612868e180f5 Mon Sep 17 00:00:00 2001 From: ai4rei Date: Sun, 8 May 2011 05:34:35 +0000 Subject: * Updated/revised description of instance-related script commands (bugreport:4880). - Fixed 'instance_create' would return -4 (party already instancing) when the requested party was not found. - 'instance_create' return value -2 now means 'party not found' rather than 'missing parameter'. git-svn-id: https://rathena.svn.sourceforge.net/svnroot/rathena/trunk@14809 54d463be-8e91-2dee-dedb-b68131a5f0ec --- doc/script_commands.txt | 108 ++++++++++++++++++++++++++++++++++-------------- 1 file changed, 77 insertions(+), 31 deletions(-) (limited to 'doc') diff --git a/doc/script_commands.txt b/doc/script_commands.txt index 2e930e8a3..a8f3fb63c 100644 --- a/doc/script_commands.txt +++ b/doc/script_commands.txt @@ -4,7 +4,7 @@ //= A reference manual for the eAthena scripting language. //= Commands are sorted depending on their functionality. //===== Version =========================================== -//= 3.41.20110427 +//= 3.42.20110508 //========================================================= //= 1.0 - First release, filled will as much info as I could //= remember or figure out, most likely there are errors, @@ -171,6 +171,9 @@ //= 3.41.20110427 //= Updated description of 'itemheal' primarily to remove overhead and lies //= about client effects. [Ai4rei] +//= 3.42.20110508 +//= Updated description of all instance commands to reflect actual behavior. +//= [Ai4rei] //========================================================= This document is a reference manual for all the scripting commands and functions @@ -5542,7 +5545,7 @@ currently ignored by the client and appears always green. 5,1.- End of time-related commands // -*announce "",{,{,{,{,{,}}}}}}; +*announce "",{,{,{,{,{,}}}}}; This command will broadcast a message to all or most players, similar to @kami/@kamib GM commands. @@ -6766,18 +6769,17 @@ This will open a book item at the specified page ======================== --------------------------------------- -*instance_create("",,) +*instance_create("",); -Create an instance using the name "" for the Party of . -Instance ID currently will only be ID_ENDLESS (5) or ID_CATACOMBS (6) -Most Instance_* commands are used in conjunction with this command and depend +Create an instance using the name "" for the Party of . +Most instance_* commands are used in conjunction with this command and depend on the ID this command returns. Example: // Store the Party ID of the invoking character. set .@party_id, getcharid(1); // Attempt to create an instance using that party ID. - set .@id, instance_create("Endless Tower", .@party_id, ID_ENDLESS); + set .@id, instance_create("Endless Tower", .@party_id); if (.@id == -1) { // Party ID is in use by another instance. ... } @@ -6786,67 +6788,111 @@ Example: } --------------------------------------- -*instance_destroy() +*instance_destroy {}; -Destroys instance with the ID . +Destroys instance with the ID . If no ID is specified, the instance, +the script is attached to, is used. If the script is not attached to an instance, +the instance of the currently attached player's party is used. If no player is +currently attached, the command fails and causes the script to halt. --------------------------------------- -*instance_attachmap(,"") -*instance_detachmap(,"") +*instance_attachmap("",{,}); + +Attaches the map "" to the instance specified with . The +optional parameter specifies, whether a map requires emulation for instancing (1) +or not (0 = default). -Attach or detach the map "" to the instance with the . +Returns the resulting map name on success or an empty string on failure. --------------------------------------- -*instance_init(); +*instance_detachmap ""{,}; -Initiate the instance of . +Detach the map "" to the instance with the . If no ID is +specified, the instance, the script is attached to, is used. If the script is not +attached to an instance, the instance of the currently attached player's party is +used. If no player is currently attached, the command fails and causes the script +to halt. --------------------------------------- -*instance_announce ,"",{,}; +*instance_init ; -Works like announce, but has the parameter, where 0 = active instance? +Initializes the instance given by . This copies all NPCs from the +source maps to the instanced maps. --------------------------------------- -*instance_attach(); +*instance_announce ,"",{,{,{,{,{,}}}}}; -Attaches a script to the provided ? +Works like announce, but has the parameter. If instance id is 0, the +instance, the script is attached to, is used. If the script is not attached to an +instance, the instance of the currently attached player's party is used. If no +player is currently attached, the command fails and causes the script to halt. --------------------------------------- -*instance_npcname("",) +*instance_attach ; -Retrieve the unique name given to a copy of an NPC for an instance, the given -"" that belongs to instance . Can be used with such commands -as enablenpc and disablenpc, donpcevent, etc. +Attaches the current script to the instance given by . --------------------------------------- -*has_instance("") +*instance_npcname(""{,}); -Check if the player has been queued for the instance. +Retrieves the unique name given to a copy of an NPC given by "" in an +instance specified . If no ID is specified, the instance, the script +is attached to, is used. If the script is not attached to an instance, the +instance of the currently attached player's party is used. If no player is +currently attached, the command fails and causes the script to halt. --------------------------------------- -*instance_id() +*has_instance(""{,}); + +Checks whether or not the given map belongs to specified instance. If no ID is +specified, the instance, the script is attached to, is used. If the script is not +attached to an instance, the instance of the currently attached player's party +is used. If no player is currently attached, the command fails and causes the +script to halt. -Apparently returns the ID the player is currently attached too. +Returns the name of the instanced map on success, otherwise an empty string. --------------------------------------- -*instance_warpall "",,; +*instance_id({}); -Warp all players in the instance to and given coordinates. +Retrieves the instance id, depending on . If type is not given, it defaults +to 0. + +Type: + 0 - Instance ID the script is attached to. + 1 - Instance ID of the currently attached player's party. --------------------------------------- -*instance_set_timeout ,,; +*instance_warpall "",,{,}; + +Warps all players in the instance to at given +coordinates. If no ID is specified, the instance, the script is attached to, +is used. If the script is not attached to an instance, the instance of the +currently attached player's party is used. If no player is currently attached, +the command fails and causes the script to halt. + +--------------------------------------- + +*instance_set_timeout ,{,}; + +Sets the timeout values for an instance given by . If no ID is +specified, the instance, the script is attached to, is used. If the script is +not attached to an instance, the instance of the currently attached player's +party is used. If no player is currently attached, the command fails and causes +the script to halt. -Lifetime of for , while is how long until the -instance times out while inactive. +Parameter specifies the total amount of time the instance will +exist. Parameter specifies how long players have, when they are +outside of the instance, until it is destroyed. --------------------------------------- -- cgit v1.2.3-60-g2f50