Modding:Objects - Revision history

imported>Zeltron0012: removed a duplicate mention of CombatLevel in custom attributes

2026-08-08T10:59:23Z

removed a duplicate mention of CombatLevel in custom attributes

← Older revision		Revision as of 10:59, 8 August 2026
Line 122:		Line 122:
	! purpose		! purpose
	\|-		\|-
	\| <samp>CombatLevel</samp><br /><samp>FarmingLevel</samp><br /><samp>FishingLevel</samp><br /><samp>ForagingLevel</samp><br /><samp>LuckLevel</samp><br /><samp>MiningLevel~~</samp><br /><samp>CombatLevel~~</samp>		\| <samp>CombatLevel</samp><br /><samp>FarmingLevel</samp><br /><samp>FishingLevel</samp><br /><samp>ForagingLevel</samp><br /><samp>LuckLevel</samp><br /><samp>MiningLevel</samp>
	\| ''(Optional)'' An amount applied to the matching [[Skills\|skill level]] while the buff is active. This can be negative for a debuff. Default 0.		\| ''(Optional)'' An amount applied to the matching [[Skills\|skill level]] while the buff is active. This can be negative for a debuff. Default 0.
	\|-		\|-

imported>Glymr: /* Basic info */

2025-11-19T18:16:38Z

Basic info

