Merge branch 'develop' into stable

11 files changed, 25 insertions, 125 deletions

diff --git a/src/SMAPI.Mods.ErrorHandler/ModEntry.cs b/src/SMAPI.Mods.ErrorHandler/ModEntry.cs
index 067f6a8d..bfbfd2dc 100644
--- a/src/SMAPI.Mods.ErrorHandler/ModEntry.cs
+++ b/src/SMAPI.Mods.ErrorHandler/ModEntry.cs
@@ -30,7 +30,6 @@ namespace StardewModdingAPI.Mods.ErrorHandler
             // apply patches
             HarmonyPatcher.Apply(this.ModManifest.UniqueID, this.Monitor,
                 new DialoguePatcher(monitorForGame, this.Helper.Reflection),
-                new DictionaryPatcher(this.Helper.Reflection),
                 new EventPatcher(monitorForGame),
                 new GameLocationPatcher(monitorForGame),
                 new IClickableMenuPatcher(),
@@ -58,7 +57,7 @@ namespace StardewModdingAPI.Mods.ErrorHandler
         /// <summary>The method invoked when a save is loaded.</summary>
         /// <param name="sender">The event sender.</param>
         /// <param name="e">The event arguments.</param>
-        private void OnSaveLoaded(object sender, SaveLoadedEventArgs e)
+        private void OnSaveLoaded(object? sender, SaveLoadedEventArgs e)
         {
             // show in-game warning for removed save content
             if (this.IsSaveContentRemoved)
@@ -81,7 +80,7 @@ namespace StardewModdingAPI.Mods.ErrorHandler
             MethodInfo getMonitorForGame = coreType.GetMethod("GetMonitorForGame")
                 ?? throw new InvalidOperationException("Can't access the SMAPI's 'GetMonitorForGame' method. This mod may not work correctly.");
 
-            return (IMonitor)getMonitorForGame.Invoke(core, new object[0]) ?? this.Monitor;
+            return (IMonitor?)getMonitorForGame.Invoke(core, Array.Empty<object>()) ?? this.Monitor;
         }
     }
 }
diff --git a/src/SMAPI.Mods.ErrorHandler/Patches/DialoguePatcher.cs b/src/SMAPI.Mods.ErrorHandler/Patches/DialoguePatcher.cs
index 7a3af39c..e98eec3c 100644
--- a/src/SMAPI.Mods.ErrorHandler/Patches/DialoguePatcher.cs
+++ b/src/SMAPI.Mods.ErrorHandler/Patches/DialoguePatcher.cs
@@ -17,10 +17,10 @@ namespace StardewModdingAPI.Mods.ErrorHandler.Patches
         ** Fields
         *********/
         /// <summary>Writes messages to the console and log file on behalf of the game.</summary>
-        private static IMonitor MonitorForGame;
+        private static IMonitor MonitorForGame = null!;
 
         /// <summary>Simplifies access to private code.</summary>
