diff options
author | Haru <haru@dotalux.com> | 2014-10-25 02:28:09 +0200 |
---|---|---|
committer | Haru <haru@dotalux.com> | 2014-10-27 00:55:29 +0100 |
commit | bcf7a77e17b98997dfde8a54bbb2d279236e966b (patch) | |
tree | 81daef840361c778385ab3e92e82e3586fbdfca0 /doc/script_commands.txt | |
parent | ce85609f42d6f0f2fd1db6e76bce9744e231074e (diff) | |
download | hercules-bcf7a77e17b98997dfde8a54bbb2d279236e966b.tar.gz hercules-bcf7a77e17b98997dfde8a54bbb2d279236e966b.tar.bz2 hercules-bcf7a77e17b98997dfde8a54bbb2d279236e966b.tar.xz hercules-bcf7a77e17b98997dfde8a54bbb2d279236e966b.zip |
Marked command jump_zero as deprecated.
- Added prefixed version for internal use.
- Note: The command will be completely removed after about a month.
Custom, third party scripts will require updates, in case they were
using this command. Please see the jump_zero documentation.
Signed-off-by: Haru <haru@dotalux.com>
Diffstat (limited to 'doc/script_commands.txt')
-rw-r--r-- | doc/script_commands.txt | 24 |
1 files changed, 16 insertions, 8 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt index 651ce05e2..4edb596b6 100644 --- a/doc/script_commands.txt +++ b/doc/script_commands.txt @@ -974,14 +974,14 @@ Within executable script code, some lines can be labels: <label name>: Labels are points of reference in your script, which can be used to route -execution with 'goto', 'menu' and 'jump_zero' commands, invoked with -'doevent' and 'donpcevent' commands and are otherwise essential. A label's -name may not be longer than 22 characters. (23rd is the ':'.) There is -some confusion in the source about whether it's 22, 23 or 24 all over the -place, so keeping labels under 22 characters could be wise. It may only -contain alphanumeric characters and underscore. In addition to labels you -name yourself, there are also some special labels which the script engine -will start execution from if a special event happens: +execution with 'goto' and 'menu' commands, invoked with 'doevent', 'donpcevent' +and 'callsub' commands and are otherwise essential. A label's name may not be +longer than 22 characters. (23rd is the ':'.) There is some confusion in the +source about whether it's 22, 23 or 24 all over the place, so keeping labels +under 22 characters could be wise. It may only contain alphanumeric characters +and underscore. In addition to labels you name yourself, there are also some +special labels which the script engine will start execution from if a special +event happens: OnClock<hour><minute>: OnMinute<minute>: @@ -2058,6 +2058,14 @@ else if (<condition 2>) { *jump_zero (<condition>),<label>; + @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ + @ /!\ This command is deprecated @ + @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ + +This command is deprecated and it should not be used in new scripts, as it is +scheduled to be removed at any time on or after November 27th, 2014. Please +consider using 'if', 'switch', 'for', 'while', as appropriate. + This command works like an 'if'+'goto' combination in one go. (See 'if'). If the condition is false (equal to zero) this command will immediately jump to the specified label like in 'goto'. |