GH-1054 Allow clearing only negative potion effects when using /heal command (#1059)

* GH-1054 Allow clearing only negative potion effects when using /heal command

Author: vLuckyyy

buildSrc/src/main/kotlin/Versions.kt

@@ -34,6 +34,8 @@ object Versions {
 
     const val TRIUMPH_GUI = "3.1.12"
 
+    const val XSERIES = "13.3.3"
+
     const val BSTATS = "3.1.0"
 
     const val CAFFEINE = "3.2.2"

eternalcore-core/build.gradle.kts

@@ -49,6 +49,12 @@ eternalShadow {
         "com.eternalcode.multification",
     )
 
+    // XSeries
+    library("com.github.cryptomorin:XSeries:${Versions.XSERIES}")
+    libraryRelocate(
+        "com.cryptomorin.xseries",
+    )
+
     // EternalCode Commons & GitCheck
     library("com.eternalcode:eternalcode-commons-bukkit:${Versions.ETERNALCODE_COMMONS}")
     library("com.eternalcode:eternalcode-commons-adventure:${Versions.ETERNALCODE_COMMONS}")

eternalcore-core/src/main/java/com/eternalcode/core/configuration/implementation/PluginConfiguration.java

@@ -6,6 +6,7 @@
 import com.eternalcode.core.feature.automessage.AutoMessageSettings;
 import com.eternalcode.core.feature.catboy.CatBoySettings;
 import com.eternalcode.core.feature.chat.ChatSettings;
+import com.eternalcode.core.feature.heal.HealConfiguration;
 import com.eternalcode.core.feature.helpop.HelpOpSettings;
 import com.eternalcode.core.feature.jail.JailSettings;
 import com.eternalcode.core.feature.randomteleport.RandomTeleportSettingsImpl;
@@ -154,6 +155,10 @@ public static class Homes {
         };
     }
 
+    @Bean
+    @Description({ " ", "# Settings controlling how player healing works and which potion effects get cleared" })
+    public HealConfiguration heal = new HealConfiguration();
+
     @Description({ " ", "# Awesome sounds" })
     public Sounds sound = new Sounds();
 

eternalcore-core/src/main/java/com/eternalcode/core/feature/heal/HealCommand.java

@@ -1,8 +1,10 @@
 package com.eternalcode.core.feature.heal;
 
 import com.eternalcode.annotations.scan.command.DescriptionDocs;
+import com.eternalcode.core.configuration.implementation.PluginConfiguration;
 import com.eternalcode.core.injector.annotations.Inject;
 import com.eternalcode.core.notice.NoticeService;
+import com.eternalcode.core.util.PotionEffectUtil;
 import com.eternalcode.core.viewer.Viewer;
 import dev.rollczi.litecommands.annotations.argument.Arg;
 import dev.rollczi.litecommands.annotations.command.Command;
@@ -16,10 +18,12 @@
 class HealCommand {
 
     private final NoticeService noticeService;
+    private final HealConfiguration healConfiguration;
 
     @Inject
-    HealCommand(NoticeService noticeService) {
+    HealCommand(NoticeService noticeService, PluginConfiguration pluginConfiguration) {
         this.noticeService = noticeService;
+        this.healConfiguration = pluginConfiguration.heal;
     }
 
     @Execute
@@ -65,6 +69,11 @@ private void heal(Player player) {
         player.setRemainingAir(player.getMaximumAir());
 
         for (PotionEffect effect : player.getActivePotionEffects()) {
+            if (healConfiguration.removeOnlyNegativeEffects) {
+                if (!PotionEffectUtil.isNegativeEffect(effect.getType())) {
+                    continue;
+                }
+            }
             player.removePotionEffect(effect.getType());
         }
     }

eternalcore-core/src/main/java/com/eternalcode/core/feature/heal/HealConfiguration.java

@@ -0,0 +1,14 @@
+package com.eternalcode.core.feature.heal;
+
+import net.dzikoysk.cdn.entity.Contextual;
+import net.dzikoysk.cdn.entity.Description;
+
+@Contextual
+public class HealConfiguration {
+
+    @Description({
+        "If true, only negative potion effects will be removed on heal",
+        "If false, all potion effects will be removed on heal"
+    })
+    public boolean removeOnlyNegativeEffects = true;
+}

eternalcore-core/src/main/java/com/eternalcode/core/util/PotionEffectUtil.java

@@ -0,0 +1,36 @@
+package com.eternalcode.core.util;
+
+import com.cryptomorin.xseries.XPotion;
+import com.cryptomorin.xseries.XTag;
+import org.bukkit.potion.PotionEffectType;
+
+/**
+ * XSeries is controversial, but it provides long-term mappings
+ * that support multiple Minecraft versions reliably.
+ * <p>
+ * This utility uses XPotion from XSeries to detect negative potion effects (debuffs).
+ * It helps keep compatibility and simplifies effect management across versions.
+ * <p>
+ * <u>Important:</u> Because potion effect names have changed between Minecraft versions
+ * from 1.17.1 (our support target) up to 1.21.7 (and later),
+ * I decided to use XSeries to handle these naming differences consistently.
+ * <p>
+ * This special utility class was created to avoid overusing XSeries directly
+ * throughout the codebase and to isolate its usage in one dedicated place.
+ */
+public final class PotionEffectUtil {
+
+    public PotionEffectUtil() {
+        throw new UnsupportedOperationException("This is a utility class and cannot be instantiated");
+    }
+
+    public static boolean isNegativeEffect(PotionEffectType effectType) {
+        if (effectType == null) {
+            return false;
+        }
+
+        XPotion xpotion = XPotion.of(effectType);
+
+        return XTag.DEBUFFS.isTagged(xpotion);
+    }
+}