oss/luanti
oss/luanti
1
0
Fork 0
mirror of https://github.com/luanti-org/luanti.git synced 2025-08-31 18:31:04 +00:00
Code Wiki Activity

Add a short_description to be used by mods (#8980)

Browse source
This commit is contained in:
DS 2020-10-09 20:11:21 +02:00 • committed by GitHub
parent b2f3f66385
commit f3ae45b2b2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 102 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc/lua_api.txt
View file

@ -2054,6 +2054,8 @@ 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`.
* `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.
@ -5994,6 +5996,8 @@ an itemstring, a table or `nil`.
stack).
* `set_metadata(metadata)`: (DEPRECATED) Returns true.
* `get_description()`: returns the description shown in inventory list tooltips.
* `get_short_description()`: returns the short description.
* Unlike the description, this does not include new lines.
* `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.
@ -7096,6 +7100,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.
short_description = "Steel Axe",
-- Must not contain new lines.
-- Defaults to the first line of description.
groups = {},
-- key = name, value = rating; rating = 1..3.