Replace image string by item image definition

Author: cx384

doc/lua_api.md

@@ -2705,10 +2705,10 @@ Some of the values in the key-value store are handled specially:
   See also: `get_description` in [`ItemStack`](#itemstack)
 * `short_description`: Set the item stack's short description.
   See also: `get_short_description` in [`ItemStack`](#itemstack)
-* `inventory_image`: Override inventory_image
-* `inventory_overlay`: Override inventory_overlay
-* `wield_image`: Override wield_image
-* `wield_overlay`: Override wield_overlay
+* `inventory_image`: Override inventory_image.name
+* `inventory_overlay`: Override inventory_overlay.name
+* `wield_image`: Override wield_image.name
+* `wield_overlay`: Override wield_overlay.name
 * `wield_scale`: Override wield_scale, use vector.to_string
 * `color`: A `ColorString`, which sets the stack's color.
 * `palette_index`: If the item has a palette, this is used to get the
@@ -5849,8 +5849,8 @@ Utilities
       particlespawner_exclude_player = true,
       -- core.generate_decorations() supports `use_mapgen_biomes` parameter (5.14.0)
       generate_decorations_biomes = true,
-      -- Item definitions make use of the `inventory_image_animation`, `inventory_overlay_animation`,
-      -- `wield_overlay_animation` and `wield_image_animation` field (5.16.0)
+      -- Item definition fields `inventory_image`, `inventory_overlay`, `wield_image`
+      -- and `wield_overlay` accept a table containing animation definitions. (5.16.0)
       item_image_animation = true,
   }
   ```
@@ -9855,6 +9855,13 @@ Tile animation definition
 }
 ```
 
+Item image definition
+---------------------
+
+* `"image.png"`
+* `{name="image.png", animation={Tile Animation definition}}`
+    * Basically a tile definition but for items
+
 Item definition
 ---------------
 
@@ -9881,32 +9888,20 @@ Used by `core.register_node`, `core.register_craftitem`, and
     --      {bendy = 2, snappy = 1},
     --      {hard = 1, metal = 1, spikes = 1}
 
-    inventory_image = "",
-    -- Texture shown in the inventory GUI
+    inventory_image = <Item image definition>,
+    -- Image shown in the inventory GUI
     -- Defaults to a 3D rendering of the node if left empty.
 
-    inventory_overlay = "",
-    -- An overlay texture which is not affected by colorization
+    inventory_overlay = <Item image definition>,
+    -- An overlay image which is not affected by colorization
 
-    inventory_image_animation = {Tile Animation definition},
-    -- Optional, animates the `inventory_image` if specified
-
-    inventory_overlay_animation = {Tile Animation definition},
-    -- Optional, animates the `inventory_overlay` if specified
-
-    wield_image = "",
-    -- Texture shown when item is held in hand
+    wield_image = <Item image definition>,
+    -- Image shown when item is held in hand
     -- Defaults to a 3D rendering of the node if left empty.
 
-    wield_overlay = "",
+    wield_overlay = <Item image definition>,
     -- Like inventory_overlay but only used in the same situation as wield_image
 
-    wield_image_animation = {Tile Animation definition}
-    -- Optional, animates the `wield_image` if specified
-
-    wield_overlay_animation = {Tile Animation definition}
-    -- Optional, animates `wield_overlay` if specified
-
     wield_scale = {x = 1, y = 1, z = 1},
     -- Scale for the item when held in hand
 

games/devtest/mods/testitems/init.lua

@@ -171,72 +171,58 @@ core.register_on_leaveplayer(function(player, timed_out)
 	vmanip_for_trees[player:get_player_name()] = nil
 end)
 
-core.register_craftitem("testitems:inventory_image_animation", {
-	description = S("Animated Test Item").."\n"..
-		S("Image animate from A to D in 4s cycle"),
-	inventory_image= "testnodes_anim.png^[invert:rgb",
-	inventory_image_animation = {
+-- Animation test items
+
+local animated_image = {
+	name = "testnodes_anim.png^[invert:rgb",
+	animation = {
 		type = "vertical_frames",
 		aspect_w = 16,
 		aspect_h = 16,
 		length = 4.0,
-	},
+	}
+}
+
+local animated_overlay = {
+	name = "testitems_animation_overlay.png",
+	animation = {
+		type = "sheet_2d",
+		frames_w = 1,
+		frames_h = 4,
+		frame_length = 1.0,
+	}
+}
+
+core.register_craftitem("testitems:inventory_image_animation", {
+	description = S("Animated Test Item").."\n"..
+		S("Image animate from A to D in 4s cycle"),
+	inventory_image = animated_image
 })
 
 core.register_craftitem("testitems:inventory_image_animation_overlay", {
 	description = S("Animated Test Item With Overlay").."\n"..
 		S("Should be colored red and have green stripes that move").."\n"..
 		S("Image animate from A to D in 4s cycle"),
-	inventory_image= "testnodes_anim.png^[invert:rgb",
-	inventory_overlay="testitems_animation_overlay.png",
-	inventory_image_animation = {
-		type = "vertical_frames",
-		aspect_w = 16,
-		aspect_h = 16,
-		length = 4.0,
-	},
-	inventory_overlay_animation = {
-		type = "vertical_frames",
-		aspect_w = 16,
-		aspect_h = 16,
-		length = 4.0,
-	},
+	inventory_image = animated_image,
+	inventory_overlay = animated_overlay,
 	color = "#ff0000",
 })
 
 core.register_craftitem("testitems:wield_image_animation", {
 	description = S("Wield Animated Test Item").."\n"..
 		S("Looks like the Animated Test Item, "..
 			"but only animated for the wield mesh."),
-	inventory_image= "testnodes_anim.png^[invert:rgb^[verticalframe:4:0",
-	wield_image= "testnodes_anim.png^[invert:rgb",
-	wield_image_animation = {
-		type = "sheet_2d",
-		frames_w = 1,
-		frames_h = 4,
-		frame_length = 1.0,
-	},
+	inventory_image = "testnodes_anim.png^[invert:rgb^[verticalframe:4:0",
+	wield_image = animated_image,
 })
 
 core.register_craftitem("testitems:wield_image_animation_overlay", {
 	description = S("Wield Animated Test Item With Overlay").."\n"..
 		S("Looks like the animated Test Item With Overlay, "..
 			"but only animated for the wield mesh."),
-	inventory_image= "testnodes_anim.png^[invert:rgb^[verticalframe:4:0",
-	inventory_overlay= "testitems_animation_overlay.png^[verticalframe:4:0",
-	wield_image= "testnodes_anim.png^[invert:rgb",
-	wield_overlay="testitems_animation_overlay.png",
-	wield_image_animation = {
-		type = "sheet_2d",
-		frames_w = 1,
-		frames_h = 4,
-		frame_length = 1.0,
-	},
-	wield_overlay_animation = {
-		type = "sheet_2d",
-		frames_w = 1,
-		frames_h = 4,
-		frame_length = 1.0,
-	},
+	inventory_image = "testnodes_anim.png^[invert:rgb^[verticalframe:4:0",
+	inventory_overlay = "testitems_animation_overlay.png^[verticalframe:4:0",
+	wield_image = animated_image,
+	wield_overlay = animated_overlay,
 	color = "#ff0000",
 })

src/client/item_visuals_manager.cpp

@@ -24,16 +24,16 @@ ItemVisualsManager::ItemVisuals *ItemVisualsManager::createItemVisuals( const It
 	IItemDefManager *idef = client->idef();
 
 	const ItemDefinition &def = item.getDefinition(idef);
-	std::string inventory_image = item.getInventoryImage(idef);
-	std::string inventory_overlay = item.getInventoryOverlay(idef);
-	const TileAnimationParams &inventory_image_animation = item.getInventoryImageAnimation(idef);
-	const TileAnimationParams &inventory_overlay_animation = item.getInventoryOverlayAnimation(idef);
+	ItemImageDef inventory_image = item.getInventoryImage(idef);
+	ItemImageDef inventory_overlay = item.getInventoryOverlay(idef);
 
+	// Key only consists of item name + image name,
+	// because animation currently cannot be overridden by meta
 	std::ostringstream os(def.name);
-	if (!inventory_image.empty())
-		os << "/" << inventory_image;
-	if (!inventory_overlay.empty())
-		os << ":" << inventory_overlay;
+	if (!inventory_image.name.empty())
+		os << "/" << inventory_image.name;
+	if (!inventory_overlay.name.empty())
+		os << ":" << inventory_overlay.name;
 	std::string cache_key = os.str();
 
 
@@ -51,32 +51,37 @@ ItemVisualsManager::ItemVisuals *ItemVisualsManager::createItemVisuals( const It
 	auto iv = std::make_unique<ItemVisuals>();
 
 	auto populate_texture_and_animation = [&](
-			const std::string &image_name, const TileAnimationParams &animation,
-			video::ITexture *&texture,
+			const ItemImageDef &image, video::ITexture *&texture,
 			std::unique_ptr<ItemVisuals::OwnedAnimationInfo> &owned_animation)
 	{
-		texture = nullptr;
-		if (!image_name.empty()) {
-			texture = tsrc->getTexture(image_name);
-
-			// Get inventory texture frames
-			if (animation.type != TileAnimationType::TAT_NONE && texture) {
-				int frame_length_ms;
-				owned_animation = std::make_unique<ItemVisuals::OwnedAnimationInfo>(
-						createAnimationFrames(tsrc, image_name, animation, frame_length_ms),
-						frame_length_ms);
-
-				// Set first frame
-				texture = owned_animation->frames[0].texture;
-			}
+		if (image.name.empty()) {
+			texture = nullptr;
+			return;
 		}
+
+		if (image.animation.type == TileAnimationType::TAT_NONE) {
+			texture = tsrc->getTexture(image.name);
+			return;
+		}
+
+		// Get inventory texture frames
+		int frame_length_ms;
+		owned_animation = std::make_unique<ItemVisuals::OwnedAnimationInfo>(
+				createAnimationFrames(tsrc, image.name, image.animation,
+				frame_length_ms), frame_length_ms);
+
+		// Set first frame
+		if (!owned_animation || !owned_animation->frames.empty())
+			texture = owned_animation->frames[0].texture;
+		else
+			texture = nullptr;
 	};
 
-	populate_texture_and_animation(inventory_image, inventory_image_animation,
-			iv->inventory_texture, iv->inventory_animation);
+	populate_texture_and_animation(inventory_image, iv->inventory_texture,
+			iv->inventory_animation);
 
-	populate_texture_and_animation(inventory_overlay, inventory_overlay_animation,
-			iv->inventory_overlay_texture, iv->inventory_overlay_animation);
+	populate_texture_and_animation(inventory_overlay, iv->inventory_overlay_texture,
+			iv->inventory_overlay_animation);
 
 	createItemMesh(client, def, iv->inventory_texture,
 			iv->inventory_animation ? &(iv->inventory_animation->info) : nullptr,

src/client/wieldmesh.cpp

@@ -411,41 +411,41 @@ void WieldMeshSceneNode::setItem(const ItemStack &item, Client *client, bool che
 	m_buffer_info.clear();
 	m_base_color = item_visuals->getItemstackColor(item, client);
 
-	const std::string wield_image = item.getWieldImage(idef);
-	const std::string wield_overlay = item.getWieldOverlay(idef);
+	const ItemImageDef wield_image = item.getWieldImage(idef);
+	const ItemImageDef wield_overlay = item.getWieldOverlay(idef);
 	const v3f wield_scale = item.getWieldScale(idef);
-	const TileAnimationParams wield_image_animation = item.getWieldImageAnimation(idef);
-	const TileAnimationParams wield_overlay_animation = item.getWieldOverlayAnimation(idef);
 
 	// If wield_image needs to be checked and is defined, it overrides everything else
-	if (!wield_image.empty() && check_wield_image) {
-		video::ITexture *wield_texture = tsrc->getTexture(wield_image);
-		video::ITexture *wield_overlay_texture = wield_image.empty() ?
-				nullptr : tsrc->getTexture(wield_overlay);
+	if (!wield_image.name.empty() && check_wield_image) {
+		video::ITexture *wield_texture;
+		video::ITexture *wield_overlay_texture = nullptr;
 
-		// Animation
 		int frame_length_ms;
 		m_wield_image_frames = std::vector<FrameSpec>(createAnimationFrames(
-				tsrc, wield_image, wield_image_animation, frame_length_ms));
+				tsrc, wield_image.name, wield_image.animation, frame_length_ms));
 		if (m_wield_image_frames.empty()) {
 			m_buffer_info.emplace_back();
+			wield_texture = tsrc->getTexture(wield_image.name);
 		} else {
 			m_buffer_info.emplace_back(&m_wield_image_frames, frame_length_ms);
 			wield_texture = m_wield_image_frames[0].texture;
 		}
 
-		// Overlay animation
-		int overlay_frame_length_ms;
-		m_wield_overlay_frames = std::vector<FrameSpec>(createAnimationFrames(
-				tsrc, wield_overlay, wield_overlay_animation, overlay_frame_length_ms));
-		if (m_wield_overlay_frames.empty()) {
-			// overlay is white, if present
-			m_buffer_info.emplace_back(true, video::SColor(0xFFFFFFFF));
-		} else {
-			m_buffer_info.emplace_back(
-					&m_wield_overlay_frames, overlay_frame_length_ms,
-					true, video::SColor(0xFFFFFFFF));
-			wield_overlay_texture = m_wield_overlay_frames[0].texture;
+		// Overlay
+		if (!wield_overlay.name.empty()) {
+			int overlay_frame_length_ms;
+			m_wield_overlay_frames = std::vector<FrameSpec>(createAnimationFrames(
+					tsrc, wield_overlay.name, wield_overlay.animation, overlay_frame_length_ms));
+			if (m_wield_overlay_frames.empty()) {
+				// overlay is white, if present
+				m_buffer_info.emplace_back(true, video::SColor(0xFFFFFFFF));
+				wield_overlay_texture = tsrc->getTexture(wield_overlay.name);
+			} else {
+				m_buffer_info.emplace_back(
+						&m_wield_overlay_frames, overlay_frame_length_ms,
+						true, video::SColor(0xFFFFFFFF));
+				wield_overlay_texture = m_wield_overlay_frames[0].texture;
+			}
 		}
 
 		setExtruded(wield_texture, wield_overlay_texture, wield_scale);

src/inventory.cpp

@@ -256,24 +256,45 @@ std::string ItemStack::getShortDescription(const IItemDefManager *itemdef) const
 	return desc;
 }
 
-#define image_get_function(NAME, FIELD) \
-std::string ItemStack::get##NAME(const IItemDefManager *itemdef) const \
-{ \
-	std::string texture = metadata.getString(#FIELD); \
-	if (texture.empty()) \
-		texture = getDefinition(itemdef).FIELD; \
-	return texture; \
-} \
-const TileAnimationParams ItemStack::get##NAME##Animation(const IItemDefManager *itemdef) const \
-{ \
-	return getDefinition(itemdef).FIELD##_animation; \
-}
-
-image_get_function(InventoryImage, inventory_image)
-image_get_function(InventoryOverlay, inventory_overlay)
-image_get_function(WieldImage, wield_image)
-image_get_function(WieldOverlay, wield_overlay)
-#undef image_get_function
+ItemImageDef ItemStack::getInventoryImage(const IItemDefManager *itemdef) const
+{
+	ItemImageDef image = getDefinition(itemdef).inventory_image;
+	std::string meta_image = metadata.getString("inventory_image");
+	if (!meta_image.empty())
+		image.name = meta_image;
+
+	return image;
+}
+
+ItemImageDef ItemStack::getInventoryOverlay(const IItemDefManager *itemdef) const
+{
+	ItemImageDef image = getDefinition(itemdef).inventory_overlay;
+	std::string meta_image = metadata.getString("inventory_overlay");
+	if (!meta_image.empty())
+		image.name = meta_image;
+
+	return image;
+}
+
+ItemImageDef ItemStack::getWieldImage(const IItemDefManager *itemdef) const
+{
+	ItemImageDef image = getDefinition(itemdef).wield_image;
+	std::string meta_image = metadata.getString("wield_image");
+	if (!meta_image.empty())
+		image.name = meta_image;
+
+	return image;
+}
+
+ItemImageDef ItemStack::getWieldOverlay(const IItemDefManager *itemdef) const
+{
+	ItemImageDef image = getDefinition(itemdef).wield_overlay;
+	std::string meta_image = metadata.getString("wield_overlay");
+	if (!meta_image.empty())
+		image.name = meta_image;
+
+	return image;
+}
 
 v3f ItemStack::getWieldScale(const IItemDefManager *itemdef) const
 {