summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI/Framework/Models/DisabledMod.cs
diff options
context:
space:
mode:
Diffstat (limited to 'src/StardewModdingAPI/Framework/Models/DisabledMod.cs')
-rw-r--r--src/StardewModdingAPI/Framework/Models/DisabledMod.cs22
1 files changed, 22 insertions, 0 deletions
diff --git a/src/StardewModdingAPI/Framework/Models/DisabledMod.cs b/src/StardewModdingAPI/Framework/Models/DisabledMod.cs
new file mode 100644
index 00000000..170fa760
--- /dev/null
+++ b/src/StardewModdingAPI/Framework/Models/DisabledMod.cs
@@ -0,0 +1,22 @@
+namespace StardewModdingAPI.Framework.Models
+{
+ /// <summary>Metadata about for a mod that should never be loaded.</summary>
+ internal class DisabledMod
+ {
+ /*********
+ ** Accessors
+ *********/
+ /****
+ ** From config
+ ****/
+ /// <summary>The unique mod IDs.</summary>
+ public string[] ID { get; set; }
+
+ /// <summary>The mod name.</summary>
+ public string Name { get; set; }
+
+ /// <summary>The reason phrase to show in the warning, or <c>null</c> to use the default value.</summary>
+ /// <example>"this mod is no longer supported or used"</example>
+ public string ReasonPhrase { get; set; }
+ }
+}