summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndrei Karas <akaras@inbox.ru>2017-07-25 23:14:27 +0300
committerAndrei Karas <akaras@inbox.ru>2017-07-25 23:14:27 +0300
commit9cb7d5b2620e4d2f976dbae366860a6c41690198 (patch)
tree5ef28c490219443cd797a86a04c0b15cdaa2b93c
parent3746f02c4cb4a87a0bfca1319656a9d067c90c2b (diff)
downloaddocs-9cb7d5b2620e4d2f976dbae366860a6c41690198.tar.gz
docs-9cb7d5b2620e4d2f976dbae366860a6c41690198.tar.bz2
docs-9cb7d5b2620e4d2f976dbae366860a6c41690198.tar.xz
docs-9cb7d5b2620e4d2f976dbae366860a6c41690198.zip
Update constants and scripts documentation from hercules.
-rw-r--r--server/scripts/constants.md17
-rw-r--r--server/scripts/script_commands.txt54
2 files changed, 69 insertions, 2 deletions
diff --git a/server/scripts/constants.md b/server/scripts/constants.md
index 0ecb527..40d9a26 100644
--- a/server/scripts/constants.md
+++ b/server/scripts/constants.md
@@ -3948,6 +3948,13 @@
- `BL_CHAR`: 539
- `BL_ALL`: 4095
+### Refine Chance Types
+
+- `REFINE_CHANCE_TYPE_NORMAL`: 0
+- `REFINE_CHANCE_TYPE_ENRICHED`: 1
+- `REFINE_CHANCE_TYPE_E_NORMAL`: 2
+- `REFINE_CHANCE_TYPE_E_ENRICHED`: 3
+
### Player permissions
- `PERM_TRADE`: 1
@@ -3977,6 +3984,16 @@
- `PERM_DISABLE_EXP`: 33554432
- `PERM_DISABLE_SKILL_USAGE`: 67108864
+### Data types
+
+- `DATATYPE_NIL`: 128
+- `DATATYPE_STR`: 256
+- `DATATYPE_INT`: 512
+- `DATATYPE_CONST`: 1024
+- `DATATYPE_PARAM`: 2048
+- `DATATYPE_VAR`: 4096
+- `DATATYPE_LABEL`: 8192
+
### Renewal
- `RENEWAL`: 1
diff --git a/server/scripts/script_commands.txt b/server/scripts/script_commands.txt
index bf403bf..9148e02 100644
--- a/server/scripts/script_commands.txt
+++ b/server/scripts/script_commands.txt
@@ -3212,7 +3212,7 @@ If the equip was not found or the type is invalid, -1 is returned.
---------------------------------------
-*getequipoptioninfo(<equip_index>,<slot>,<type>);
+*getequipoption(<equip_index>,<slot>,<type>);
Gets the option information of an equipment.
@@ -3408,6 +3408,30 @@ Example :
---------------------------------------
+*getcalendartime(<hour>, <minute>{, <day of month>{, <day of week>}})
+
+This function returns the timestamp of the next ocurrence of given time.
+
+Day of Month specifies a day between 1 and 31 in the future, by default its value is -1 (don't use).
+Day of Week specifies a day in the week and its valid values are:
+ 0 - SUNDAY
+ 1 - MONDAY
+ 2 - TUESDAY
+ 3 - WEDNESDAY
+ 4 - THURSDAY
+ 5 - FRIDAY
+ 6 - SATURDAY
+
+In order to use Day of Week, you must use Day of Month as -1.
+If for some reason the command fails, it'll return -1.
+
+Examples :
+ getcalendartime(19, 00); // Next 7 pm
+ getcalendartime(19, 00, 6); // Next day 6 of the month, at 7pm
+ getcalendartime(19, 10, -1, 1); // Next Monday, at 7:10pm
+
+---------------------------------------
+
*gettimestr(<format string>, <max length>)
This function will return a string containing time data as specified by
@@ -8337,6 +8361,30 @@ Example:
---------------------------------------
+*getdatatype(<argument>)
+
+This command returns the raw type of the given <argument>. Unlike
+isstr, this command does not evaluate the argument. The returned type
+is bitmasked.
+
+types include:
+
+ DATATYPE_NIL
+ DATATYPE_STR
+ DATATYPE_INT
+ DATATYPE_CONST
+ DATATYPE_PARAM
+ DATATYPE_VAR
+ DATATYPE_LABEL
+
+Example:
+
+ getdatatype() // DATATYPE_NIL
+ getdatatype("foo") // DATATYPE_STR
+ getdatatype(@foo$) // (DATATYPE_VAR | DATATYPE_STR)
+
+---------------------------------------
+
*charisalpha("<string>", <position>)
This function will return true if the character number Position in the given
@@ -9128,9 +9176,11 @@ Example
---------------------------------------
-*setquest(<ID>)
+*setquest(<ID>{, <Time Limit>})
Place quest of <ID> in the users quest log, the state of which is "active".
+If Time Limit is given, this quest will have its expire time set to <Time Limit>, an UNIX epoch time,
+ignoring quest_db setting.
If questinfo() is set, and the same ID is specified here, the icon will be cleared when the quest is set.