← Older revision		Revision as of 18:16, 19 November 2025
Line 30:		Line 30:
	'''Caution:''' adding custom items with the <samp>Arch</samp> type is inadvisable as it often leads to [[Artifact Spot\|artifact spot]]s becoming broken and not giving any items.		'''Caution:''' adding custom items with the <samp>Arch</samp> type is inadvisable as it often leads to [[Artifact Spot\|artifact spot]]s becoming broken and not giving any items.

	Note: The Type affects whether an item shows up in the collections menu. For example, items with Type: Cooking will show up as silhouettes in the cooked items collection menu, items with Type: Minerals will show up as silhouettes in the mineral collection menu, etc. However, the Category of the item must also be the correct ~~type~~ or the item will not count toward Perfection/Achievements. For example, if an item has Type: Cooking, it must also be "Category": -7 in order to count toward the "Gourmet Chef" achievement and Perfection.		'''Note:''' The "Type" affects whether an item shows up in the collections menu. For example, items with <samp>Type: Cooking</samp> will show up as silhouettes in the cooked items collection menu, items with <samp>Type: Minerals</samp> will show up as silhouettes in the mineral collection menu, etc. However, the [[Modding:Items#Categories\|Category]] of the item must also be the correct number or the item will not count toward Perfection/Achievements. For example, if an item has Type: Cooking, it must also be "Category": -7 in order to count toward the "Gourmet Chef" achievement and Perfection.
	\|-		\|-
	\| <samp>Category</samp>		\| <samp>Category</samp>

imported>Glymr at 18:14, 19 November 2025

2025-11-19T18:14:26Z

← Older revision		Revision as of 18:14, 19 November 2025
Line 30:		Line 30:
	'''Caution:''' adding custom items with the <samp>Arch</samp> type is inadvisable as it often leads to [[Artifact Spot\|artifact spot]]s becoming broken and not giving any items.		'''Caution:''' adding custom items with the <samp>Arch</samp> type is inadvisable as it often leads to [[Artifact Spot\|artifact spot]]s becoming broken and not giving any items.

	Note: The Type affects whether an item shows up in the collections menu. For example, items with Type: Cooking will show up as silhouettes in the cooked items collection menu, items with Type: Minerals will show up as silhouettes in the mineral collection menu, etc. However, the Category of the item must also be the correct type ~~for~~ the item to count toward Perfection/Achievements. For example, if an item has Type: Cooking, it must be "Category": -7 in order to count toward the "Gourmet Chef" achievement and Perfection.		Note: The Type affects whether an item shows up in the collections menu. For example, items with Type: Cooking will show up as silhouettes in the cooked items collection menu, items with Type: Minerals will show up as silhouettes in the mineral collection menu, etc. However, the Category of the item must also be the correct type or the item will not count toward Perfection/Achievements. For example, if an item has Type: Cooking, it must also be "Category": -7 in order to count toward the "Gourmet Chef" achievement and Perfection.
	\|-		\|-
	\| <samp>Category</samp>		\| <samp>Category</samp>

imported>Glymr at 18:13, 19 November 2025

2025-11-19T18:13:12Z

← Older revision		Revision as of 18:13, 19 November 2025
Line 29:		Line 29:

	'''Caution:''' adding custom items with the <samp>Arch</samp> type is inadvisable as it often leads to [[Artifact Spot\|artifact spot]]s becoming broken and not giving any items.		'''Caution:''' adding custom items with the <samp>Arch</samp> type is inadvisable as it often leads to [[Artifact Spot\|artifact spot]]s becoming broken and not giving any items.

			Note: The Type affects whether an item shows up in the collections menu. For example, items with Type: Cooking will show up as silhouettes in the cooked items collection menu, items with Type: Minerals will show up as silhouettes in the mineral collection menu, etc. However, the Category of the item must also be the correct type for the item to count toward Perfection/Achievements. For example, if an item has Type: Cooking, it must be "Category": -7 in order to count toward the "Gourmet Chef" achievement and Perfection.
	\|-		\|-
	\| <samp>Category</samp>		\| <samp>Category</samp>

imported>Esca: /* Edibility */ Fix data field name (see ObjectBuffData.cs)

2025-07-16T18:00:52Z

Edibility: Fix data field name (see ObjectBuffData.cs)

← Older revision		Revision as of 18:00, 16 July 2025
Line 89:		Line 89:
	! result		! result
	\|-		\|-
	\| <samp>Duration</samp><br /><samp>IconTexture</samp><br /><samp>~~SpriteIndex~~</samp><br /><samp>GlowColor</samp>		\| <samp>Duration</samp><br /><samp>IconTexture</samp><br /><samp>IconSpriteIndex</samp><br /><samp>GlowColor</samp>
	\| If specified, the value in <samp>Data/Objects</samp> is used instead of the one in <samp>Data/Buffs</samp>. If omitted, defaults to the value from <samp>Data/Buffs</samp>.		\| If specified, the value in <samp>Data/Objects</samp> is used instead of the one in <samp>Data/Buffs</samp>. If omitted, defaults to the value from <samp>Data/Buffs</samp>.
	\|-		\|-
Line 105:		Line 105:
	\| ''(Optional)'' The asset name for the icon texture to load. This must contain one or more 16x16 icons in a grid of any size. If omitted, the game will draw a default icon based on the <samp>BuffId</samp> and <samp>CustomAttributes</samp> fields.		\| ''(Optional)'' The asset name for the icon texture to load. This must contain one or more 16x16 icons in a grid of any size. If omitted, the game will draw a default icon based on the <samp>BuffId</samp> and <samp>CustomAttributes</samp> fields.
	\|-		\|-
	\| <samp>~~SpriteIndex~~</samp>		\| <samp>IconSpriteIndex</samp>
	\| ''(Optional)'' The buff's icon index within the <samp>IconTexture</samp>, where 0 is the top-left icon. Default 0.		\| ''(Optional)'' The buff's icon index within the <samp>IconTexture</samp>, where 0 is the top-left icon. Default 0.
	\|-		\|-

imported>Abagaianye: Updated CanBeTrashed field to add that it also affects shipping

2025-06-08T13:43:24Z

Updated CanBeTrashed field to add that it also affects shipping

← Older revision		Revision as of 13:43, 8 June 2025
Line 197:		Line 197:
	\|-		\|-
	\| <samp>CanBeTrashed</samp>		\| <samp>CanBeTrashed</samp>
	\| ''(Optional)'' Whether this item can be trashed from the player's inventory. Default true.		\| ''(Optional)'' Whether this item can be trashed from the player's inventory. Also affects whether the item can be shipped but not whether it can be sold to shops. Default true.
	\|-		\|-
	\| <samp>ExcludeFromRandomSale</samp>		\| <samp>ExcludeFromRandomSale</samp>
Line 203:		Line 203:
	\|-		\|-
	\| <samp>ExcludeFromFishingCollection</samp><br /><samp>ExcludeFromShippingCollection</samp>		\| <samp>ExcludeFromFishingCollection</samp><br /><samp>ExcludeFromShippingCollection</samp>
	\| ''(Optional)'' Whether to exclude this item from the fishing/shipping collection and their respective effect on the [[perfection\|perfection score]]. Default false, in which case the normal requirements apply (e.g. artifacts are always excluded from the shipping collection).		\| ''(Optional)'' Whether to exclude this item from the fishing/shipping collection and their respective effect on the [[perfection\|perfection score]]. Default false, in which case the normal requirements apply (e.g., artifacts are always excluded from the shipping collection).
	\|}		\|}