-        private static IReflectionHelper Reflection;
+        private static IReflectionHelper Reflection = null!;
 
 
         /*********
@@ -54,12 +54,12 @@ namespace StardewModdingAPI.Mods.ErrorHandler.Patches
         /// <param name="speaker">The NPC for which the dialogue is being parsed.</param>
         /// <param name="__exception">The exception thrown by the wrapped method, if any.</param>
         /// <returns>Returns the exception to throw, if any.</returns>
-        private static Exception Finalize_Constructor(Dialogue __instance, string masterDialogue, NPC speaker, Exception __exception)
+        private static Exception? Finalize_Constructor(Dialogue __instance, string masterDialogue, NPC? speaker, Exception? __exception)
         {
             if (__exception != null)
             {
                 // log message
-                string name = !string.IsNullOrWhiteSpace(speaker?.Name) ? speaker.Name : null;
+                string? name = !string.IsNullOrWhiteSpace(speaker?.Name) ? speaker.Name : null;
                 DialoguePatcher.MonitorForGame.Log($"Failed parsing dialogue string{(name != null ? $" for {name}" : "")}:\n{masterDialogue}\n{__exception.GetLogSummary()}", LogLevel.Error);
 
                 // set default dialogue
diff --git a/src/SMAPI.Mods.ErrorHandler/Patches/DictionaryPatcher.cs b/src/SMAPI.Mods.ErrorHandler/Patches/DictionaryPatcher.cs
deleted file mode 100644
index 8ceafcc5..00000000
--- a/src/SMAPI.Mods.ErrorHandler/Patches/DictionaryPatcher.cs
+++ /dev/null
@@ -1,98 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Diagnostics.CodeAnalysis;
-using HarmonyLib;
-using StardewModdingAPI.Internal.Patching;
-using StardewValley.GameData;
-using StardewValley.GameData.HomeRenovations;
-using StardewValley.GameData.Movies;
-
-namespace StardewModdingAPI.Mods.ErrorHandler.Patches
-{
-    /// <summary>Harmony patches for <see cref="Dictionary{TKey,TValue}"/> which add the accessed key to <see cref="KeyNotFoundException"/> exceptions.</summary>
-    /// <remarks>Patch methods must be static for Harmony to work correctly. See the Harmony documentation before renaming patch arguments.</remarks>
-    [SuppressMessage("ReSharper", "InconsistentNaming", Justification = "Argument names are defined by Harmony and methods are named for clarity.")]
-    [SuppressMessage("ReSharper", "IdentifierTypo", Justification = "Argument names are defined by Harmony and methods are named for clarity.")]
-    internal class DictionaryPatcher : BasePatcher
-    {
-        /*********
-        ** Fields
-        *********/
-        /// <summary>Simplifies access to private code.</summary>
-        private static IReflectionHelper Reflection;
-
-
-        /*********
-        ** Public methods
-        *********/
-        /// <summary>Construct an instance.</summary>
-        /// <param name="reflector">Simplifies access to private code.</param>
-        public DictionaryPatcher(IReflectionHelper reflector)
-        {
-            DictionaryPatcher.Reflection = reflector;
-        }
-
-        /// <inheritdoc />
-        public override void Apply(Harmony harmony, IMonitor monitor)
-        {
-            Type[] keyTypes = { typeof(int), typeof(string) };
-            Type[] valueTypes = { typeof(int), typeof(string), typeof(HomeRenovation), typeof(MovieData), typeof(SpecialOrderData) };
-
-            foreach (Type keyType in keyTypes)
-            {
-                foreach (Type valueType in valueTypes)
-                {
-                    Type dictionaryType = typeof(Dictionary<,>).MakeGenericType(keyType, valueType);
-
-                    harmony.Patch(
-                        original: AccessTools.Method(dictionaryType, "get_Item") ?? throw new InvalidOperationException($"Can't find method {PatchHelper.GetMethodString(dictionaryType, "get_Item")} to patch."),
-                        finalizer: this.GetHarmonyMethod(nameof(DictionaryPatcher.Finalize_GetItem))
-                    );
-
-                    harmony.Patch(
-                        original: AccessTools.Method(dictionaryType, "Add") ?? throw new InvalidOperationException($"Can't find method {PatchHelper.GetMethodString(dictionaryType, "Add")} to patch."),
-                        finalizer: this.GetHarmonyMethod(nameof(DictionaryPatcher.Finalize_Add))
-                    );
-                }
-            }
-        }
-
-
-        /*********
-        ** Private methods
-        *********/
-        /// <summary>The method to call after the dictionary indexer throws an exception.</summary>
-        /// <param name="key">The dictionary key being fetched.</param>
-        /// <param name="__exception">The exception thrown by the wrapped method, if any.</param>
-        /// <returns>Returns the exception to throw, if any.</returns>
-        private static Exception Finalize_GetItem(object key, Exception __exception)
-        {
-            if (__exception is KeyNotFoundException)
-                DictionaryPatcher.AddKey(__exception, key);
-
-            return __exception;
-        }
-
-        /// <summary>The method to call after a dictionary insert throws an exception.</summary>
-        /// <param name="key">The dictionary key being inserted.</param>
-        /// <param name="__exception">The exception thrown by the wrapped method, if any.</param>
-        /// <returns>Returns the exception to throw, if any.</returns>
-        private static Exception Finalize_Add(object key, Exception __exception)
-        {
-            if (__exception is ArgumentException)
-                DictionaryPatcher.AddKey(__exception, key);
-
-            return __exception;
-        }
-
-        /// <summary>Add the dictionary key to an exception message.</summary>
-        /// <param name="exception">The exception whose message to edit.</param>
-        /// <param name="key">The dictionary key.</param>
-        private static void AddKey(Exception exception, object key)
-        {
-            DictionaryPatcher.Reflection
-                .GetField<string>(exception, "_message")
-                .SetValue($"{exception.Message}\nkey: '{key}'");
-        }
-    }
-}
diff --git a/src/SMAPI.Mods.ErrorHandler/Patches/EventPatcher.cs b/src/SMAPI.Mods.ErrorHandler/Patches/EventPatcher.cs
index 1b706147..073c62cc 100644
--- a/src/SMAPI.Mods.ErrorHandler/Patches/EventPatcher.cs
+++ b/src/SMAPI.Mods.ErrorHandler/Patches/EventPatcher.cs
@@ -16,7 +16,7 @@ namespace StardewModdingAPI.Mods.ErrorHandler.Patches
         ** Fields
         *********/
         /// <summary>Writes messages to the console and log file on behalf of the game.</summary>
