summaryrefslogtreecommitdiff
path: root/src/SMAPI
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2021-08-16 17:21:44 -0400
committerJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2021-08-25 18:17:45 -0400
commitc20fcec169d75b395636b06adcbec8d5101447fd (patch)
treef972c05085eae1dbc758232286e1a9e1b344aad0 /src/SMAPI
parent6cf7c49f34eac8edd18012d41d1f49a149fb1f5a (diff)
downloadSMAPI-c20fcec169d75b395636b06adcbec8d5101447fd.tar.gz
SMAPI-c20fcec169d75b395636b06adcbec8d5101447fd.tar.bz2
SMAPI-c20fcec169d75b395636b06adcbec8d5101447fd.zip
expand data helper docs (#799)
Diffstat (limited to 'src/SMAPI')
-rw-r--r--src/SMAPI/IDataHelper.cs4
1 files changed, 2 insertions, 2 deletions
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
/// <summary>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.</summary>
/// <typeparam name="TModel">The model type. This should be a plain class that has public properties for the data you want. The properties can be complex types.</typeparam>
/// <param name="key">The unique key identifying the data.</param>
- /// <param name="data">The arbitrary data to save.</param>
+ /// <param name="data">The arbitrary data to save, or <c>null</c> to remove the entry.</param>
/// <exception cref="InvalidOperationException">The player hasn't loaded a save file yet or isn't the main player.</exception>
void WriteSaveData<TModel>(string key, TModel data) where TModel : class;
@@ -55,7 +55,7 @@ namespace StardewModdingAPI
/// <summary>Save arbitrary data to the local computer, synchronised by GOG/Steam if applicable.</summary>
/// <typeparam name="TModel">The model type. This should be a plain class that has public properties for the data you want. The properties can be complex types.</typeparam>
/// <param name="key">The unique key identifying the data.</param>
- /// <param name="data">The arbitrary data to save.</param>
+ /// <param name="data">The arbitrary data to save, or <c>null</c> to delete the file.</param>
void WriteGlobalData<TModel>(string key, TModel data) where TModel : class;
}
}