summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI
diff options
context:
space:
mode:
Diffstat (limited to 'src/StardewModdingAPI')
-rw-r--r--src/StardewModdingAPI/Framework/ModHelpers/BaseHelper.cs23
-rw-r--r--src/StardewModdingAPI/Framework/ModHelpers/CommandHelper.cs6
-rw-r--r--src/StardewModdingAPI/Framework/ModHelpers/ContentHelper.cs6
-rw-r--r--src/StardewModdingAPI/Framework/ModHelpers/ModHelper.cs12
-rw-r--r--src/StardewModdingAPI/Framework/ModHelpers/ReflectionHelper.cs6
-rw-r--r--src/StardewModdingAPI/Framework/ModHelpers/TranslationHelper.cs6
-rw-r--r--src/StardewModdingAPI/ICommandHelper.cs2
-rw-r--r--src/StardewModdingAPI/IContentHelper.cs2
-rw-r--r--src/StardewModdingAPI/IModLinked.cs12
-rw-r--r--src/StardewModdingAPI/IReflectionHelper.cs2
-rw-r--r--src/StardewModdingAPI/ITranslationHelper.cs2
-rw-r--r--src/StardewModdingAPI/Program.cs4
-rw-r--r--src/StardewModdingAPI/StardewModdingAPI.csproj2
13 files changed, 66 insertions, 19 deletions
diff --git a/src/StardewModdingAPI/Framework/ModHelpers/BaseHelper.cs b/src/StardewModdingAPI/Framework/ModHelpers/BaseHelper.cs
new file mode 100644
index 00000000..16032da1
--- /dev/null
+++ b/src/StardewModdingAPI/Framework/ModHelpers/BaseHelper.cs
@@ -0,0 +1,23 @@
+namespace StardewModdingAPI.Framework.ModHelpers
+{
+ /// <summary>The common base class for mod helpers.</summary>
+ internal abstract class BaseHelper : IModLinked
+ {
+ /*********
+ ** Accessors
+ *********/
+ /// <summary>The unique ID of the mod for which the helper was created.</summary>
+ public string ModID { get; }
+
+
+ /*********
+ ** Protected methods
+ *********/
+ /// <summary>Construct an instance.</summary>
+ /// <param name="modID">The unique ID of the relevant mod.</param>
+ protected BaseHelper(string modID)
+ {
+ this.ModID = modID;
+ }
+ }
+}
diff --git a/src/StardewModdingAPI/Framework/ModHelpers/CommandHelper.cs b/src/StardewModdingAPI/Framework/ModHelpers/CommandHelper.cs
index 5fd56fdf..bdedb07c 100644
--- a/src/StardewModdingAPI/Framework/ModHelpers/CommandHelper.cs
+++ b/src/StardewModdingAPI/Framework/ModHelpers/CommandHelper.cs
@@ -3,7 +3,7 @@ using System;
namespace StardewModdingAPI.Framework.ModHelpers
{
/// <summary>Provides an API for managing console commands.</summary>
- internal class CommandHelper : ICommandHelper
+ internal class CommandHelper : BaseHelper, ICommandHelper
{
/*********
** Accessors
@@ -19,9 +19,11 @@ namespace StardewModdingAPI.Framework.ModHelpers
** Public methods
*********/
/// <summary>Construct an instance.</summary>
+ /// <param name="modID">The unique ID of the relevant mod.</param>
/// <param name="modName">The friendly mod name for this instance.</param>
/// <param name="commandManager">Manages console commands.</param>
- public CommandHelper(string modName, CommandManager commandManager)
+ public CommandHelper(string modID, string modName, CommandManager commandManager)
+ : base(modID)
{
this.ModName = modName;
this.CommandManager = commandManager;
diff --git a/src/StardewModdingAPI/Framework/ModHelpers/ContentHelper.cs b/src/StardewModdingAPI/Framework/ModHelpers/ContentHelper.cs
index 4fc46dd0..5f72176e 100644
--- a/src/StardewModdingAPI/Framework/ModHelpers/ContentHelper.cs
+++ b/src/StardewModdingAPI/Framework/ModHelpers/ContentHelper.cs
@@ -16,7 +16,7 @@ using xTile.Tiles;
namespace StardewModdingAPI.Framework.ModHelpers
{
/// <summary>Provides an API for loading content assets.</summary>
- internal class ContentHelper : IContentHelper
+ internal class ContentHelper : BaseHelper, IContentHelper
{
/*********
** Properties
@@ -56,8 +56,10 @@ namespace StardewModdingAPI.Framework.ModHelpers
/// <summary>Construct an instance.</summary>
/// <param name="contentManager">SMAPI's underlying content manager.</param>
/// <param name="modFolderPath">The absolute path to the mod folder.</param>
+ /// <param name="modID">The unique ID of the relevant mod.</param>
/// <param name="modName">The friendly mod name for use in errors.</param>
- public ContentHelper(SContentManager contentManager, string modFolderPath, string modName)
+ public ContentHelper(SContentManager contentManager, string modFolderPath, string modID, string modName)
+ : base(modID)
{
this.ContentManager = contentManager;
this.ModFolderPath = modFolderPath;
diff --git a/src/StardewModdingAPI/Framework/ModHelpers/ModHelper.cs b/src/StardewModdingAPI/Framework/ModHelpers/ModHelper.cs
index 965a940a..20d891a1 100644
--- a/src/StardewModdingAPI/Framework/ModHelpers/ModHelper.cs
+++ b/src/StardewModdingAPI/Framework/ModHelpers/ModHelper.cs
@@ -5,7 +5,7 @@ using StardewModdingAPI.Framework.Serialisation;
namespace StardewModdingAPI.Framework.ModHelpers
{
/// <summary>Provides simplified APIs for writing mods.</summary>
- internal class ModHelper : IModHelper, IDisposable
+ internal class ModHelper : BaseHelper, IModHelper, IDisposable
{
/*********
** Properties
@@ -40,6 +40,7 @@ namespace StardewModdingAPI.Framework.ModHelpers
** Public methods
*********/
/// <summary>Construct an instance.</summary>
+ /// <param name="modID">The mod's unique ID.</param>
/// <param name="displayName">The mod's display name.</param>
/// <param name="modDirectory">The full path to the mod's folder.</param>
/// <param name="jsonHelper">Encapsulate SMAPI's JSON parsing.</param>
@@ -49,7 +50,8 @@ namespace StardewModdingAPI.Framework.ModHelpers
/// <param name="reflection">Simplifies access to private game code.</param>
/// <exception cref="ArgumentNullException">An argument is null or empty.</exception>
/// <exception cref="InvalidOperationException">The <paramref name="modDirectory"/> path does not exist on disk.</exception>
- public ModHelper(string displayName, string modDirectory, JsonHelper jsonHelper, IModRegistry modRegistry, CommandManager commandManager, SContentManager contentManager, IReflectionHelper reflection)
+ public ModHelper(string modID, string displayName, string modDirectory, JsonHelper jsonHelper, IModRegistry modRegistry, CommandManager commandManager, SContentManager contentManager, IReflectionHelper reflection)
+ : base(modID)
{
// validate
if (string.IsNullOrWhiteSpace(modDirectory))
@@ -64,11 +66,11 @@ namespace StardewModdingAPI.Framework.ModHelpers
// initialise
this.DirectoryPath = modDirectory;
this.JsonHelper = jsonHelper;
- this.Content = new ContentHelper(contentManager, modDirectory, displayName);
+ this.Content = new ContentHelper(contentManager, modDirectory, modID, displayName);
this.ModRegistry = modRegistry;
- this.ConsoleCommands = new CommandHelper(displayName, commandManager);
+ this.ConsoleCommands = new CommandHelper(modID, displayName, commandManager);
this.Reflection = reflection;
- this.Translation = new TranslationHelper(displayName, contentManager.GetLocale(), contentManager.GetCurrentLanguage());
+ this.Translation = new TranslationHelper(modID, displayName, contentManager.GetLocale(), contentManager.GetCurrentLanguage());
}
/****
diff --git a/src/StardewModdingAPI/Framework/ModHelpers/ReflectionHelper.cs b/src/StardewModdingAPI/Framework/ModHelpers/ReflectionHelper.cs
index 5a21d999..9411a97a 100644
--- a/src/StardewModdingAPI/Framework/ModHelpers/ReflectionHelper.cs
+++ b/src/StardewModdingAPI/Framework/ModHelpers/ReflectionHelper.cs
@@ -5,7 +5,7 @@ namespace StardewModdingAPI.Framework.ModHelpers
{
/// <summary>Provides helper methods for accessing private game code.</summary>
/// <remarks>This implementation searches up the type hierarchy, and caches the reflected fields and methods with a sliding expiry (to optimise performance without unnecessary memory usage).</remarks>
- internal class ReflectionHelper : IReflectionHelper
+ internal class ReflectionHelper : BaseHelper, IReflectionHelper
{
/*********
** Properties
@@ -18,8 +18,10 @@ namespace StardewModdingAPI.Framework.ModHelpers
** Public methods
*********/
/// <summary>Construct an instance.</summary>
+ /// <param name="modID">The unique ID of the relevant mod.</param>
/// <param name="reflector">The underlying reflection helper.</param>
- public ReflectionHelper(Reflector reflector)
+ public ReflectionHelper(string modID, Reflector reflector)
+ : base(modID)
{
this.Reflector = reflector;
}
diff --git a/src/StardewModdingAPI/Framework/ModHelpers/TranslationHelper.cs b/src/StardewModdingAPI/Framework/ModHelpers/TranslationHelper.cs
index 86737f85..bbe3a81a 100644
--- a/src/StardewModdingAPI/Framework/ModHelpers/TranslationHelper.cs
+++ b/src/StardewModdingAPI/Framework/ModHelpers/TranslationHelper.cs
@@ -6,7 +6,7 @@ using StardewValley;
namespace StardewModdingAPI.Framework.ModHelpers
{
/// <summary>Provides 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> &lt; <c>pt.json</c> &lt; <c>default.json</c>).</summary>
- internal class TranslationHelper : ITranslationHelper
+ internal class TranslationHelper : BaseHelper, ITranslationHelper
{
/*********
** Properties
@@ -35,10 +35,12 @@ namespace StardewModdingAPI.Framework.ModHelpers
** Public methods
*********/
/// <summary>Construct an instance.</summary>
+ /// <param name="modID">The unique ID of the relevant mod.</param>
/// <param name="modName">The name of the relevant mod for error messages.</param>
/// <param name="locale">The initial locale.</param>
/// <param name="languageCode">The game's current language code.</param>
- public TranslationHelper(string modName, string locale, LocalizedContentManager.LanguageCode languageCode)
+ public TranslationHelper(string modID, string modName, string locale, LocalizedContentManager.LanguageCode languageCode)
+ : base(modID)
{
// save data
this.ModName = modName;
diff --git a/src/StardewModdingAPI/ICommandHelper.cs b/src/StardewModdingAPI/ICommandHelper.cs
index 3a51ffb4..fb562e32 100644
--- a/src/StardewModdingAPI/ICommandHelper.cs
+++ b/src/StardewModdingAPI/ICommandHelper.cs
@@ -3,7 +3,7 @@
namespace StardewModdingAPI
{
/// <summary>Provides an API for managing console commands.</summary>
- public interface ICommandHelper
+ public interface ICommandHelper : IModLinked
{
/*********
** Public methods
diff --git a/src/StardewModdingAPI/IContentHelper.cs b/src/StardewModdingAPI/IContentHelper.cs
index 1d520135..32a9ff19 100644
--- a/src/StardewModdingAPI/IContentHelper.cs
+++ b/src/StardewModdingAPI/IContentHelper.cs
@@ -5,7 +5,7 @@ using Microsoft.Xna.Framework.Graphics;
namespace StardewModdingAPI
{
/// <summary>Provides an API for loading content assets.</summary>
- public interface IContentHelper
+ public interface IContentHelper : IModLinked
{
/// <summary>Load content from the game folder or mod folder (if not already cached), and return it. When loading a <c>.png</c> file, this must be called outside the game's draw loop.</summary>
/// <typeparam name="T">The expected data type. The main supported types are <see cref="Texture2D"/> and dictionaries; other types may be supported by the game's content pipeline.</typeparam>
diff --git a/src/StardewModdingAPI/IModLinked.cs b/src/StardewModdingAPI/IModLinked.cs
new file mode 100644
index 00000000..172ee30c
--- /dev/null
+++ b/src/StardewModdingAPI/IModLinked.cs
@@ -0,0 +1,12 @@
+namespace StardewModdingAPI
+{
+ /// <summary>An instance linked to a mod.</summary>
+ public interface IModLinked
+ {
+ /*********
+ ** Accessors
+ *********/
+ /// <summary>The unique ID of the mod for which the instance was created.</summary>
+ string ModID { get; }
+ }
+}
diff --git a/src/StardewModdingAPI/IReflectionHelper.cs b/src/StardewModdingAPI/IReflectionHelper.cs
index 77943c6c..f66e3a31 100644
--- a/src/StardewModdingAPI/IReflectionHelper.cs
+++ b/src/StardewModdingAPI/IReflectionHelper.cs
@@ -3,7 +3,7 @@
namespace StardewModdingAPI
{
/// <summary>Simplifies access to private game code.</summary>
- public interface IReflectionHelper
+ public interface IReflectionHelper : IModLinked
{
/*********
** Public methods
diff --git a/src/StardewModdingAPI/ITranslationHelper.cs b/src/StardewModdingAPI/ITranslationHelper.cs
index dac83025..c4b72444 100644
--- a/src/StardewModdingAPI/ITranslationHelper.cs
+++ b/src/StardewModdingAPI/ITranslationHelper.cs
@@ -4,7 +4,7 @@ using StardewValley;
namespace StardewModdingAPI
{
/// <summary>Provides 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> &lt; <c>pt.json</c> &lt; <c>default.json</c>).</summary>
- public interface ITranslationHelper
+ public interface ITranslationHelper : IModLinked
{
/*********
** Accessors
diff --git a/src/StardewModdingAPI/Program.cs b/src/StardewModdingAPI/Program.cs
index 97bc0256..66ed0a85 100644
--- a/src/StardewModdingAPI/Program.cs
+++ b/src/StardewModdingAPI/Program.cs
@@ -703,8 +703,8 @@ namespace StardewModdingAPI
// inject data
mod.ModManifest = manifest;
- var reflectionHelper = new ReflectionHelper(this.Reflection);
- mod.Helper = new ModHelper(metadata.DisplayName, metadata.DirectoryPath, jsonHelper, this.ModRegistry, this.CommandManager, contentManager, reflectionHelper);
+ var reflectionHelper = new ReflectionHelper(manifest.UniqueID, this.Reflection);
+ mod.Helper = new ModHelper(manifest.UniqueID, metadata.DisplayName, metadata.DirectoryPath, jsonHelper, this.ModRegistry, this.CommandManager, contentManager, reflectionHelper);
mod.Monitor = this.GetSecondaryMonitor(metadata.DisplayName);
#if !SMAPI_2_0
mod.PathOnDisk = metadata.DirectoryPath;
diff --git a/src/StardewModdingAPI/StardewModdingAPI.csproj b/src/StardewModdingAPI/StardewModdingAPI.csproj
index da058fb0..93d55b0a 100644
--- a/src/StardewModdingAPI/StardewModdingAPI.csproj
+++ b/src/StardewModdingAPI/StardewModdingAPI.csproj
@@ -128,6 +128,7 @@
<Compile Include="Framework\Countdown.cs" />
<Compile Include="Framework\IModMetadata.cs" />
<Compile Include="Framework\Models\DisabledMod.cs" />
+ <Compile Include="Framework\ModHelpers\BaseHelper.cs" />
<Compile Include="Framework\ModHelpers\CommandHelper.cs" />
<Compile Include="Framework\ModHelpers\ContentHelper.cs" />
<Compile Include="Framework\ModHelpers\ModHelper.cs" />
@@ -186,6 +187,7 @@
<Compile Include="IManifest.cs" />
<Compile Include="IMod.cs" />
<Compile Include="IModHelper.cs" />
+ <Compile Include="IModLinked.cs" />
<Compile Include="Framework\Logging\LogFileManager.cs" />
<Compile Include="IPrivateProperty.cs" />
<Compile Include="ISemanticVersion.cs" />