summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI/IModRegistry.cs
blob: 676c97348e682d9e5dc59eed0ec6c4e802dce8fc (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 metadata about loaded mods.</summary>
    public interface IModRegistry
    {
        /// <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);
    }
}