Modding:Animal data - Revision history

imported>Pathoschild: /* Other */ link StatToIncrementOnProduce to new Modding:Stats page, remove redundant info

2025-09-20T22:08:23Z

Other: link StatToIncrementOnProduce to new Modding:Stats page, remove redundant info

← Older revision		Revision as of 22:08, 20 September 2025
Line 370:		Line 370:
	\|-		\|-
	\| <samp>StatToIncrementOnProduce</samp>		\| <samp>StatToIncrementOnProduce</samp>
	\| ''(Optional)'' The ~~game stat counters~~ to increment when the animal produces an item. Default none. This consists of a list of models with these fields:		\| ''(Optional)'' The [[Modding:Stats\|tracked stats]] to increment when the animal produces an item. Default none. This consists of a list of models with these fields:
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
Line 380:		Line 380:
	\|-		\|-
	\| <samp>StatName</samp>		\| <samp>StatName</samp>
	\| The ~~name of the~~ stat ~~to increase whenever a valid item~~ (~~as specified by <samp>RequiredItemId</samp> and/or <samp>RequiredTags</samp>~~) ~~is produced. This can be a vanilla stat or a custom one. If the stat doesn't already exist it will be created~~.		\| The [[Modding:Stats\|stat key]] (case-insensitive).
	\|-		\|-
	\| <samp>RequiredItemId</samp>		\| <samp>RequiredItemId</samp>

imported>Abagaianye: Added RequiredItemId field to StatToIncrementOnProduce and clarified explanation of StatName

2025-06-08T11:18:12Z

Added RequiredItemId field to StatToIncrementOnProduce and clarified explanation of StatName

← Older revision		Revision as of 11:18, 8 June 2025
Line 380:		Line 380:
	\|-		\|-
	\| <samp>StatName</samp>		\| <samp>StatName</samp>
	\| The name of the stat ~~counter~~ field on <samp>~~Game1.stats~~</samp>.		\| The name of the stat to increase whenever a valid item (as specified by <samp>RequiredItemId</samp> and/or <samp>RequiredTags</samp>) is produced. This can be a vanilla stat or a custom one. If the stat doesn't already exist it will be created.
			\|-
			\| <samp>RequiredItemId</samp>
			\| ''(Optional)'' The qualified or unqualified [[Modding:Objects\|object ID]] that the animal must produce to increment the stat listed in <samp>StatName</samp>. If both this field and <samp>RequiredTags</samp> are omitted the stat will increase every time the animal produces any item.
	\|-		\|-
	\| <samp>RequiredTags</samp>		\| <samp>RequiredTags</samp>
	\| ''(Optional)'' A comma-delimited list of [[Modding:Context tags\|context tags]] required on the ~~main input~~ item. The stat is only incremented if the item has ''all'' of these. You can negate a tag with <samp>!</samp> (like <code>bone_item,!fossil_item</code> for bone items that aren't fossils). Defaults to always enabled.		\| ''(Optional)'' A comma-delimited list of [[Modding:Context tags\|context tags]] required on the item produced. The stat is only incremented if the item has ''all'' of these. You can negate a tag with <samp>!</samp> (like <code>bone_item, !fossil_item</code> for bone items that aren't fossils). Defaults to always enabled.
	\|}		\|}
	\|-		\|-

