diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/constants.md | 7 | ||||
| -rw-r--r-- | doc/script_commands.txt | 71 |
2 files changed, 46 insertions, 32 deletions
diff --git a/doc/constants.md b/doc/constants.md index 07a4d8a6d..d1c926c29 100644 --- a/doc/constants.md +++ b/doc/constants.md @@ -364,6 +364,7 @@ - `mf_pairship_endable`: 58 - `mf_nostorage`: 59 - `mf_nogstorage`: 60 +- `mf_nopet`: 61 ### Cell Properties @@ -5154,6 +5155,12 @@ - `P_AIRSHIP_ITEM_NOT_ENOUGH`: 2 - `P_AIRSHIP_ITEM_INVALID`: 5 +### player allowed actions when dead + +- `PCALLOWACTION_NONE`: 0 +- `PCALLOWACTION_TRADE`: 1 +- `PCALLOWACTION_CHAT`: 2 + ### questinfo types - `QINFO_JOB`: 0 diff --git a/doc/script_commands.txt b/doc/script_commands.txt index cc23da4ca..ee56087b2 100644 --- a/doc/script_commands.txt +++ b/doc/script_commands.txt @@ -3195,23 +3195,24 @@ This command sets a bunch of arrays with a complete list of whatever the invoking character has in its inventory, including all the data needed to recreate these items perfectly if they are destroyed. Here's what you get: -@inventorylist_id[] - array of item ids. -@inventorylist_idx[] - array of item inventory index. -@inventorylist_amount[] - their corresponding item amounts. -@inventorylist_equip[] - will return the slot the item is equipped on, if at all. -@inventorylist_refine[] - for how much it is refined. -@inventorylist_identify[] - whether it is identified. -@inventorylist_attribute[] - whether it is broken. -@inventorylist_card1[] - These four arrays contain card data for the -@inventorylist_card2[] items. These data slots are also used to store -@inventorylist_card3[] names inscribed on the items, so you can -@inventorylist_card4[] explicitly check if the character owns an item - made by a specific craftsman. -@inventorylist_expire[] - expire time (Unix time stamp). 0 means never - expires. -@inventorylist_bound[] - whether it is an account bounded item or not. -@inventorylist_favorite[] - whether it is favorite (inside favorite tab) or not. -@inventorylist_count - the number of items in these lists. +@inventorylist_id[] - array of item ids. +@inventorylist_idx[] - array of item inventory index. +@inventorylist_amount[] - their corresponding item amounts. +@inventorylist_equip[] - will return the slot the item is equipped on, if at all. +@inventorylist_refine[] - for how much it is refined. +@inventorylist_identify[] - whether it is identified. +@inventorylist_attribute[] - whether it is broken. +@inventorylist_card1[] - These four arrays contain card data for the items. +@inventorylist_card2[] These data slots are also used to store names inscribed +@inventorylist_card3[] on the items, so you can explicitly check if the character +@inventorylist_card4[] owns an item made by a specific craftsman. +@inventorylist_expire[] - expire time (Unix time stamp). 0 means never expires. +@inventorylist_bound[] - whether it is an account bounded item or not. +@inventorylist_favorite[] - whether it is favorite (inside favorite tab) or not. +@inventorylist_opt_id1~5[] - array of random option id. +@inventorylist_opt_val1~5[] - array of random option val. +@inventorylist_opt_param1~5[] - array of random option param. +@inventorylist_count - the number of items in these lists. This could be handy to save/restore a character's inventory, since no other command returns such a complete set of data, and could also be the @@ -3239,14 +3240,15 @@ recreate these items perfectly if they are destroyed. Here's what you get: @cartinventorylist_refine[] - for how much it is refined. @cartinventorylist_identify[] - whether it is identified. @cartinventorylist_attribute[] - whether it is broken. -@cartinventorylist_card1[] - These four arrays contain card data for the -@cartinventorylist_card2[] items. These data slots are also used to store -@cartinventorylist_card3[] names inscribed on the items, so you can -@cartinventorylist_card4[] explicitly check if the character owns an item - made by a specific craftsman. -@cartinventorylist_expire[] - expire time (Unix time stamp). 0 means never - expires. +@cartinventorylist_card1[] - These four arrays contain card data for the items. +@cartinventorylist_card2[] These data slots are also used to store names inscribed on the items, +@cartinventorylist_card3[] so you can explicitly check if the character owns an item +@cartinventorylist_card4[] made by a specific craftsman. +@cartinventorylist_expire[] - expire time (Unix time stamp). 0 means never expires. @cartinventorylist_bound - whether it is an account bound item or not. +@inventorylist_opt_id1~5[] - array of random option id. +@inventorylist_opt_val1~5[] - array of random option val. +@inventorylist_opt_param1~5[] - array of random option param. @cartinventorylist_count - the number of items in these lists. This could be handy to save/restore a character's cart_inventory, since no @@ -3626,7 +3628,7 @@ If the player is not found, returns -1. *gettimetick(<type>) Valid types are : - 0 - server's tick (milleseconds), unsigned int, loops every ~50 days + 0 - server's tick (milleseconds), unsigned int, loops every ~25 days 1 - time since the start of the current day in seconds 2 - UNIX epoch time (number of seconds elapsed since 1st of January 1970) @@ -7656,7 +7658,8 @@ In the OnBuyItem, two arrays are filled (@bought_nameid and and the amount sold of it. Same goes for the OnSellItem label, only the variables are named different (@sold_nameid, @sold_quantity, @sold_refine, @sold_attribute, @sold_identify, @sold_card1, @sold_card2, @sold_card3, -@sold_card4). An example on a shop comes with Hercules, and can be found +@sold_card4, @sold_opt_id1~5, @sold_opt_val1~5, @sold_opt_param1~5). +An example on a shop comes with Hercules, and can be found in the doc/sample/npc_dynamic_shop.txt file. This example shows how to use the labels and their set variables to create @@ -9656,13 +9659,19 @@ Check getitem2 command for more information of the extra parameters. //===================================== --------------------------------------- -*instance_create("<instance name>", <owner id>{, <optional owner_type>}) +*instance_create("<instance_name>", <owner_id>{, <owner_type>}) -Create an instance using the name "<instance name>" for the <owner_id> of -owner_type (when not provided, defaults to IOT_PARTY). Most instance_* +Creates an instance using the name "<instance_name>" for the <owner_id> of +<owner_type> (when not provided, defaults to IOT_PARTY). Most instance_* commands are used in conjunction with this command and depend on the ID this command returns. +Valid <owner_type> values: +- IOT_NONE (0) - <owner_id> can be any arbitrary number. +- IOT_CHAR (1) - <owner_id> is account ID. +- IOT_PARTY (2) - <owner_id> is party ID. +- IOT_GUILD (3) - <owner_id> is guild ID. + Example: // Store the Party ID of the invoking character. .@party_id = getcharid(CHAR_ID_PARTY); @@ -9673,11 +9682,9 @@ Example: // ... } else if (.@id == -2) { // Invalid Party ID // ... - } else if (.@id == -3) { // No free instances (MAX_INSTANCE exceeded) - // ... } else if (.@id == -4) { // Already exists // ... - } else (.@id < 0) { // Unspecified error while queuing instance. + } else if (.@id < 0) { // Unspecified error while queuing instance. // ... } |