using StardewModdingAPI.Framework.Models; namespace StardewModdingAPI.Framework.ModLoading { /// <summary>Metadata for a mod.</summary> internal class ModMetadata : IModMetadata { /********* ** Accessors *********/ /// <summary>The mod's display name.</summary> public string DisplayName { get; } /// <summary>The mod's full directory path.</summary> public string DirectoryPath { get; } /// <summary>The mod manifest.</summary> public IManifest Manifest { get; } /// <summary>Metadata about the mod from SMAPI's internal data (if any).</summary> public ModDataRecord DataRecord { get; } /// <summary>The metadata resolution status.</summary> public ModMetadataStatus Status { get; private set; } /// <summary>The reason the metadata is invalid, if any.</summary> public string Error { get; private set; } /// <summary>The mod instance (if it was loaded).</summary> public IMod Mod { get; private set; } /// <summary>The mod-provided API (if any).</summary> public object Api { get; private set; } /********* ** Public methods *********/ /// <summary>Construct an instance.</summary> /// <param name="displayName">The mod's display name.</param> /// <param name="directoryPath">The mod's full directory path.</param> /// <param name="manifest">The mod manifest.</param> /// <param name="dataRecord">Metadata about the mod from SMAPI's internal data (if any).</param> public ModMetadata(string displayName, string directoryPath, IManifest manifest, ModDataRecord dataRecord) { this.DisplayName = displayName; this.DirectoryPath = directoryPath; this.Manifest = manifest; this.DataRecord = dataRecord; } /// <summary>Set the mod status.</summary> /// <param name="status">The metadata resolution status.</param> /// <param name="error">The reason the metadata is invalid, if any.</param> /// <returns>Return the instance for chaining.</returns> public IModMetadata SetStatus(ModMetadataStatus status, string error = null) { this.Status = status; this.Error = error; return this; } /// <summary>Set the mod instance.</summary> /// <param name="mod">The mod instance to set.</param> public IModMetadata SetMod(IMod mod) { this.Mod = mod; return this; } /// <summary>Set the mod-provided API instance.</summary> /// <param name="api">The mod-provided API.</param> public IModMetadata SetApi(object api) { this.Api = api; return this; } } }