imported>Pathoschild: /* Audio & Sprite / rewrite Shadow description into field priority list for clarity

2025-01-17T18:39:08Z

Audio & Sprite: rewrite Shadow* description into field priority list for clarity

← Older revision		Revision as of 18:39, 17 January 2025
Line 292:		Line 292:
	\|-		\|-
	\| <samp>ShadowWhenBaby</samp><br /><samp>ShadowWhenBabySwims</samp><br /><samp>ShadowWhenAdult</samp><br /><samp>ShadowWhenAdultSwims</samp><br /><samp>Shadow</samp>		\| <samp>ShadowWhenBaby</samp><br /><samp>ShadowWhenBabySwims</samp><br /><samp>ShadowWhenAdult</samp><br /><samp>ShadowWhenAdultSwims</samp><br /><samp>Shadow</samp>
	\| ''(Optional)'' The shadow to draw under the farm animal. The <samp>~~Baby~~</samp> ~~fields only apply~~ when the ~~farm~~ animal is ~~a baby, and~~ <samp>~~Adult~~</samp> ~~fields only applies when it's an adult (e.g. a baby animal won't default to the adult fields). When the farm animal swims, it'll use the~~ <samp>~~Swims~~</samp> ~~variant if it's set,~~ else ~~default to the non-swim variant. It will fall back to the default~~ <samp>Shadow</samp> ~~field if no more specific field is specified~~.		\| ''(Optional)'' The shadow to draw under the farm animal.

			The fields are checked in this order, and the first existing one which matches the animal is used:
			# <samp>ShadowWhenBabySwims</samp> or <samp>ShadowWhenAdultSwims</samp> when the animal is swimming;
			# <samp>ShadowWhenBaby</samp> or <samp>ShadowWhenAdult</samp> in general;
			# else <samp>Shadow</samp>.

	These consist of a model with these fields:		These consist of a model with these fields:

imported>VulpesLucida: integrate

2025-01-17T14:50:37Z

integrate

← Older revision		Revision as of 14:50, 17 January 2025
Line 2:		Line 2:

	This page explains how to create and edit in-game [[Animals\|farm animals]].		This page explains how to create and edit in-game [[Animals\|farm animals]].

	~~===Copie from [[Modding:Migrate to Stardew Valley 1.6.9]]===~~
	~~{{migration guide doc status\|[[Modding:Animal data]]\|done=false}}~~

	~~<ul>~~
	~~<li>1.6.9 adds a new field in <samp>Data/FarmAnimals</samp>:~~
	~~{\| class="wikitable"~~
	\|-
	~~! field~~
	~~! effect~~
	\|-
	~~\| <samp>Shadow</samp>~~
	~~\| ''(Optional)'' The shadow to draw under the farm animal, if a more specific field like <samp>ShadowWhenAdult</samp> doesn't apply. Defaults to omitted.~~
	~~\|}</li>~~
	<li>The previously hardcoded stats (<samp>cowMilkProduced</samp>, <samp>goatMilkProduced</samp>, and <samp>sheepWoolProduced</samp>) are now incremented via the <samp>StatToIncrementOnproduce</samp> data field.</li>
	~~</ul>~~

	==Data format==		==Data format==
Line 307:		Line 291:
	* If true: 16 (down), 18 (right), 22 (left), and 20 (up).		* If true: 16 (down), 18 (right), 22 (left), and 20 (up).
	\|-		\|-
	\| <samp>ShadowWhenBaby</samp><br /><samp>ShadowWhenBabySwims</samp><br /><samp>ShadowWhenAdult</samp><br /><samp>ShadowWhenAdultSwims</samp>		\| <samp>ShadowWhenBaby</samp><br /><samp>ShadowWhenBabySwims</samp><br /><samp>ShadowWhenAdult</samp><br /><samp>ShadowWhenAdultSwims</samp><br /><samp>Shadow</samp>
	\| ''(Optional)'' The shadow to draw under the farm animal. The <samp>Baby</samp> fields only apply when the farm animal is a baby, and <samp>Adult</samp> fields only applies when it's an adult (e.g. a baby animal won't default to the adult fields). When the farm animal swims, it'll use the <samp>Swims</samp> variant if it's set, else default to the non-swim variant.		\| ''(Optional)'' The shadow to draw under the farm animal. The <samp>Baby</samp> fields only apply when the farm animal is a baby, and <samp>Adult</samp> fields only applies when it's an adult (e.g. a baby animal won't default to the adult fields). When the farm animal swims, it'll use the <samp>Swims</samp> variant if it's set, else default to the non-swim variant. It will fall back to the default <samp>Shadow</samp> field if no more specific field is specified.

	These consist of a model with these fields:		These consist of a model with these fields:

imported>VulpesLucida: add info from Modding:Migrate to Stardew Valley 1.6.9 (main author Pathoschild)

2025-01-17T14:39:33Z

add info from Modding:Migrate to Stardew Valley 1.6.9 (main author Pathoschild)

← Older revision		Revision as of 14:39, 17 January 2025
Line 2:		Line 2:

	This page explains how to create and edit in-game [[Animals\|farm animals]].		This page explains how to create and edit in-game [[Animals\|farm animals]].

			===Copie from [[Modding:Migrate to Stardew Valley 1.6.9]]===
			{{migration guide doc status\|[[Modding:Animal data]]\|done=false}}

			<ul>
			<li>1.6.9 adds a new field in <samp>Data/FarmAnimals</samp>:
			{\| class="wikitable"
			\|-
			! field
			! effect
			\|-
			\| <samp>Shadow</samp>
			\| ''(Optional)'' The shadow to draw under the farm animal, if a more specific field like <samp>ShadowWhenAdult</samp> doesn't apply. Defaults to omitted.
			\|}</li>
			<li>The previously hardcoded stats (<samp>cowMilkProduced</samp>, <samp>goatMilkProduced</samp>, and <samp>sheepWoolProduced</samp>) are now incremented via the <samp>StatToIncrementOnproduce</samp> data field.</li>
			</ul>

	==Data format==		==Data format==

imported>Pathoschild: update link

2024-12-15T19:14:07Z

update link

← Older revision		Revision as of 19:14, 15 December 2024
Line 378:		Line 378:
	\|-		\|-
	\| <samp>RequiredTags</samp>		\| <samp>RequiredTags</samp>
	\| ''(Optional)'' A comma-delimited list of [[Modding:~~Items#~~Context tags\|context tags]] required on the main input item. The stat is only incremented if the item has ''all'' of these. You can negate a tag with <samp>!</samp> (like <code>bone_item,!fossil_item</code> for bone items that aren't fossils). Defaults to always enabled.		\| ''(Optional)'' A comma-delimited list of [[Modding:Context tags\|context tags]] required on the main input item. The stat is only incremented if the item has ''all'' of these. You can negate a tag with <samp>!</samp> (like <code>bone_item,!fossil_item</code> for bone items that aren't fossils). Defaults to always enabled.
	\|}		\|}
	\|-		\|-

imported>Pathoschild: /* Spritesheet layout */ move pre-1.6 migration to Modding:Migrate to Stardew Valley 1.6#Custom farm animals

