diff options
51 files changed, 229 insertions, 37 deletions
diff --git a/docs/technical-docs.md b/docs/technical-docs.md index 5883ee00..1d69f868 100644 --- a/docs/technical-docs.md +++ b/docs/technical-docs.md @@ -105,8 +105,8 @@ SMAPI uses a small number of conditional compilation constants, which you can se flag | purpose ---- | ------- -`SMAPI_FOR_WINDOWS` | Indicates that SMAPI is being compiled on Windows for players on Windows. Set automatically in `crossplatform.targets`. - +`SMAPI_FOR_WINDOWS` | Whether SMAPI is being compiled on Windows for players on Windows. Set automatically in `crossplatform.targets`. +`SMAPI_3_0_STRICT` | Whether to exclude all deprecated APIs from compilation. This is useful for testing mods for SMAPI 3.0 compatibility. # SMAPI web services ## Overview diff --git a/src/SMAPI.Mods.ConsoleCommands/ModEntry.cs b/src/SMAPI.Mods.ConsoleCommands/ModEntry.cs index 7588043d..30951064 100644 --- a/src/SMAPI.Mods.ConsoleCommands/ModEntry.cs +++ b/src/SMAPI.Mods.ConsoleCommands/ModEntry.cs @@ -29,7 +29,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands helper.ConsoleCommands.Add(command.Name, command.Description, (name, args) => this.HandleCommand(command, name, args)); // hook events - GameEvents.UpdateTick += this.GameEvents_UpdateTick; + helper.Events.GameLoop.UpdateTicked += this.OnUpdateTicked; } @@ -39,7 +39,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands /// <summary>The method invoked when the game updates its state.</summary> /// <param name="sender">The event sender.</param> /// <param name="e">The event arguments.</param> - private void GameEvents_UpdateTick(object sender, EventArgs e) + private void OnUpdateTicked(object sender, EventArgs e) { if (!Context.IsWorldReady) return; diff --git a/src/SMAPI.Tests/Utilities/SemanticVersionTests.cs b/src/SMAPI.Tests/Utilities/SemanticVersionTests.cs index 1782308b..2e7719eb 100644 --- a/src/SMAPI.Tests/Utilities/SemanticVersionTests.cs +++ b/src/SMAPI.Tests/Utilities/SemanticVersionTests.cs @@ -47,7 +47,7 @@ namespace StardewModdingAPI.Tests.Utilities Assert.AreEqual(major, version.MajorVersion, "The major version doesn't match the given value."); Assert.AreEqual(minor, version.MinorVersion, "The minor version doesn't match the given value."); Assert.AreEqual(patch, version.PatchVersion, "The patch version doesn't match the given value."); - Assert.AreEqual(string.IsNullOrWhiteSpace(tag) ? null : tag.Trim(), version.Build, "The tag doesn't match the given value."); + Assert.AreEqual(string.IsNullOrWhiteSpace(tag) ? null : tag.Trim(), version.PrereleaseTag, "The tag doesn't match the given value."); return version.ToString(); } diff --git a/src/SMAPI/Context.cs b/src/SMAPI/Context.cs index c7aed81d..cd1cf1c2 100644 --- a/src/SMAPI/Context.cs +++ b/src/SMAPI/Context.cs @@ -22,7 +22,7 @@ namespace StardewModdingAPI /// <summary>Whether <see cref="IsPlayerFree"/> is true and the player is free to move (e.g. not using a tool).</summary> public static bool CanPlayerMove => Context.IsPlayerFree && Game1.player.CanMove; - /// <summary>Whether the game is currently running the draw loop. This isn't relevant to most mods, since you should use <see cref="GraphicsEvents.OnPostRenderEvent"/> to draw to the screen.</summary> + /// <summary>Whether the game is currently running the draw loop. This isn't relevant to most mods, since you should use <see cref="IDisplayEvents"/> events to draw to the screen.</summary> public static bool IsInDrawLoop { get; internal set; } /// <summary>Whether <see cref="IsWorldReady"/> and the player loaded the save in multiplayer mode (regardless of whether any other players are connected).</summary> diff --git a/src/SMAPI/Events/ContentEvents.cs b/src/SMAPI/Events/ContentEvents.cs index 3bf3881b..99369cae 100644 --- a/src/SMAPI/Events/ContentEvents.cs +++ b/src/SMAPI/Events/ContentEvents.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using StardewModdingAPI.Framework; using StardewModdingAPI.Framework.Events; @@ -46,3 +47,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/ControlEvents.cs b/src/SMAPI/Events/ControlEvents.cs index c50d5bea..5626ff81 100644 --- a/src/SMAPI/Events/ControlEvents.cs +++ b/src/SMAPI/Events/ControlEvents.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using Microsoft.Xna.Framework.Input; using StardewModdingAPI.Framework; @@ -124,3 +125,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/EventArgsClickableMenuChanged.cs b/src/SMAPI/Events/EventArgsClickableMenuChanged.cs index 5e00b86d..a0b903b7 100644 --- a/src/SMAPI/Events/EventArgsClickableMenuChanged.cs +++ b/src/SMAPI/Events/EventArgsClickableMenuChanged.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using StardewValley.Menus; @@ -29,3 +30,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/EventArgsClickableMenuClosed.cs b/src/SMAPI/Events/EventArgsClickableMenuClosed.cs index 65751da7..77db69ea 100644 --- a/src/SMAPI/Events/EventArgsClickableMenuClosed.cs +++ b/src/SMAPI/Events/EventArgsClickableMenuClosed.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using StardewValley.Menus; @@ -24,3 +25,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/EventArgsControllerButtonPressed.cs b/src/SMAPI/Events/EventArgsControllerButtonPressed.cs index 3243b80b..949446e1 100644 --- a/src/SMAPI/Events/EventArgsControllerButtonPressed.cs +++ b/src/SMAPI/Events/EventArgsControllerButtonPressed.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using Microsoft.Xna.Framework; using Microsoft.Xna.Framework.Input; @@ -30,3 +31,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/EventArgsControllerButtonReleased.cs b/src/SMAPI/Events/EventArgsControllerButtonReleased.cs index e05a080b..d6d6d840 100644 --- a/src/SMAPI/Events/EventArgsControllerButtonReleased.cs +++ b/src/SMAPI/Events/EventArgsControllerButtonReleased.cs @@ -1,4 +1,5 @@ -using System; +#if !SMAPI_3_0_STRICT +using System; using Microsoft.Xna.Framework; using Microsoft.Xna.Framework.Input; @@ -30,3 +31,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/EventArgsControllerTriggerPressed.cs b/src/SMAPI/Events/EventArgsControllerTriggerPressed.cs index a2087733..33be2fa3 100644 --- a/src/SMAPI/Events/EventArgsControllerTriggerPressed.cs +++ b/src/SMAPI/Events/EventArgsControllerTriggerPressed.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using Microsoft.Xna.Framework; using Microsoft.Xna.Framework.Input; @@ -35,3 +36,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/EventArgsControllerTriggerReleased.cs b/src/SMAPI/Events/EventArgsControllerTriggerReleased.cs index d2eecbec..e90ff712 100644 --- a/src/SMAPI/Events/EventArgsControllerTriggerReleased.cs +++ b/src/SMAPI/Events/EventArgsControllerTriggerReleased.cs @@ -1,4 +1,5 @@ -using System; +#if !SMAPI_3_0_STRICT +using System; using Microsoft.Xna.Framework; using Microsoft.Xna.Framework.Input; @@ -35,3 +36,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/EventArgsInput.cs b/src/SMAPI/Events/EventArgsInput.cs index 0cafdba5..837de2f8 100644 --- a/src/SMAPI/Events/EventArgsInput.cs +++ b/src/SMAPI/Events/EventArgsInput.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using System.Collections.Generic; @@ -60,3 +61,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/EventArgsIntChanged.cs b/src/SMAPI/Events/EventArgsIntChanged.cs index a018695c..76ec6d08 100644 --- a/src/SMAPI/Events/EventArgsIntChanged.cs +++ b/src/SMAPI/Events/EventArgsIntChanged.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; namespace StardewModdingAPI.Events @@ -28,3 +29,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/EventArgsInventoryChanged.cs b/src/SMAPI/Events/EventArgsInventoryChanged.cs index 3a2354b6..488dd23f 100644 --- a/src/SMAPI/Events/EventArgsInventoryChanged.cs +++ b/src/SMAPI/Events/EventArgsInventoryChanged.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using System.Collections.Generic; using System.Linq; @@ -39,3 +40,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/EventArgsKeyPressed.cs b/src/SMAPI/Events/EventArgsKeyPressed.cs index d9d81e10..6204d821 100644 --- a/src/SMAPI/Events/EventArgsKeyPressed.cs +++ b/src/SMAPI/Events/EventArgsKeyPressed.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using Microsoft.Xna.Framework.Input; @@ -24,3 +25,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/EventArgsKeyboardStateChanged.cs b/src/SMAPI/Events/EventArgsKeyboardStateChanged.cs index 14e397ce..2c3203b1 100644 --- a/src/SMAPI/Events/EventArgsKeyboardStateChanged.cs +++ b/src/SMAPI/Events/EventArgsKeyboardStateChanged.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using Microsoft.Xna.Framework.Input; @@ -29,3 +30,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/EventArgsLevelUp.cs b/src/SMAPI/Events/EventArgsLevelUp.cs index e9a697e7..06c70088 100644 --- a/src/SMAPI/Events/EventArgsLevelUp.cs +++ b/src/SMAPI/Events/EventArgsLevelUp.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using StardewModdingAPI.Enums; @@ -51,3 +52,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/EventArgsLocationBuildingsChanged.cs b/src/SMAPI/Events/EventArgsLocationBuildingsChanged.cs index e8184ebe..25e84722 100644 --- a/src/SMAPI/Events/EventArgsLocationBuildingsChanged.cs +++ b/src/SMAPI/Events/EventArgsLocationBuildingsChanged.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using System.Collections.Generic; using System.Linq; @@ -37,3 +38,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/EventArgsLocationObjectsChanged.cs b/src/SMAPI/Events/EventArgsLocationObjectsChanged.cs index 3bb387d5..9ca2e3e2 100644 --- a/src/SMAPI/Events/EventArgsLocationObjectsChanged.cs +++ b/src/SMAPI/Events/EventArgsLocationObjectsChanged.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using System.Collections.Generic; using System.Linq; @@ -38,3 +39,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/EventArgsLocationsChanged.cs b/src/SMAPI/Events/EventArgsLocationsChanged.cs index 20984f45..1a59e612 100644 --- a/src/SMAPI/Events/EventArgsLocationsChanged.cs +++ b/src/SMAPI/Events/EventArgsLocationsChanged.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using System.Collections.Generic; using System.Linq; @@ -31,3 +32,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/EventArgsMineLevelChanged.cs b/src/SMAPI/Events/EventArgsMineLevelChanged.cs index c82fed35..c63b04e9 100644 --- a/src/SMAPI/Events/EventArgsMineLevelChanged.cs +++ b/src/SMAPI/Events/EventArgsMineLevelChanged.cs @@ -1,4 +1,5 @@ -using System; +#if !SMAPI_3_0_STRICT +using System; namespace StardewModdingAPI.Events { @@ -28,3 +29,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/EventArgsMouseStateChanged.cs b/src/SMAPI/Events/EventArgsMouseStateChanged.cs index 57298164..09f3f759 100644 --- a/src/SMAPI/Events/EventArgsMouseStateChanged.cs +++ b/src/SMAPI/Events/EventArgsMouseStateChanged.cs @@ -1,4 +1,5 @@ -using System; +#if !SMAPI_3_0_STRICT +using System; using Microsoft.Xna.Framework; using Microsoft.Xna.Framework.Input; @@ -40,3 +41,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/EventArgsPlayerWarped.cs b/src/SMAPI/Events/EventArgsPlayerWarped.cs index 93026aea..d1aa1588 100644 --- a/src/SMAPI/Events/EventArgsPlayerWarped.cs +++ b/src/SMAPI/Events/EventArgsPlayerWarped.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using StardewValley; @@ -30,3 +31,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/EventArgsValueChanged.cs b/src/SMAPI/Events/EventArgsValueChanged.cs index 1d25af49..7bfac7a2 100644 --- a/src/SMAPI/Events/EventArgsValueChanged.cs +++ b/src/SMAPI/Events/EventArgsValueChanged.cs @@ -1,4 +1,5 @@ -using System; +#if !SMAPI_3_0_STRICT +using System; namespace StardewModdingAPI.Events { @@ -28,4 +29,5 @@ namespace StardewModdingAPI.Events this.NewValue = newValue; } } -}
\ No newline at end of file +} +#endif diff --git a/src/SMAPI/Events/GameEvents.cs b/src/SMAPI/Events/GameEvents.cs index 13f6bfb0..39b77f99 100644 --- a/src/SMAPI/Events/GameEvents.cs +++ b/src/SMAPI/Events/GameEvents.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using StardewModdingAPI.Framework; using StardewModdingAPI.Framework.Events; @@ -123,3 +124,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/GraphicsEvents.cs b/src/SMAPI/Events/GraphicsEvents.cs index de79e42e..be29bf11 100644 --- a/src/SMAPI/Events/GraphicsEvents.cs +++ b/src/SMAPI/Events/GraphicsEvents.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using StardewModdingAPI.Framework; using StardewModdingAPI.Framework.Events; @@ -121,3 +122,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/InputEvents.cs b/src/SMAPI/Events/InputEvents.cs index 788dde62..255b9c8a 100644 --- a/src/SMAPI/Events/InputEvents.cs +++ b/src/SMAPI/Events/InputEvents.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using StardewModdingAPI.Framework; using StardewModdingAPI.Framework.Events; @@ -57,3 +58,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/LocationEvents.cs b/src/SMAPI/Events/LocationEvents.cs index 4aad5387..e0bcd853 100644 --- a/src/SMAPI/Events/LocationEvents.cs +++ b/src/SMAPI/Events/LocationEvents.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using StardewModdingAPI.Framework; using StardewModdingAPI.Framework.Events; @@ -68,3 +69,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/MenuEvents.cs b/src/SMAPI/Events/MenuEvents.cs index 502ec340..e36cb498 100644 --- a/src/SMAPI/Events/MenuEvents.cs +++ b/src/SMAPI/Events/MenuEvents.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using StardewModdingAPI.Framework; using StardewModdingAPI.Framework.Events; @@ -57,3 +58,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/MineEvents.cs b/src/SMAPI/Events/MineEvents.cs index 617c8013..954c844a 100644 --- a/src/SMAPI/Events/MineEvents.cs +++ b/src/SMAPI/Events/MineEvents.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using StardewModdingAPI.Framework; using StardewModdingAPI.Framework.Events; @@ -46,3 +47,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/MultiplayerEvents.cs b/src/SMAPI/Events/MultiplayerEvents.cs index 14c58031..7e8328a4 100644 --- a/src/SMAPI/Events/MultiplayerEvents.cs +++ b/src/SMAPI/Events/MultiplayerEvents.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using StardewModdingAPI.Framework; using StardewModdingAPI.Framework.Events; @@ -79,3 +80,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/PlayerEvents.cs b/src/SMAPI/Events/PlayerEvents.cs index 4f5f4a37..1193675f 100644 --- a/src/SMAPI/Events/PlayerEvents.cs +++ b/src/SMAPI/Events/PlayerEvents.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using StardewModdingAPI.Framework; using StardewModdingAPI.Framework.Events; @@ -69,3 +70,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/SaveEvents.cs b/src/SMAPI/Events/SaveEvents.cs index 5b83efc8..156d3047 100644 --- a/src/SMAPI/Events/SaveEvents.cs +++ b/src/SMAPI/Events/SaveEvents.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using StardewModdingAPI.Framework; using StardewModdingAPI.Framework.Events; @@ -101,3 +102,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/SpecialisedEvents.cs b/src/SMAPI/Events/SpecialisedEvents.cs index 482ac62e..0dd726e9 100644 --- a/src/SMAPI/Events/SpecialisedEvents.cs +++ b/src/SMAPI/Events/SpecialisedEvents.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using StardewModdingAPI.Framework; using StardewModdingAPI.Framework.Events; @@ -46,3 +47,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Events/TimeEvents.cs b/src/SMAPI/Events/TimeEvents.cs index cca6a056..61491dc8 100644 --- a/src/SMAPI/Events/TimeEvents.cs +++ b/src/SMAPI/Events/TimeEvents.cs @@ -1,3 +1,4 @@ +#if !SMAPI_3_0_STRICT using System; using StardewModdingAPI.Framework; using StardewModdingAPI.Framework.Events; @@ -57,3 +58,4 @@ namespace StardewModdingAPI.Events } } } +#endif diff --git a/src/SMAPI/Framework/Events/EventManager.cs b/src/SMAPI/Framework/Events/EventManager.cs index b9d1c453..0ad85adf 100644 --- a/src/SMAPI/Framework/Events/EventManager.cs +++ b/src/SMAPI/Framework/Events/EventManager.cs @@ -1,5 +1,7 @@ using System.Diagnostics.CodeAnalysis; +#if !SMAPI_3_0_STRICT using Microsoft.Xna.Framework.Input; +#endif using StardewModdingAPI.Events; namespace StardewModdingAPI.Framework.Events @@ -156,6 +158,7 @@ namespace StardewModdingAPI.Framework.Events public readonly ManagedEvent<UnvalidatedUpdateTickedEventArgs> UnvalidatedUpdateTicked; +#if !SMAPI_3_0_STRICT /********* ** Events (old) *********/ @@ -342,6 +345,7 @@ namespace StardewModdingAPI.Framework.Events /// <summary>Raised after the in-game clock changes.</summary> public readonly ManagedEvent<EventArgsIntChanged> Legacy_TimeOfDayChanged; +#endif /********* @@ -354,7 +358,9 @@ namespace StardewModdingAPI.Framework.Events { // create shortcut initialisers ManagedEvent<TEventArgs> ManageEventOf<TEventArgs>(string typeName, string eventName) => new ManagedEvent<TEventArgs>($"{typeName}.{eventName}", monitor, modRegistry); +#if !SMAPI_3_0_STRICT ManagedEvent ManageEvent(string typeName, string eventName) => new ManagedEvent($"{typeName}.{eventName}", monitor, modRegist |