Modding:Item queries - Revision history

imported>Sunbeam135 at 00:10, 18 January 2026

2026-01-18T00:10:17Z

← Older revision		Revision as of 00:10, 18 January 2026
Line 316:		Line 316:
	[[Category:Modding]]		[[Category:Modding]]

			[[ru:Модификации:Запросы предметов]]
	[[zh:模组:物品查询]]		[[zh:模组:物品查询]]

imported>Selph: correction: `Name` doesn't default to the `Id` and could be unset

2025-10-07T03:15:59Z

correction: `Name` doesn't default to the `Id` and could be unset

← Older revision		Revision as of 03:15, 7 October 2025
Line 205:		Line 205:
	\| ''(Optional)'' Whether to get the crafting/cooking recipe for the item, instead of the item itself. Default false.		\| ''(Optional)'' Whether to get the crafting/cooking recipe for the item, instead of the item itself. Default false.

	The game will unlock the recipe with the ID equal to the item query's <samp>ObjectInternalName</samp> field, or the target item's internal <samp>Name</samp> ~~(which defaults to its ID)~~ if not set.		The game will unlock the recipe with the ID equal to the item query's <samp>ObjectInternalName</samp> field, or the target item's internal <samp>Name</samp> if not set.
	\|-		\|-
	\| <samp>Quality</samp>		\| <samp>Quality</samp>

imported>Margotbean at 15:53, 29 September 2025

2025-09-29T15:53:07Z

