Fix + Improvement: Hoppity API and Hoppity Visitor Reward (#5201)

Author: DavidArthurCole

src/main/java/at/hannibal2/skyhanni/config/features/event/hoppity/summary/HoppityEventSummaryConfig.kt

@@ -56,6 +56,7 @@ class HoppityEventSummaryConfig {
         MEAL_EGGS_FOUND("§7You found §b45§7/§a47 §6Chocolate Meal Eggs§7."),
         HITMAN_EGGS("§7You recovered §b20§7/§a40 §7missed §6Meal Eggs §7from §cRabbit Hitman§7."),
         HOPPITY_RABBITS_BOUGHT("§7You bought §b7 §fRabbits §7from §aHoppity§7."),
+        VISITOR_RABBITS("§6Hoppity §7gave you §b3 §dRabbits §7on your §aGarden§7."),
         SIDE_DISH_EGGS("§7You found §b4 §6§lSide Dish Eggs §r§7in the §6Chocolate Factory§7."),
         MILESTONE_RABBITS("§7You claimed §b2 §6§lMilestone Rabbits§7."),
         EMPTY_1(""),

src/main/java/at/hannibal2/skyhanni/features/event/hoppity/HoppityApi.kt

@@ -25,6 +25,7 @@ import at.hannibal2.skyhanni.features.event.hoppity.HoppityEggType.Companion.res
 import at.hannibal2.skyhanni.features.event.hoppity.HoppityEggType.HITMAN
 import at.hannibal2.skyhanni.features.event.hoppity.HoppityEggType.SIDE_DISH
 import at.hannibal2.skyhanni.features.event.hoppity.HoppityEggType.STRAY
+import at.hannibal2.skyhanni.features.event.hoppity.HoppityEggType.VISITOR
 import at.hannibal2.skyhanni.features.inventory.chocolatefactory.CFApi
 import at.hannibal2.skyhanni.features.inventory.chocolatefactory.CFBarnManager
 import at.hannibal2.skyhanni.features.inventory.chocolatefactory.stray.CFStrayTracker
@@ -321,7 +322,7 @@ object HoppityApi {
 
             // Each of these have their own from-Hypixel chats, so we don't need to add a message here
             // as it will be handled in the attemptFireRabbitFound method, from the chat event.
-            in resettingEntries, HITMAN, BOUGHT, BOUGHT_ABIPHONE -> null
+            in resettingEntries, HITMAN, BOUGHT, BOUGHT_ABIPHONE, VISITOR -> null
             else -> "§d§lHOPPITY'S HUNT §r§7Unknown Egg Type: §c§l${event.type}"
         }?.let { hoppityDataSet.hoppityMessages.add(it) }
 
@@ -337,6 +338,11 @@ object HoppityApi {
             postApiEggFoundEvent(type, event, note)
         }
 
+        if (IslandType.GARDEN.isCurrent()) HoppityEggsManager.hoppityVisitorAccepted.matchMatcher(event.cleanMessage) {
+            hoppityDataSet.reset()
+            postApiEggFoundEvent(VISITOR, event)
+        }
+
         HoppityEggsManager.hitmanEggFoundPattern.matchMatcher(event.message) {
             hoppityDataSet.reset()
             postApiEggFoundEvent(HITMAN, event)

src/main/java/at/hannibal2/skyhanni/features/event/hoppity/HoppityEggType.kt

@@ -31,7 +31,8 @@ enum class HoppityEggType(
     BOUGHT_ABIPHONE("✆ Bought", "§a", -1),
     CHOCOLATE_SHOP_MILESTONE("Shop Milestone", "§6§l", -1),
     CHOCOLATE_FACTORY_MILESTONE("Chocolate Milestone", "§6§l", -1),
-    STRAY("Stray", "§a", -1)
+    STRAY("Stray", "§a", -1),
+    VISITOR("Visitor", "§d", -1),
     ;
 
     val isResetting get() = resettingEntries.contains(this)

src/main/java/at/hannibal2/skyhanni/features/event/hoppity/HoppityEggsManager.kt

@@ -102,6 +102,14 @@ object HoppityEggsManager {
         "§7§lDUPLICATE RABBIT! §6\\+(?<amount>[\\d,]+) Chocolate",
     )
 
+    /**
+     * REGEX-TEST: [NPC] Hoppity: Simply exquisite! I don't think I'll ever get tired of chocolate.
+     */
+    val hoppityVisitorAccepted by CFApi.patternGroup.pattern(
+        "hoppity.visitor.accepted",
+        "\\[NPC\\] Hoppity: Simply exquisite.+"
+    )
+
     private val noEggsLeftPattern by CFApi.patternGroup.pattern(
         "egg.noneleft",
         "§cThere are no hidden Chocolate Rabbit Eggs nearby! Try again later!",

src/main/java/at/hannibal2/skyhanni/features/event/hoppity/summary/HoppityEventSummary.kt

@@ -371,6 +371,12 @@ object HoppityEventSummary {
                 statList.addStr("§7You bought §b${boughtCount.addSeparators()} §f$rabbitFormat §7from §aHoppity§7.")
             }
 
+            put(HoppityStat.VISITOR_RABBITS) { statList, stats, _ ->
+                val visitorCount = stats.mealsFound[HoppityEggType.VISITOR]?.takeIf { it > 0 } ?: return@put
+                val rabbitFormat = StringUtils.pluralize(visitorCount, "Rabbit")
+                statList.addStr("§6Hoppity §7gave you §b$visitorCount §d$rabbitFormat §r§7on your §aGarden§7.")
+            }
+
             put(HoppityStat.SIDE_DISH_EGGS) { statList, stats, _ ->
                 val sideDishCount = stats.mealsFound[HoppityEggType.SIDE_DISH]?.takeIf { it > 0 } ?: return@put
                 val eggFormat = StringUtils.pluralize(sideDishCount, "Egg")

src/main/java/at/hannibal2/skyhanni/features/inventory/chocolatefactory/stray/CFStrayTimer.kt

@@ -43,8 +43,8 @@ object CFStrayTimer {
         timer = when (event.type) {
             // If a stray is found, the timer is no longer relevant
             HoppityEggType.STRAY -> Duration.ZERO
-            // Only reset the timer for meal entries and hitman eggs
-            in HoppityEggType.resettingEntries, HoppityEggType.HITMAN -> 30.seconds
+            // Only reset the timer for meal entries, and hitman/visitor rabbits
+            in HoppityEggType.resettingEntries, HoppityEggType.HITMAN, HoppityEggType.VISITOR -> 30.seconds
             else -> return
         }
         lastTimerSubtraction = null