src/SMAPI/Framework/ModHelpers/BaseHelper.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

namespace StardewModdingAPI.Framework.ModHelpers
{
    /// <summary>The common base class for mod helpers.</summary>
    internal abstract class BaseHelper : IModLinked
    {
        /*********
        ** Fields
        *********/
        /// <summary>The mod using this instance.</summary>
        protected readonly IModMetadata Mod;


        /*********
        ** Accessors
        *********/
        /// <inheritdoc />
        public string ModID => this.Mod.Manifest.UniqueID;


        /*********
        ** Protected methods
        *********/
        /// <summary>Construct an instance.</summary>
        /// <param name="mod">The mod using this instance.</param>
        protected BaseHelper(IModMetadata mod)
        {
            this.Mod = mod;
        }
    }
}