end
itemdef.name = name
- -- default description to item name
- itemdef.description = itemdef.description or name
-- default short_description to first line of description
itemdef.short_description = itemdef.short_description or
- itemdef.description:gsub("\n.*","")
+ (itemdef.description or ""):gsub("\n.*","")
-- Apply defaults and add to registered_* table
if itemdef.type == "node" then
Some of the values in the key-value store are handled specially:
-* `description`: Set the item stack's description. Defaults to
- `idef.description`.
-* `short_description`: Set the item stack's short description. Defaults
- to `idef.short_description`.
+* `description`: Set the item stack's description.
+ See also: `get_description` in [`ItemStack`]
+* `short_description`: Set the item stack's short description.
+ See also: `get_short_description` in [`ItemStack`]
* `color`: A `ColorString`, which sets the stack's color.
* `palette_index`: If the item has a palette, this is used to get the
current color from the palette.
stack).
* `set_metadata(metadata)`: (DEPRECATED) Returns true.
* `get_description()`: returns the description shown in inventory list tooltips.
+ * The engine uses the same as this function for item descriptions.
+ * Fields for finding the description, in order:
+ * `description` in item metadata (See [Item Metadata].)
+ * `description` in item definition
+ * item name
* `get_short_description()`: returns the short description.
* Unlike the description, this does not include new lines.
+ * The engine uses the same as this function for short item descriptions.
+ * Fields for finding the short description, in order:
+ * `short_description` in item metadata (See [Item Metadata].)
+ * `short_description` in item definition
+ * first line of the description (See `get_description()`.)
* `clear()`: removes all items from the stack, making it empty.
* `replace(item)`: replace the contents of this stack.
* `item` can also be an itemstring or table.
{
description = "Steel Axe",
-- Can contain new lines. "\n" has to be used as new line character.
- -- Defaults to the item's name.
+ -- See also: `get_description` in [`ItemStack`]
short_description = "Steel Axe",
-- Must not contain new lines.
-- Defaults to the first line of description.
+ -- See also: `get_short_description` in [`ItemStack`]
groups = {},
-- key = name, value = rating; rating = 1..3.