Modding:Items - Revision history

imported>Malevolent-bagel at 16:15, 4 August 2026

2026-08-04T16:15:22Z

← Older revision		Revision as of 16:15, 4 August 2026
Line 196:		Line 196:

	===Categories===		===Categories===
	Each item also has a category (represented by a negative integer). In code, you can get an item's category value from <samp>item.Category</samp>, and its translated name from <samp>item.getCategoryName()</samp>. Here are the valid categories:		Each item also has a category (represented by a negative integer). In code, you can get an item's category value from <samp>item.Category</samp>, and its translated name from <samp>item.getCategoryName()</samp>. 0 can be used as a blank value. Here are the valid categories:

	{\| class="wikitable sortable"		{\| class="wikitable sortable"

imported>Sunbeam135: /* See also */

2026-01-12T21:20:41Z

imported>Esca: /* Item IDs */ Fix link to unique string ID info

2025-09-21T12:12:10Z

Item IDs: Fix link to unique string ID info

← Older revision		Revision as of 12:12, 21 September 2025
Line 7:		Line 7:
	Every item is identified in the game data using a unique item ID. This has two forms:		Every item is identified in the game data using a unique item ID. This has two forms:

	* The ''unqualified item ID'' (<code>item.ItemId</code>) is a [[#Unique string ID\|unique string ID]] for the item, like <samp>128</samp> (vanilla item) or <samp>Example.ModId_Watermelon</samp> (custom item). For legacy reasons, the unqualified ID for vanilla items may not be globally unique; for example, Pufferfish (object 128) and Mushroom Box (bigcraftable 128) both have item ID <samp>128</samp>.		* The ''unqualified item ID'' (<code>item.ItemId</code>) is a [[Modding:Common data field types#Unique string ID\|unique string ID]] for the item, like <samp>128</samp> (vanilla item) or <samp>Example.ModId_Watermelon</samp> (custom item). For legacy reasons, the unqualified ID for vanilla items may not be globally unique; for example, Pufferfish (object 128) and Mushroom Box (bigcraftable 128) both have item ID <samp>128</samp>.
	* The ''qualified item ID'' (<code>item.QualifiedItemId</code>) is a globally unique identifier which combines the item's [[#Item types\|type ID]] and unqualified item ID, like <samp>(O)128</samp> for [[Modding:Objects\|object]] ID 128.		* The ''qualified item ID'' (<code>item.QualifiedItemId</code>) is a globally unique identifier which combines the item's [[#Item types\|type ID]] and unqualified item ID, like <samp>(O)128</samp> for [[Modding:Objects\|object]] ID 128.

imported>KhloeLeclair: Add a color column to the category table with the hard-coded colors from the Object.GetCategoryColor() method.

2025-03-11T17:46:32Z

Add a color column to the category table with the hard-coded colors from the Object.GetCategoryColor() method.

Show changes

imported>Pathoschild: use {{Content Patcher example}}

2025-02-01T20:05:13Z

use {{Content Patcher example}}

← Older revision		Revision as of 20:05, 1 February 2025
Line 103:		Line 103:
	For example, this content pack adds a new Pufferchick item with a custom image, custom gift tastes, and a custom crop that produces it. Note that item references in other data assets like <samp>Data/Crops</samp> and <samp>Data/NPCGiftTastes</samp> use the item ID.		For example, this content pack adds a new Pufferchick item with a custom image, custom gift tastes, and a custom crop that produces it. Note that item references in other data assets like <samp>Data/Crops</samp> and <samp>Data/NPCGiftTastes</samp> use the item ID.

	~~{{#tag:syntaxhighlight\|<nowiki>~~		{{Content Patcher example\|<nowiki>
	{
	~~"Format": "</nowiki>~~{{Content Patcher ~~version}}~~<nowiki>",
	"Changes": [		"Changes": [
	// add item		// add item
Line 163:		Line 161:
	}		}
	]		]
	}</nowiki>~~\|lang=javascript~~}}		</nowiki>}}

	Most item data assets work just like <samp>Data/Objects</samp>. See also specific info for [[Modding:Fruit_trees\|custom fruit trees]], [[Modding:Tools\|custom tools]], and [[Modding:Weapons\|melee weapons]].		Most item data assets work just like <samp>Data/Objects</samp>. See also specific info for [[Modding:Fruit_trees\|custom fruit trees]], [[Modding:Tools\|custom tools]], and [[Modding:Weapons\|melee weapons]].

imported>Pathoschild: /* Work with item metadata */ copyedit

2024-12-31T19:41:05Z

Work with item metadata: copyedit

← Older revision		Revision as of 19:41, 31 December 2024
Line 503:		Line 503:
	\|-		\|-
	\| <samp>ItemRegistry.Create</samp>		\| <samp>ItemRegistry.Create</samp>
	\| [[#Create item instances\|~~create~~ an item instance]].		\| [[#Create item instances\|Create an item instance]].
	\|-		\|-
	\| <samp>ItemRegistry.Exists</samp>		\| <samp>ItemRegistry.Exists</samp>
	\| Get whether a qualified or unqualified item ID matches an existing item. For example:		\| Get whether a qualified or unqualified item ID matches an existing item. For example:
	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	bool ~~pufferfishExist~~ = ItemRegistry.Exists("(O)128");		bool pufferfishExists = ItemRegistry.Exists("(O)128");
	</syntaxhighlight>		</syntaxhighlight>
	\|-		\|-
Line 521:		Line 521:
	\|-		\|-
	\| <samp>ItemRegistry.GetMetadata</samp>		\| <samp>ItemRegistry.GetMetadata</samp>
	\| ~~This lets you get~~ high-level info about an item:		\| Get high-level info about an item:
	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	// get info about Rubber Boots		// get info about Rubber Boots
	ItemMetadata ~~info~~ = ItemRegistry.GetMetadata("(B)505");		ItemMetadata metadata = ItemRegistry.GetMetadata("(B)505");

	// get item ID info		// get item ID info
	$"The item has unqualified ID {~~info~~.LocalId}, qualified ID {~~info~~.QualifiedId}, and is defined by the {~~info~~.TypeIdentifier} item data definition.";		$"The item has unqualified ID {metadata.LocalId}, qualified ID {metadata.QualifiedId}, and is defined by the {metadata.TypeIdentifier} item data definition.";

	// does the item exist in the data files?		// does the item exist in the data files?
	bool exists = ~~info~~.Exists();		bool exists = metadata.Exists();
	</syntaxhighlight>		</syntaxhighlight>

Line 536:		Line 536:
	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	// get parsed info		// get parsed info
	ParsedItemData data = ~~info~~.GetParsedData();		ParsedItemData data = metadata.GetParsedData();
	$"The internal name is {data.InternalName}, translated name {data.DisplayName}, description {data.Description}, etc.";		$"The internal name is {data.InternalName}, translated name {data.DisplayName}, description {data.Description}, etc.";

Line 562:		Line 562:
	\|-		\|-
	\| <samp>ItemRegistry.GetDataOrErrorItem</samp>		\| <samp>ItemRegistry.GetDataOrErrorItem</samp>
	\| Equivalent to <samp>ItemRegistry.GetData</samp>, except that it'll return info for an Error Item if the item doesn't exist (e.g. for drawing in inventory).		\| Equivalent to <samp>ItemRegistry.GetData</samp>, except that it'll return info for an [[Error Item]] if the item doesn't exist (e.g. for drawing in inventory).
	\|-		\|-
	\| <samp>ItemRegistry.GetErrorItemName</samp>		\| <samp>ItemRegistry.GetErrorItemName</samp>

imported>Pathoschild: /* Identify items */ fix typo

2024-12-31T19:35:26Z

Identify items: fix typo

← Older revision		Revision as of 19:35, 31 December 2024
Line 470:		Line 470:
	bool isPufferfish = ItemRegistry.HasItemId(item, "128");		bool isPufferfish = ItemRegistry.HasItemId(item, "128");

	// ~~qualified~~ an item ID if needed		// qualify an item ID if needed
	string pufferfishQualifiedId = ItemRegistry.QualifyItemId("128"); // returns "(O)128"		string pufferfishQualifiedId = ItemRegistry.QualifyItemId("128"); // returns "(O)128"
	</syntaxhighlight>		</syntaxhighlight>

imported>Pathoschild: revert quality change (the quality values are multiples of 2: 0124 instead of 0123)

2024-12-31T19:31:32Z

revert quality change (the quality values are multiples of 2: 0124 instead of 0123)

← Older revision		Revision as of 19:31, 31 December 2024
Line 193:		Line 193:
	\|-		\|-
	\| iridium		\| iridium
	\| <samp>3</samp>		\| <samp>4</samp>
	\| <samp>Object.bestQuality</samp>		\| <samp>Object.bestQuality</samp>
	\|}		\|}

imported>Crisosphinx: /* Quality */

2024-12-24T22:29:15Z

Quality

← Older revision		Revision as of 22:29, 24 December 2024
Line 193:		Line 193:
	\|-		\|-
	\| iridium		\| iridium
	\| <samp>4</samp>		\| <samp>3</samp>
	\| <samp>Object.bestQuality</samp>		\| <samp>Object.bestQuality</samp>
	\|}		\|}

