From 30c870ef0bd8ffbaca798fecec942a40212f5ea9 Mon Sep 17 00:00:00 2001 From: Wuzzy Date: Wed, 28 Dec 2016 21:18:35 +0100 Subject: Mention what to do with hand and air --- API.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) (limited to 'API.md') diff --git a/API.md b/API.md index d2b6a56..2b2fc27 100644 --- a/API.md +++ b/API.md @@ -160,7 +160,7 @@ Suppressing an entry is useful for items which aren't supposed to be directly seen or obtained by the player or if they are only used for technical and/or internal purposes. Another possible reason to suppress an entry is to scrub the entry list of lots of very similar related items where the -difference is too small to justify two seperate entries (e.g. +difference is too small to justify two separate entries (e.g. burning furnace vs inactive furnace, because the gameplay mechanics are identical for both). @@ -174,7 +174,22 @@ System to learn more. By default, all entries are hidden except air and the hand. To mark an entry as hidden, add the field `_doc_items_hidden=true` to its -item definition. To mark an entry +item definition. To make sure an entry is never hidden, add +`_doc_items_hidden=false` instead (this rarely needs to be specified +explicitly). + +### Hand and air +The mod adds some default help texts for the hand and the air which are +written in a way that they probably are true for most subgames out of the +box, but especially the hand help text is kept intentionally vague. +If you want to change these help texts or the entry names or other +attributes, just add `_doc_items_*` fields to the item definition, either +by re-defining or overwriting these items (e.g. with +`minetest.override_item`). + +In the mod `doc_minetest_game`, the default hand help text is overwritten +to explain the hand in more detail, especially the hand behaviour in +Creative Mode. ## Functions This is the reference of all available functions in this API. -- cgit v1.2.3