summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHaru <haru@dotalux.com>2014-09-20 15:16:56 +0200
committerHaru <haru@dotalux.com>2014-09-20 15:22:14 +0200
commitb0006317e5cc4a48cd5b8a501b94813cd3b93670 (patch)
tree82e5f26c5ea7139adc824ee9273cb547425512b6 /doc
parent9d91a8ea819c24df708b89d6dc0b98c3fea36876 (diff)
downloadhercules-b0006317e5cc4a48cd5b8a501b94813cd3b93670.tar.gz
hercules-b0006317e5cc4a48cd5b8a501b94813cd3b93670.tar.bz2
hercules-b0006317e5cc4a48cd5b8a501b94813cd3b93670.tar.xz
hercules-b0006317e5cc4a48cd5b8a501b94813cd3b93670.zip
Replaced hardcoded values with constants for status_change_start's flag
- Please use the values from enum scstart_flag when calling status_change_start or related functions. - This also applies to the sc_start script commands. Signed-off-by: Haru <haru@dotalux.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/script_commands.txt10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 2d92779ec..0af9644dd 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -5357,10 +5357,12 @@ This is used primarily in item scripts. When used in an NPC script, a flag MUST
be defined for the rate to work.
Optional value <flag> is how the status change start will be handled (a bitmask).
- 1: Status change cannot be avoided.
- 2: Tick cannot be reduced by stats (default).
- 4: sc_data loaded, so no value will be altered.
- 8: Rate cannot be reduced.
+ SCFLAG_NONE = 0x00: No special behavior.
+ SCFLAG_NOAVOID = 0x01: Status change cannot be avoided.
+ SCFLAG_FIXEDTICK = 0x02: Tick cannot be reduced by stats (default).
+ SCFLAG_LOADED = 0x04: sc_data was loaded, no value will be altered.
+ SCFLAG_FIXEDRATE = 0x08: Rate cannot be reduced.
+ SCFLAG_NOICON = 0x10: Status icon (SI) won't be shown.
If a <GID> is given, the status change will be invoked on the specified character
instead of the one attached to the script. This can only be defined after setting