summaryrefslogtreecommitdiff
path: root/src/SMAPI/Framework
diff options
context:
space:
mode:
Diffstat (limited to 'src/SMAPI/Framework')
-rw-r--r--src/SMAPI/Framework/IModMetadata.cs13
-rw-r--r--src/SMAPI/Framework/ModLoading/ModMetadata.cs18
2 files changed, 20 insertions, 11 deletions
diff --git a/src/SMAPI/Framework/IModMetadata.cs b/src/SMAPI/Framework/IModMetadata.cs
index 673c5b2e..7bf7d98c 100644
--- a/src/SMAPI/Framework/IModMetadata.cs
+++ b/src/SMAPI/Framework/IModMetadata.cs
@@ -80,14 +80,17 @@ namespace StardewModdingAPI.Framework
/// <param name="api">The mod-provided API.</param>
IModMetadata SetApi(object api);
- /// <summary>Set the update status, indicating no errors happened.</summary>
+ /// <summary>Set the update version.</summary>
/// <param name="latestVersion">The latest version.</param>
+ IModMetadata SetUpdateVersion(ISemanticVersion latestVersion);
+
+ /// <summary>Set the preview update version.</summary>
/// <param name="latestPreviewVersion">The latest preview version.</param>
- IModMetadata SetUpdateStatus(ISemanticVersion latestVersion, ISemanticVersion latestPreviewVersion);
+ IModMetadata SetPreviewUpdateVersion(ISemanticVersion latestPreviewVersion);
- /// <summary>Set the update status, indicating an error happened.</summary>
- /// <param name="updateCheckError">The error checking for updates, if any.</param>
- IModMetadata SetUpdateStatus(string updateCheckError);
+ /// <summary>Set the error that occured while checking for updates.</summary>
+ /// <param name="updateCheckError">The error checking for updates.</param>
+ IModMetadata SetUpdateError(string updateCheckError);
/// <summary>Whether the mod manifest was loaded (regardless of whether the mod itself was loaded).</summary>
bool HasManifest();
diff --git a/src/SMAPI/Framework/ModLoading/ModMetadata.cs b/src/SMAPI/Framework/ModLoading/ModMetadata.cs
index 8f544da3..1ead1387 100644
--- a/src/SMAPI/Framework/ModLoading/ModMetadata.cs
+++ b/src/SMAPI/Framework/ModLoading/ModMetadata.cs
@@ -124,19 +124,25 @@ namespace StardewModdingAPI.Framework.ModLoading
return this;
}
- /// <summary>Set the update status.</summary>
+ /// <summary>Set the update version.</summary>
/// <param name="latestVersion">The latest version.</param>
- /// <param name="latestPreviewVersion">The latest preview version.</param>
- public IModMetadata SetUpdateStatus(ISemanticVersion latestVersion, ISemanticVersion latestPreviewVersion)
+ public IModMetadata SetUpdateVersion(ISemanticVersion latestVersion)
{
this.LatestVersion = latestVersion;
+ return this;
+ }
+
+ /// <summary>Set the preview update version.</summary>
+ /// <param name="latestPreviewVersion">The latest preview version.</param>
+ public IModMetadata SetPreviewUpdateVersion(ISemanticVersion latestPreviewVersion)
+ {
this.LatestPreviewVersion = latestPreviewVersion;
return this;
}
- // <summary>Set the update status, indicating an error happened.</summary>
- /// <param name="updateCheckError">The error checking for updates, if any.</param>
- public IModMetadata SetUpdateStatus(string updateCheckError)
+ /// <summary>Set the error that occured while checking for updates.</summary>
+ /// <param name="updateCheckError">The error checking for updates.</param>
+ public IModMetadata SetUpdateError(string updateCheckError)
{
this.UpdateCheckError = updateCheckError;
return this;