summaryrefslogtreecommitdiff
path: root/API.md
diff options
context:
space:
mode:
authorWuzzy <almikes@aol.com>2016-12-13 12:31:26 +0100
committerWuzzy <almikes@aol.com>2016-12-13 12:31:26 +0100
commitdfe653e1789538f9b669db2dcb788c71447cc7c9 (patch)
treeb019d49cc6dd7db8e497356fa9bab6aee517f890 /API.md
parent4ae274b9e282cbd3de4b6d8779a2245cb12a1f0e (diff)
*_durability and make it more flexible
Diffstat (limited to 'API.md')
-rw-r--r--API.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/API.md b/API.md
index 3103992..b7cd14f 100644
--- a/API.md
+++ b/API.md
@@ -46,7 +46,9 @@ easy and quick manipulation of the item help entries. All fields are optional.
* `_doc_items_create_entry`: Whether to create an entry for this item (default: `true`)
* `_doc_items_entry_name`: The title of the entry. By default, this is the same as the `description` field
of the item. This field is required if the `description` is empty
-* `_doc_items_uses_fixed`: Exact number of uses for a tool before it breaks, use this is the use count is fixed. If it varies or is unlimited, please don't use this field
+* `_doc_items_durability`: Two meanings:
+ * It it is a `number`: Number of uses for a tool before it breaks, use this is the use count is fixed.
+ * If it is a `string`: Free-form text which explains how the durability works. Try to keep it short.
A full explanation of these fields is provided below.