Client support for grub hunt goal

Author: BadMagic100

Archipelago.HollowKnight/Archipelago.HollowKnight.csproj

@@ -8,7 +8,7 @@
     <Description>The Archipelago Multiworld client for Hollow Knight</Description>
     <Copyright>
     </Copyright>
-    <Version>0.4.1</Version>
+    <Version>0.4.2</Version>
     <OutputPath>bin\$(Configuration)\</OutputPath>
     <LangVersion>latest</LangVersion>
     <Company>The Archipelago Community</Company>

Archipelago.HollowKnight/Archipelago.cs

@@ -51,6 +51,7 @@ public override string GetVersion()
         public static Archipelago Instance;
         public ArchipelagoSession session { get; private set; }
         public SlotOptions SlotOptions { get; set; }
+        public int GrubHuntRequiredGrubs { get; set; }
         public bool ArchipelagoEnabled { get; set; }
 
         public int Slot { get; private set; }
@@ -111,6 +112,17 @@ public void StartOrResumeGame(bool randomize)
             LogDebug("StartOrResumeGame: This is an Archipelago Game.");
 
             LoginSuccessful loginResult = ConnectToArchipelago();
+            if (loginResult.SlotData.TryGetValue("grub_count", out object objGrubsRequired))
+            {
+                GrubHuntRequiredGrubs = (int)((long) objGrubsRequired);
+            }
+            else
+            {
+                // if not present, it's an older world version so make the goal functionally impossible
+                // (e.g. for Any goal)
+                GrubHuntRequiredGrubs = int.MaxValue;
+            }
+
             if (randomize)
             {
                 LogDebug("StartOrResumeGame: Beginning first time randomization.");

Archipelago.HollowKnight/Goals.cs

@@ -1,9 +1,11 @@
 using Archipelago.HollowKnight.IC.Modules;
 using Archipelago.MultiClient.Net.Exceptions;
 using ItemChanger;
+using MonoMod.RuntimeDetour;
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Reflection;
 using System.Threading.Tasks;
 
 namespace Archipelago.HollowKnight
@@ -16,7 +18,8 @@ public enum GoalsLookup
         Radiance = 3,
         Godhome = 4,
         GodhomeFlower = 5,
-        MAX = GodhomeFlower
+        GrubHunt = 6,
+        MAX = GrubHunt
     }
 
     public abstract class Goal
@@ -30,7 +33,8 @@ public abstract class Goal
             [GoalsLookup.SealedSiblings] = new SealedSiblingsGoal(),
             [GoalsLookup.Radiance] = new RadianceGoal(),
             [GoalsLookup.Godhome] = new GodhomeGoal(),
-            [GoalsLookup.GodhomeFlower] = new GodhomeFlowerGoal()
+            [GoalsLookup.GodhomeFlower] = new GodhomeFlowerGoal(),
+            [GoalsLookup.GrubHunt] = new GrubHuntGoal(),
         };
 
         static Goal()
@@ -206,4 +210,45 @@ public class GodhomeFlowerGoal : EndingGoal
         public override string Description => "Defeat Absolute Radiance in Pantheon 5<br>after delivering the flower to the Godseeker.";
         public override string MinimumGoalScene => SceneNames.Cinematic_Ending_E;
     }
+
+    public class GrubHuntGoal : Goal
+    {
+        public override string Name => "Grub Hunt";
+
+        public override string Description => $"Save {Archipelago.Instance.GrubHuntRequiredGrubs} of your Grubs.";
+
+        private static readonly MethodInfo setIntInternal = typeof(PlayerData).GetMethod("SetIntInternal");
+        private Hook onSetIntInternal;
+        
+        public override void OnSelected()
+        {
+            if (onSetIntInternal == null)
+            {
+                onSetIntInternal = new Hook(setIntInternal, OnSetPlayerInt);
+            }
+            else
+            {
+                onSetIntInternal.Apply();
+            }
+        }
+
+        public override void OnDeselected()
+        {
+            onSetIntInternal.Undo();
+        }
+
+        protected override bool VictoryCondition()
+        {
+            return PlayerData.instance.grubsCollected >= Archipelago.Instance.GrubHuntRequiredGrubs;
+        }
+
+        private async void OnSetPlayerInt(On.PlayerData.orig_SetInt orig, PlayerData self, string intName, int value)
+        {
+            orig(self, intName, value);
+            if (intName == nameof(PlayerData.grubsCollected))
+            {
+                await CheckForVictoryAsync();
+            }
+        }
+    }
 }