From a8c58d5cbba994849ea78e3eecefbefb70070bb7 Mon Sep 17 00:00:00 2001 From: Francisco Date: Fri, 10 Dec 2021 03:24:42 -0800 Subject: [PATCH] Add pauloue's ItemStack example to docs (#9853) --- doc/lua_api.txt | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/lua_api.txt b/doc/lua_api.txt index aff739cfb..e26497555 100644 --- a/doc/lua_api.txt +++ b/doc/lua_api.txt @@ -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