src/SMAPI/Events/AssetReadyEventArgs.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

#nullable disable

using System;

namespace StardewModdingAPI.Events
{
    /// <summary>Event arguments for an <see cref="IContentEvents.AssetReady"/> event.</summary>
    public class AssetReadyEventArgs : EventArgs
    {
        /*********
        ** Accessors
        *********/
        /// <summary>The name of the asset being requested.</summary>
        public IAssetName Name { get; }

        /// <summary>The <see cref="Name"/> with any locale codes stripped.</summary>
        /// <remarks>For example, if <see cref="Name"/> contains a locale like <c>Data/Bundles.fr-FR</c>, this will be the name without locale like <c>Data/Bundles</c>. If the name has no locale, this field is equivalent.</remarks>
        public IAssetName NameWithoutLocale { get; }


        /*********
        ** Public methods
        *********/
        /// <summary>Construct an instance.</summary>
        /// <param name="name">The name of the asset being requested.</param>
        /// <param name="nameWithoutLocale">The <paramref name="name"/> with any locale codes stripped.</param>
        internal AssetReadyEventArgs(IAssetName name, IAssetName nameWithoutLocale)
        {
            this.Name = name;
            this.NameWithoutLocale = nameWithoutLocale;
        }
    }
}