diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/constants.md | 12 | ||||
| -rw-r--r-- | doc/script_commands.txt | 63 |
2 files changed, 60 insertions, 15 deletions
diff --git a/doc/constants.md b/doc/constants.md index 5feb3736d..c44654b71 100644 --- a/doc/constants.md +++ b/doc/constants.md @@ -5133,6 +5133,18 @@ - `PCBLOCK_COMMANDS`: 128 - `PCBLOCK_NPC`: 256 +### NPC item action constants + +- `ITEMENABLEDNPC_NONE`: 0 +- `ITEMENABLEDNPC_EQUIP`: 1 +- `ITEMENABLEDNPC_CONSUME`: 2 + +### NPC allowed skill use constants + +- `SKILLENABLEDNPC_NONE`: 0 +- `SKILLENABLEDNPC_SELF`: 1 +- `SKILLENABLEDNPC_ALL`: 2 + ### private airship responds - `P_AIRSHIP_NONE`: 0 diff --git a/doc/script_commands.txt b/doc/script_commands.txt index a3a0e5673..2fc6a95e5 100644 --- a/doc/script_commands.txt +++ b/doc/script_commands.txt @@ -434,17 +434,39 @@ marked as usable in pet scripts to work in there reliably. Numbers ------- +The Hercules scripting engine supports 4 types of number literals: + +type base syntax +---------------------------------------------- +decimal 10 255 +hexadecimal 16 0xFF +octal 8 0o377 +binary 2 0b11111111 + Beside the common decimal numbers, which are nothing special whatsoever (though do not expect to use fractions, since ALL numbers are integer in this language), the script engine also handles hexadecimal numbers, which are otherwise identical. Writing a number like '0x<hex digits>' will make it recognized as a hexadecimal value. Notice that 0x10 is equal to 16. -Also notice that if you try to 'mes 0x10' it will print '16'. +Also notice that if you try to 'mes 0x10' it will print '16'. If you wish +to make calculations in base 8, you can also use the octal notation like +'0o<octal digits>'. To make calculations in base 2 (binary), you can use +the binary notation like '0b<binary digits>'. + +The following are all equivalent: + 255 == 0xFF == 0o377 == 0b11111111 Number values can't exceed the limits of an integer variable: Any number greater than INT_MAX (2147483647) or smaller than INT_MIN (-2147483648) will be capped to those values and will cause a warning to be reported. +Underscores can also be used as visual separators for digit grouping purposes: + 2_147_483_647 + 0x7FFF_FFFF + +Keep in mind that number literals cannot start or end with a separator and no +more than one separator can be used in a row (so 12_3___456 is illegal). + Variables --------- @@ -5663,21 +5685,32 @@ Example: --------------------------------------- -*enable_items() -*disable_items() +*enable_items({<flag>}) +*enableitemuse({<flag>}) +*disable_items({<flag>}) +*disableitemuse({<flag>}) + +These commands enable/disable item actions while interacting with a NPC. +When disable_items() is invoked, item actions defined by <flag> are disabled +during scripts until enable_items() is called or the script has terminated. +To avoid possible exploits, when disable_items() is invoked, it will only +disable item actions while running that script in particular. +Note that if a different script also invokes disable_items(), it will override +the last call so you may want to call this command at the start of your +script without assuming the effect is still in effect. +If <flag> is omitted all item actions will be disabled. +The enable_items() command enables item actions defined by <flag> during +scripts until disable_items() is invoked or the script has terminated. +If <flag> is omitted it defaults to 'item_enabled_npc' battle flag. +For a list of supported flags have a look at the description of +'item_enabled_npc' battle flag in 'conf/map/battle/items.conf'. +Unless disable_items() or enable_items() is invoked the script will use +'item_enabled_npc' battle flag by default. + +Example: -These commands enable/disable changing of equipments while an NPC is -running. When disable_items() is run, equipments cannot be changed -during scripts until enable_items() is called or the script has -terminated. To avoid possible exploits, when disable_items() is invoked, -it will only disable changing equips while running that script in -particular. Note that if a different script also calls disable_items(), -it will override the last call (so you may want to call this command at -the start of your script without assuming the effect is still in -effect). -If 'item_enabled_npc' option is set to true in 'conf/map/battle/items.conf' all -NPC are allowing changing of equipment by default except for those have been -set with 'disable_items'. + // This will disable changing equipment during this script. + disable_items(ITEMENABLEDNPC_EQUIP); --------------------------------------- |