summaryrefslogtreecommitdiff
path: root/src/SMAPI/IModRegistry.cs
blob: 5ef3fd6514b9237791be8f122ad582d301f7d3bc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
using System.Collections.Generic;

namespace StardewModdingAPI
{
    /// <summary>Provides an API for fetching metadata about loaded mods.</summary>
    public interface IModRegistry : IModLinked
    {
        /// <summary>Get metadata for all loaded mods.</summary>
        IEnumerable<IManifest> GetAll();

        /// <summary>Get metadata for a loaded mod.</summary>
        /// <param name="uniqueID">The mod's unique ID.</param>
        /// <returns>Returns the matching mod's metadata, or <c>null</c> if not found.</returns>
        IManifest Get(string uniqueID);

        /// <summary>Get whether a mod has been loaded.</summary>
        /// <param name="uniqueID">The mod's unique ID.</param>
        bool IsLoaded(string uniqueID);
    }
}