summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI/Framework/Models
diff options
context:
space:
mode:
Diffstat (limited to 'src/StardewModdingAPI/Framework/Models')
-rw-r--r--src/StardewModdingAPI/Framework/Models/ModDataID.cs (renamed from src/StardewModdingAPI/Framework/Models/ModCompatibilityID.cs)12
-rw-r--r--src/StardewModdingAPI/Framework/Models/ModDataRecord.cs (renamed from src/StardewModdingAPI/Framework/Models/ModCompatibility.cs)6
-rw-r--r--src/StardewModdingAPI/Framework/Models/SConfig.cs4
3 files changed, 11 insertions, 11 deletions
diff --git a/src/StardewModdingAPI/Framework/Models/ModCompatibilityID.cs b/src/StardewModdingAPI/Framework/Models/ModDataID.cs
index 98e70116..5b45b507 100644
--- a/src/StardewModdingAPI/Framework/Models/ModCompatibilityID.cs
+++ b/src/StardewModdingAPI/Framework/Models/ModDataID.cs
@@ -1,10 +1,10 @@
-using System;
+using System;
using Newtonsoft.Json;
namespace StardewModdingAPI.Framework.Models
{
- /// <summary>Uniquely identifies a mod for compatibility checks.</summary>
- internal class ModCompatibilityID
+ /// <summary>Uniquely identifies a mod in SMAPI's internal data.</summary>
+ internal class ModDataID
{
/*********
** Accessors
@@ -23,11 +23,11 @@ namespace StardewModdingAPI.Framework.Models
** Public methods
*********/
/// <summary>Construct an instance.</summary>
- public ModCompatibilityID() { }
+ public ModDataID() { }
/// <summary>Construct an instance.</summary>
- /// <param name="data">The mod ID or a JSON string matching the <see cref="ModCompatibilityID"/> fields.</param>
- public ModCompatibilityID(string data)
+ /// <param name="data">The mod ID or a JSON string matching the <see cref="ModDataID"/> fields.</param>
+ public ModDataID(string data)
{
// JSON can be stuffed into the ID string as a convenience hack to keep JSON mod lists
// formatted readably. The tradeoff is that the format is a bit more magical, but that's
diff --git a/src/StardewModdingAPI/Framework/Models/ModCompatibility.cs b/src/StardewModdingAPI/Framework/Models/ModDataRecord.cs
index 7489a306..d40f2c78 100644
--- a/src/StardewModdingAPI/Framework/Models/ModCompatibility.cs
+++ b/src/StardewModdingAPI/Framework/Models/ModDataRecord.cs
@@ -3,15 +3,15 @@ using StardewModdingAPI.Framework.Serialisation;
namespace StardewModdingAPI.Framework.Models
{
- /// <summary>Metadata about a mod version that SMAPI should assume is compatible or broken, regardless of whether it detects incompatible code.</summary>
- internal class ModCompatibility
+ /// <summary>Metadata about a mod from SMAPI's internal data.</summary>
+ internal class ModDataRecord
{
/*********
** Accessors
*********/
/// <summary>The unique mod IDs.</summary>
[JsonConverter(typeof(SFieldConverter))]
- public ModCompatibilityID[] ID { get; set; }
+ public ModDataID[] ID { get; set; }
/// <summary>The mod name.</summary>
public string Name { get; set; }
diff --git a/src/StardewModdingAPI/Framework/Models/SConfig.cs b/src/StardewModdingAPI/Framework/Models/SConfig.cs
index 720d4a6d..401e1a3a 100644
--- a/src/StardewModdingAPI/Framework/Models/SConfig.cs
+++ b/src/StardewModdingAPI/Framework/Models/SConfig.cs
@@ -21,7 +21,7 @@ namespace StardewModdingAPI.Framework.Models
/// <summary>Whether SMAPI should log more information about the game context.</summary>
public bool VerboseLogging { get; set; }
- /// <summary>A list of mod versions which should be considered compatible or incompatible regardless of whether SMAPI detects incompatible code.</summary>
- public ModCompatibility[] ModCompatibility { get; set; }
+ /// <summary>Extra metadata about mods.</summary>
+ public ModDataRecord[] ModData { get; set; }
}
}