Modding:Migrate to Stardew Valley 1.3 - Revision history

imported>Margotbean: zh link

2026-04-14T07:57:26Z

zh link

← Older revision		Revision as of 07:57, 14 April 2026
Line 208:		Line 208:

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

			[[zh:模组:迁移至游戏本体1.3]]

imported>Margotbean: Text replacement - "i.e. " to "''i.e.,'' "

2021-11-08T01:06:31Z

Text replacement - "i.e. " to "''i.e.,'' "

← Older revision		Revision as of 01:06, 8 November 2021
Line 166:		Line 166:
	Your code is referencing a [[#Net fields\|net field]], which can cause subtle bugs. You should access the underlying value instead:		Your code is referencing a [[#Net fields\|net field]], which can cause subtle bugs. You should access the underlying value instead:
	<ul>		<ul>
	<li>For a reference type (i.e. one that can contain <samp>null</samp>), you can use the <samp>.Value</samp> property (or <samp>.FieldDict</samp> for a <samp>NetDictionary</samp>):		<li>For a reference type (''i.e.,'' one that can contain <samp>null</samp>), you can use the <samp>.Value</samp> property (or <samp>.FieldDict</samp> for a <samp>NetDictionary</samp>):
	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	if (building.indoors.Value == null)		if (building.indoors.Value == null)
Line 177:		Line 177:
	// ...		// ...
	</syntaxhighlight></li>		</syntaxhighlight></li>
	<li>For a value type (i.e. one that can't contain <samp>null</samp>), check if the parent is null (if needed) and compare with <samp>.Value</samp>:		<li>For a value type (''i.e.,'' one that can't contain <samp>null</samp>), check if the parent is null (if needed) and compare with <samp>.Value</samp>:
	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	if (item != null && item.category.Value == 0)		if (item != null && item.category.Value == 0)

imported>Margotbean: Text replacement - "''e.g.''," to "''e.g.,''"

2021-11-08T00:40:45Z

Text replacement - "''e.g.''," to "''e.g.,''"

← Older revision		Revision as of 00:40, 8 November 2021
Line 106:		Line 106:

	===SMAPI event changes===		===SMAPI event changes===
	Some SMAPI events were rewritten so they make sense in multiplayer. These also use a new architecture under the hood, so they provide much more useful event data (''e.g.'', added/removed instead of just current values). The following events have breaking changes:		Some SMAPI events were rewritten so they make sense in multiplayer. These also use a new architecture under the hood, so they provide much more useful event data (''e.g.,'' added/removed instead of just current values). The following events have breaking changes:

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

imported>Margotbean: Text replacement - "(e.g. " to "(''e.g.'', "

2021-11-07T23:41:34Z

Text replacement - "(e.g. " to "(''e.g.'', "

← Older revision		Revision as of 23:41, 7 November 2021
Line 106:		Line 106:

	===SMAPI event changes===		===SMAPI event changes===
	Some SMAPI events were rewritten so they make sense in multiplayer. These also use a new architecture under the hood, so they provide much more useful event data (e.g. added/removed instead of just current values). The following events have breaking changes:		Some SMAPI events were rewritten so they make sense in multiplayer. These also use a new architecture under the hood, so they provide much more useful event data (''e.g.'', added/removed instead of just current values). The following events have breaking changes:

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

imported>Margotbean: Text replacement - "tt>" to "samp>"

2021-11-04T18:48:32Z

Text replacement - "tt>" to "samp>"

Show changes

imported>RetroEdit: Replace deprecated tags with tags; add new template Template:Modder compatibility header

2021-02-19T17:49:42Z

Replace deprecated <source> tags with <syntaxhighlight> tags; add new template Template:Modder compatibility header

← Older revision		Revision as of 17:49, 19 February 2021
Line 1:		Line 1:
	←[[Modding:Index\|Index]]		←[[Modding:Index\|Index]]

	~~'''This page is for modders. Players: see [[Modding:Mod~~ compatibility~~]] instead.'''~~ For updating Content Patcher or XNB mods, see [[Modding:Migrate XNB changes to Stardew Valley 1.3\|''Migrate XNB changes to Stardew Valley 1.3'']].		{{Modder compatibility header}}
			For updating Content Patcher or XNB mods, see [[Modding:Migrate XNB changes to Stardew Valley 1.3\|''Migrate XNB changes to Stardew Valley 1.3'']].

	This page explains how to update your SMAPI mod code for compatibility with Stardew Valley 1.3.		This page explains how to update your SMAPI mod code for compatibility with Stardew Valley 1.3.
Line 31:		Line 32:
	===⚠ Net fields===		===⚠ Net fields===
	A 'net type' is any of several new classes which Stardew Valley 1.3 uses to sync data between players, named for the <code>Net</code> prefix in their name. A net type can represent a simple value like <tt>NetBool</tt>, or complex values like <tt>NetFieldDictionary</tt>. Many existing fields have been converted to net types (called 'net fields'), each wrapping the underlying value:		A 'net type' is any of several new classes which Stardew Valley 1.3 uses to sync data between players, named for the <code>Net</code> prefix in their name. A net type can represent a simple value like <tt>NetBool</tt>, or complex values like <tt>NetFieldDictionary</tt>. Many existing fields have been converted to net types (called 'net fields'), each wrapping the underlying value:
	: <~~source~~ lang="C#">		: <syntaxhighlight lang="C#">
	NetString str = new NetString("bar");		NetString str = new NetString("bar");
	if (str.Value == "bar") // true		if (str.Value == "bar") // true
	</~~source~~>		</syntaxhighlight>

	Impact on mods:		Impact on mods:
Line 166:		Line 167:
	<ul>		<ul>
	<li>For a reference type (i.e. one that can contain <tt>null</tt>), you can use the <tt>.Value</tt> property (or <tt>.FieldDict</tt> for a <tt>NetDictionary</tt>):		<li>For a reference type (i.e. one that can contain <tt>null</tt>), you can use the <tt>.Value</tt> property (or <tt>.FieldDict</tt> for a <tt>NetDictionary</tt>):
	<~~source~~ lang="c#">		<syntaxhighlight lang="c#">
	if (building.indoors.Value == null)		if (building.indoors.Value == null)
	</~~source~~>		</syntaxhighlight>

	Or convert the value before comparison:		Or convert the value before comparison:
	<~~source~~ lang="c#">		<syntaxhighlight lang="c#">
	GameLocation indoors = building.indoors.Value;		GameLocation indoors = building.indoors.Value;
	if(indoors == null)		if(indoors == null)
	// ...		// ...
	</~~source~~></li>		</syntaxhighlight></li>
	<li>For a value type (i.e. one that can't contain <tt>null</tt>), check if the parent is null (if needed) and compare with <tt>.Value</tt>:		<li>For a value type (i.e. one that can't contain <tt>null</tt>), check if the parent is null (if needed) and compare with <tt>.Value</tt>:
	<~~source~~ lang="c#">		<syntaxhighlight lang="c#">
	if (item != null && item.category.Value == 0)		if (item != null && item.category.Value == 0)
	</~~source~~></li>		</syntaxhighlight></li>
	</ul>		</ul>

imported>Pathoschild: /* An instance of analyzer ... cannot be created */ update link

2020-07-17T15:43:44Z

An instance of analyzer ... cannot be created: update link

← Older revision		Revision as of 15:43, 17 July 2020
Line 188:		Line 188:

	===An instance of analyzer ... cannot be created===		===An instance of analyzer ... cannot be created===
	Update to the latest [https://~~www~~.~~visualstudio~~.com/vs/community/ Visual Studio ~~2017~~]; the NuGet package uses a recent feature that isn't available in older versions.		Update to the latest [https://visualstudio.microsoft.com/vs/community/ Visual Studio]; the NuGet package uses a recent feature that isn't available in older versions.

	==FAQs==		==FAQs==

imported>Pathoschild: update links

2019-09-25T18:19:57Z

update links

imported>Pathoschild: /* Game1.player.friendships is obsolete */ fix typos

2019-09-13T20:07:13Z

Game1.player.friendships is obsolete: fix typos

← Older revision		Revision as of 20:07, 13 September 2019
Line 56:		Line 56:
	! new equivalent		! new equivalent
	\|-		\|-
	\| <code>Game1.friendships[name][0]</code>		\| <code>Game1.player.friendships[name][0]</code>
	\| <code>Game1.friendshipData[name].Points</code>		\| <code>Game1.player.friendshipData[name].Points</code>
	\|-		\|-
	\| <code>Game1.friendships[name][1]</code>		\| <code>Game1.player.friendships[name][1]</code>
	\| <code>Game1.friendshipData[name].GiftsThisWeek</code>		\| <code>Game1.player.friendshipData[name].GiftsThisWeek</code>
	\|-		\|-
	\| <code>Game1.friendships[name][2]</code>		\| <code>Game1.player.friendships[name][2]</code>
	\| <code>Game1.friendshipData[name].TalkedToToday</code> (0 → false, 1 → true)		\| <code>Game1.player.friendshipData[name].TalkedToToday</code> (0 → false, 1 → true)
	\|-		\|-
	\| <code>Game1.friendships[name][3]</code>		\| <code>Game1.player.friendships[name][3]</code>
	\| <code>Game1.friendshipData[name].GiftsToday</code> (0 → false, 1 → true)		\| <code>Game1.player.friendshipData[name].GiftsToday</code> (0 → false, 1 → true)

	\|}		\|}

imported>Pathoschild: /* Game1.player.friendships is obsolete */ add conversion table

2019-06-27T23:01:25Z

Game1.player.friendships is obsolete: add conversion table

@@ Line 50: / Line 50: @@
 ===Game1.player.friendships is obsolete===
 The <tt>Game1.player.friendships</tt> field is always null in Stardew Valley 1.3. Use the new <tt>Game1.player.friendshipData</tt> field instead, which wraps the raw data with a more useful model and more data.
 ===Texture constructor arguments===

← Older revision		Revision as of 18:19, 25 September 2019
Line 156:		Line 156:

	===This implicitly converts...===		===This implicitly converts...===
	Sample warning: "''This implicitly converts '{0}' from Net{1} to {2}, but Net{1} has unintuitive implicit conversion rules. Consider comparing against the actual value instead to avoid bugs. See https://smapi.io/~~buildmsg~~/avoid-implicit-net-field-cast for details.''"		Sample warning: "''This implicitly converts '{0}' from Net{1} to {2}, but Net{1} has unintuitive implicit conversion rules. Consider comparing against the actual value instead to avoid bugs. See https://smapi.io/package/avoid-implicit-net-field-cast for details.''"

	Your code is referencing a [[#Net fields\|net field]], which can cause subtle bugs. The field you're referencing has an equivalent non-net property, like <tt>monster.Health</tt> (<tt>int</tt>) instead of <tt>monster.health</tt> (<tt>NetBool</tt>). Change your code to use the suggested property instead.		Your code is referencing a [[#Net fields\|net field]], which can cause subtle bugs. The field you're referencing has an equivalent non-net property, like <tt>monster.Health</tt> (<tt>int</tt>) instead of <tt>monster.health</tt> (<tt>NetBool</tt>). Change your code to use the suggested property instead.

	===FieldName is a Net* field...===		===FieldName is a Net* field...===
	Sample warning: "'''{0}' is a Net{1} field; consider using the {2} property instead. See https://smapi.io/~~buildmsg~~/avoid-net-field for details.''"		Sample warning: "'''{0}' is a Net{1} field; consider using the {2} property instead. See https://smapi.io/package/avoid-net-field for details.''"

	Your code is referencing a [[#Net fields\|net field]], which can cause subtle bugs. You should access the underlying value instead:		Your code is referencing a [[#Net fields\|net field]], which can cause subtle bugs. You should access the underlying value instead:
Line 183:		Line 183:

	===The FieldName field is obsolete...===		===The FieldName field is obsolete...===
	Sample warning: "''The 'Character.friendships' field is obsolete and should be replaced with 'friendshipData'. See https://smapi.io/~~buildmsg~~/avoid-obsolete-field for details.''"		Sample warning: "''The 'Character.friendships' field is obsolete and should be replaced with 'friendshipData'. See https://smapi.io/package/avoid-obsolete-field for details.''"

	You're referencing a field which should no longer be used. Use the suggested field name instead to fix it.		You're referencing a field which should no longer be used. Use the suggested field name instead to fix it.
Line 204:		Line 204:

	===Why not use implicit net field conversion?===		===Why not use implicit net field conversion?===
	The migration guide suggests [[#Net fields\|avoiding net field implicit conversion]]. This may be the most tedious part of the migration for many mods, and the code compiles fine without doing that, so it's tempting to just skip this step. That's not recommended. Although net field conversions will work fine in most cases, their conversion rules can cause strange bugs in unexpected places. It's better to avoid it altogether, rather than learn all the different cases where they'll cause problems. If you really want, you can [https://~~github~~.~~com~~/~~Pathoschild~~/~~SMAPI/blob/develop/docs/mod-build-config.md#~~code-warnings disable the build warnings] and decide for yourself when to use the implicit conversion.		The migration guide suggests [[#Net fields\|avoiding net field implicit conversion]]. This may be the most tedious part of the migration for many mods, and the code compiles fine without doing that, so it's tempting to just skip this step. That's not recommended. Although net field conversions will work fine in most cases, their conversion rules can cause strange bugs in unexpected places. It's better to avoid it altogether, rather than learn all the different cases where they'll cause problems. If you really want, you can [https://smapi.io/package/code-warnings disable the build warnings] and decide for yourself when to use the implicit conversion.

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