Add per-stack descriptions using ItemStack Metadata

minetest · Feb 4, 2017 · f2f9a92 · f2f9a92
1 parent f2aa2c6
commit f2f9a92
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
@@ -1473,6 +1473,10 @@ Item stacks can store metadata too. See `ItemStackMetaRef`.
 
 Item metadata only contains a key-value store.
 
+Some of the values in the key-value store are handled specially:
+
+* `description`: Set the itemstack's description. Defaults to idef.description
+
 Example stuff:
 
     local meta = stack:get_meta()

diff --git a/src/guiFormSpecMenu.cpp b/src/guiFormSpecMenu.cpp
@@ -2303,7 +2303,12 @@ void GUIFormSpecMenu::drawList(const ListDrawSpec &s, int phase,
 			// Draw tooltip
 			std::wstring tooltip_text = L"";
 			if (hovering && !m_selected_item) {
-				tooltip_text = utf8_to_wide(item.getDefinition(m_client->idef()).description);
+				const std::string &desc = item.metadata.getString("description");
+				if (desc.empty())
+					tooltip_text =
+						utf8_to_wide(item.getDefinition(m_client->idef()).description);
+				else
+					tooltip_text = utf8_to_wide(desc);
 			}
 			if (tooltip_text != L"") {
 				std::vector<std::wstring> tt_rows = str_split(tooltip_text, L'\n');