Dalamud/Dalamud/Plugin/Services/ITextureSubstitutionProvider.cs

using System.Collections.Generic;

namespace Dalamud.Plugin.Services;

/// <summary>
/// Service that grants you the ability to replace texture data that is to be loaded by Dalamud.
/// </summary>
public interface ITextureSubstitutionProvider : IDalamudService
{
    /// <summary>
    /// Delegate describing a function that may be used to intercept and replace texture data.
    /// The path assigned may point to another texture inside the game's dats, or a .tex file or image on the disk.
    /// </summary>
    /// <param name="path">The path to the texture that is to be loaded.</param>
    /// <param name="replacementPath">The path that should be loaded instead.</param>
    public delegate void TextureDataInterceptorDelegate(string path, ref string? replacementPath);

    /// <summary>
    /// Event that will be called once Dalamud wants to load texture data.
    /// </summary>
    public event TextureDataInterceptorDelegate? InterceptTexDataLoad;

    /// <summary>
    /// Get a path that may be substituted by a subscriber to ITextureSubstitutionProvider.
    /// </summary>
    /// <param name="originalPath">The original path to substitute.</param>
    /// <returns>The original path, if no subscriber is registered or there is no substitution, or the substituted path.</returns>
    public string GetSubstitutedPath(string originalPath);

    /// <summary>
    /// Notify Dalamud about substitution status for files at the specified VFS paths changing.
    /// You should call this with all paths that were either previously substituted and are no longer,
    /// and paths that are newly substituted.
    /// </summary>
    /// <param name="paths">The paths with a changed substitution status.</param>
    /// <remarks>
    /// This function will not invalidate the copies of the textures loaded from plugins.
    /// </remarks>
    public void InvalidatePaths(IEnumerable<string> paths);
}