src/SMAPI/Framework/DeprecationWarning.cs


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

namespace StardewModdingAPI.Framework
{
    /// <summary>A deprecation warning for a mod.</summary>
    internal class DeprecationWarning
    {
        /*********
        ** Accessors
        *********/
        /// <summary>The affected mod's display name.</summary>
        public string ModName { get; }

        /// <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; }


        /*********
        ** Public methods
        *********/
        /// <summary>Construct an instance.</summary>
        /// <param name="modName">The affected mod's display name.</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>
        public DeprecationWarning(string modName, string nounPhrase, string version, DeprecationLevel level)
        {
            this.ModName = modName;
            this.NounPhrase = nounPhrase;
            this.Version = version;
            this.Level = level;
        }
    }
}