imported>BarleyZP: /* For C# mods */ typo in scarecrow

2025-03-27T16:30:06Z

For C# mods: typo in scarecrow

← Older revision		Revision as of 16:30, 27 March 2025
Line 230:		Line 230:
	\|-		\|-
	\| <samp>Object.GetRadiusForScarecrow()</samp>		\| <samp>Object.GetRadiusForScarecrow()</samp>
	\| The tile radius that Object protects as a scarecrow. Default behavior: Checks for the value in the <samp>crow_scare_radius_{{t\|radius}}</samp> [[Modding:Context tags\|context tag]] if applicable, then defaults to 17 if the internal name contains "Deluxe" and 9 otherwise. Can be patched to support custom ~~scarecrow~~.		\| The tile radius that Object protects as a scarecrow. Default behavior: Checks for the value in the <samp>crow_scare_radius_{{t\|radius}}</samp> [[Modding:Context tags\|context tag]] if applicable, then defaults to 17 if the internal name contains "Deluxe" and 9 otherwise. Can be patched to support custom scarecrows.
	\|-		\|-
	\| <samp>Object.IsBar()</samp>		\| <samp>Object.IsBar()</samp>

imported>BarleyZP: /* For C# mods */ Note about using GetRadiusForScarecrow to support custom scarecrows.

2025-03-27T16:29:58Z

For C# mods: Note about using GetRadiusForScarecrow to support custom scarecrows.

← Older revision		Revision as of 16:29, 27 March 2025
Line 230:		Line 230:
	\|-		\|-
	\| <samp>Object.GetRadiusForScarecrow()</samp>		\| <samp>Object.GetRadiusForScarecrow()</samp>
	\| The tile radius that Object protects as a scarecrow. Default behavior: Checks for the value in the <samp>crow_scare_radius_{{t\|radius}}</samp> [[Modding:Context tags\|context tag]] if applicable, then defaults to 17 if the internal name contains "Deluxe" and 9 otherwise.		\| The tile radius that Object protects as a scarecrow. Default behavior: Checks for the value in the <samp>crow_scare_radius_{{t\|radius}}</samp> [[Modding:Context tags\|context tag]] if applicable, then defaults to 17 if the internal name contains "Deluxe" and 9 otherwise. Can be patched to support custom scarecrow.
	\|-		\|-
	\| <samp>Object.IsBar()</samp>		\| <samp>Object.IsBar()</samp>

imported>BarleyZP: /* For C# mods */ Add scarecrow methods info from Modding:Migrate to Stardew Valley 1.5.5 (main author Pathoschild, with formatting fixes by Margotbean). Fix Object class capitalization. Add descriptions to the scarecrow methods from game decompile.

2025-03-27T16:29:35Z

For C# mods: Add scarecrow methods info from Modding:Migrate to Stardew Valley 1.5.5 (main author Pathoschild, with formatting fixes by Margotbean). Fix Object class capitalization. Add descriptions to the scarecrow methods from game decompile.

