src/SMAPI/Events/IContentEvents.cs


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

using System;
using StardewValley;

namespace StardewModdingAPI.Events
{
    /// <summary>Events related to assets loaded from the content pipeline (including data, maps, and textures).</summary>
    public interface IContentEvents
    {
        /// <summary>Raised when an asset is being requested from the content pipeline.</summary>
        /// <remarks>
        /// The asset isn't necessarily being loaded yet (e.g. the game may be checking if it exists). Mods can register the changes they want to apply using methods on the <paramref name="e"/> parameter. These will be applied when the asset is actually loaded.
        ///
        /// If the asset is requested multiple times in the same tick (e.g. once to check if it exists and once to load it), SMAPI might only raise the event once and reuse the cached result.
        /// </remarks>
        event EventHandler<AssetRequestedEventArgs> AssetRequested;

        /// <summary>Raised after one or more assets were invalidated from the content cache by a mod, so they'll be reloaded next time they're requested. If the assets will be reloaded or propagated automatically, this event is raised before that happens.</summary>
        event EventHandler<AssetsInvalidatedEventArgs> AssetsInvalidated;
    }
}