summaryrefslogtreecommitdiff
path: root/src/SMAPI/Framework/Deprecations/DeprecationWarning.cs
diff options
context:
space:
mode:
Diffstat (limited to 'src/SMAPI/Framework/Deprecations/DeprecationWarning.cs')
-rw-r--r--src/SMAPI/Framework/Deprecations/DeprecationWarning.cs48
1 files changed, 48 insertions, 0 deletions
diff --git a/src/SMAPI/Framework/Deprecations/DeprecationWarning.cs b/src/SMAPI/Framework/Deprecations/DeprecationWarning.cs
new file mode 100644
index 00000000..38062daf
--- /dev/null
+++ b/src/SMAPI/Framework/Deprecations/DeprecationWarning.cs
@@ -0,0 +1,48 @@
+using System.Diagnostics;
+
+namespace StardewModdingAPI.Framework.Deprecations
+{
+ /// <summary>A deprecation warning for a mod.</summary>
+ internal class DeprecationWarning
+ {
+ /*********
+ ** Accessors
+ *********/
+ /// <summary>The affected mod.</summary>
+ public IModMetadata? Mod { get; }
+
+ /// <summary>Get the display name for the affected mod.</summary>
+ public string ModName => this.Mod?.DisplayName ?? "<unknown mod>";
+
+ /// <summary>A noun phrase describing what is deprecated.</summary>
+ public string NounPhrase { get; }
+
+ /// <summary>The SMAPI version which deprecated it.</summary>
+ public string Version { get; }
+
+ /// <summary>The deprecation level for the affected code.</summary>
+ public DeprecationLevel Level { get; }
+
+ /// <summary>The stack trace when the deprecation warning was raised.</summary>
+ public StackTrace StackTrace { get; }
+
+
+ /*********
+ ** Public methods
+ *********/
+ /// <summary>Construct an instance.</summary>
+ /// <param name="mod">The affected mod.</param>
+ /// <param name="nounPhrase">A noun phrase describing what is deprecated.</param>
+ /// <param name="version">The SMAPI version which deprecated it.</param>
+ /// <param name="level">The deprecation level for the affected code.</param>
+ /// <param name="stackTrace">The stack trace when the deprecation warning was raised.</param>
+ public DeprecationWarning(IModMetadata? mod, string nounPhrase, string version, DeprecationLevel level, StackTrace stackTrace)
+ {
+ this.Mod = mod;
+ this.NounPhrase = nounPhrase;
+ this.Version = version;
+ this.Level = level;
+ this.StackTrace = stackTrace;
+ }
+ }
+}