Refactor HiddenSwitch to core

Author: me4502

craftbook-bukkit/build.gradle.kts

@@ -57,13 +57,14 @@ dependencies {
 }
 
 tasks.named<Copy>("processResources") {
+    // Avoid carrying project reference into task execution
     val internalVersion = project.internalVersion
     inputs.property("internalVersion", internalVersion)
     filesMatching("plugin.yml") {
-        expand("internalVersion" to internalVersion)
+        expand(mapOf("internalVersion" to internalVersion.get()))
     }
     filesMatching("paper-plugin.yml") {
-        expand("internalVersion" to internalVersion)
+        expand(mapOf("internalVersion" to internalVersion.get()))
     }
 }
 

craftbook-bukkit/src/main/java/org/enginehub/craftbook/bukkit/mechanic/BukkitMechanicManager.java

@@ -549,7 +549,7 @@ public void setup() {
             .name("HiddenSwitch")
             .description(TranslatableComponent.of("craftbook.hiddenswitch.description"))
             .category(MechanicCategory.GENERAL)
-            .className("org.enginehub.craftbook.mechanics.HiddenSwitch")
+            .className("org.enginehub.craftbook.bukkit.mechanics.BukkitHiddenSwitch")
             .buildAndRegister();
 
         // TODO CommandItems needs to load early (after variables).

…ub/craftbook/mechanics/HiddenSwitch.java …bukkit/mechanics/BukkitHiddenSwitch.javacraftbook-bukkit/src/main/java/org/enginehub/craftbook/mechanics/HiddenSwitch.java renamed to craftbook-bukkit/src/main/java/org/enginehub/craftbook/bukkit/mechanics/BukkitHiddenSwitch.java craftbook-bukkit/src/main/java/org/enginehub/craftbook/mechanics/HiddenSwitch.java renamed to craftbook-bukkit/src/main/java/org/enginehub/craftbook/bukkit/mechanics/BukkitHiddenSwitch.java

@@ -13,9 +13,8 @@
  * see <http://www.gnu.org/licenses/>.
  */
 
-package org.enginehub.craftbook.mechanics;
+package org.enginehub.craftbook.bukkit.mechanics;
 
-import com.sk89q.util.yaml.YAMLProcessor;
 import com.sk89q.worldedit.util.formatting.text.TextComponent;
 import com.sk89q.worldedit.util.formatting.text.TranslatableComponent;
 import net.kyori.adventure.text.Component;
@@ -36,13 +35,13 @@
 import org.bukkit.event.block.SignChangeEvent;
 import org.bukkit.event.player.PlayerInteractEvent;
 import org.bukkit.inventory.EquipmentSlot;
-import org.enginehub.craftbook.AbstractCraftBookMechanic;
 import org.enginehub.craftbook.ChangedSign;
 import org.enginehub.craftbook.CraftBook;
 import org.enginehub.craftbook.CraftBookPlayer;
 import org.enginehub.craftbook.bukkit.CraftBookPlugin;
 import org.enginehub.craftbook.mechanic.CraftBookMechanic;
 import org.enginehub.craftbook.mechanic.MechanicType;
+import org.enginehub.craftbook.mechanics.HiddenSwitch;
 import org.enginehub.craftbook.util.EventUtil;
 import org.enginehub.craftbook.util.LocationUtil;
 import org.enginehub.craftbook.util.ProtectionUtil;
@@ -51,9 +50,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
-public class HiddenSwitch extends AbstractCraftBookMechanic implements Listener {
+public class BukkitHiddenSwitch extends HiddenSwitch implements Listener {
 
-    public HiddenSwitch(MechanicType<? extends CraftBookMechanic> mechanicType) {
+    public BukkitHiddenSwitch(MechanicType<? extends CraftBookMechanic> mechanicType) {
         super(mechanicType);
     }
 
@@ -208,12 +207,4 @@ private boolean toggleSwitches(Block sign, BlockFace direction) {
 
         return toggledSwitch;
     }
-
-    private boolean allowAnyFace;
-
-    @Override
-    public void loadFromConfiguration(YAMLProcessor config) {
-        config.setComment("allow-any-face", "Allows the Hidden Switch to be activated from any face of the block.");
-        allowAnyFace = config.getBoolean("allow-any-face", true);
-    }
 }

craftbook-bukkit/src/main/java/org/enginehub/craftbook/bukkit/mechanics/dispenser/BukkitDispenserRecipes.java

@@ -47,7 +47,7 @@
 
 public class BukkitDispenserRecipes extends DispenserRecipes implements Listener {
 
-    public static final Registry<DispenserRecipe> REGISTRY = new NamespacedRegistry<>("dispenser recipe", "craftbook");
+    public static final Registry<DispenserRecipe> REGISTRY = new NamespacedRegistry<>("dispenser recipe", "craftbook:dispenser_recipe", "craftbook");
 
     public BukkitDispenserRecipes(MechanicType<? extends CraftBookMechanic> mechanicType) {
         super(mechanicType);

craftbook-bukkit/src/main/java/org/enginehub/craftbook/bukkit/mechanics/variables/BukkitVariableManager.java

@@ -43,7 +43,8 @@
 import org.enginehub.craftbook.mechanics.variables.VariableManager;
 import org.jspecify.annotations.Nullable;
 
-import java.io.File;
+import java.nio.file.Files;
+import java.nio.file.Path;
 import java.util.List;
 
 import static com.google.common.base.Preconditions.checkNotNull;
@@ -62,10 +63,9 @@ public void enable() throws MechanicInitializationException {
         CraftBookPlugin.logDebugMessage("Initializing Variables!", "startup.variables");
 
         try {
-            File varFile = CraftBook.getInstance().getPlatform().getWorkingDirectory().resolve("variables.yml").toFile();
-            if (!varFile.exists()) {
-                //noinspection ResultOfMethodCallIgnored
-                varFile.createNewFile();
+            Path varFile = CraftBook.getInstance().getPlatform().getWorkingDirectory().resolve("variables.yml");
+            if (!Files.exists(varFile)) {
+                Files.createFile(varFile);
             }
             variableConfiguration = new VariableConfiguration(new YAMLProcessor(varFile, true, YAMLFormat.EXTENDED));
             variableConfiguration.load();

craftbook-core/src/main/java/org/enginehub/craftbook/mechanic/MechanicTypes.java

@@ -24,6 +24,7 @@
 import org.enginehub.craftbook.mechanics.ChunkAnchor;
 import org.enginehub.craftbook.mechanics.CookingPot;
 import org.enginehub.craftbook.mechanics.Elevator;
+import org.enginehub.craftbook.mechanics.HiddenSwitch;
 import org.enginehub.craftbook.mechanics.JackOLantern;
 import org.enginehub.craftbook.mechanics.LightStone;
 import org.enginehub.craftbook.mechanics.LightSwitch;
@@ -71,6 +72,7 @@ public class MechanicTypes {
     public static final @Nullable MechanicType<Elevator> ELEVATOR = get("elevator");
     // public static final @Nullable MechanicType<Gate> GATE = get("gate");
     // public static final @Nullable MechanicType<HeadDrops> HEAD_DROPS = get("head_drops");
+    public static final @Nullable MechanicType<HiddenSwitch> HIDDEN_SWITCH = get("hidden_switch");
     public static final @Nullable MechanicType<JackOLantern> JACK_O_LANTERN = get("jack_o_lantern");
     public static final @Nullable MechanicType<LightSwitch> LIGHT_SWITCH = get("light_switch");
     public static final @Nullable MechanicType<LightStone> LIGHTSTONE = get("lightstone");

craftbook-core/src/main/java/org/enginehub/craftbook/mechanics/HiddenSwitch.java

@@ -0,0 +1,36 @@
+/*
+ * CraftBook Copyright (C) EngineHub and Contributors <https://enginehub.org/>
+ *
+ * This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free
+ * Software Foundation, either version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
+ * warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along with this program. If not,
+ * see <http://www.gnu.org/licenses/>.
+ */
+
+package org.enginehub.craftbook.mechanics;
+
+import com.sk89q.util.yaml.YAMLProcessor;
+import org.enginehub.craftbook.AbstractCraftBookMechanic;
+import org.enginehub.craftbook.mechanic.CraftBookMechanic;
+import org.enginehub.craftbook.mechanic.MechanicType;
+
+public class HiddenSwitch extends AbstractCraftBookMechanic {
+
+    public HiddenSwitch(MechanicType<? extends CraftBookMechanic> mechanicType) {
+        super(mechanicType);
+    }
+
+    protected boolean allowAnyFace;
+
+    @Override
+    public void loadFromConfiguration(YAMLProcessor config) {
+        config.setComment("allow-any-face", "Allows the Hidden Switch to be activated from any face of the block.");
+        allowAnyFace = config.getBoolean("allow-any-face", true);
+    }
+}