src/SMAPI/Framework/Content/AssetLoadOperation.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
39
40

using System;

namespace StardewModdingAPI.Framework.Content
{
    /// <summary>An operation which provides the initial instance of an asset when it's requested from the content pipeline.</summary>
    internal class AssetLoadOperation
    {
        /*********
        ** Accessors
        *********/
        /// <summary>The mod loading the asset.</summary>
        public IModMetadata Mod { get; }

        /// <summary>The content pack on whose behalf the asset is being loaded, if any.</summary>
        public IModMetadata OnBehalfOf { get; }

        /// <summary>Whether to allow skipping this operation to resolve a load conflict.</summary>
        public bool AllowSkipOnConflict { get; }

        /// <summary>Load the initial value for an asset.</summary>
        public Func<IAssetInfo, object> GetData { get; }


        /*********
        ** Public methods
        *********/
        /// <summary>Construct an instance.</summary>
        /// <param name="mod">The mod applying the edit.</param>
        /// <param name="allowSkipOnConflict">Whether to allow skipping this operation to resolve a load conflict.</param>
        /// <param name="onBehalfOf">The content pack on whose behalf the asset is being loaded, if any.</param>
        /// <param name="getData">Load the initial value for an asset.</param>
        public AssetLoadOperation(IModMetadata mod, bool allowSkipOnConflict, IModMetadata onBehalfOf, Func<IAssetInfo, object> getData)
        {
            this.Mod = mod;
            this.AllowSkipOnConflict = allowSkipOnConflict;
            this.OnBehalfOf = onBehalfOf;
            this.GetData = getData;
        }
    }
}