Add notification cooldown, close #33

NotRyken · NotRyken · commit 02d9bd860eb1 · 2025-12-13T10:54:02.000+08:00
diff --git a/changelog.md b/changelog.md
@@ -3,6 +3,7 @@
 ## 2.6.3
 
 - Fixed message parsing breaking on translation strings with indexed placeholders
+- Added a cooldown option for notifications
 
 ## 2.6.2
 
diff --git a/common/src/main/java/dev/terminalmc/chatnotify/ChatNotify.java b/common/src/main/java/dev/terminalmc/chatnotify/ChatNotify.java
@@ -83,6 +83,12 @@ public static void afterClientTick(Minecraft mc) {
         ResponseUtil.tickResponses(mc);
         TimingUtil.tickActions();
 
+        // Cooldowns
+        for (Notification notif : Config.get().getNotifs()) {
+            if (notif.countdown > 0)
+                notif.countdown -= 1;
+        }
+
         // Config reset warning toast
         if (hasResetConfig && mc.screen instanceof TitleScreen) {
             hasResetConfig = false;
diff --git a/common/src/main/java/dev/terminalmc/chatnotify/config/Notification.java b/common/src/main/java/dev/terminalmc/chatnotify/config/Notification.java
@@ -58,6 +58,11 @@ public class Notification implements StringSupplier {
      */
     public transient boolean editing = false;
 
+    /**
+     * The time, in ticks, remaining until this notification is eligible for triggering.
+     */
+    public transient long countdown = 0;
+
     // Options
 
     /**
@@ -84,6 +89,13 @@ public enum CheckOwnMode {
         OFF,
     }
 
+    /**
+     * The time, in ticks, for which this instance should be ineligible for activation after being
+     * activated.
+     */
+    public int cooldown;
+    public static final int cooldownDefault = 0;
+
     /**
      * Whether this instance allows use of inclusion triggers.
      */
@@ -227,6 +239,7 @@ public enum CheckOwnMode {
     Notification(
             boolean enabled,
             CheckOwnMode checkOwnMode,
+            int cooldown,
             boolean inclusionEnabled,
             boolean exclusionEnabled,
             boolean responseEnabled,
@@ -260,6 +273,7 @@ public enum CheckOwnMode {
     ) {
         this.enabled = enabled;
         this.checkOwnMode = checkOwnMode;
+        this.cooldown = cooldown;
         this.inclusionEnabled = inclusionEnabled;
         this.exclusionEnabled = exclusionEnabled;
         this.responseEnabled = responseEnabled;
@@ -300,6 +314,7 @@ static Notification createUser() {
         return new Notification(
                 enabledDefault,
                 CheckOwnMode.values()[0],
+                cooldownDefault,
                 inclusionEnabledDefault,
                 exclusionEnabledDefault,
                 responseEnabledDefault,
@@ -340,6 +355,7 @@ static Notification createBlank(Sound sound, TextStyle textStyle) {
         return new Notification(
                 enabledDefault,
                 CheckOwnMode.values()[0],
+                cooldownDefault,
                 inclusionEnabledDefault,
                 exclusionEnabledDefault,
                 responseEnabledDefault,
@@ -378,7 +394,7 @@ static Notification createBlank(Sound sound, TextStyle textStyle) {
      * user if {@code ownMsg} is {@code true}).
      */
     public boolean canBeTriggered(boolean ownMsg) {
-        if (enabled && !editing) {
+        if (enabled && countdown <= 0 && !editing) {
             if (ownMsg) {
                 return switch (checkOwnMode) {
                     case DEFER -> Config.get().checkOwnMessages;
@@ -546,6 +562,13 @@ public Notification deserialize(
                     silent
             );
 
+            int cooldown = JsonUtil.getOrDefault(
+                    obj,
+                    "cooldown",
+                    cooldownDefault,
+                    silent
+            );
+
             boolean responseEnabled = JsonUtil.getOrDefault(
                     obj,
                     "responseEnabled",
@@ -774,6 +797,7 @@ public Notification deserialize(
             return new Notification(
                     enabled,
                     checkOwnMode,
+                    cooldown,
                     inclusionEnabled,
                     exclusionEnabled,
                     responseEnabled,
diff --git a/common/src/main/java/dev/terminalmc/chatnotify/gui/widget/list/root/notif/MiscOptionList.java b/common/src/main/java/dev/terminalmc/chatnotify/gui/widget/list/root/notif/MiscOptionList.java
@@ -61,6 +61,7 @@ public MiscOptionList(
     @Override
     protected void addEntries() {
         Minecraft mc = Minecraft.getInstance();
+        resetLabelWidth();
 
         addEntry(new OptionList.Entry.Text(
                 entryX,
@@ -72,6 +73,20 @@ protected void addEntries() {
         ));
         addEntry(new Entry.Controls(entryX, entryWidth, entryHeight, notif));
 
+        registerLabel(localized("options", "notif.misc.control.cooldown"));
+        addEntry(new Entry.CustomLabeledMessageReset(
+                dynWideEntryX,
+                dynWideEntryWidth,
+                entryHeight,
+                () -> notif.cooldown,
+                (s) -> notif.cooldown = Integer.parseInt(s.strip()),
+                Notification.cooldownDefault,
+                localized("option", "notif.misc.control.cooldown"),
+                localized("option", "notif.misc.control.cooldown")
+                        .append(".\n")
+                        .append(localized("option", "notif.misc.control.cooldown.tooltip"))
+        ));
+
         addEntry(new OptionList.Entry.Text(
                 entryX,
                 entryWidth,
@@ -189,7 +204,6 @@ protected void addEntries() {
         ));
 
         // register all label texts, so that they are properly aligned
-        resetLabelWidth();
         registerLabel(localized("options", "notif.misc.timing.delay"));
         registerLabel(localized("option", "notif.misc.timing.title_fade_in"));
         registerLabel(localized("option", "notif.misc.timing.title_stay"));
diff --git a/common/src/main/java/dev/terminalmc/chatnotify/util/text/MessageUtil.java b/common/src/main/java/dev/terminalmc/chatnotify/util/text/MessageUtil.java
@@ -304,6 +304,9 @@ private static String checkOwner(String cleanStr) {
                 // Trigger notification
                 anyTriggered = true;
 
+                // Start countdown
+                notif.countdown = notif.cooldown;
+
                 // Play sound
                 if (!anySoundPlayed || Config.get().notifMode.equals(Config.NotifMode.ALL)) {
                     anySoundPlayed = playSound(notif);
diff --git a/common/src/main/resources/assets/chatnotify/lang/en_us.json b/common/src/main/resources/assets/chatnotify/lang/en_us.json
@@ -112,6 +112,8 @@
   "option.chatnotify.notif.list.tooltip": "A notification will be activated when an incoming chat message matches one of the notification's triggers.",
   "option.chatnotify.notif.misc": "Misc",
   "option.chatnotify.notif.misc.control": "Misc Controls",
+  "option.chatnotify.notif.misc.control.cooldown": "Notification cooldown",
+  "option.chatnotify.notif.misc.control.cooldown.tooltip": "Time in ticks the notification should be disabled after being activated.",
   "option.chatnotify.notif.misc.control.self_notify.status.DEFER": "Defer",
   "option.chatnotify.notif.misc.control.self_notify.status.DEFER.tooltip": "Global option will be used.",
   "option.chatnotify.notif.misc.control.self_notify.status.OFF": "Override - OFF",
diff --git a/common/src/main/resources/assets/chatnotify/lang/ru_ru.json b/common/src/main/resources/assets/chatnotify/lang/ru_ru.json
@@ -112,6 +112,8 @@
   "option.chatnotify.notif.list.tooltip": "Уведомление будет активировано, если входящее сообщение в чате соответствует одному из триггеров уведомления.",
   "option.chatnotify.notif.misc": "Дополнительные параметры",
   "option.chatnotify.notif.misc.control": "Дополнительные элементы управления",
+  "option.chatnotify.notif.misc.control.cooldown": "Время между уведомлениями",
+  "option.chatnotify.notif.misc.control.cooldown.tooltip": "Продолжительность (в тиках) между последовательными активациями этого уведомления.",
   "option.chatnotify.notif.misc.control.self_notify.status.DEFER": "Отложить",
   "option.chatnotify.notif.misc.control.self_notify.status.DEFER.tooltip": "Будет использована глобальная настройка.",
   "option.chatnotify.notif.misc.control.self_notify.status.OFF": "Переопределить - ВЫКЛ",
diff --git a/common/src/main/resources/assets/chatnotify/lang/zh_cn.json b/common/src/main/resources/assets/chatnotify/lang/zh_cn.json
@@ -112,6 +112,8 @@
   "option.chatnotify.notif.list.tooltip": "传入消息将激活第一个启用且与触发器匹配的通知",
   "option.chatnotify.notif.misc": "高级选项",
   "option.chatnotify.notif.misc.control": "高级控制",
+  "option.chatnotify.notif.misc.control.cooldown": "Notification cooldown",
+  "option.chatnotify.notif.misc.control.cooldown.tooltip": "Time in ticks the notification should be disabled after being activated.",
   "option.chatnotify.notif.misc.control.self_notify.status.DEFER": "推迟",
   "option.chatnotify.notif.misc.control.self_notify.status.DEFER.tooltip": "将使用全局选项",
   "option.chatnotify.notif.misc.control.self_notify.status.OFF": "覆盖 - 关闭",
diff --git a/common/src/main/resources/assets/chatnotify/lang/zh_tw.json b/common/src/main/resources/assets/chatnotify/lang/zh_tw.json
@@ -112,6 +112,8 @@
   "option.chatnotify.notif.list.tooltip": "傳入訊息將會啟動第一個啟用且觸發條件相符的通知。",
   "option.chatnotify.notif.misc": "進階選項",
   "option.chatnotify.notif.misc.control": "Advanced Controls",
+  "option.chatnotify.notif.misc.control.cooldown": "Notification cooldown",
+  "option.chatnotify.notif.misc.control.cooldown.tooltip": "Time in ticks the notification should be disabled after being activated.",
   "option.chatnotify.notif.misc.control.self_notify.status.DEFER": "Defer",
   "option.chatnotify.notif.misc.control.self_notify.status.DEFER.tooltip": "Global option will be used.",
   "option.chatnotify.notif.misc.control.self_notify.status.OFF": "Override - OFF",
