summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI/Framework/Models/DisabledMod.cs
blob: 170fa7601adfb98f0a624dd97e58e0fc686c41f9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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; }
    }
}