Add new mode for void protection & implement it for more multis (#2024)

* Void protection improvements

* Rename methods: isXXXButtonEnabled -> supportsXXX

* Adjust texture for forbidden

* Add MultiBlockFeatureSupportDumpers

* Fix oversight in PCBFactory

* Revert void protection support for PA

* Rename class: ControllerWithButtons -> ControllerWithOptionalFeatures

2 files changed, 79 insertions, 1 deletions

diff --git a/src/main/java/gregtech/api/enums/GT_Values.java b/src/main/java/gregtech/api/enums/GT_Values.java
index 3d4180667a..d494c5b64c 100644
--- a/src/main/java/gregtech/api/enums/GT_Values.java
+++ b/src/main/java/gregtech/api/enums/GT_Values.java
@@ -343,7 +343,7 @@ public class GT_Values {
             UPGRADE_TANKS_COUNT = "gt.tankcount.upg", // Int
             UPGRADE_TANKS_PREFIX = "gt.tank.upg", // NBT Tag
             SEPARATE_INPUTS = "gt.separate.inputs", // Boolean
-            VOID_EXCESS = "gt.void.excess", // Boolean
+            VOIDING_MODE = "gt.voiding.mode", // String
             BATCH_MODE = "gt.batch.mode", // Boolean
             RECIPE_LOCK = "gt.recipe.lock", // Boolean
 
diff --git a/src/main/java/gregtech/api/enums/VoidingMode.java b/src/main/java/gregtech/api/enums/VoidingMode.java
new file mode 100644
index 0000000000..47f837daac
--- /dev/null
+++ b/src/main/java/gregtech/api/enums/VoidingMode.java
@@ -0,0 +1,78 @@
+package gregtech.api.enums;
+
+import javax.annotation.Nonnull;
+
+import com.gtnewhorizons.modularui.api.drawable.UITexture;
+
+import gregtech.api.gui.modularui.GT_UITextures;
+
+public enum VoidingMode {
+
+    /**
+     * Voids nothing, protects both item and fluid
+     */
+    VOID_NONE(true, true, GT_UITextures.BUTTON_STANDARD, GT_UITextures.OVERLAY_BUTTON_VOID_EXCESS_NONE, "none"),
+    /**
+     * Voids item, protects fluid
+     */
+    VOID_ITEM(false, true, GT_UITextures.BUTTON_STANDARD_PRESSED, GT_UITextures.OVERLAY_BUTTON_VOID_EXCESS_ITEM,
+        "item"),
+    /**
+     * Voids fluid, protects item
+     */
+    VOID_FLUID(true, false, GT_UITextures.BUTTON_STANDARD_PRESSED, GT_UITextures.OVERLAY_BUTTON_VOID_EXCESS_FLUID,
+        "fluid"),
+    /**
+     * Voids all, protects nothing
+     */
+    VOID_ALL(false, false, GT_UITextures.BUTTON_STANDARD_PRESSED, GT_UITextures.OVERLAY_BUTTON_VOID_EXCESS_ALL, "all");
+
+    public final boolean protectItem;
+    public final boolean protectFluid;
+    public final UITexture buttonTexture;
+    public final UITexture buttonOverlay;
+    public final String name;
+
+    VoidingMode(boolean protectItem, boolean protectFluid, UITexture buttonTexture, UITexture buttonOverlay,
+        String name) {
+        this.protectItem = protectItem;
+        this.protectFluid = protectFluid;
+        this.buttonTexture = buttonTexture;
+        this.buttonOverlay = buttonOverlay;
+        this.name = name;
+    }
+
+    public String getTransKey() {
+        return "GT5U.gui.button.voiding_mode_" + name;
+    }
+
+    public VoidingMode next() {
+        return values()[(ordinal() + 1) % values().length];
+    }
+
+    public VoidingMode previous() {
+        return values()[(ordinal() + values().length - 1) % values().length];
+    }
+
+    /**
+     * Do not use this for loading mode from TEs, to prevent mode being shifted when new mode is added.
+     */
+    @Nonnull
+    public static VoidingMode fromOrdinal(int ordinal) {
+        if (ordinal >= 0 && ordinal < values().length) {
+            return values()[ordinal];
+        }
+        return VOID_NONE;
+    }
+
+    @Nonnull
+    public static VoidingMode fromName(String name) {
+        for (VoidingMode mode : values()) {
+            if (mode.name.equals(name)) {
+                return mode;
+            }
+        }
+        return VOID_NONE;
+    }
+
+}