2024-12-15T19:11:04Z

Spritesheet layout: move pre-1.6 migration to Modding:Migrate to Stardew Valley 1.6#Custom farm animals

← Older revision		Revision as of 19:11, 15 December 2024
Line 389:		Line 389:

	==Spritesheet layout==		==Spritesheet layout==
	~~===Explanation===~~
	Each farm animal's spritesheet must have exactly 4 columns, and at least 5–7 rows (depending on the data fields). The sprite size depends on the [[#Audio .26 Sprite\|<samp>SpriteWidth</samp> and <samp>SpriteHeight</samp>]] fields; for example, the default sprite width of 16 pixels means the spritesheet must be exactly 4 × 16 = 64 pixels wide.		Each farm animal's spritesheet must have exactly 4 columns, and at least 5–7 rows (depending on the data fields). The sprite size depends on the [[#Audio .26 Sprite\|<samp>SpriteWidth</samp> and <samp>SpriteHeight</samp>]] fields; for example, the default sprite width of 16 pixels means the spritesheet must be exactly 4 × 16 = 64 pixels wide.

Line 469:		Line 468:
	\|}		\|}

	~~===Pre-1.6 vanilla layouts===~~
	Before Stardew Valley 1.6, there were two main spritesheet layouts depending on whether the animal lived in a [[barn]] or [[coop]]. If you want to match the previous spritesheet layouts (e.g. to update a pre-1.6 custom animal), the options to set are:
	~~<syntaxhighlight lang="js">~~
	~~// for barn animals~~
	~~"UseFlippedRightForLeft": true,~~
	~~"UseDoubleUniqueAnimationFrames": false~~

	~~// for coop animals~~
	~~"UseFlippedRightForLeft": false,~~
	~~"UseDoubleUniqueAnimationFrames": true~~
	~~</syntaxhighlight>~~
	[[Category:Modding]]		[[Category:Modding]]

	[[ru:Модификации:Животные]]		[[ru:Модификации:Животные]]
	[[zh:模组:动物数据]]		[[zh:模组:动物数据]]

imported>Pathoschild: update links

2024-12-15T19:07:57Z

update links

