blob: af888b71ebd62f0e2d627d2c3838f49f3ce3414e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
using System;
using System.Linq;
using StardewModdingAPI.Framework.ModData;
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 ParsedModDataRecord 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 loaded and <see cref="IsContentPack"/> is false).</summary>
public IMod Mod { get; private set; }
/// <summary>The content pack instance (if loaded and <see cref="IsContentPack"/> is true).</summary>
public IContentPack ContentPack { get; private set; }
/// <summary>Writes messages to the console and log file as this mod.</summary>
public IMonitor Monitor { get; private set; }
/// <summary>The mod-provided API (if any).</summary>
public object Api { get; private set; }
/// <summary>Whether the mod is a content pack.</summary>
public bool IsContentPack => this.Manifest?.ContentPackFor != null;
/*********
** 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, ParsedModDataRecord 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)
{
if (this.ContentPack != null)
throw new InvalidOperationException("A mod can't be both an assembly mod and content pack.");
this.Mod = mod;
this.Monitor = mod.Monitor;
return this;
}
/// <summary>Set the mod instance.</summary>
/// <param name="contentPack">The contentPack instance to set.</param>
/// <param name="monitor">Writes messages to the console and log file.</param>
public IModMetadata SetMod(IContentPack contentPack, IMonitor monitor)
{
if (this.Mod != null)
throw new InvalidOperationException("A mod can't be both an assembly mod and content pack.");
this.ContentPack = contentPack;
this.Monitor = monitor;
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;
}
/// <summary>Whether the mod has at least one update key set.</summary>
public bool HasUpdateKeys()
{
return
this.Manifest?.UpdateKeys != null
&& this.Manifest.UpdateKeys.Any(key => !string.IsNullOrWhiteSpace(key));
}
}
}
|
