Re-add infinite mode to Bridge/Door/Gate mechanics. Resolves #1370

Author: me4502

craftbook-bukkit/src/main/java/org/enginehub/craftbook/mechanics/area/Bridge.java

@@ -91,6 +91,17 @@ public void onSignChange(SignChangeEvent event) {
             return;
         }
 
+        String signLine0 = PlainTextComponentSerializer.plainText().serialize(event.line(0));
+        if (signLine0.equalsIgnoreCase("infinite") && !player.hasPermission("craftbook.bridge.create.infinite")) {
+            if (CraftBook.getInstance().getPlatform().getConfiguration().showPermissionMessages) {
+                player.printError(TranslatableComponent.of(
+                        "craftbook.bridge.infinite-permissions"
+                ));
+            }
+            SignUtil.cancelSignChange(event);
+            return;
+        }
+
         if (signLine1.equalsIgnoreCase("[bridge]")) {
             event.line(1, Component.text("[Bridge]"));
             player.printInfo(TranslatableComponent.of("craftbook.bridge.create"));

craftbook-bukkit/src/main/java/org/enginehub/craftbook/mechanics/area/CuboidToggleMechanic.java

@@ -67,7 +67,7 @@ public boolean close(Sign sign, Sign farSide, BlockData blockData, CuboidRegion
             Block b = sign.getWorld().getBlockAt(bv.x(), bv.y(), bv.z());
             if (BlockUtil.isBlockReplacable(b.getType())) {
                 if (CraftBook.getInstance().getPlatform().getConfiguration().safeDestruction) {
-                    if (getStoredBlockCounts(sign, farSide) > 0) {
+                    if (hasRequiredBlockCounts(1, sign, farSide)) {
                         b.setBlockData(blockData);
                         takeFromStoredBlockCounts(getCostOfBlock(blockData), sign, farSide);
                     } else {

craftbook-bukkit/src/main/java/org/enginehub/craftbook/mechanics/area/Door.java

@@ -92,6 +92,17 @@ public void onSignChange(SignChangeEvent event) {
             return;
         }
 
+        String signLine0 = PlainTextComponentSerializer.plainText().serialize(event.line(0));
+        if (signLine0.equalsIgnoreCase("infinite") && !player.hasPermission("craftbook.door.create.infinite")) {
+            if (CraftBook.getInstance().getPlatform().getConfiguration().showPermissionMessages) {
+                player.printError(TranslatableComponent.of(
+                        "craftbook.door.infinite-permissions"
+                ));
+            }
+            SignUtil.cancelSignChange(event);
+            return;
+        }
+
         if (signLine1.equalsIgnoreCase("[door]")) {
             event.line(1, Component.text("[Door]"));
             player.printInfo(TranslatableComponent.of("craftbook.door.end-create"));

craftbook-bukkit/src/main/java/org/enginehub/craftbook/mechanics/area/Gate.java

@@ -205,8 +205,7 @@ private boolean toggleColumn(@Nullable BukkitChangedSign sign, GateColumn column
             }
 
             if (CraftBook.getInstance().getPlatform().getConfiguration().safeDestruction) {
-                int blockCount = getStoredBlockCounts(sign.getSign(), otherSign);
-                if (!close || blockCount > 0) {
+                if (!close || hasRequiredBlockCounts(1, sign.getSign(), otherSign)) {
                     boolean transactionSuccess = false;
                     if (!close && bloType == expectedType) {
                         transactionSuccess = addToStoredBlockCount(sign.getSign(), 1);
@@ -368,6 +367,17 @@ public void onSignChange(SignChangeEvent event) {
             return;
         }
 
+        String signLine0 = PlainTextComponentSerializer.plainText().serialize(event.line(0));
+        if (signLine0.equalsIgnoreCase("infinite") && !player.hasPermission("craftbook.gate.create.infinite")) {
+            if (CraftBook.getInstance().getPlatform().getConfiguration().showPermissionMessages) {
+                player.printError(TranslatableComponent.of(
+                    "craftbook.gate.infinite-permissions"
+                ));
+            }
+            SignUtil.cancelSignChange(event);
+            return;
+        }
+
         event.line(1, Component.text("[Gate]"));
         player.printInfo(TranslatableComponent.of("craftbook.gate.create"));
     }

craftbook-bukkit/src/main/java/org/enginehub/craftbook/mechanics/area/StoredBlockMechanic.java

@@ -18,6 +18,7 @@
 import com.sk89q.worldedit.bukkit.BukkitAdapter;
 import com.sk89q.worldedit.util.formatting.text.TextComponent;
 import com.sk89q.worldedit.world.block.BlockType;
+import net.kyori.adventure.text.Component;
 import net.kyori.adventure.text.serializer.plain.PlainTextComponentSerializer;
 import org.bukkit.Material;
 import org.bukkit.NamespacedKey;
@@ -55,6 +56,7 @@ public abstract class StoredBlockMechanic extends AbstractCraftBookMechanic impl
 
     private final NamespacedKey storedBlockTypeKey = new NamespacedKey("craftbook", "toggle_block_type");
     private final NamespacedKey storedBlockQuantityKey = new NamespacedKey("craftbook", "toggle_block_quantity");
+    protected final static int INFINITE_SENTINEL = Integer.MIN_VALUE;
 
     public StoredBlockMechanic(MechanicType<? extends CraftBookMechanic> mechanicType) {
         super(mechanicType);
@@ -165,10 +167,10 @@ public void onPipeSuck(PipeSuckEvent event) {
         List<ItemStack> items = event.getItems();
         try {
             Material base = getOrSetStoredType(event.getSuckedBlock());
-            int blocks = getStoredBlockCount(sign);
+            int blocks = getStoredBlockCounts(sign);
             if (blocks > 0) {
                 items.add(new ItemStack(base, blocks));
-                setStoredBlockCount(sign, 0);
+                takeFromStoredBlockCounts(blocks, sign);
             }
             event.setItems(items);
         } catch (InvalidMechanismException e) {
@@ -194,9 +196,10 @@ public void onBlockBreak(BlockBreakEvent event) {
         }
 
         CraftBookPlayer player = CraftBookPlugin.inst().wrapPlayer(event.getPlayer());
-        int amount = getStoredBlockCounts(sign);
+        int amount = getStoredBlockCount(sign);
 
-        if (amount > 0) {
+        //noinspection ConstantValue
+        if (amount > 0 && amount != INFINITE_SENTINEL) {
             try {
                 Material base = getOrSetStoredType(event.getBlock());
                 while (amount > 0) {
@@ -248,6 +251,9 @@ public boolean takeFromStoredBlockCounts(int amount, @Nullable Sign... signs) {
                 continue;
             }
             int stored = getStoredBlockCount(sign);
+            if (stored == INFINITE_SENTINEL) {
+                return true;
+            }
             if (stored >= amount) {
                 return setStoredBlockCount(sign, stored - amount);
             } else {
@@ -278,6 +284,11 @@ public boolean addToStoredBlockCount(Sign sign, int amount) {
      * If `enforce-type` is set, it will only return the amount of blocks of the type stored in the first sign.
      * </p>
      *
+     * <p>
+     * Only use this when getting actual physical blocks, it will not count infinite signs.
+     * Use {@link #hasRequiredBlockCounts(int, Sign...)} for quantity checks.
+     * </p>
+     *
      * @param signs The list of signs
      * @return The stored block count
      */
@@ -292,38 +303,111 @@ public int getStoredBlockCounts(@Nullable Sign... signs) {
         int sum = 0;
         for (Sign sign : signs) {
             if (sign != null && getStoredType(sign) == type) {
-                sum += getStoredBlockCount(sign);
+                int stored = getStoredBlockCount(sign);
+                if (stored == INFINITE_SENTINEL) {
+                    // Skip infinite signs in this data.
+                    continue;
+                }
+                sum += stored;
             }
         }
 
         return sum;
     }
 
+    /**
+     * Checks whether the given signs contain enough blocks to meet the given count.
+     *
+     * @param count The count to check for
+     * @param signs The list of signs
+     * @return Whether the signs contain more or equal to count
+     */
+    public boolean hasRequiredBlockCounts(int count, @Nullable Sign... signs) {
+        if (count <= 0) {
+            // Short-circuit if something asks for no blocks for whatever reason.
+            return true;
+        }
+        if (signs.length == 0 || signs[0] == null) {
+            return false;
+        }
+
+        Material type = getStoredType(signs[0]);
+
+        int sum = 0;
+        for (Sign sign : signs) {
+            if (sign != null && getStoredType(sign) == type) {
+                int stored = getStoredBlockCount(sign);
+                if (stored == INFINITE_SENTINEL) {
+                    // Infinite means this is always true.
+                    return true;
+                }
+                sum += stored;
+            }
+        }
+
+        return count >= sum;
+    }
+
     /**
      * Gets the number of stored blocks within this sign.
      *
+     * <p>
+     * This gets the raw data, use {@link #getStoredBlockCounts(Sign...)} instead.
+     * </p>
+     *
      * @param sign The sign
      * @return The stored block count
      */
-    public int getStoredBlockCount(Sign sign) {
+    private int getStoredBlockCount(Sign sign) {
         if (sign.getPersistentDataContainer().has(storedBlockQuantityKey, PersistentDataType.INTEGER)) {
             //noinspection DataFlowIssue
             return sign.getPersistentDataContainer().get(storedBlockQuantityKey, PersistentDataType.INTEGER);
         }
+        for (Side side : Side.values()) {
+            String signLine0 = PlainTextComponentSerializer.plainText().serialize(sign.getSide(side).line(0));
+            if (signLine0.equals("infinite")) {
+                // Persist infinite data to internal data.
+                sign.getSide(side).line(0, Component.text(""));
+                sign.getPersistentDataContainer().set(storedBlockQuantityKey, PersistentDataType.INTEGER, INFINITE_SENTINEL);
+                sign.update(false, false);
+                return INFINITE_SENTINEL;
+            }
+        }
         return 0;
     }
 
+    /**
+     * Gets whether this sign contains infinite blocks.
+     *
+     * @param sign The sign to check
+     * @return Whether it contains infinite blocks
+     */
+    private boolean hasInfiniteBlockCount(Sign sign) {
+        int count = getStoredBlockCount(sign);
+        return count == INFINITE_SENTINEL;
+    }
+
     /**
      * Sets the stored block count within this sign.
      *
+     * <p>
+     * This sets the raw data, use {@link #takeFromStoredBlockCounts(int, Sign...)} instead.
+     * </p>
+     *
      * @param sign The sign
      * @param count The count
      * @return If the count was set
      */
-    public boolean setStoredBlockCount(Sign sign, int count) {
+    private boolean setStoredBlockCount(Sign sign, int count) {
         if (count < 0) {
             return false;
         }
+
+        if (hasInfiniteBlockCount(sign)) {
+            // Don't modify the count if it's infinite, to avoid accidentally making it finite.
+            return true;
+        }
+
         sign.getPersistentDataContainer().set(storedBlockQuantityKey, PersistentDataType.INTEGER, count);
         return true;
     }

craftbook-core/src/main/resources/lang/strings.json

@@ -37,6 +37,7 @@
     "craftbook.bridge.too-short": "This bridge is too short to activate",
     "craftbook.bridge.restock": "You restock the bridge",
     "craftbook.bridge.restock-permissions": "You don't have permission to restock bridges",
+    "craftbook.bridge.infinite-permissions": "You don't have permission to create infinite bridges",
     "craftbook.bridge.unusable-material": "This material cannot be used to make a bridge",
 
     "craftbook.chairs.description": "Allows sitting on stair blocks.",
@@ -63,6 +64,7 @@
     "craftbook.door.missing-other-sign": "Door sign required on other side (or it was too far away).",
     "craftbook.door.not-enough-blocks": "Not enough blocks to construct this door (try restocking?)",
     "craftbook.door.restock-permissions": "You don't have permission to restock doors",
+    "craftbook.door.infinite-permissions": "You don't have permission to create infinite doors",
     "craftbook.door.restock": "You restock the door",
     "craftbook.door.toggle": "You activate the door",
     "craftbook.door.too-short": "This door is too short to activate",
@@ -85,6 +87,7 @@
     "craftbook.gate.description": "Create gates that can be opened and closed by players or redstone.",
     "craftbook.gate.not-enough-blocks": "Not enough blocks to construct this gate (try restocking?)",
     "craftbook.gate.restock-permissions": "You don't have permission to restock gates",
+    "craftbook.gate.infinite-permissions": "You don't have permission to create infinite gates",
     "craftbook.gate.restock": "You restock the gate",
     "craftbook.gate.not-found": "No gate was found (is it too far away?)",
     "craftbook.gate.toggle": "You activate the gate",