Modding:Modder Guide/APIs/Data - Revision history

imported>Margotbean: ru link

2026-01-07T18:51:27Z

ru link

← Older revision		Revision as of 18:51, 7 January 2026
Line 139:		Line 139:
	</syntaxhighlight>		</syntaxhighlight>

	[[ru:Модификации:Руководство мододела/API/~~Data~~]]		[[ru:Модификации:Руководство мододела/API/Данные]]
	[[zh:模组:制作指南/APIs/Data]]		[[zh:模组:制作指南/APIs/Data]]

imported>Sunbeam135: /* Mod data */

2026-01-02T12:38:26Z

Mod data

← Older revision		Revision as of 12:38, 2 January 2026
Line 139:		Line 139:
	</syntaxhighlight>		</syntaxhighlight>

			[[ru:Модификации:Руководство мододела/API/Data]]
	[[zh:模组:制作指南/APIs/Data]]		[[zh:模组:制作指南/APIs/Data]]

imported>VulpesLucida: zh link

2025-01-05T14:29:17Z

zh link

← Older revision		Revision as of 14:29, 5 January 2025
Line 138:		Line 138:
	...		...
	</syntaxhighlight>		</syntaxhighlight>

			[[zh:模组:制作指南/APIs/Data]]

imported>Pathoschild: /* Mod data */ rewrite, add more info from migration guide

2023-01-31T00:47:47Z

Mod data: rewrite, add more info from migration guide

← Older revision		Revision as of 00:47, 31 January 2023
Line 123:		Line 123:
	==See also==		==See also==
	===Mod data===		===Mod data===
	~~As mentioned in the [[Modding:Migrate to Stardew Valley 1.5#Custom mod data\|1.5 Migration Guide]], you~~ can store ~~arbitrary string~~ data on a ~~per-game, per-player basis in the~~ <samp>~~Game1.player.~~modData</samp> dictionary. This is ~~automatically serialized/deserialized with~~ the ~~game,~~ and ~~works correctly~~ in multiplayer.		You can also store custom data for individual game entities which have a <samp>modData</samp> dictionary field. That includes NPCs and players (<samp>Character</samp>), <samp>GameLocation</samp>, <samp>Item</samp>, and <samp>TerrainFeature</samp>. This is persisted to the save file and synchronized in multiplayer.

			Usage notes:
			* To avoid mod conflicts, prefixing data fields with your mod ID is strongly recommended (see the example below).
			* When you split an item stack, the new stack copies the previous one's <samp>modData</samp> field; when merged into another stack, the merged items adopt the target stack's mod data. Otherwise mod data has no effect on item split/merge logic (''e.g.,'' you can still merge items with different mod data).</li>

			For example, this writes and then reads a custom 'age' value for an item:
	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	~~public static class PerPlayerData {~~		// write a custom value
			item.modData[$"{this.ModManifest.UniqueID}/item-age"] = "30";
	~~static string HomeComputerNameKey {~~
	~~get { return~~ $"{~~ModEntry.instance~~.ModManifest.UniqueID}/~~HomeComputerName~~"; }
	}

	~~public static string HomeComputerName {~~		// read it
	~~get {~~		if (item.modData.TryGetValue($"{this.ModManifest.UniqueID}/item-age", out string rawAge) && int.TryParse(rawAge, int age))
	~~string result;~~		...
	if (~~Game1.player~~.modData.TryGetValue(~~HomeComputerNameKey~~, out ~~result~~)) {
	~~return result;~~
	}
	~~return "Home Computer";~~
	}
	~~set {~~
	~~Game1~~.~~player~~.~~modData[HomeComputerNameKey] = value;~~
	}
	}
	}
	</syntaxhighlight>		</syntaxhighlight>

imported>Pathoschild: move mod data into a separate subsection (it's not part of the data API documented by this page)

2023-01-31T00:39:36Z

move mod data into a separate subsection (it's not part of the data API documented by this page)

@@ Line 4: / Line 4: @@
 ==Storage options==
 ===JSON files===
 You can store data in arbitrary <samp>.json</samp> files in your mod folder. Note that these files will be lost if the player deletes them (''e.g.,'' when updating your mod), so this is mainly useful for bundled files, cache files, etc.
@@ Line 144: / Line 119: @@
 // delete entry (if present)
 this.Helper.Data.WriteSaveData<DataModel>("example-key", null);
 </syntaxhighlight>

imported>Margotbean: fix internal link format

2023-01-29T16:00:33Z

fix internal link format

← Older revision		Revision as of 16:00, 29 January 2023
Line 5:		Line 5:
	==Storage options==		==Storage options==
	===Player modData===		===Player modData===
	As mentioned in the [[~~https://stardewvalleywiki.com/~~Modding:~~Migrate_to_Stardew_Valley_1~~.5#~~Custom_mod_data~~\|1.5 Migration Guide]], you can store arbitrary string data on a per-game, per-player basis in the <samp>Game1.player.modData</samp> dictionary. This is automatically serialized/deserialized with the game, and works correctly in multiplayer.		As mentioned in the [[Modding:Migrate to Stardew Valley 1.5#Custom mod data\|1.5 Migration Guide]], you can store arbitrary string data on a per-game, per-player basis in the <samp>Game1.player.modData</samp> dictionary. This is automatically serialized/deserialized with the game, and works correctly in multiplayer.

	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">

imported>JoeStrout: Added note and example about storing data on Game1.player.modData

2023-01-29T15:27:11Z

Added note and example about storing data on Game1.player.modData

@@ Line 4: / Line 4: @@
 ==Storage options==
 ===JSON files===
 You can store data in arbitrary <samp>.json</samp> files in your mod folder. Note that these files will be lost if the player deletes them (''e.g.,'' when updating your mod), so this is mainly useful for bundled files, cache files, etc.

imported>Atravita: /* Creating a data model */

2022-12-01T16:10:39Z

Creating a data model

← Older revision		Revision as of 16:10, 1 December 2022
Line 83:		Line 83:
	</syntaxhighlight>		</syntaxhighlight>

	Only public properties and fields will be serialized, and your class needs a zero-parameter constructor.		Only public properties and fields will be serialized, and your class needs a zero-parameter constructor. SMAPI uses NewtonSoft to serialize these models, so if you need finer-grained control over what gets serialized, use NewtonSoft annotations.

	===Default values===		===Default values===

imported>Atravita: /* Creating a data model */

2022-11-28T03:03:50Z

Creating a data model

← Older revision		Revision as of 03:03, 28 November 2022
Line 83:		Line 83:
	</syntaxhighlight>		</syntaxhighlight>

	Only public properties and fields will be serialized.		Only public properties and fields will be serialized, and your class needs a zero-parameter constructor.

	===Default values===		===Default values===

imported>Atravita: /* Creating a data model */

2022-11-28T03:03:26Z

Creating a data model

← Older revision		Revision as of 03:03, 28 November 2022
Line 68:		Line 68:
	The ''data model'' is a C# class you create, with properties representing the data you want to store. It can contain almost anything from a few boolean fields to a complex object graph. Here's a simple data model:		The ''data model'' is a C# class you create, with properties representing the data you want to store. It can contain almost anything from a few boolean fields to a complex object graph. Here's a simple data model:
	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	class ModData		public sealed class ModData
	{		{
	public bool ExampleBoolean { get; set; }		public bool ExampleBoolean { get; set; }
Line 82:		Line 82:
	}		}
	</syntaxhighlight>		</syntaxhighlight>

			Only public properties and fields will be serialized.

	===Default values===		===Default values===