imported>Pathoschild: /* Item types */ add trinket type, update unqualified item ID priority list

2024-12-16T05:33:47Z

Item types: add trinket type, update unqualified item ID priority list

← Older revision		Revision as of 05:33, 16 December 2024
Line 72:		Line 72:
	\| <samp>Data/Tools</samp>		\| <samp>Data/Tools</samp>
	\| Items that can be swung or used by the player to perform some effect (e.g. dig dirt, chop trees, milk or shear animals, etc).		\| Items that can be swung or used by the player to perform some effect (e.g. dig dirt, chop trees, milk or shear animals, etc).
			\|-
			\| [[Modding:Trinkets\|Trinkets]]
			\| <samp>(TR)</samp>
			\| <samp>Data/Trinkets</samp>
			\| Items that can be equipped in the player's [[Trinkets\|trinket]] slot to enable special effects.
	\|-		\|-
	\| [[Modding:Wallpaper and flooring\|Wallpaper & flooring]]		\| [[Modding:Wallpaper and flooring\|Wallpaper & flooring]]
Line 84:		Line 89:
	\|}		\|}

	When resolving an unqualified item ID like <samp>128</samp>, the game will get the first item type for which it exists in this order: object, big craftable, furniture, weapon, boots, hat, pants, shirt, tool, wallpaper, and floorpaper.		When resolving an unqualified item ID like <samp>128</samp>, the game will get the first item type for which it exists in this order: object, big craftable, furniture, weapon, boots, hat, mannequin, pants, shirt, tool, trinket, wallpaper, and floorpaper.

	===Item sprites===		===Item sprites===

← Older revision		Revision as of 21:20, 12 January 2026
Line 617:		Line 617:
	[[Category:Modding]]		[[Category:Modding]]

			[[ru:Модификации:Предметы]]
	[[zh:模组:物品数据]]		[[zh:模组:物品数据]]