-        private static IMonitor MonitorForGame;
+        private static IMonitor MonitorForGame = null!;
 
 
         /*********
diff --git a/src/SMAPI.Mods.ErrorHandler/Patches/GameLocationPatcher.cs b/src/SMAPI.Mods.ErrorHandler/Patches/GameLocationPatcher.cs
index 7df6b0a2..9247fa48 100644
--- a/src/SMAPI.Mods.ErrorHandler/Patches/GameLocationPatcher.cs
+++ b/src/SMAPI.Mods.ErrorHandler/Patches/GameLocationPatcher.cs
@@ -17,8 +17,7 @@ namespace StardewModdingAPI.Mods.ErrorHandler.Patches
         ** Fields
         *********/
         /// <summary>Writes messages to the console and log file on behalf of the game.</summary>
-        private static IMonitor MonitorForGame;
-
+        private static IMonitor MonitorForGame = null!;
 
         /*********
         ** Public methods
@@ -52,7 +51,7 @@ namespace StardewModdingAPI.Mods.ErrorHandler.Patches
         /// <param name="precondition">The precondition to be parsed.</param>
         /// <param name="__exception">The exception thrown by the wrapped method, if any.</param>
         /// <returns>Returns the exception to throw, if any.</returns>
-        private static Exception Finalize_CheckEventPrecondition(ref int __result, string precondition, Exception __exception)
+        private static Exception? Finalize_CheckEventPrecondition(ref int __result, string precondition, Exception? __exception)
         {
             if (__exception != null)
             {
@@ -68,7 +67,7 @@ namespace StardewModdingAPI.Mods.ErrorHandler.Patches
         /// <param name="map">The map whose tilesheets to update.</param>
         /// <param name="__exception">The exception thrown by the wrapped method, if any.</param>
         /// <returns>Returns the exception to throw, if any.</returns>
-        private static Exception Finalize_UpdateSeasonalTileSheets(GameLocation __instance, Map map, Exception __exception)
+        private static Exception? Finalize_UpdateSeasonalTileSheets(GameLocation __instance, Map map, Exception? __exception)
         {
             if (__exception != null)
                 GameLocationPatcher.MonitorForGame.Log($"Failed updating seasonal tilesheets for location '{__instance.NameOrUniqueName}': \n{__exception}", LogLevel.Error);
diff --git a/src/SMAPI.Mods.ErrorHandler/Patches/NpcPatcher.cs b/src/SMAPI.Mods.ErrorHandler/Patches/NpcPatcher.cs
index 275bb5bf..11f7ec69 100644
--- a/src/SMAPI.Mods.ErrorHandler/Patches/NpcPatcher.cs
+++ b/src/SMAPI.Mods.ErrorHandler/Patches/NpcPatcher.cs
@@ -18,7 +18,7 @@ namespace StardewModdingAPI.Mods.ErrorHandler.Patches
         ** Fields
         *********/
         /// <summary>Writes messages to the console and log file on behalf of the game.</summary>