← Older revision		Revision as of 16:29, 27 March 2025
Line 229:		Line 229:
	! effect		! effect
	\|-		\|-
	\| <samp>~~object~~.IsBar()</samp>		\| <samp>Object.GetRadiusForScarecrow()</samp>
			\| The tile radius that Object protects as a scarecrow. Default behavior: Checks for the value in the <samp>crow_scare_radius_{{t\|radius}}</samp> [[Modding:Context tags\|context tag]] if applicable, then defaults to 17 if the internal name contains "Deluxe" and 9 otherwise.
			\|-
			\| <samp>Object.IsBar()</samp>
	\| Whether the item is a [[Copper Bar\|copper bar]], [[Iron Bar\|iron bar]], [[Gold Bar\|gold bar]], [[Iridium Bar\|iridium bar]], or [[Radioactive Bar\|radioactive bar]].		\| Whether the item is a [[Copper Bar\|copper bar]], [[Iron Bar\|iron bar]], [[Gold Bar\|gold bar]], [[Iridium Bar\|iridium bar]], or [[Radioactive Bar\|radioactive bar]].
	\|-		\|-
	\| <samp>~~object~~.IsBreakableStone()</samp>		\| <samp>Object.IsBreakableStone()</samp>
	\| Whether the item is a stone debris item which can be broken by a pickaxe.		\| Whether the item is a stone debris item which can be broken by a pickaxe.
	\|-		\|-
	\| <samp>~~object~~.IsFence()</samp>		\| <samp>Object.IsFence()</samp>
	\| Whether the item is a [[Crafting#Fences\|fence]].		\| Whether the item is a [[Crafting#Fences\|fence]].
	\|-		\|-
	\| <samp>~~object~~.IsFruitTreeSapling()</samp>		\| <samp>Object.IsFruitTreeSapling()</samp>
	\| Whether the item is a [[Fruit Trees\|fruit tree]] sapling. This checks the <samp>Data\fruitTrees</samp> keys, so it works with custom fruit trees too.		\| Whether the item is a [[Fruit Trees\|fruit tree]] sapling. This checks the <samp>Data\fruitTrees</samp> keys, so it works with custom fruit trees too.
	\|-		\|-
	\| <samp>~~object~~.IsHeldOverHead()</samp>		\| <samp>Object.IsHeldOverHead()</samp>
	\| Whether the player is shown holding up the item when it's selected in their toolbar. Default true (except for furniture).		\| Whether the player is shown holding up the item when it's selected in their toolbar. Default true (except for furniture).
	\|-		\|-
	\| <samp>~~object~~.IsIncubator()</samp>		\| <samp>Object.IsIncubator()</samp>
	\| Whether the item can incubate [[Animals\|farm animal]] eggs when placed in a building.		\| Whether the item can incubate [[Animals\|farm animal]] eggs when placed in a building.
	\|-		\|-
	\| <samp>object.IsTapper()</samp>		\| <samp>Object.IsScarecrow()</samp>
			\| Whether the item is a scarecrow. Default: <samp>true</samp> if the object has the <samp>crow_scare</samp> [[Modding:Context_tags\|context tag]]. Otherwise, returns whether the object's internal name contains "arecrow". Can be patched to support custom scarecrows.
			\|-
			\| <samp>Object.IsTapper()</samp>
	\| Whether the item is a [[Tapper\|tapper]] or [[Heavy Tapper\|heavy tapper]].		\| Whether the item is a [[Tapper\|tapper]] or [[Heavy Tapper\|heavy tapper]].
	\|-		\|-
	\| <samp>~~object~~.IsTeaSapling()</samp>		\| <samp>Object.IsTeaSapling()</samp>
	\| Whether the item is a [[Tea Sapling\|tea sapling]].		\| Whether the item is a [[Tea Sapling\|tea sapling]].
	\|-		\|-
	\| <samp>~~object~~.IsTwig()</samp>		\| <samp>Object.IsTwig()</samp>
	\| Whether the item is a twig debris item.		\| Whether the item is a twig debris item.
	\|-		\|-
	\| <samp>~~object~~.IsWeeds()</samp>		\| <samp>Object.IsWeeds()</samp>
	\| Whether the item is a weed debris item.		\| Whether the item is a weed debris item.
	\|}		\|}