← Older revision		Revision as of 15:53, 29 September 2025
Line 53:		Line 53:
	\|-		\|-
	\| <samp>RANDOM_ITEMS {{t\|type definition ID}} {{o\|min ID}} {{o\|max ID}} {{o\|flags}}</samp>		\| <samp>RANDOM_ITEMS {{t\|type definition ID}} {{o\|min ID}} {{o\|max ID}} {{o\|flags}}</samp>
	\| All items from the given [[Modding:Items#~~Item_types~~\|type definition ID]] in randomized order, optionally filtered to those with a numeric ID in the given {{o\|min ID}} and {{o\|max ID}} range (inclusive).		\| All items from the given [[Modding:Items#Item types\|type definition ID]] in randomized order, optionally filtered to those with a numeric ID in the given {{o\|min ID}} and {{o\|max ID}} range (inclusive).

	The {{o\|flags}} specify options to apply. If specified, they must be at the end of the argument list (with or without {{o\|min ID}} and/or {{o\|max ID}}). The flags can be any combination of:		The {{o\|flags}} specify options to apply. If specified, they must be at the end of the argument list (with or without {{o\|min ID}} and/or {{o\|max ID}}). The flags can be any combination of:

imported>Abagaianye: Fixed remaining broken links

2025-09-29T03:16:44Z

Fixed remaining broken links

← Older revision		Revision as of 03:16, 29 September 2025
Line 27:		Line 27:
	\|-		\|-
	\| <samp>ALL_ITEMS {{o\|type ID}} {{o\|flags}}</samp>		\| <samp>ALL_ITEMS {{o\|type ID}} {{o\|flags}}</samp>
	\| Every item provided by the [[~~#Custom items~~\|item data definitions]]. If {{o\|type ID}} is set to an item type identifier (like <samp>(O)</samp> for object), only returns items from the matching item data definition.		\| Every item provided by the [[Modding:Items\|item data definitions]]. If {{o\|type ID}} is set to an item type identifier (like <samp>(O)</samp> for object), only returns items from the matching item data definition.

	The {{o\|flags}} specify options to apply. If specified, they must be at the end of the argument list (with or without {{o\|type ID}}). The flags can be any combination of:		The {{o\|flags}} specify options to apply. If specified, they must be at the end of the argument list (with or without {{o\|type ID}}). The flags can be any combination of:
Line 53:		Line 53:
	\|-		\|-
	\| <samp>RANDOM_ITEMS {{t\|type definition ID}} {{o\|min ID}} {{o\|max ID}} {{o\|flags}}</samp>		\| <samp>RANDOM_ITEMS {{t\|type definition ID}} {{o\|min ID}} {{o\|max ID}} {{o\|flags}}</samp>
	\| All items from the given [[#~~Item types~~\|type definition ID]] in randomized order, optionally filtered to those with a numeric ID in the given {{o\|min ID}} and {{o\|max ID}} range (inclusive).		\| All items from the given [[Modding:Items#Item_types\|type definition ID]] in randomized order, optionally filtered to those with a numeric ID in the given {{o\|min ID}} and {{o\|max ID}} range (inclusive).

	The {{o\|flags}} specify options to apply. If specified, they must be at the end of the argument list (with or without {{o\|min ID}} and/or {{o\|max ID}}). The flags can be any combination of:		The {{o\|flags}} specify options to apply. If specified, they must be at the end of the argument list (with or without {{o\|min ID}} and/or {{o\|max ID}}). The flags can be any combination of:
Line 87:		Line 87:
	</syntaxhighlight>		</syntaxhighlight>

	Or a random [[~~#Custom items~~\|custom item]] added by a mod by its item ID prefix:		Or a random [[Modding:Items\|custom item]] added by a mod by its item ID prefix:
	<syntaxhighlight lang="json">		<syntaxhighlight lang="json">
	{		{
	"ItemId": "RANDOM_ITEMS (O)",		"ItemId": "RANDOM_ITEMS (O)",
	"MaxItems": 1,		"MaxItems": 1,
	"PerItemCondition": "ITEM_ID_PREFIX Target ~~AuthorName_ModName_~~"		"PerItemCondition": "ITEM_ID_PREFIX Target AuthorName.ModName_"
	}		}
	</syntaxhighlight>		</syntaxhighlight>
Line 160:		Line 160:

	==Item spawn fields==		==Item spawn fields==
	''Item spawn fields'' are a common set of fields to use item queries in data assets like [[~~#Custom machines~~\|machines]] and [[~~#Custom shops~~\|shops]]. These are only available for data assets which specifically mention they support item spawn fields in their docs.		''Item spawn fields'' are a common set of fields to use item queries in data assets like [[Modding:Machines\|machines]] and [[Modding:Shops\|shops]]. These are only available for data assets which specifically mention they support item spawn fields in their docs.

	{\| class="wikitable"		{\| class="wikitable"
Line 174:		Line 174:
	\| <samp>ItemId</samp>		\| <samp>ItemId</samp>
	\| One of:		\| One of:
	* the [[~~#Custom items~~\|qualified or unqualified item ID]] (like <samp>(O)128</samp> for a [[pufferfish]]);		* the [[Modding:Items\|qualified or unqualified item ID]] (like <samp>(O)128</samp> for a [[pufferfish]]);
	* or an [[#~~Item~~ queries\|item query]] to dynamically choose one or more items.		* or an [[#Available queries\|item query]] to dynamically choose one or more items.
	\|-		\|-
	\| <samp>RandomItemId</samp>		\| <samp>RandomItemId</samp>
Line 220:		Line 220:
	\|-		\|-
	\| <samp>ObjectDisplayName</samp>		\| <samp>ObjectDisplayName</samp>
	\| ''(Optional)'' For objects only, a [[Modding:Tokenizable strings\|tokenizable string]] for the item's display name. Defaults to the item's display name in <samp>Data/Objects</samp>. This can optionally contain <code>%DISPLAY_NAME</code> (the item's default display name) and <code>%PRESERVED_DISPLAY_NAME</code> (the preserved item's display name if applicable, ''e.g.'' if set via <samp>PreserveId</samp> in [[~~#Custom machines~~\|machine data]]).		\| ''(Optional)'' For objects only, a [[Modding:Tokenizable strings\|tokenizable string]] for the item's display name. Defaults to the item's display name in <samp>Data/Objects</samp>. This can optionally contain <code>%DISPLAY_NAME</code> (the item's default display name) and <code>%PRESERVED_DISPLAY_NAME</code> (the preserved item's display name if applicable, ''e.g.'' if set via <samp>PreserveId</samp> in [[Modding:Machines\|machine data]]).

	'''Careful:''' text in this field will be saved permanently in the object's info and won't be updated when the player changes language or the content pack changes. That includes Content Patcher translations (like <code><nowiki>%DISPLAY_NAME {{i18n: wine}}</nowiki></code>), which will save the translated text for the current language. Instead, add the text to a strings asset like <samp>Strings/Objects</samp> and then use the [[Modding:Tokenizable strings\|<samp>[LocalizedText]</samp> token]].		'''Careful:''' text in this field will be saved permanently in the object's info and won't be updated when the player changes language or the content pack changes. That includes Content Patcher translations (like <code><nowiki>%DISPLAY_NAME {{i18n: wine}}</nowiki></code>), which will save the translated text for the current language. Instead, add the text to a strings asset like <samp>Strings/Objects</samp> and then use the [[Modding:Tokenizable strings\|<samp>[LocalizedText]</samp> token]].

imported>OnionNinja: Valid fields > correct links from residual anchors to actual locations

2025-09-25T05:02:03Z

Valid fields > correct links from residual anchors to actual locations

← Older revision		Revision as of 05:02, 25 September 2025
Line 5:		Line 5:
	==Overview==		==Overview==
	===Valid fields===		===Valid fields===
	These are used in various places like [[~~#Custom machines~~\|machine data]] and [[~~#Custom shops~~\|shop data]]. These can only be used if the field's docs specifically mention that it allows item queries.		These are used in various places like [[Modding:Machines\|machine data]] and [[Modding:Shops\|shop data]]. These can only be used if the field's docs specifically mention that it allows item queries.

	===Query format===		===Query format===

imported>Esca: /* Item spawn fields */ Fix links to quantity modifiers

2025-06-22T20:55:11Z

Item spawn fields: Fix links to quantity modifiers

← Older revision		Revision as of 20:55, 22 June 2025
Line 259:		Line 259:
	\|-		\|-
	\| <samp>QualityModifiers</samp><br /><samp>StackModifiers</samp>		\| <samp>QualityModifiers</samp><br /><samp>StackModifiers</samp>
	\| ''(Optional)'' [[#Quantity modifiers\|Quantity modifiers]] applied to the <samp>Quality</samp> or <samp>Stack</samp> value. Default none.		\| ''(Optional)'' [[Modding:Common data field types#Quantity modifiers\|Quantity modifiers]] applied to the <samp>Quality</samp> or <samp>Stack</samp> value. Default none.

	The quality modifiers operate on the numeric quality values (''i.e.'' <samp>0</samp> = normal, <samp>1</samp> = silver, <samp>2</samp> = gold, and <samp>4</samp> = iridium). For example, silver × 2 is gold.		The quality modifiers operate on the numeric quality values (''i.e.'' <samp>0</samp> = normal, <samp>1</samp> = silver, <samp>2</samp> = gold, and <samp>4</samp> = iridium). For example, silver × 2 is gold.
	\|-		\|-
	\| <samp>QualityModifierMode</samp><br /><samp>StackModifierMode</samp>		\| <samp>QualityModifierMode</samp><br /><samp>StackModifierMode</samp>
	\| ''(Optional)'' [[#Quantity modifiers\|Quantity modifier modes]] which indicate what to do if multiple modifiers in the <samp>QualityModifiers</samp> or <samp>StackModifiers</samp> field apply at the same time. Default <samp>Stack</samp>.		\| ''(Optional)'' [[Modding:Common data field types#Quantity modifiers\|Quantity modifier modes]] which indicate what to do if multiple modifiers in the <samp>QualityModifiers</samp> or <samp>StackModifiers</samp> field apply at the same time. Default <samp>Stack</samp>.
	\|-		\|-
	\| <samp>ModData</samp>		\| <samp>ModData</samp>

imported>BarleyZP: /* Item spawn fields */ add ObjectColor info from Modding:Migrate to Stardew Valley 1.6.9 (main author Pathoschild)

2025-05-19T18:47:51Z

Item spawn fields: add ObjectColor info from Modding:Migrate to Stardew Valley 1.6.9 (main author Pathoschild)

← Older revision		Revision as of 18:47, 19 May 2025
Line 251:		Line 251:
	Now when the player changes language, the object will automatically get the new translation from <samp>Strings/Object</samp>.		Now when the player changes language, the object will automatically get the new translation from <samp>Strings/Object</samp>.
	}}		}}
			\|-
			\| <samp>ObjectColor</samp>
			\| ''(Optional)'' The [[Modding:Common data field types#Color\|tint color]] to apply to the produced item. Default none.
	\|-		\|-
	\| <samp>ToolUpgradeLevel</samp>		\| <samp>ToolUpgradeLevel</samp>

imported>Pathoschild: use {{Content Patcher example}}, make example formatting consistent

2025-02-01T20:01:13Z

use {{Content Patcher example}}, make example formatting consistent

← Older revision		Revision as of 20:01, 1 February 2025
Line 71:		Line 71:

	For example, you can sell a random [[wallpaper]] for {{price\|200}} in <samp>Data/Shops</samp>:		For example, you can sell a random [[wallpaper]] for {{price\|200}} in <samp>Data/Shops</samp>:
	<syntaxhighlight lang="js">		<syntaxhighlight lang="json">
	{		{
	"ItemId": "RANDOM_ITEMS (WP)",		"ItemId": "RANDOM_ITEMS (WP)",
Line 80:		Line 80:

	Or a random [[House Plant\|house plant]]:		Or a random [[House Plant\|house plant]]:
	<syntaxhighlight lang="js">		<syntaxhighlight lang="json">
	{		{
	"ItemId": "RANDOM_ITEMS (F) 1376 1390",		"ItemId": "RANDOM_ITEMS (F) 1376 1390",
Line 88:		Line 88:

	Or a random [[#Custom items\|custom item]] added by a mod by its item ID prefix:		Or a random [[#Custom items\|custom item]] added by a mod by its item ID prefix:
	<syntaxhighlight lang="js">		<syntaxhighlight lang="json">
	{		{
	"ItemId": "RANDOM_ITEMS (O)",		"ItemId": "RANDOM_ITEMS (O)",
Line 97:		Line 97:

	Or 10 random objects with any category except <samp>-13</samp> or <samp>-14</samp>:		Or 10 random objects with any category except <samp>-13</samp> or <samp>-14</samp>:
	<syntaxhighlight lang="js">		<syntaxhighlight lang="json">
	{		{
	"ItemId": "RANDOM_ITEMS (O)",		"ItemId": "RANDOM_ITEMS (O)",
Line 179:		Line 179:
	\| <samp>RandomItemId</samp>		\| <samp>RandomItemId</samp>
	\| ''(Optional)'' A list of item IDs to randomly choose from, using the same format as <samp>ItemId</samp> (including item queries). If set, <samp>ItemId</samp> is optional and ignored. Each entry in the list has an equal probability of being chosen. For example:		\| ''(Optional)'' A list of item IDs to randomly choose from, using the same format as <samp>ItemId</samp> (including item queries). If set, <samp>ItemId</samp> is optional and ignored. Each entry in the list has an equal probability of being chosen. For example:
	<syntaxhighlight lang="js">		<syntaxhighlight lang="json">
	// wood, stone, or pizza		// wood, stone, or pizza
	"RandomItemId": [ "(O)388", "(O)390", "(O)206" ]		"RandomItemId": [ "(O)388", "(O)390", "(O)206" ]
Line 193:		Line 193:

	For example, this can be used to filter queries like <samp>RANDOM_ITEMS</samp>:		For example, this can be used to filter queries like <samp>RANDOM_ITEMS</samp>:
	<syntaxhighlight lang="js">		<syntaxhighlight lang="json">
	// random mineral		// random mineral
	"ItemId": "RANDOM_ITEMS (O)",		"ItemId": "RANDOM_ITEMS (O)",
Line 232:		Line 232:
	</syntaxhighlight></li>		</syntaxhighlight></li>
	<li>Add the text to a strings asset visible to the game:		<li>Add the text to a strings asset visible to the game:
	~~{{#tag:syntaxhighlight\|<nowiki>~~		{{Content Patcher example\|<nowiki>
	{
	~~"Format": "</nowiki>~~{{Content Patcher ~~version}}~~<nowiki>",
	"Changes": [		"Changes": [
	{		{
Line 243:		Line 241:
	}		}
	}		}
	}</nowiki>~~\|lang=javascript~~}}</li>		]
			</nowiki>}}</li>
	<li>Use the [[Modding:Tokenizable strings\|<samp>[LocalizedText]</samp> token]] to get your translation, and pass in the flavor as an argument:		<li>Use the [[Modding:Tokenizable strings\|<samp>[LocalizedText]</samp> token]] to get your translation, and pass in the flavor as an argument:
	<syntaxhighlight lang="json">		<syntaxhighlight lang="json">
Line 268:		Line 267:

	For example:		For example:
	<syntaxhighlight lang="js">		<syntaxhighlight lang="json">
	"ModData": {		"ModData": {
	"Example.ModId_FieldName": "some custom data"		"Example.ModId_FieldName": "some custom data"

imported>VulpesLucida: zh link

2024-10-27T13:47:49Z

zh link

← Older revision		Revision as of 13:47, 27 October 2024
Line 313:		Line 313:

	[[Category:Modding]]		[[Category:Modding]]

			[[zh:模组:物品查询]]

imported>Margotbean at 03:27, 13 September 2024

2024-09-13T03:27:07Z

← Older revision		Revision as of 03:27, 13 September 2024
Line 147:		Line 147:
	\|-		\|-
	\| <samp>MONSTER_SLAYER_REWARDS</samp>		\| <samp>MONSTER_SLAYER_REWARDS</samp>
	\| All items unlocked by [[Adventurer's Guild#~~Monster_Eradication_Goals~~\|monster eradication goals]] which have been completed and collected from Gil by the current player at the current time. The list sort order follows the order of monsters in MonsterSlayerQuests.xnb, e.g., Slime Ring, Savage Ring, Burglar Ring, etc.		\| All items unlocked by [[Adventurer's Guild#Monster Eradication Goals\|monster eradication goals]] which have been completed and collected from Gil by the current player at the current time. The list sort order follows the order of monsters in MonsterSlayerQuests.xnb, e.g., Slime Ring, Savage Ring, Burglar Ring, etc.
	\|-		\|-
	\| <samp>MOVIE_CONCESSIONS_FOR_GUEST {{o\|NPC name}}</samp>		\| <samp>MOVIE_CONCESSIONS_FOR_GUEST {{o\|NPC name}}</samp>