-        private static IMonitor MonitorForGame;
+        private static IMonitor MonitorForGame = null!;
 
 
         /*********
@@ -54,7 +54,7 @@ namespace StardewModdingAPI.Mods.ErrorHandler.Patches
         /// <param name="__result">The return value of the original method.</param>
         /// <param name="__exception">The exception thrown by the wrapped method, if any.</param>
         /// <returns>Returns the exception to throw, if any.</returns>
-        private static Exception Finalize_CurrentDialogue(NPC __instance, ref Stack<Dialogue> __result, Exception __exception)
+        private static Exception? Finalize_CurrentDialogue(NPC __instance, ref Stack<Dialogue> __result, Exception? __exception)
         {
             if (__exception == null)
                 return null;
@@ -71,7 +71,7 @@ namespace StardewModdingAPI.Mods.ErrorHandler.Patches
         /// <param name="__result">The patched method's return value.</param>
         /// <param name="__exception">The exception thrown by the wrapped method, if any.</param>
         /// <returns>Returns the exception to throw, if any.</returns>
-        private static Exception Finalize_ParseMasterSchedule(string rawData, NPC __instance, ref Dictionary<int, SchedulePathDescription> __result, Exception __exception)
+        private static Exception? Finalize_ParseMasterSchedule(string rawData, NPC __instance, ref Dictionary<int, SchedulePathDescription> __result, Exception? __exception)
         {
             if (__exception != null)
             {
diff --git a/src/SMAPI.Mods.ErrorHandler/Patches/ObjectPatcher.cs b/src/SMAPI.Mods.ErrorHandler/Patches/ObjectPatcher.cs
index fd4ea35c..09a6fbbd 100644
--- a/src/SMAPI.Mods.ErrorHandler/Patches/ObjectPatcher.cs
+++ b/src/SMAPI.Mods.ErrorHandler/Patches/ObjectPatcher.cs
@@ -57,7 +57,7 @@ namespace StardewModdingAPI.Mods.ErrorHandler.Patches
         /// <param name="__result">The patched method's return value.</param>
         /// <param name="__exception">The exception thrown by the wrapped method, if any.</param>
         /// <returns>Returns the exception to throw, if any.</returns>
-        private static Exception Finalize_Object_loadDisplayName(ref string __result, Exception __exception)
+        private static Exception? Finalize_Object_loadDisplayName(ref string __result, Exception? __exception)
         {
             if (__exception is KeyNotFoundException)
             {
diff --git a/src/SMAPI.Mods.ErrorHandler/Patches/SaveGamePatcher.cs b/src/SMAPI.Mods.ErrorHandler/Patches/SaveGamePatcher.cs
index 0a7ed212..490bbfb6 100644
--- a/src/SMAPI.Mods.ErrorHandler/Patches/SaveGamePatcher.cs
+++ b/src/SMAPI.Mods.ErrorHandler/Patches/SaveGamePatcher.cs
@@ -22,10 +22,10 @@ namespace StardewModdingAPI.Mods.ErrorHandler.Patches
         ** Fields
         *********/
         /// <summary>Writes messages to the console and log file.</summary>
-        private static IMonitor Monitor;
+        private static IMonitor Monitor = null!;
 
         /// <summary>A callback invoked when custom content is removed from the save data to avoid a crash.</summary>
