summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndrei Karas <akaras@inbox.ru>2017-04-19 23:09:32 +0300
committerAndrei Karas <akaras@inbox.ru>2017-04-19 23:09:32 +0300
commitfa105b1205b93cb544c9de90e17ebfe0937acb32 (patch)
tree8c416ea21caaf387ffa233eda93612617009f150
parent0865b4e44ad86eb855d927970751a09a35626c12 (diff)
downloaddocs-fa105b1205b93cb544c9de90e17ebfe0937acb32.tar.gz
docs-fa105b1205b93cb544c9de90e17ebfe0937acb32.tar.bz2
docs-fa105b1205b93cb544c9de90e17ebfe0937acb32.tar.xz
docs-fa105b1205b93cb544c9de90e17ebfe0937acb32.zip
Add evol plugin based item option functions into scripts documentation.
-rw-r--r--server/scripts/evol_script_commands.txt52
1 files changed, 52 insertions, 0 deletions
diff --git a/server/scripts/evol_script_commands.txt b/server/scripts/evol_script_commands.txt
index 0985ed6..9c4e021 100644
--- a/server/scripts/evol_script_commands.txt
+++ b/server/scripts/evol_script_commands.txt
@@ -958,3 +958,55 @@ Example:
slide 25, 194;
---------------------------------------
+
+*getitemoptionidbyindex invIndex, optIndex;
+
+Return option id for item with inventory index invIndex and option index optIndex.
+
+Example:
+ mes getitemoptionidbyindex(10, 0);
+ mes getitemoptionidbyindex(10, 1);
+ mes getitemoptionidbyindex(10, 2);
+ mes getitemoptionidbyindex(10, 3);
+ mes getitemoptionidbyindex(10, 4);
+
+---------------------------------------
+
+*getitemoptionvaluebyindex invIndex, optIndex;
+
+Return option value for item with inventory index invIndex and option index optIndex.
+
+Example:
+ mes getitemoptionvaluebyindex(10, 0);
+ mes getitemoptionvaluebyindex(10, 1);
+ mes getitemoptionvaluebyindex(10, 2);
+ mes getitemoptionvaluebyindex(10, 3);
+ mes getitemoptionvaluebyindex(10, 4);
+
+---------------------------------------
+
+*getitemoptionparambyindex invIndex, optIndex;
+
+Return option parameter for item with inventory index invIndex and option index optIndex.
+For now item parameters not saved and useless.
+
+Example:
+ mes getitemoptionparambyindex(10, 0);
+ mes getitemoptionparambyindex(10, 1);
+ mes getitemoptionparambyindex(10, 2);
+ mes getitemoptionparambyindex(10, 3);
+ mes getitemoptionparambyindex(10, 4);
+
+---------------------------------------
+
+*setitemoptionbyindex invIndex, optIndex, [optName,] optValue;
+
+Set option value and type for item with inventory index invIndex and option index optIndex.
+optName is item option name field from item_options.conf.
+optValue is any custom data for item option with given name.
+
+Example:
+ // .@item here is item inventory index
+ setitemoptionbyindex(.@item, 0, VAR_MAXHPAMOUNT, 200);
+ setitemoptionbyindex(.@item, 1, VAR_STRAMOUNT, 10);
+ setitemoptionbyindex(.@item, 2, VAR_VITAMOUNT, -5);