Modding:Migrate to Stardew Valley 1.6.16 - Revision history

imported>Spacechase0: /* Game state query changes */ Added `IS_GREEN_RAIN_DAY` GSQ change.

2026-09-20T21:20:17Z

Game state query changes: Added `IS_GREEN_RAIN_DAY` GSQ change.

← Older revision		Revision as of 21:20, 20 September 2026
Line 1,362:		Line 1,362:
	\| <samp>PLAYER_STAT {{t\|player}} {{t\|stat key}} {{o\|min value}} {{o\|max value}}</samp>		\| <samp>PLAYER_STAT {{t\|player}} {{t\|stat key}} {{o\|min value}} {{o\|max value}}</samp>
	\| The {{o\|min value}} argument is now optional.		\| The {{o\|min value}} argument is now optional.
			\|-
			\| <samp>IS_GREEN_RAIN_DAY {{o\|day}}</samp>
			\| The {{o\|day}} argument has been added. Valid values are <samp>today</samp>, <samp>tomorrow</samp>, and a number of days offset from the current day (ex. <samp>-1</samp> would be yesterday).

			If not specified, it will default to <samp>tomorrow</samp>.
	\|}</li>		\|}</li>
	</ul>		</ul>

imported>Spacechase0: /* Trigger action changes */ add new trigger action

2026-08-17T18:49:55Z

Trigger action changes: add new trigger action

← Older revision		Revision as of 18:49, 17 August 2026
Line 1,569:		Line 1,569:
	\| <samp>ShowPrivateChatMessage {{t\|message}} {{o\|color}}</samp>		\| <samp>ShowPrivateChatMessage {{t\|message}} {{o\|color}}</samp>
	\| Add a message to the chat box which is only visible to the current player. The {{t\|message}} is the [[Modding:Tokenizable strings\|tokenizable string]] to show, and {{o\|color}} is the text [[Modding:Common data field types#Color\|color]].		\| Add a message to the chat box which is only visible to the current player. The {{t\|message}} is the [[Modding:Tokenizable strings\|tokenizable string]] to show, and {{o\|color}} is the text [[Modding:Common data field types#Color\|color]].
			\|-
			\| <samp>AddItemFromQuery {{t\|query}}</samp>
			\| Adds a random item from the specified item query.
	\|}		\|}
	</ul>		</ul>

imported>Spacechase0: /* Debug command changes */ add new command

2026-07-18T01:05:05Z

Debug command changes: add new command

← Older revision		Revision as of 01:05, 18 July 2026
Line 440:		Line 440:
	This warp does not persist across saves, and may disappear at any time based on other game code.		This warp does not persist across saves, and may disappear at any time based on other game code.
	\|-		\|-
	\| <samp>/currency {{t\|currencyType}} {{t\|amount}}</samp> ~~(new)~~		\| <samp>currency {{t\|currencyType}} {{t\|amount}}</samp>
	\| Gives yourself {{t\|amount}} of the specified currency type. Valid currency types are:		\| Gives yourself {{t\|amount}} of the specified currency type. Valid currency types are:
	{\| class="wikitable"		{\| class="wikitable"
Line 459:		Line 459:
	\| {{Price\|0\|Gem}}		\| {{Price\|0\|Gem}}
	\|}		\|}
			\|-
			\| <samp>printEvent </samp>
			\| If there is an event currently running, prints the event ID and current event command.
	\|}</li>		\|}</li>
	<li>Improved existing commands:		<li>Improved existing commands:

imported>Spacechase0: /* Cache changes */ update for DataCache, and new behavior for item sprite indices

2026-06-24T20:14:48Z

Cache changes: update for DataCache, and new behavior for item sprite indices