-        private static Action OnContentRemoved;
+        private static Action OnContentRemoved = null!;
 
 
         /*********
@@ -74,10 +74,10 @@ namespace StardewModdingAPI.Mods.ErrorHandler.Patches
         /// <summary>The method to call after <see cref="SaveGame.LoadFarmType"/> throws an exception.</summary>
         /// <param name="__exception">The exception thrown by the wrapped method, if any.</param>
         /// <returns>Returns the exception to throw, if any.</returns>
-        private static Exception Finalize_LoadFarmType(Exception __exception)
+        private static Exception? Finalize_LoadFarmType(Exception? __exception)
         {
             // missing custom farm type
-            if (__exception?.Message?.Contains("not a valid farm type") == true && !int.TryParse(SaveGame.loaded.whichFarm, out _))
+            if (__exception?.Message.Contains("not a valid farm type") == true && !int.TryParse(SaveGame.loaded.whichFarm, out _))
             {
                 SaveGamePatcher.Monitor.Log(__exception.GetLogSummary(), LogLevel.Error);
                 SaveGamePatcher.Monitor.Log($"Removed invalid custom farm type '{SaveGame.loaded.whichFarm}' to avoid a crash when loading save '{Constants.SaveFolderName}'. (Did you remove a custom farm type mod?)", LogLevel.Warn);
@@ -108,7 +108,7 @@ namespace StardewModdingAPI.Mods.ErrorHandler.Patches
         /// <summary>Remove content which no longer exists in the game data.</summary>
         /// <param name="location">The current game location.</param>
         /// <param name="npcs">The NPC data.</param>
-        private static bool RemoveBrokenContent(GameLocation location, IDictionary<string, string> npcs)
+        private static bool RemoveBrokenContent(GameLocation? location, IDictionary<string, string> npcs)
         {
             bool removedAny = false;
             if (location == null)
@@ -121,7 +121,7 @@ namespace StardewModdingAPI.Mods.ErrorHandler.Patches
                 {
                     try
                     {
-                        BluePrint _ = new BluePrint(building.buildingType.Value);
+                        BluePrint _ = new(building.buildingType.Value);
                     }
                     catch (ContentLoadException)
                     {
diff --git a/src/SMAPI.Mods.ErrorHandler/Patches/SpriteBatchPatcher.cs b/src/SMAPI.Mods.ErrorHandler/Patches/SpriteBatchPatcher.cs
index f243c6d1..d369e0ef 100644
--- a/src/SMAPI.Mods.ErrorHandler/Patches/SpriteBatchPatcher.cs
+++ b/src/SMAPI.Mods.ErrorHandler/Patches/SpriteBatchPatcher.cs
@@ -28,9 +28,9 @@ namespace StardewModdingAPI.Mods.ErrorHandler.Patches
         /*********
         ** Private methods
         *********/
-        /// <summary>The method to call after <see cref="SpriteBatch.CheckValid"/>.</summary>
+        /// <summary>The method to call after <see cref="SpriteBatch.CheckValid(Texture2D)"/>.</summary>
         /// <param name="texture">The texture to validate.</param>
-        private static void After_CheckValid(Texture2D texture)
+        private static void After_CheckValid(Texture2D? texture)
         {
             if (texture?.IsDisposed == true)
                 throw new ObjectDisposedException("Cannot draw this texture because it's disposed.");
diff --git a/src/SMAPI.Mods.ErrorHandler/Patches/UtilityPatcher.cs b/src/SMAPI.Mods.ErrorHandler/Patches/UtilityPatcher.cs
index ce85d0c2..6d75a581 100644
--- a/src/SMAPI.Mods.ErrorHandler/Patches/UtilityPatcher.cs
+++ b/src/SMAPI.Mods.ErrorHandler/Patches/UtilityPatcher.cs
@@ -33,7 +33,7 @@ namespace StardewModdingAPI.Mods.ErrorHandler.Patches
         /// <param name="delimiter">The delimiter by which to split the text description.</param>
         /// <param name="__exception">The exception thrown by the wrapped method, if any.</param>
         /// <returns>Returns the exception to throw, if any.</returns>
-        private static Exception Finalize_GetItemFromStandardTextDescription(string description, char delimiter, ref Exception __exception)
+        private static Exception? Finalize_GetItemFromStandardTextDescription(string description, char delimiter, ref Exception? __exception)
         {
             return __exception != null
                 ? new FormatException($"Failed to parse item text description \"{description}\" with delimiter \"{delimiter}\".", __exception)
diff --git a/src/SMAPI.Mods.ErrorHandler/manifest.json b/src/SMAPI.Mods.ErrorHandler/manifest.json
index 11bc0b42..c082bf75 100644
--- a/src/SMAPI.Mods.ErrorHandler/manifest.json
+++ b/src/SMAPI.Mods.ErrorHandler/manifest.json
@@ -1,9 +1,9 @@
 {
     "Name": "Error Handler",
     "Author": "SMAPI",
-    "Version": "3.13.4",
+    "Version": "3.14.0",
     "Description": "Handles some common vanilla errors to log more useful info or avoid breaking the game.",
     "UniqueID": "SMAPI.ErrorHandler",
     "EntryDll": "ErrorHandler.dll",
-    "MinimumApiVersion": "3.13.4"
+    "MinimumApiVersion": "3.14.0"
 }