imported>Pathoschild: /* Format */ update for 1.6.9 (based on Modding:Migrate to Stardew Valley 1.6.9#In Data/Objects, where I'm the only author)

2025-02-11T03:22:28Z

Format: update for 1.6.9 (based on Modding:Migrate to Stardew Valley 1.6.9#In Data/Objects, where I'm the only author)

← Older revision		Revision as of 03:22, 11 February 2025
Line 48:		Line 48:
	\| <samp>SpriteIndex</samp>		\| <samp>SpriteIndex</samp>
	\| The sprite's index within the <samp>Texture</samp>, where 0 is the top-left sprite.		\| The sprite's index within the <samp>Texture</samp>, where 0 is the top-left sprite.
			\|-
			\| <samp>ColorOverlayFromNextIndex</samp>
			\| ''(Optional)'' When drawn as a colored object, whether to apply the color to the next sprite in the spritesheet and draw that over the main sprite. If false, the color is applied to the main sprite instead. Default false.
	\|}		\|}

Line 117:		Line 120:
	! purpose		! purpose
	\|-		\|-
	\| <samp>FarmingLevel</samp><br /><samp>FishingLevel</samp><br /><samp>ForagingLevel</samp><br /><samp>LuckLevel</samp><br /><samp>MiningLevel</samp><br /><samp>CombatLevel</samp>		\| <samp>CombatLevel</samp><br /><samp>FarmingLevel</samp><br /><samp>FishingLevel</samp><br /><samp>ForagingLevel</samp><br /><samp>LuckLevel</samp><br /><samp>MiningLevel</samp><br /><samp>CombatLevel</samp>
	\| ''(Optional)'' An amount applied to the matching [[Skills\|skill level]] while the buff is active. This can be negative for a debuff. Default 0.		\| ''(Optional)'' An amount applied to the matching [[Skills\|skill level]] while the buff is active. This can be negative for a debuff. Default 0.
	\|-		\|-
	\| <samp>Attack</samp><br /><samp>~~Defense~~</samp><br /><samp>~~MagneticRadius~~</samp><br /><samp>~~MaxStamina~~</samp><br /><samp>~~Speed~~</samp><br /><samp>Immunity</samp><br /><samp>KnockbackMultiplier</samp><br /><samp>~~WeaponSpeedMultiplier~~</samp><br /><samp>~~AttackMultiplier~~</samp><br /><samp>~~CriticalChanceMultiplier~~</samp><br /><samp>~~CriticalPowerMultiplier~~</samp><br /><samp>~~WeaponPrecisionMultiplier~~</samp>		\| <samp>Attack</samp><br /><samp>AttackMultiplier</samp><br /><samp>CriticalChanceMultiplier</samp><br /><samp>CriticalPowerMultiplier</samp><br /><samp>Defense</samp><br /><samp>Immunity</samp><br /><samp>KnockbackMultiplier</samp><br /><samp>MagneticRadius</samp><br /><samp>MaxStamina</samp><br /><samp>Speed</samp><br /><samp>WeaponPrecisionMultiplier</samp><br /><samp>WeaponSpeedMultiplier</samp>
	\| ''(Optional)'' An amount applied to the player's [[attack]], [[~~defense]], [[Magnetism~~\|~~magnetic radius~~]]~~, maximum~~ [[~~Energy~~\|~~stamina~~]], [[~~speed~~]], [[immunity]], [[weight]] ~~multiplier~~, [[~~speed~~\|~~weapon speed~~]] ~~multipler~~, [[~~attack~~]] ~~multiplier~~, [[~~Crit._Chance\|crit chance~~]] ~~multiplier~~, [[~~Crit._Power~~\|~~crit power~~]] ~~multiplier, or weapon percision multiplier~~ while the buff is active. This can be negative for a debuff. Default 0.		\| ''(Optional)'' An amount applied to the player's [[attack]], [[Crit. Chance\|critical chance]] and [[Crit. Power\|critical power]], [[defense]], [[immunity]], knockback (i.e. [[weight]]), [[Magnetism\|magnetic radius]], maximum [[Energy\|stamina]], [[speed]], or weapon precision/[[speed\|speed]] while the buff is active. This can be negative for a debuff. Default 0.
	\|}		\|}
	\|-		\|-