Add ItemStack:get_description() to get tooltip (#8847)

p-ouellette · sfan5 · commit 008b80fe1ca9 · 2019-08-24T18:38:02.000+02:00
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
@@ -5254,6 +5254,7 @@ an itemstring, a table or `nil`.
 * `get_metadata()`: (DEPRECATED) Returns metadata (a string attached to an item
   stack).
 * `set_metadata(metadata)`: (DEPRECATED) Returns true.
+* `get_description()`: returns the description shown in inventory list tooltips.
 * `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.
diff --git a/src/gui/guiFormSpecMenu.cpp b/src/gui/guiFormSpecMenu.cpp
@@ -2844,37 +2844,23 @@ void GUIFormSpecMenu::drawList(const ListDrawSpec &s, int layer,
 		}
 
 		if (layer == 1) {
-			// Draw item stack
 			if (selected)
 				item.takeItem(m_selected_amount);
 
 			if (!item.empty()) {
+				// Draw item stack
 				drawItemStack(driver, m_font, item,
 					rect, &AbsoluteClippingRect, m_client,
 					rotation_kind);
-			}
-
-			// Draw tooltip
-			std::wstring tooltip_text;
-			if (hovering && !m_selected_item) {
-				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 (!item.name.empty()) {
-					if (tooltip_text.empty())
-						tooltip_text = utf8_to_wide(item.name);
-					else if (m_tooltip_append_itemname)
-						tooltip_text += utf8_to_wide("\n[" + item.name + "]");
+				// Draw tooltip
+				if (hovering && !m_selected_item) {
+					std::string tooltip = item.getDescription(m_client->idef());
+					if (m_tooltip_append_itemname)
+						tooltip += "\n[" + item.name + "]";
+					showTooltip(utf8_to_wide(tooltip), m_default_tooltip_color,
+							m_default_tooltip_bgcolor);
 				}
 			}
-			if (!tooltip_text.empty()) {
-				showTooltip(tooltip_text, m_default_tooltip_color,
-					m_default_tooltip_bgcolor);
-			}
 		}
 	}
 }
diff --git a/src/inventory.cpp b/src/inventory.cpp
@@ -246,6 +246,14 @@ std::string ItemStack::getItemString() const
 	return os.str();
 }
 
+std::string ItemStack::getDescription(IItemDefManager *itemdef) const
+{
+	std::string desc = metadata.getString("description");
+	if (desc.empty())
+		desc = getDefinition(itemdef).description;
+	return desc.empty() ? name : desc;
+}
+
 
 ItemStack ItemStack::addItem(ItemStack newitem, IItemDefManager *itemdef)
 {
diff --git a/src/inventory.h b/src/inventory.h
@@ -47,6 +47,8 @@ struct ItemStack
 
 	// Returns the string used for inventory
 	std::string getItemString() const;
+	// Returns the tooltip
+	std::string getDescription(IItemDefManager *itemdef) const;
 
 	/*
 		Quantity methods
diff --git a/src/script/lua_api/l_item.cpp b/src/script/lua_api/l_item.cpp
@@ -175,6 +175,16 @@ int LuaItemStack::l_set_metadata(lua_State *L)
 	return 1;
 }
 
+// get_description(self)
+int LuaItemStack::l_get_description(lua_State *L)
+{
+	NO_MAP_LOCK_REQUIRED;
+	LuaItemStack *o = checkobject(L, 1);
+	std::string desc = o->m_stack.getDescription(getGameDef(L)->idef());
+	lua_pushstring(L, desc.c_str());
+	return 1;
+}
+
 // clear(self) -> true
 int LuaItemStack::l_clear(lua_State *L)
 {
@@ -470,6 +480,7 @@ const luaL_Reg LuaItemStack::methods[] = {
 	luamethod(LuaItemStack, get_meta),
 	luamethod(LuaItemStack, get_metadata),
 	luamethod(LuaItemStack, set_metadata),
+	luamethod(LuaItemStack, get_description),
 	luamethod(LuaItemStack, clear),
 	luamethod(LuaItemStack, replace),
 	luamethod(LuaItemStack, to_string),
diff --git a/src/script/lua_api/l_item.h b/src/script/lua_api/l_item.h
@@ -66,6 +66,9 @@ class LuaItemStack : public ModApiBase {
 	// set_metadata(self, string)
 	static int l_set_metadata(lua_State *L);
 
+	// get_description(self)
+	static int l_get_description(lua_State *L);
+
 	// clear(self) -> true
 	static int l_clear(lua_State *L);
 

Original file line number	Diff line number	Diff line change
`@@ -246,6 +246,14 @@ std::string ItemStack::getItemString() const`
`246`	`246`	`return os.str();`
`247`	`247`	`}`
`248`	`248`
	`249`	`+std::string ItemStack::getDescription(IItemDefManager *itemdef) const`
	`250`	`+{`
	`251`	`+ std::string desc = metadata.getString("description");`
	`252`	`+ if (desc.empty())`
	`253`	`+ desc = getDefinition(itemdef).description;`
	`254`	`+ return desc.empty() ? name : desc;`
	`255`	`+}`
	`256`	`+`
`249`	`257`
`250`	`258`	`ItemStack ItemStack::addItem(ItemStack newitem, IItemDefManager *itemdef)`
`251`	`259`	`{`