summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI/Framework/ModLoading/ModMetadata.cs
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <github@jplamondonw.com>2017-05-11 23:21:02 -0400
committerJesse Plamondon-Willard <github@jplamondonw.com>2017-05-11 23:21:02 -0400
commitbb165f2079e33d02c0e673db73ac5b336272a3fa (patch)
tree339ea1fa033070c470d5ac2a19698c63a49dd611 /src/StardewModdingAPI/Framework/ModLoading/ModMetadata.cs
parentdc4ad15afee05cd3c474273f921314cb0656d76c (diff)
downloadSMAPI-bb165f2079e33d02c0e673db73ac5b336272a3fa.tar.gz
SMAPI-bb165f2079e33d02c0e673db73ac5b336272a3fa.tar.bz2
SMAPI-bb165f2079e33d02c0e673db73ac5b336272a3fa.zip
organise a few framework classes
Diffstat (limited to 'src/StardewModdingAPI/Framework/ModLoading/ModMetadata.cs')
-rw-r--r--src/StardewModdingAPI/Framework/ModLoading/ModMetadata.cs40
1 files changed, 40 insertions, 0 deletions
diff --git a/src/StardewModdingAPI/Framework/ModLoading/ModMetadata.cs b/src/StardewModdingAPI/Framework/ModLoading/ModMetadata.cs
new file mode 100644
index 00000000..1ac167dc
--- /dev/null
+++ b/src/StardewModdingAPI/Framework/ModLoading/ModMetadata.cs
@@ -0,0 +1,40 @@
+using StardewModdingAPI.Framework.Models;
+
+namespace StardewModdingAPI.Framework.ModLoading
+{
+ /// <summary>Metadata for a mod.</summary>
+ internal class ModMetadata
+ {
+ /*********
+ ** Accessors
+ *********/
+ /// <summary>The mod's display name.</summary>
+ public string DisplayName { get; }
+
+ /// <summary>The mod's full directory path.</summary>
+ public string DirectoryPath { get; }
+
+ /// <summary>The mod manifest.</summary>
+ public IManifest Manifest { get; }
+
+ /// <summary>Optional metadata about a mod version that SMAPI should assume is compatible or broken, regardless of whether it detects incompatible code.</summary>
+ public ModCompatibility Compatibility { get; }
+
+
+ /*********
+ ** Public methods
+ *********/
+ /// <summary>Construct an instance.</summary>
+ /// <param name="displayName">The mod's display name.</param>
+ /// <param name="directoryPath">The mod's full directory path.</param>
+ /// <param name="manifest">The mod manifest.</param>
+ /// <param name="compatibility">Optional metadata about a mod version that SMAPI should assume is compatible or broken, regardless of whether it detects incompatible code.</param>
+ public ModMetadata(string displayName, string directoryPath, IManifest manifest, ModCompatibility compatibility)
+ {
+ this.DisplayName = displayName;
+ this.DirectoryPath = directoryPath;
+ this.Manifest = manifest;
+ this.Compatibility = compatibility;
+ }
+ }
+}