From c20fcec169d75b395636b06adcbec8d5101447fd Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Mon, 16 Aug 2021 17:21:44 -0400 Subject: expand data helper docs (#799) --- src/SMAPI/IDataHelper.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'src/SMAPI') diff --git a/src/SMAPI/IDataHelper.cs b/src/SMAPI/IDataHelper.cs index 252030bd..4922c8da 100644 --- a/src/SMAPI/IDataHelper.cs +++ b/src/SMAPI/IDataHelper.cs @@ -38,7 +38,7 @@ namespace StardewModdingAPI /// Save arbitrary data to the current save slot. This is only possible if a save has been loaded, and the data will be lost if the player exits without saving the current day. /// The model type. This should be a plain class that has public properties for the data you want. The properties can be complex types. /// The unique key identifying the data. - /// The arbitrary data to save. + /// The arbitrary data to save, or null to remove the entry. /// The player hasn't loaded a save file yet or isn't the main player. void WriteSaveData(string key, TModel data) where TModel : class; @@ -55,7 +55,7 @@ namespace StardewModdingAPI /// Save arbitrary data to the local computer, synchronised by GOG/Steam if applicable. /// The model type. This should be a plain class that has public properties for the data you want. The properties can be complex types. /// The unique key identifying the data. - /// The arbitrary data to save. + /// The arbitrary data to save, or null to delete the file. void WriteGlobalData(string key, TModel data) where TModel : class; } } -- cgit