← Older revision		Revision as of 19:07, 15 December 2024
Line 20:		Line 20:
	\|-		\|-
	\| <samp>House</samp>		\| <samp>House</samp>
	\| The [[Modding:~~Migrate to Stardew Valley 1.6#Custom buildings~~\|building ID]] for the main building type that houses this animal. The animal will also be placeable in buildings whose <samp>ValidOccupantTypes</samp> field contains this value.		\| The [[Modding:Buildings\|building ID]] for the main building type that houses this animal. The animal will also be placeable in buildings whose <samp>ValidOccupantTypes</samp> field contains this value.
	\|-		\|-
	\| <samp>Gender</samp>		\| <samp>Gender</samp>
Line 98:		Line 98:
	\|-		\|-
	\| <samp>EggItemIds</samp>		\| <samp>EggItemIds</samp>
	\| ''(Optional)'' A list of the [[Modding:~~Items~~\|object IDs]] that can be placed in the [[incubator]] or [[Ostrich Incubator\|ostrich incubator]] to hatch this animal. If the animal's <samp>House</samp> field doesn't match the current building, the entry will be ignored. Default none.		\| ''(Optional)'' A list of the [[Modding:Objects\|object IDs]] that can be placed in the [[incubator]] or [[Ostrich Incubator\|ostrich incubator]] to hatch this animal. If the animal's <samp>House</samp> field doesn't match the current building, the entry will be ignored. Default none.
	\|-		\|-
	\| <samp>IncubationTime</samp>		\| <samp>IncubationTime</samp>
Line 159:		Line 159:
	\|-		\|-
	\| <samp>ItemId</samp>		\| <samp>ItemId</samp>
	\| The [[Modding:~~Items~~\|''unqualified'' object ID]] of the item to produce.		\| The [[Modding:Objects\|''unqualified'' object ID]] of the item to produce.
	\|-		\|-
	\| <samp>Condition</samp>		\| <samp>Condition</samp>
Line 223:		Line 223:
	\|-		\|-
	\| <samp>HarvestTool</samp>		\| <samp>HarvestTool</samp>
	\| ''(Optional)'' The [[Modding:~~Items~~\|tool ID]] with which produced items can be collected from the animal, if the <samp>HarvestType</samp> is set to <samp>HarvestWithTool</samp>. The values recognized by the vanilla tools are <samp>Milk Pail</samp> and <samp>Shears</samp>. Default none.		\| ''(Optional)'' The [[Modding:Tools\|tool ID]] with which produced items can be collected from the animal, if the <samp>HarvestType</samp> is set to <samp>HarvestWithTool</samp>. The values recognized by the vanilla tools are <samp>Milk Pail</samp> and <samp>Shears</samp>. Default none.
	\|-		\|-
	\| <samp>CanEatGoldenCrackers</samp>		\| <samp>CanEatGoldenCrackers</samp>
Line 352:		Line 352:
	\|-		\|-
	\| <samp>CustomFields</samp>		\| <samp>CustomFields</samp>
	\| The [[Modding:~~Migrate to Stardew Valley 1.6~~#Custom ~~data~~ fields\|custom fields]] for this entry.		\| The [[Modding:Common data field types#Custom fields\|custom fields]] for this entry.
	\|}		\|}

imported>Margotbean: zh link

2024-09-10T17:39:09Z

zh link

← Older revision		Revision as of 17:39, 10 September 2024
Line 483:		Line 483:

	[[ru:Модификации:Животные]]		[[ru:Модификации:Животные]]
			[[zh:模组:动物数据]]

imported>Falseroku: Fix links that were targeting as if this page was still on the migration page

2024-06-10T03:44:03Z

Fix links that were targeting as if this page was still on the migration page

← Older revision		Revision as of 03:44, 10 June 2024
Line 20:		Line 20:
	\|-		\|-
	\| <samp>House</samp>		\| <samp>House</samp>
	\| The [[#Custom buildings\|building ID]] for the main building type that houses this animal. The animal will also be placeable in buildings whose <samp>ValidOccupantTypes</samp> field contains this value.		\| The [[Modding:Migrate to Stardew Valley 1.6#Custom buildings\|building ID]] for the main building type that houses this animal. The animal will also be placeable in buildings whose <samp>ValidOccupantTypes</samp> field contains this value.
	\|-		\|-
	\| <samp>Gender</samp>		\| <samp>Gender</samp>
Line 98:		Line 98:
	\|-		\|-
	\| <samp>EggItemIds</samp>		\| <samp>EggItemIds</samp>
	\| ''(Optional)'' A list of the [[~~#Custom items~~\|object IDs]] that can be placed in the [[incubator]] or [[Ostrich Incubator\|ostrich incubator]] to hatch this animal. If the animal's <samp>House</samp> field doesn't match the current building, the entry will be ignored. Default none.		\| ''(Optional)'' A list of the [[Modding:Items\|object IDs]] that can be placed in the [[incubator]] or [[Ostrich Incubator\|ostrich incubator]] to hatch this animal. If the animal's <samp>House</samp> field doesn't match the current building, the entry will be ignored. Default none.
	\|-		\|-
	\| <samp>IncubationTime</samp>		\| <samp>IncubationTime</samp>
Line 159:		Line 159:
	\|-		\|-
	\| <samp>ItemId</samp>		\| <samp>ItemId</samp>
	\| The [[~~#Custom items~~\|''unqualified'' object ID]] of the item to produce.		\| The [[Modding:Items\|''unqualified'' object ID]] of the item to produce.
	\|-		\|-
	\| <samp>Condition</samp>		\| <samp>Condition</samp>
Line 183:		Line 183:
	\|-		\|-
	\| <samp>DeluxeProduceCareDivisor</samp><br /><samp>DeluxeProduceLuckMultiplier</samp>		\| <samp>DeluxeProduceCareDivisor</samp><br /><samp>DeluxeProduceLuckMultiplier</samp>
	\| ''(Optional)'' [[#Quantity modifiers\|Quantity modifiers]] which change the probability of producing the <samp>DeluxeProduceItemId</samp>, based on this formula:		\| ''(Optional)'' [[Modding:Common data field types#Quantity modifiers\|Quantity modifiers]] which change the probability of producing the <samp>DeluxeProduceItemId</samp>, based on this formula:
	<pre>		<pre>
	if happiness > 200:		if happiness > 200:
Line 201:		Line 201:
	For example, given a friendship of 102 and happiness of 150, the probability with the default field values will be <code>((102 + 0) / 1200) + (daily_luck * 0) = (102 / 1200) = 0.085</code> or 8.5%.		For example, given a friendship of 102 and happiness of 150, the probability with the default field values will be <code>((102 + 0) / 1200) + (daily_luck * 0) = (102 / 1200) = 0.085</code> or 8.5%.

	See [[Animals#Produce]] for more info on the calculation.		See [[Animals#Produce\|Animal Produce]] for more info on the calculation.
	\|-		\|-
	\| <samp>HarvestType</samp>		\| <samp>HarvestType</samp>
Line 223:		Line 223:
	\|-		\|-
	\| <samp>HarvestTool</samp>		\| <samp>HarvestTool</samp>
	\| ''(Optional)'' The [[~~#Custom items~~\|tool ID]] with which produced items can be collected from the animal, if the <samp>HarvestType</samp> is set to <samp>HarvestWithTool</samp>. The values recognized by the vanilla tools are <samp>Milk Pail</samp> and <samp>Shears</samp>. Default none.		\| ''(Optional)'' The [[Modding:Items\|tool ID]] with which produced items can be collected from the animal, if the <samp>HarvestType</samp> is set to <samp>HarvestWithTool</samp>. The values recognized by the vanilla tools are <samp>Milk Pail</samp> and <samp>Shears</samp>. Default none.
	\|-		\|-
	\| <samp>CanEatGoldenCrackers</samp>		\| <samp>CanEatGoldenCrackers</samp>
Line 229:		Line 229:
	\|}		\|}

	===Audio & ~~sprite~~===		===Audio & Sprite===
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
Line 236:		Line 236:
	\|-		\|-
	\| <samp>Sound</samp>		\| <samp>Sound</samp>
	\| ''(Optional)'' The [[~~#Custom audio~~\|audio cue ID]] for the sound produced by the animal (e.g. when pet). Default none.		\| ''(Optional)'' The [[Modding:Audio\|audio cue ID]] for the sound produced by the animal (e.g. when pet). Default none.
	\|-		\|-
	\| <samp>BabySound</samp>		\| <samp>BabySound</samp>
Line 352:		Line 352:
	\|-		\|-
	\| <samp>CustomFields</samp>		\| <samp>CustomFields</samp>
	\| The [[#Custom data fields\|custom fields]] for this entry.		\| The [[Modding:Migrate to Stardew Valley 1.6#Custom data fields\|custom fields]] for this entry.
	\|}		\|}

Line 390:		Line 390:
	==Spritesheet layout==		==Spritesheet layout==
	===Explanation===		===Explanation===
	Each farm animal's spritesheet must have exactly 4 columns, and at least 5–7 rows (depending on the data fields). The sprite size depends on the [[#Audio ~~& sprite~~\|<samp>SpriteWidth</samp> and <samp>SpriteHeight</samp>]] fields; for example, the default sprite width of 16 pixels means the spritesheet must be exactly 4 × 16 = 64 pixels wide.		Each farm animal's spritesheet must have exactly 4 columns, and at least 5–7 rows (depending on the data fields). The sprite size depends on the [[#Audio .26 Sprite\|<samp>SpriteWidth</samp> and <samp>SpriteHeight</samp>]] fields; for example, the default sprite width of 16 pixels means the spritesheet must be exactly 4 × 16 = 64 pixels wide.

	The expected rows are:		The expected rows are: