summaryrefslogtreecommitdiff
path: root/API.md
diff options
context:
space:
mode:
authorWuzzy <almikes@aol.com>2016-08-10 07:47:39 +0200
committerWuzzy <almikes@aol.com>2016-08-10 07:47:39 +0200
commit8ca3fae3589e73c90377eefabd01d9a2c89c3d10 (patch)
tree6b82b479f7999f1c3416ae1591d7d84bcab9ea45 /API.md
parent21f5ddc650bb5f1faa2daa297fc25979f9652e02 (diff)
Function: add_suppressed_item_entries
Diffstat (limited to 'API.md')
-rw-r--r--API.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/API.md b/API.md
index 10b1037..a1a7bdf 100644
--- a/API.md
+++ b/API.md
@@ -298,6 +298,15 @@ the item is not in creative inventory.
to the group `in_doc=1` (see above). Only use this function when you can
not use groups.
+### `doc.sub.items.add_suppressed_item_entries(itemstrings)`
+Adds items which will be forced to **not** be added to the entry list.
+
+`itemstrings` is a table of itemstrings of items to force the entries for.
+
+***Note***: The recommended way to suppress item entries is by adding the
+item to the group `not_in_doc=1` (see above). Only use this function when you
+can not use groups.
+
### `doc.sub.items.add_item_name_overrides(itemstrings)`
Overrides the entry names of entries to the provided names. By default,
each entry name equals the item's `description` field.