summaryrefslogtreecommitdiff
path: root/src/SMAPI/Patches/SaveGamePatcher.cs
blob: 969c514e4fdb0e08ffb4e8ac0d4d5cefd72eb27f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
using System;
using System.Diagnostics.CodeAnalysis;
using HarmonyLib;
using StardewModdingAPI.Internal.Patching;
using StardewValley;
using StardewValley.Menus;

namespace StardewModdingAPI.Patches
{
    /// <summary>Harmony patches for <see cref="SaveGame"/> which track the last loaded save ID.</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 SaveGamePatcher : BasePatcher
    {
        /*********
        ** Fields
        *********/
        /// <summary>A callback to invoke when a save file is being loaded.</summary>
        private static Action<string> OnSaveFileReading;


        /*********
        ** Public methods
        *********/
        /// <summary>Construct an instance.</summary>
        /// <param name="onSaveFileReading">A callback to invoke when a save file is being loaded.</param>
        public SaveGamePatcher(Action<string> onSaveFileReading)
        {
            SaveGamePatcher.OnSaveFileReading = onSaveFileReading;
        }

        /// <inheritdoc />
        public override void Apply(Harmony harmony, IMonitor monitor)
        {
            harmony.Patch(
                original: this.RequireMethod<SaveGame>(nameof(SaveGame.getLoadEnumerator)),
                prefix: this.GetHarmonyMethod(nameof(SaveGamePatcher.Before_GetLoadEnumerator))
            );
        }


        /*********
        ** Private methods
        *********/
        /// <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_GetLoadEnumerator(string file)
        {
            SaveGamePatcher.OnSaveFileReading(file);
            return true;
        }
    }
}