summaryrefslogtreecommitdiff
path: root/src/SMAPI.Mods.ErrorHandler/ModPatches/PyTkPatcher.cs
blob: f084902a5cbd969afb47fb0770e330bb1bfa5404 (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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
#if SMAPI_DEPRECATED
using System;
using System.Diagnostics.CodeAnalysis;
using System.Reflection;
using HarmonyLib;
using Microsoft.Xna.Framework;
using Microsoft.Xna.Framework.Graphics;
using StardewModdingAPI.Framework;
using StardewModdingAPI.Framework.Content;
using StardewModdingAPI.Internal;
using StardewModdingAPI.Internal.Patching;

//
// This is part of a three-part fix for PyTK 1.23.* and earlier. When removing this, search
// 'Platonymous.Toolkit' to find the other part in SMAPI and Content Patcher.
//

namespace StardewModdingAPI.Mods.ErrorHandler.ModPatches
{
    /// <summary>Harmony patches for the PyTK mod for compatibility with newer SMAPI versions.</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.")]
    [SuppressMessage("ReSharper", "StringLiteralTypo", Justification = "'Platonymous' is part of the mod ID.")]
    internal class PyTkPatcher : BasePatcher
    {
        /*********
        ** Fields
        *********/
        /// <summary>The PyTK mod metadata, if it's installed.</summary>
        private static IModMetadata? PyTk;


        /*********
        ** Public methods
        *********/
        /// <summary>Construct an instance.</summary>
        /// <param name="modRegistry">The mod registry from which to read PyTK metadata.</param>
        public PyTkPatcher(IModRegistry modRegistry)
        {
            IModMetadata? pyTk = (IModMetadata?)modRegistry.Get(@"Platonymous.Toolkit");
            if (pyTk is not null && pyTk.Manifest.Version.IsOlderThan("1.24.0"))
                PyTkPatcher.PyTk = pyTk;
        }

        /// <inheritdoc />
        public override void Apply(Harmony harmony, IMonitor monitor)
        {
            try
            {
                // get mod info
                IModMetadata? pyTk = PyTkPatcher.PyTk;
                if (pyTk is null)
                    return;

                // get patch method
                const string patchMethodName = "PatchImage";
                MethodInfo? patch = AccessTools.Method(pyTk.Mod!.GetType(), patchMethodName);
                if (patch is null)
                {
                    monitor.Log("Failed applying compatibility patch for PyTK. Its image scaling feature may not work correctly.", LogLevel.Warn);
                    monitor.Log($"Couldn't find patch method '{pyTk.Mod.GetType().FullName}.{patchMethodName}'.");
                    return;
                }

                // apply patch
                harmony = new($"{harmony.Id}.compatibility-patches.PyTK");
                harmony.Patch(
                    original: AccessTools.Method(typeof(AssetDataForImage), nameof(AssetDataForImage.PatchImage), new[] { typeof(Texture2D), typeof(Rectangle), typeof(Rectangle), typeof(PatchMode) }),
                    prefix: new HarmonyMethod(patch)
                );
            }
            catch (Exception ex)
            {
                monitor.Log("Failed applying compatibility patch for PyTK. Its image scaling feature may not work correctly.", LogLevel.Warn);
                monitor.Log(ex.GetLogSummary());
            }
        }
    }
}
#endif