Skip to content
Permalink
Browse files

Do not set a default for description in itemdef table (#10559)

* Do not set a default for description in itemdef table

* improve documentation
  • Loading branch information
Desour committed Nov 10, 2020
1 parent fca4db4 commit be3fe161fc831c9e6da1357dc908ed4a7681c46c
Showing with 17 additions and 8 deletions.
  1. +1 −3 builtin/game/register.lua
  2. +16 −5 doc/lua_api.txt
@@ -118,11 +118,9 @@ function core.register_item(name, itemdef)
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
@@ -2023,10 +2023,10 @@ Item metadata only contains a key-value store.

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.
@@ -5983,8 +5983,18 @@ an itemstring, a table or `nil`.
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.
@@ -7085,11 +7095,12 @@ Used by `minetest.register_node`, `minetest.register_craftitem`, and
{
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.

0 comments on commit be3fe16

Please sign in to comment.
You can’t perform that action at this time.