migrate to the new Harmony patch pattern used in my mods

That improves validation and error-handling.

2 files changed, 27 insertions, 28 deletions

diff --git a/src/SMAPI/Patches/Game1Patcher.cs b/src/SMAPI/Patches/Game1Patcher.cs
index 82b13869..173a2055 100644
--- a/src/SMAPI/Patches/Game1Patcher.cs
+++ b/src/SMAPI/Patches/Game1Patcher.cs
@@ -2,19 +2,19 @@ using System;
 using System.Diagnostics.CodeAnalysis;
 using HarmonyLib;
 using StardewModdingAPI.Enums;
-using StardewModdingAPI.Framework.Patching;
 using StardewModdingAPI.Framework.Reflection;
+using StardewModdingAPI.Internal.Patching;
 using StardewValley;
 using StardewValley.Menus;
 using StardewValley.Minigames;
 
 namespace StardewModdingAPI.Patches
 {
-    /// <summary>Harmony patches which notify SMAPI for save creation load stages.</summary>
+    /// <summary>Harmony patches for <see cref="Game1"/> which notify SMAPI for save load stages.</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 Game1Patcher : IHarmonyPatch
+    internal class Game1Patcher : BasePatcher
     {
         /*********
         ** Fields
@@ -42,25 +42,25 @@ namespace StardewModdingAPI.Patches
         }
 
         /// <inheritdoc />
-        public void Apply(Harmony harmony)
+        public override void Apply(Harmony harmony, IMonitor monitor)
         {
             // detect CreatedInitialLocations and SaveAddedLocations
             harmony.Patch(
-                original: AccessTools.Method(typeof(Game1), nameof(Game1.AddModNPCs)),
-                prefix: new HarmonyMethod(this.GetType(), nameof(Game1Patcher.Before_Game1_AddModNPCs))
+                original: this.RequireMethod<Game1>(nameof(Game1.AddModNPCs)),
+                prefix: this.GetHarmonyMethod(nameof(Game1Patcher.Before_AddModNpcs))
             );
 
             // detect CreatedLocations, and track IsInLoadForNewGame
             harmony.Patch(
-                original: AccessTools.Method(typeof(Game1), nameof(Game1.loadForNewGame)),
-                prefix: new HarmonyMethod(this.GetType(), nameof(Game1Patcher.Before_Game1_LoadForNewGame)),
-                postfix: new HarmonyMethod(this.GetType(), nameof(Game1Patcher.After_Game1_LoadForNewGame))
+                original: this.RequireMethod<Game1>(nameof(Game1.loadForNewGame)),
+                prefix: this.GetHarmonyMethod(nameof(Game1Patcher.Before_LoadForNewGame)),
+                postfix: this.GetHarmonyMethod(nameof(Game1Patcher.After_LoadForNewGame))
             );
 
             // detect ReturningToTitle
             harmony.Patch(
-                original: AccessTools.Method(typeof(Game1), nameof(Game1.CleanupReturningToTitle)),
-                prefix: new HarmonyMethod(this.GetType(), nameof(Game1Patcher.Before_Game1_CleanupReturningToTitle))
+                original: this.RequireMethod<Game1>(nameof(Game1.CleanupReturningToTitle)),
+                prefix: this.GetHarmonyMethod(nameof(Game1Patcher.Before_CleanupReturningToTitle))
             );
         }
 
@@ -68,10 +68,10 @@ namespace StardewModdingAPI.Patches
         /*********
         ** Private methods
         *********/
-        /// <summary>Called before <see cref="Game1.AddModNPCs"/>.</summary>
+        /// <summary>The method to call before <see cref="Game1.AddModNPCs"/>.</summary>
         /// <returns>Returns whether to execute the original method.</returns>
         /// <remarks>This method must be static for Harmony to work correctly. See the Harmony documentation before renaming arguments.</remarks>
-        private static bool Before_Game1_AddModNPCs()
+        private static bool Before_AddModNpcs()
         {
             // When this method is called from Game1.loadForNewGame, it happens right after adding the vanilla
             // locations but before initializing them.
@@ -86,27 +86,27 @@ namespace StardewModdingAPI.Patches
             return true;
         }
 
-        /// <summary>Called before <see cref="Game1.CleanupReturningToTitle"/>.</summary>
+        /// <summary>The method to call before <see cref="Game1.CleanupReturningToTitle"/>.</summary>
         /// <returns>Returns whether to execute the original method.</returns>
         /// <remarks>This method must be static for Harmony to work correctly. See the Harmony documentation before renaming arguments.</remarks>
-        private static bool Before_Game1_CleanupReturningToTitle()
+        private static bool Before_CleanupReturningToTitle()
         {
             Game1Patcher.OnStageChanged(LoadStage.ReturningToTitle);
             return true;
         }
 
-        /// <summary>Called before <see cref="Game1.loadForNewGame"/>.</summary>
+        /// <summary>The method to call before <see cref="Game1.loadForNewGame"/>.</summary>
         /// <returns>Returns whether to execute the original method.</returns>
         /// <remarks>This method must be static for Harmony to work correctly. See the Harmony documentation before renaming arguments.</remarks>
-        private static bool Before_Game1_LoadForNewGame()
+        private static bool Before_LoadForNewGame()
         {
             Game1Patcher.IsInLoadForNewGame = true;
             return true;
         }
 
-        /// <summary>Called after <see cref="Game1.loadForNewGame"/>.</summary>
+        /// <summary>The method to call after <see cref="Game1.loadForNewGame"/>.</summary>
         /// <remarks>This method must be static for Harmony to work correctly. See the Harmony documentation before renaming arguments.</remarks>
-        private static void After_Game1_LoadForNewGame()
+        private static void After_LoadForNewGame()
         {
             Game1Patcher.IsInLoadForNewGame = false;
 
diff --git a/src/SMAPI/Patches/TitleMenuPatcher.cs b/src/SMAPI/Patches/TitleMenuPatcher.cs
index a889adfc..b4320ce0 100644
--- a/src/SMAPI/Patches/TitleMenuPatcher.cs
+++ b/src/SMAPI/Patches/TitleMenuPatcher.cs
@@ -2,16 +2,16 @@ using System;
 using System.Diagnostics.CodeAnalysis;
 using HarmonyLib;
 using StardewModdingAPI.Enums;
-using StardewModdingAPI.Framework.Patching;
+using StardewModdingAPI.Internal.Patching;
 using StardewValley.Menus;
 
 namespace StardewModdingAPI.Patches
 {
-    /// <summary>Harmony patches which notify SMAPI for save creation load stages.</summary>
+    /// <summary>Harmony patches for <see cref="TitleMenu"/> which notify SMAPI when a new character was created.</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 TitleMenuPatcher : IHarmonyPatch
+    internal class TitleMenuPatcher : BasePatcher
     {
         /*********
         ** Fields
@@ -31,12 +31,11 @@ namespace StardewModdingAPI.Patches
         }
 
         /// <inheritdoc />
-        public void Apply(Harmony harmony)
+        public override void Apply(Harmony harmony, IMonitor monitor)
         {
-            // detect CreatedBasicInfo
             harmony.Patch(
-                original: AccessTools.Method(typeof(TitleMenu), nameof(TitleMenu.createdNewCharacter)),
-                prefix: new HarmonyMethod(this.GetType(), nameof(TitleMenuPatcher.Before_TitleMenu_CreatedNewCharacter))
+                original: this.RequireMethod<TitleMenu>(nameof(TitleMenu.createdNewCharacter)),
+                prefix: this.GetHarmonyMethod(nameof(TitleMenuPatcher.Before_CreatedNewCharacter))
             );
         }
 
@@ -44,10 +43,10 @@ namespace StardewModdingAPI.Patches
         /*********
         ** Private methods
         *********/
-        /// <summary>Called before <see cref="TitleMenu.createdNewCharacter"/>.</summary>
+        /// <summary>The method to call before <see cref="TitleMenu.createdNewCharacter"/>.</summary>
         /// <returns>Returns whether to execute the original method.</returns>
         /// <remarks>This method must be static for Harmony to work correctly. See the Harmony documentation before renaming arguments.</remarks>
-        private static bool Before_TitleMenu_CreatedNewCharacter()
+        private static bool Before_CreatedNewCharacter()
         {
             TitleMenuPatcher.OnStageChanged(LoadStage.CreatedBasicInfo);
             return true;