minetest
/
minetest
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add pauloue's ItemStack example to docs (#9853)

master
Francisco 2021-12-10 03:24:42 -08:00 committed by GitHub
parent d9d219356a
commit a8c58d5cbb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/lua_api.txt
View File

@ -2181,6 +2181,21 @@ Example:
meta:set_string("key", "value")
print(dump(meta:to_table()))
Example manipulations of "description" and expected output behaviors:
print(ItemStack("default:pick_steel"):get_description()) --> Steel Pickaxe
print(ItemStack("foobar"):get_description()) --> Unknown Item
local stack = ItemStack("default:stone")
stack:get_meta():set_string("description", "Custom description\nAnother line")
print(stack:get_description()) --> Custom description\nAnother line
print(stack:get_short_description()) --> Custom description
stack:get_meta():set_string("short_description", "Short")
print(stack:get_description()) --> Custom description\nAnother line
print(stack:get_short_description()) --> Short
print(ItemStack("mod:item_with_no_desc"):get_description()) --> mod:item_with_no_desc