Merge branch 'add-mod-build-config' into develop

1 files changed, 47 insertions, 0 deletions

diff --git a/src/SMAPI/Framework/IModMetadata.cs b/src/SMAPI/Framework/IModMetadata.cs
new file mode 100644
index 00000000..c21734a7
--- /dev/null
+++ b/src/SMAPI/Framework/IModMetadata.cs
@@ -0,0 +1,47 @@
+using StardewModdingAPI.Framework.Models;
+using StardewModdingAPI.Framework.ModLoading;
+
+namespace StardewModdingAPI.Framework
+{
+    /// <summary>Metadata for a mod.</summary>
+    internal interface IModMetadata
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The mod's display name.</summary>
+        string DisplayName { get; }
+
+        /// <summary>The mod's full directory path.</summary>
+        string DirectoryPath { get; }
+
+        /// <summary>The mod manifest.</summary>
+        IManifest Manifest { get; }
+
+        /// <summary>>Metadata about the mod from SMAPI's internal data (if any).</summary>
+        ModDataRecord DataRecord { get; }
+
+        /// <summary>The metadata resolution status.</summary>
+        ModMetadataStatus Status { get; }
+
+        /// <summary>The reason the metadata is invalid, if any.</summary>
+        string Error { get; }
+
+        /// <summary>The mod instance (if it was loaded).</summary>
+        IMod Mod { get; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Set the mod status.</summary>
+        /// <param name="status">The metadata resolution status.</param>
+        /// <param name="error">The reason the metadata is invalid, if any.</param>
+        /// <returns>Return the instance for chaining.</returns>
+        IModMetadata SetStatus(ModMetadataStatus status, string error = null);
+
+        /// <summary>Set the mod instance.</summary>
+        /// <param name="mod">The mod instance to set.</param>
+        IModMetadata SetMod(IMod mod);
+    }
+}