Adds nextTier to CombatTaskNotifier

Also updates changeLog, tests, and json-examples
pajlads · Nov 9, 2024 · fb429d9 · fb429d9
1 parent a264b7f
commit fb429d9
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,7 +1,7 @@
 ## Unreleased
 
 - Minor: Remove boss image embed from kill count notifications with screenshots disabled. (#578)
-- Dev: Add current tier and total possible points to combat task metadata. (#586)
+- Dev: Add current tier, total possible points, and next tier to combat task metadata. (#586)
 
 ## 1.10.12
 

diff --git a/docs/json-examples.md b/docs/json-examples.md
@@ -351,7 +351,8 @@ JSON for Combat Achievement Notifications:
     "tierProgress": 517,
     "tierTotalPoints": 645,
     "totalPossiblePoints": 14814,
-    "currentTier": "MASTER"
+    "currentTier": "MASTER",
+    "nextTier": "GRANDMASTER"
   },
   "type": "COMBAT_ACHIEVEMENT"
 }
@@ -370,6 +371,7 @@ JSON for Combat Achievement Tier Completion Notifications:
     "tierProgress": 0,
     "tierTotalPoints": 540,
     "totalPossiblePoints": 14814,
+    "nextTier": "GRANDMASTER",
     "justCompletedTier": "MASTER"
   },
   "type": "COMBAT_ACHIEVEMENT"

diff --git a/src/main/java/dinkplugin/notifiers/CombatTaskNotifier.java b/src/main/java/dinkplugin/notifiers/CombatTaskNotifier.java
@@ -86,7 +86,8 @@ private void handle(CombatAchievementTier tier, String task) {
             int totalPoints = client.getVarbitValue(TOTAL_POINTS_ID);
             int totalPossiblePoints = client.getVarbitValue(GRANDMASTER_TOTAL_POINTS_ID);
 
-            Integer nextUnlockPointsThreshold = cumulativeUnlockPoints.ceilingKey(totalPoints + 1);
+            var nextThreshold = cumulativeUnlockPoints.ceilingEntry(totalPoints + 1);
+            Integer nextUnlockPointsThreshold = nextThreshold != null ? nextThreshold.getKey() : null;
             Map.Entry<Integer, CombatAchievementTier> prev = cumulativeUnlockPoints.floorEntry(totalPoints);
             int prevThreshold = prev != null ? prev.getKey() : 0;
 
@@ -102,6 +103,7 @@ private void handle(CombatAchievementTier tier, String task) {
             CombatAchievementTier completedTier = crossedThreshold ? prev.getValue() : null;
             String completedTierName = completedTier != null ? completedTier.getDisplayName() : "N/A";
             CombatAchievementTier currentTier = crossedThreshold || prev == null ? null : prev.getValue();
+            CombatAchievementTier nextTier = nextThreshold != null ? nextThreshold.getValue() : null;
 
             String player = Utils.getPlayerName(client);
             Template message = Template.builder()
@@ -119,7 +121,7 @@ private void handle(CombatAchievementTier tier, String task) {
                 .type(NotificationType.COMBAT_ACHIEVEMENT)
                 .text(message)
                 .playerName(player)
-                .extra(new CombatAchievementData(tier, task, taskPoints, totalPoints, tierProgress, tierTotalPoints, totalPossiblePoints, currentTier, completedTier))
+                .extra(new CombatAchievementData(tier, task, taskPoints, totalPoints, tierProgress, tierTotalPoints, totalPossiblePoints, currentTier, nextTier, completedTier))
                 .build());
         });
     }

diff --git a/src/main/java/dinkplugin/notifiers/data/CombatAchievementData.java b/src/main/java/dinkplugin/notifiers/data/CombatAchievementData.java
@@ -72,6 +72,12 @@ public class CombatAchievementData extends NotificationData {
     @Nullable
     CombatAchievementTier currentTier;
 
+    /**
+     * The next tier to be unlocked
+     */
+    @Nullable
+    CombatAchievementTier nextTier;
+
     /**
      * The tier whose rewards were just unlocked,
      * <i>if</i> the player just completed the tier.

diff --git a/src/test/java/dinkplugin/notifiers/CombatTaskNotifierTest.java b/src/test/java/dinkplugin/notifiers/CombatTaskNotifierTest.java
@@ -73,7 +73,7 @@ void testNotify() {
                         .replacement("{{task}}", Replacements.ofWiki("Whack-a-Mole"))
                         .build()
                 )
-                .extra(new CombatAchievementData(CombatAchievementTier.HARD, "Whack-a-Mole", 3, 200, 85, 189, 2005,  CombatAchievementTier.MEDIUM, null))
+                .extra(new CombatAchievementData(CombatAchievementTier.HARD, "Whack-a-Mole", 3, 200, 85, 189, 2005,  CombatAchievementTier.MEDIUM, CombatAchievementTier.HARD, null))
                 .playerName(PLAYER_NAME)
                 .type(NotificationType.COMBAT_ACHIEVEMENT)
                 .build()
@@ -100,7 +100,7 @@ void testNotifyUnlock() {
             false,
             NotificationBody.builder()
                 .text(buildUnlockTemplate("Master", "No Pressure"))
-                .extra(new CombatAchievementData(CombatAchievementTier.GRANDMASTER, "No Pressure", 6, 1466, 1466 - 1465, 2005 - 1465, 2005, null, CombatAchievementTier.MASTER))
+                .extra(new CombatAchievementData(CombatAchievementTier.GRANDMASTER, "No Pressure", 6, 1466, 1466 - 1465, 2005 - 1465, 2005, null, CombatAchievementTier.GRANDMASTER, CombatAchievementTier.MASTER))
                 .playerName(PLAYER_NAME)
                 .type(NotificationType.COMBAT_ACHIEVEMENT)
                 .build()
@@ -127,7 +127,7 @@ void testNotifyUnlockGrand() {
             false,
             NotificationBody.builder()
                 .text(buildUnlockTemplate("Grandmaster", "No Pressure"))
-                .extra(new CombatAchievementData(CombatAchievementTier.GRANDMASTER, "No Pressure", 6, 2005, null, null, 2005, null, CombatAchievementTier.GRANDMASTER))
+                .extra(new CombatAchievementData(CombatAchievementTier.GRANDMASTER, "No Pressure", 6, 2005, null, null, 2005, null, null, CombatAchievementTier.GRANDMASTER))
                 .playerName(PLAYER_NAME)
                 .type(NotificationType.COMBAT_ACHIEVEMENT)
                 .build()