← Older revision		Revision as of 20:14, 24 June 2026
Line 329:		Line 329:
	==Changes for all mod authors==		==Changes for all mod authors==
	===Cache changes===		===Cache changes===
	Stardew Valley 1.6.16 adds [[#TickCache\|internal caching]] to improve performance.		Stardew Valley 1.6.16 adds [[#TickCache\|internal]] [[#DataCache\|caching]] to improve performance. Typically the relevant caches will be reset right away.

	~~That means there might be a small delay between editing certain data~~, ~~and updating entities~~ which ~~''already loaded the data''. (This has no effect on new entities, so there's no issue with things like editing NPC data right before the NPC is spawned~~.)		Some entities have been changed to take advantage of this, which may impact some mods.

	~~This affects:~~
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
	! entity type		! entity type
	! ~~data cache time~~		! field
			! effect
			! technical notes
	\|-		\|-
	\| ~~farm animal~~		\| Items
	\| ~~1 second~~		\| Sprite index
	\|-		\| If <samp>SpriteIndex</samp> in the data asset is changed, existing items will be updated to match (unless something else has overridden it for that existing item, such as certain big craftables changing appearance based on the season).
	\| ~~fence~~		\| Items in existing saves will be updated for this when loaded in 1.6.16, assuming their sprite index matches the data asset value.
	~~\| 30 seconds~~
	\|-		The <samp>parentSheetIndex</samp> netfield will have a value of -1 when the data asset value should be used. The <samp>ParentSheetIndex</samp> property will have the "effective" <samp>parentSheetIndex</samp> (meaning that if the netfield has -1, it will return the data asset value).
	~~\| machine object~~
	\| 1 ~~second~~		The value from the data asset can easily retrieved from the <samp>DataParentSheetIndex</samp> propery.
	\|-
	~~\| NPC~~
	~~\| 1 second~~
	\|}		\|}

imported>Spacechase0: /* DataCache */ section contents

2026-06-24T20:02:45Z

DataCache: section contents

← Older revision		Revision as of 20:02, 24 June 2026
Line 2,013:		Line 2,013:

	====DataCache====		====DataCache====
			The new <samp>DataCache<T></samp> class loads a value on-demand and caches it until a counter is incremented.

			This is primarily intended for caching values from data assets until that asset is reloaded, and there are static methods on <samp>DataCache</samp> for doing that with several existing assets.

			<samp>DataCache<T></samp> instances only have two public methods:
			{\| class="wikitable"
			\|-
			! member
			! usage
			\|-
			\| <samp>Value</samp>
			\| Get the cached value, reloading it if needed.
			\|-
			\| <samp>Clear()</samp>
			\| Reset the cache time, so it'll be reloaded next time <samp>Value</samp> is requested.
			\|}

			<samp>DataCache</samp> has several static helper methods for invalidating based on certain vanilla assets. These take a <samp>Func<T></samp>, which will be called to get the appropriate value whenever the cache needs a new value. The current helper methods are:
			{\| class="wikitable"
			\|-
			! member
			! usage
			\|-
			\| <samp>FarmAnimalData</samp>
			\| Cache is reset when <samp>Data/FarmAnimals</samp> is reloaded.
			\|-
			\| <samp>CharacterData</samp>
			\| Cache is reset when <samp>Data/Characters</samp> is reloaded.
			\|-
			\| <samp>FenceData</samp>
			\| Cache is reset when <samp>Data/Fences</samp> is reloaded.
			\|-
			\| <samp>MachineData</samp>
			\| Cache is reset when <samp>Data/Machines</samp> is reloaded.
			\|-
			\| <samp>ItemRegistry</samp>
			\| Unlike the others, these do not reset when a specific asset is reloaded. Instead, they reset when whenever the <samp>ItemRegistry</samp> cache is rebuilt (which SMAPI triggers when any item data asset is reloaded).
			\|}

			For example, let's say you do this:
			<syntaxhighlight lang="c#">
			private readonly DataCache<int> Cached = DataCache.CharacterData(GetValue);

			/// <inheritdoc />
			public override void Entry(IModHelper helper)
			{
			helper.Events.Input.TimeChanged += (sender, e) => if (e.NewTime % 100 == 0) helper.GameContent.InvalidateCache("Data/Characters");
			helper.Events.GameLoop.UpdateTicked += (sender, e) => _ = this.Cached.Value;
			}

			private int GetValue()
			{
			this.Monitor.Log($"Fetching some character data at {Game1.timeOfDay}");
			return 0;
			}
			</syntaxhighlight>

			When you run the mod, you would see something like this (assuming no other mods are invalidating <samp>Data/Characters</samp>)...
			<blockquote>Fetching some character data at 600...<br />Fetching some character data at 700...<br />Fetching some character data at 800...</blockquote>

			The [[#Cache changes\|game uses this to cache a few frequently-accessed methods]] like <samp>npc.GetData()</samp>.

	===Utility fields & methods===		===Utility fields & methods===

imported>Spacechase0: /* TickCache */ new section for DataCache

2026-06-24T19:42:51Z

TickCache: new section for DataCache

← Older revision		Revision as of 19:42, 24 June 2026
Line 2,011:		Line 2,011:

	The [[#Cache changes\|game uses this to cache a few frequently-accessed methods]] like <samp>npc.GetData()</samp>.		The [[#Cache changes\|game uses this to cache a few frequently-accessed methods]] like <samp>npc.GetData()</samp>.

			====DataCache====

	===Utility fields & methods===		===Utility fields & methods===

imported>Spacechase0: /* Other changes */ add command line argument for saves path overriding

2026-05-28T16:53:34Z

Other changes: add command line argument for saves path overriding

← Older revision		Revision as of 16:53, 28 May 2026
Line 1,649:		Line 1,649:
	* De-hardcoded the giant [[Qi Fruit\|Qi fruit]] mystery box drop and Easter egg into <samp>Data/GiantCrops</samp>, and replaced the <samp>QiChallenge2</samp> special order check with a <samp>DROP_QI_BEANS</samp> special order rule check.		* De-hardcoded the giant [[Qi Fruit\|Qi fruit]] mystery box drop and Easter egg into <samp>Data/GiantCrops</samp>, and replaced the <samp>QiChallenge2</samp> special order check with a <samp>DROP_QI_BEANS</samp> special order rule check.
	* The value of a <samp>(O)GoldCoin</samp> item (e.g. dropped by a [[Cindersap Forest#Pot of Gold\|pot of gold]]) is now fully determined by its stack size, which is no longer limited to 999. This lets you give arbitrary gold rewards via item debris.		* The value of a <samp>(O)GoldCoin</samp> item (e.g. dropped by a [[Cindersap Forest#Pot of Gold\|pot of gold]]) is now fully determined by its stack size, which is no longer limited to 999. This lets you give arbitrary gold rewards via item debris.
			* The game now accepts a <samp>--saves-path some/saves/path/override</samp> command line argument, which will change where save files are checked for.
	* Fixed crash when loading a save with missing building interiors.		* Fixed crash when loading a save with missing building interiors.
	* Fixed farm animals in non-instanced building interiors (like the farmhouse) getting deleted on day start.		* Fixed farm animals in non-instanced building interiors (like the farmhouse) getting deleted on day start.

imported>Spacechase0: /* Other changes */ fixes for net mutexes

2026-05-27T15:54:56Z

Other changes: fixes for net mutexes

← Older revision		Revision as of 15:54, 27 May 2026
Line 2,544:		Line 2,544:
	\| <samp>OnElementChanged</samp>		\| <samp>OnElementChanged</samp>
	\| Fixed event raised before the new value is visible.		\| Fixed event raised before the new value is visible.
			\|-
			\| <samp>NetMutex</samp>
			\| <samp>ReleaseLock()</samp>
			\| When locked multiple times locally (ex. a successfully acquired callback calling another function which also locks the same <samp>NetMutex</samp> and both call <samp>ReleaseLock()</samp> in their acquired callback), fixes the lock being fully released upon the first call, rather than after all local locks are undone.
			\|-
			\| <samp>MultipleMutexRequest</samp>
			\| general usage
			\| Allows success if a <samp>NetMutex</samp> is already owned locally, matching the existing <samp>NetMutex</samp> behavior.
	\|}</li>		\|}</li>
	</ul>		</ul>

imported>Spacechase0: /* Changed assets */ update for exclude_from_furniture_catalogue

2026-05-26T18:48:23Z

Changed assets: update for exclude_from_furniture_catalogue

← Older revision		Revision as of 18:48, 26 May 2026
Line 3,960:		Line 3,960:
	* Updated for [[#Data/CookingRecipes\|new cooking recipe keys]].		* Updated for [[#Data/CookingRecipes\|new cooking recipe keys]].
	* Fixed Pierre's shop selling duplicate corn/sunflower/wheat seeds when you gave him the missing stocklist.		* Fixed Pierre's shop selling duplicate corn/sunflower/wheat seeds when you gave him the missing stocklist.
			* Furniture catalogue's <samp>ALL_ITEMS</samp> item query entry now additionally excludes items with the <samp>exclude_from_furniture_catalogue</samp> context tag.
	\| ✘ will remove fixes		\| ✘ will remove fixes
	\| ✓ mostly unaffected		\| ✓ mostly unaffected

imported>Spacechase0: /* Context tag changes */ context tag for excluding an item from the furniture catalogue

2026-05-26T18:46:55Z

Context tag changes: context tag for excluding an item from the furniture catalogue

← Older revision		Revision as of 18:46, 26 May 2026
Line 397:		Line 397:
	\| functional		\| functional
	\| Whether butterflies spawn around this furniture, similar to the [[Butterfly Hutch\|butterfly hutch]].		\| Whether butterflies spawn around this furniture, similar to the [[Butterfly Hutch\|butterfly hutch]].
			\|-
			\| <samp>exclude_from_furniture_catalogue</samp>
			\| [[Modding:Furniture\|furniture]]
			\| functional
			\| Prevents the furniture from showing up in the furniture catalogue
	\|-		\|-
	\| <samp>trash_bear_ignore</samp>		\| <samp>trash_bear_ignore</samp>