diff options
author | Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com> | 2020-09-07 13:06:27 -0400 |
---|---|---|
committer | Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com> | 2020-09-07 13:06:27 -0400 |
commit | 5e43bdbf5cd6dbab36c25287c85d42ccfeea2c83 (patch) | |
tree | 0a42305174eb84561a584549cd685c5e95670f36 /src/SMAPI/Framework/ModHelpers/ModHelper.cs | |
parent | 8da88b8fe5b41739c5cd0df3280b9770fc7f10a4 (diff) | |
parent | f9fac11028354f15d786d5b854608edb10716f79 (diff) | |
download | SMAPI-5e43bdbf5cd6dbab36c25287c85d42ccfeea2c83.tar.gz SMAPI-5e43bdbf5cd6dbab36c25287c85d42ccfeea2c83.tar.bz2 SMAPI-5e43bdbf5cd6dbab36c25287c85d42ccfeea2c83.zip |
Merge branch 'develop' into stable
Diffstat (limited to 'src/SMAPI/Framework/ModHelpers/ModHelper.cs')
-rw-r--r-- | src/SMAPI/Framework/ModHelpers/ModHelper.cs | 32 |
1 files changed, 14 insertions, 18 deletions
diff --git a/src/SMAPI/Framework/ModHelpers/ModHelper.cs b/src/SMAPI/Framework/ModHelpers/ModHelper.cs index 25401e23..d9fc8621 100644 --- a/src/SMAPI/Framework/ModHelpers/ModHelper.cs +++ b/src/SMAPI/Framework/ModHelpers/ModHelper.cs @@ -2,7 +2,6 @@ using System; using System.IO; using StardewModdingAPI.Events; using StardewModdingAPI.Framework.Input; -using StardewModdingAPI.Toolkit.Serialization; namespace StardewModdingAPI.Framework.ModHelpers { @@ -12,37 +11,37 @@ namespace StardewModdingAPI.Framework.ModHelpers /********* ** Accessors *********/ - /// <summary>The full path to the mod's folder.</summary> + /// <inheritdoc /> public string DirectoryPath { get; } - /// <summary>Manages access to events raised by SMAPI, which let your mod react when something happens in the game.</summary> + /// <inheritdoc /> public IModEvents Events { get; } - /// <summary>An API for loading content assets.</summary> + /// <inheritdoc /> public IContentHelper Content { get; } - /// <summary>An API for managing content packs.</summary> + /// <inheritdoc /> public IContentPackHelper ContentPacks { get; } - /// <summary>An API for reading and writing persistent mod data.</summary> + /// <inheritdoc /> public IDataHelper Data { get; } - /// <summary>An API for checking and changing input state.</summary> + /// <inheritdoc /> public IInputHelper Input { get; } - /// <summary>An API for accessing private game code.</summary> + /// <inheritdoc /> public IReflectionHelper Reflection { get; } - /// <summary>an API for fetching metadata about loaded mods.</summary> + /// <inheritdoc /> public IModRegistry ModRegistry { get; } - /// <summary>An API for managing console commands.</summary> + /// <inheritdoc /> public ICommandHelper ConsoleCommands { get; } - /// <summary>Provides multiplayer utilities.</summary> + /// <inheritdoc /> public IMultiplayerHelper Multiplayer { get; } - /// <summary>An API for reading translations stored in the mod's <c>i18n</c> folder, with one file per locale (like <c>en.json</c>) containing a flat key => value structure. Translations are fetched with locale fallback, so missing translations are filled in from broader locales (like <c>pt-BR.json</c> < <c>pt.json</c> < <c>default.json</c>).</summary> + /// <inheritdoc /> public ITranslationHelper Translation { get; } @@ -90,8 +89,7 @@ namespace StardewModdingAPI.Framework.ModHelpers /**** ** Mod config file ****/ - /// <summary>Read the mod's configuration file (and create it if needed).</summary> - /// <typeparam name="TConfig">The config class type. This should be a plain class that has public properties for the settings you want. These can be complex types.</typeparam> + /// <inheritdoc /> public TConfig ReadConfig<TConfig>() where TConfig : class, new() { @@ -100,9 +98,7 @@ namespace StardewModdingAPI.Framework.ModHelpers return config; } - /// <summary>Save to the mod's configuration file.</summary> - /// <typeparam name="TConfig">The config class type.</typeparam> - /// <param name="config">The config settings to save.</param> + /// <inheritdoc /> public void WriteConfig<TConfig>(TConfig config) where TConfig : class, new() { @@ -112,7 +108,7 @@ namespace StardewModdingAPI.Framework.ModHelpers /**** ** Disposal ****/ - /// <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary> + /// <inheritdoc /> public void Dispose() { // nothing to dispose yet |