diff options
| -rw-r--r-- | release-notes.md | 5 | ||||
| -rw-r--r-- | src/StardewModdingAPI/ISemanticVersion.cs | 16 | ||||
| -rw-r--r-- | src/StardewModdingAPI/SemanticVersion.cs | 27 |
3 files changed, 45 insertions, 3 deletions
diff --git a/release-notes.md b/release-notes.md index fe55ed10..628757ae 100644 --- a/release-notes.md +++ b/release-notes.md @@ -20,10 +20,11 @@ For players: * Fixed rare issue where the installer would crash trying to delete a bundled mod from `%appdata%`. For mod developers: +* Mods are now initialised after the `Initialize`/`LoadContent` phase, which means the `GameEvents.Initialize` and `GameEvents.LoadContent` events are deprecated. You can move any logic in those methods to your mod's `Entry` method. +* Mods can now specify a minimum game version in their `manifest.json`. +* Added `IsBetween` and string overloads to the `ISemanticVersion` methods. * Fixed mouse-changed event never updating prior mouse position. * Fixed `monitor.ExitGameImmediately` not working correctly. -* Mods can now specify a minimum game version in their `manifest.json`. -* Mods are now initialised after the `Initialize`/`LoadContent` phase, which means the `GameEvents.Initialize` and `GameEvents.LoadContent` events are deprecated. You can move any logic in those methods to your mod's `Entry` method. ## 1.9 See [log](https://github.com/Pathoschild/SMAPI/compare/1.8...1.9). diff --git a/src/StardewModdingAPI/ISemanticVersion.cs b/src/StardewModdingAPI/ISemanticVersion.cs index 24e6442a..27a2f67d 100644 --- a/src/StardewModdingAPI/ISemanticVersion.cs +++ b/src/StardewModdingAPI/ISemanticVersion.cs @@ -28,15 +28,31 @@ namespace StardewModdingAPI /// <param name="other">The version to compare with this instance.</param> bool IsOlderThan(ISemanticVersion other); + /// <summary>Get whether this version is older than the specified version.</summary> + /// <param name="other">The version to compare with this instance.</param> + /// <exception cref="FormatException">The specified version is not a valid semantic version.</exception> + bool IsOlderThan(string other); + /// <summary>Get whether this version is newer than the specified version.</summary> /// <param name="other">The version to compare with this instance.</param> bool IsNewerThan(ISemanticVersion other); + /// <summary>Get whether this version is newer than the specified version.</summary> + /// <param name="other">The version to compare with this instance.</param> + /// <exception cref="FormatException">The specified version is not a valid semantic version.</exception> + bool IsNewerThan(string other); + /// <summary>Get whether this version is between two specified versions (inclusively).</summary> /// <param name="min">The minimum version.</param> /// <param name="max">The maximum version.</param> bool IsBetween(ISemanticVersion min, ISemanticVersion max); + /// <summary>Get whether this version is between two specified versions (inclusively).</summary> + /// <param name="min">The minimum version.</param> + /// <param name="max">The maximum version.</param> + /// <exception cref="FormatException">One of the specified versions is not a valid semantic version.</exception> + bool IsBetween(string min, string max); + /// <summary>Get a string representation of the version.</summary> string ToString(); } diff --git a/src/StardewModdingAPI/SemanticVersion.cs b/src/StardewModdingAPI/SemanticVersion.cs index f6bfb04d..db25dc11 100644 --- a/src/StardewModdingAPI/SemanticVersion.cs +++ b/src/StardewModdingAPI/SemanticVersion.cs @@ -67,7 +67,7 @@ namespace StardewModdingAPI /// <remarks>The implementation is defined by Semantic Version 2.0 (http://semver.org/).</remarks> public int CompareTo(ISemanticVersion other) { - if(other == null) + if (other == null) throw new ArgumentNullException(nameof(other)); const int same = 0; @@ -127,6 +127,14 @@ namespace StardewModdingAPI return this.CompareTo(other) < 0; } + /// <summary>Get whether this version is older than the specified version.</summary> + /// <param name="other">The version to compare with this instance.</param> + /// <exception cref="FormatException">The specified version is not a valid semantic version.</exception> + public bool IsOlderThan(string other) + { + return this.IsOlderThan(new SemanticVersion(other)); + } + /// <summary>Get whether this version is newer than the specified version.</summary> /// <param name="other">The version to compare with this instance.</param> public bool IsNewerThan(ISemanticVersion other) @@ -134,6 +142,14 @@ namespace StardewModdingAPI return this.CompareTo(other) > 0; } + /// <summary>Get whether this version is newer than the specified version.</summary> + /// <param name="other">The version to compare with this instance.</param> + /// <exception cref="FormatException">The specified version is not a valid semantic version.</exception> + public bool IsNewerThan(string other) + { + return this.IsNewerThan(new SemanticVersion(other)); + } + /// <summary>Get whether this version is between two specified versions (inclusively).</summary> /// <param name="min">The minimum version.</param> /// <param name="max">The maximum version.</param> @@ -142,6 +158,15 @@ namespace StardewModdingAPI return this.CompareTo(min) >= 0 && this.CompareTo(max) <= 0; } + /// <summary>Get whether this version is between two specified versions (inclusively).</summary> + /// <param name="min">The minimum version.</param> + /// <param name="max">The maximum version.</param> + /// <exception cref="FormatException">One of the specified versions is not a valid semantic version.</exception> + public bool IsBetween(string min, string max) + { + return this.IsBetween(new SemanticVersion(min), new SemanticVersion(max)); + } + /// <summary>Get a string representation of the version.</summary> public override string ToString() { |