StardewValley
/
SMAPI
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

expand data helper docs (#799)

This commit is contained in:
Jesse Plamondon-Willard 2021-08-16 17:21:44 -04:00
parent 6cf7c49f34
commit c20fcec169
No known key found for this signature in database
GPG Key ID: CF8B1456B3E29F49
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/SMAPI/IDataHelper.cs
View File

@ -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> /// <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> /// <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="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> /// <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; 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> /// <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> /// <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="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; void WriteGlobalData<TModel>(string key, TModel data) where TModel : class;
} }
} }