Merge remote-tracking branch 'AbdielKavash/AlignmentLimits' into dev

# Conflicts:
#	dependencies.gradle

dependencies.gradle

@@ -1,15 +1,13 @@
 // Add your dependencies here
 
 dependencies {
-    api("com.github.GTNewHorizons:GTNHLib:0.6.19:dev")
-    implementation("com.github.GTNewHorizons:NotEnoughItems:2.7.38-GTNH:dev")
-
-    compileOnly("com.github.GTNewHorizons:ServerUtilities:2.1.41-pre")
+    api("com.github.GTNewHorizons:GTNHLib:0.6.38:dev")
+    implementation("com.github.GTNewHorizons:NotEnoughItems:2.7.64-GTNH:dev")
 
     testImplementation(platform('org.junit:junit-bom:5.9.2'))
     testImplementation('org.junit.jupiter:junit-jupiter')
 
-//    runtimeOnlyNonPublishable("com.github.GTNewHorizons:GT5-Unofficial:5.09.51.234:dev") {
+//    runtimeOnlyNonPublishable("com.github.GTNewHorizons:GT5-Unofficial:5.09.51.391:dev") {
 //        exclude group: "com.github.GTNewHorizons", module: "StructureLib"
 //    }
 }

gradle.properties

@@ -37,7 +37,7 @@ remoteMappings = https\://raw.githubusercontent.com/MinecraftForge/FML/1.7.10/co
 
 # Select a default username for testing your mod. You can always override this per-run by running
 # `./gradlew runClient --username=AnotherPlayer`, or configuring this command in your IDE.
-developmentEnvironmentUserName = "Developer"
+developmentEnvironmentUserName = Developer
 
 # Enables using modern Java syntax (up to version 17) via Jabel, while still targeting JVM 8.
 # See https://github.com/bsideup/jabel for details on how this works.
@@ -151,7 +151,7 @@ modrinthProjectId =
 #       type can be one of [project, version],
 #       and the name is the Modrinth project or version slug/id of the other mod.
 # Example: required-project:fplib;optional-project:gasstation;incompatible-project:gregtech
-# Note: GTNH Mixins is automatically set as a required dependency if usesMixins = true
+# Note: UniMixins is automatically set as a required dependency if usesMixins = true.
 modrinthRelations =
 
 # Publishing to CurseForge requires you to set the CURSEFORGE_TOKEN environment variable to one of your CurseForge API tokens.

settings.gradle

@@ -17,7 +17,7 @@ pluginManagement {
 }
 
 plugins {
-    id 'com.gtnewhorizons.gtnhsettingsconvention' version '1.0.38'
+    id 'com.gtnewhorizons.gtnhsettingsconvention' version '1.0.41'
 }
 
 

src/main/java/com/gtnewhorizon/structurelib/ClientProxy.java

@@ -20,7 +20,6 @@ import net.minecraft.client.renderer.Tessellator;
 import net.minecraft.client.renderer.culling.Frustrum;
 import net.minecraft.client.renderer.texture.TextureMap;
 import net.minecraft.client.resources.I18n;
-import net.minecraft.client.settings.KeyBinding;
 import net.minecraft.entity.Entity;
 import net.minecraft.entity.player.EntityPlayer;
 import net.minecraft.entity.player.EntityPlayerMP;
@@ -43,23 +42,17 @@ import org.lwjgl.opengl.GL11;
 import com.gtnewhorizon.structurelib.entity.fx.WeightlessParticleFX;
 import com.gtnewhorizon.structurelib.net.RegistryOrderSyncMessage;
 import com.gtnewhorizon.structurelib.net.SetChannelDataMessage;
-import com.gtnewhorizon.structurelib.net.StructureProjectorCycleModeMessage;
 
 import cpw.mods.fml.client.config.GuiConfig;
 import cpw.mods.fml.client.event.ConfigChangedEvent;
-import cpw.mods.fml.client.registry.ClientRegistry;
 import cpw.mods.fml.common.FMLCommonHandler;
-import cpw.mods.fml.common.event.FMLInitializationEvent;
 import cpw.mods.fml.common.event.FMLLoadCompleteEvent;
 import cpw.mods.fml.common.event.FMLPreInitializationEvent;
 import cpw.mods.fml.common.eventhandler.EventPriority;
 import cpw.mods.fml.common.eventhandler.SubscribeEvent;
-import cpw.mods.fml.common.gameevent.InputEvent;
 import cpw.mods.fml.common.gameevent.TickEvent.ClientTickEvent;
 import cpw.mods.fml.common.gameevent.TickEvent.Phase;
 import cpw.mods.fml.common.network.FMLNetworkEvent;
-import cpw.mods.fml.relauncher.Side;
-import cpw.mods.fml.relauncher.SideOnly;
 
 public class ClientProxy extends CommonProxy {
 
@@ -266,13 +259,6 @@ public class ClientProxy extends CommonProxy {
         MinecraftForge.EVENT_BUS.register(new ForgeEventHandler());
     }
 
-    @Override
-    public void init(FMLInitializationEvent e) {
-        super.init(e);
-
-        MinecraftForge.EVENT_BUS.register(new KeybindHandler());
-    }
-
     static void markTextureUsed(IIcon icon) {
         if (StructureLib.COMPAT instanceof IStructureCompat)
             ((IStructureCompat) StructureLib.COMPAT).markTextureUsed(icon);
@@ -668,30 +654,4 @@ public class ClientProxy extends CommonProxy {
             p.endSection();
         }
     }
-
-    public static class KeybindHandler {
-
-        private static final KeyBinding CYCLE_PROJECTOR_MODE = new KeyBinding(
-                "item.structurelib.constructableTrigger.keys.cycleMode",
-                0,
-                "item.structurelib.constructableTrigger.keyCategory");
-
-        public KeybindHandler() {
-            FMLCommonHandler.instance().bus().register(this);
-            // If somebody wants to make a UI element for this, be my guest
-            ClientRegistry.registerKeyBinding(CYCLE_PROJECTOR_MODE);
-        }
-
-        @SideOnly(Side.CLIENT)
-        @SubscribeEvent
-        public void key(InputEvent.KeyInputEvent event) {
-            if (CYCLE_PROJECTOR_MODE.isPressed()) {
-                cycleProjectorMode();
-            }
-        }
-
-        private static void cycleProjectorMode() {
-            StructureLib.net.sendToServer(new StructureProjectorCycleModeMessage());
-        }
-    }
 }

src/main/java/com/gtnewhorizon/structurelib/CommonProxy.java

@@ -14,10 +14,11 @@ import net.minecraft.util.IIcon;
 import net.minecraft.world.World;
 import net.minecraftforge.common.MinecraftForge;
 
+import com.gtnewhorizon.gtnhlib.keybind.SyncedKeybind;
+import com.gtnewhorizon.structurelib.item.ItemConstructableTrigger;
 import com.gtnewhorizon.structurelib.net.ErrorHintParticleMessage;
 import com.gtnewhorizon.structurelib.net.UpdateHintParticleMessage;
 
-import cpw.mods.fml.common.event.FMLInitializationEvent;
 import cpw.mods.fml.common.event.FMLLoadCompleteEvent;
 import cpw.mods.fml.common.event.FMLPreInitializationEvent;
 import cpw.mods.fml.common.eventhandler.SubscribeEvent;
@@ -65,8 +66,6 @@ public class CommonProxy {
 
     public void preInit(FMLPreInitializationEvent e) {}
 
-    public void init(FMLInitializationEvent e) {}
-
     public long getOverworldTime() {
         return MinecraftServer.getServer().getEntityWorld().getTotalWorldTime();
     }
@@ -111,6 +110,17 @@ public class CommonProxy {
         }
     }
 
+    private static final SyncedKeybind MODE_SWAP_KEY = SyncedKeybind.createConfigurable(
+            "item.structurelib.constructableTrigger.keys.cycleMode",
+            "item.structurelib.constructableTrigger.keyCategory",
+            0).registerGlobalListener((entityPlayerMP, syncedKeybind, isDown) -> {
+                if (!isDown) return;
+                final ItemStack held = entityPlayerMP.getHeldItem();
+                if (held != null && held.getItem() instanceof ItemConstructableTrigger) {
+                    ItemConstructableTrigger.cycleMode(held);
+                }
+            });
+
     public void displayConfigGUI(String category) {}
 
     public static class ForgeEventHandler {

src/main/java/com/gtnewhorizon/structurelib/IStructureCompat.java

@@ -1,8 +1,12 @@
 package com.gtnewhorizon.structurelib;
 
+import net.minecraft.entity.player.EntityPlayer;
 import net.minecraft.util.IIcon;
+import net.minecraft.world.World;
 
 public interface IStructureCompat {
 
     void markTextureUsed(IIcon o);
+
+    boolean checkServerUtilitiesPermission(World world, EntityPlayer actor, int x, int z);
 }

src/main/java/com/gtnewhorizon/structurelib/StructureLib.java

@@ -27,14 +27,12 @@ import com.gtnewhorizon.structurelib.net.AlignmentMessage;
 import com.gtnewhorizon.structurelib.net.ErrorHintParticleMessage;
 import com.gtnewhorizon.structurelib.net.RegistryOrderSyncMessage;
 import com.gtnewhorizon.structurelib.net.SetChannelDataMessage;
-import com.gtnewhorizon.structurelib.net.StructureProjectorCycleModeMessage;
 import com.gtnewhorizon.structurelib.net.UpdateHintParticleMessage;
 import com.gtnewhorizon.structurelib.util.InventoryUtility;
 import com.gtnewhorizon.structurelib.util.XSTR;
 
 import cpw.mods.fml.common.Mod;
 import cpw.mods.fml.common.SidedProxy;
-import cpw.mods.fml.common.event.FMLInitializationEvent;
 import cpw.mods.fml.common.event.FMLInterModComms;
 import cpw.mods.fml.common.event.FMLLoadCompleteEvent;
 import cpw.mods.fml.common.event.FMLPreInitializationEvent;
@@ -79,11 +77,6 @@ public class StructureLib {
         net.registerMessage(SetChannelDataMessage.Handler.class, SetChannelDataMessage.class, 3, Side.SERVER);
         net.registerMessage(ErrorHintParticleMessage.Handler.class, ErrorHintParticleMessage.class, 4, Side.CLIENT);
         net.registerMessage(RegistryOrderSyncMessage.Handler.class, RegistryOrderSyncMessage.class, 5, Side.SERVER);
-        net.registerMessage(
-                StructureProjectorCycleModeMessage.Handler.class,
-                StructureProjectorCycleModeMessage.class,
-                6,
-                Side.SERVER);
 
         try {
             DEBUG_MODE = Boolean.parseBoolean(System.getProperty("structurelib.debug"));
@@ -99,7 +92,7 @@ public class StructureLib {
     @Mod.Instance
     static StructureLib INSTANCE;
     @Mod.Instance(STRUCTURECOMPAT_MODID)
-    static Object COMPAT;
+    public static Object COMPAT;
 
     static Block blockHint;
     static Item itemBlockHint;
@@ -135,11 +128,6 @@ public class StructureLib {
         DevelopHelper.onPreInit();
     }
 
-    @Mod.EventHandler
-    public void init(FMLInitializationEvent e) {
-        proxy.init(e);
-    }
-
     @Mod.EventHandler
     public void loadComplete(FMLLoadCompleteEvent e) {
         proxy.loadComplete(e);

src/main/java/com/gtnewhorizon/structurelib/alignment/IAlignmentLimits.java

@@ -14,8 +14,28 @@ import com.gtnewhorizon.structurelib.alignment.enumerable.Rotation;
 
 public interface IAlignmentLimits {
 
+    /**
+     * Can be placed in any orientation.
+     */
     IAlignmentLimits UNLIMITED = (direction, rotation, flip) -> true;
 
+    /**
+     * Must be standing upright; i.e., top side of the block facing up.
+     */
+    IAlignmentLimits UPRIGHT = (direction, rotation, flip) -> direction.offsetY == 0
+            && (flip.isVerticallyFliped() ? rotation.isUpsideDown() : rotation.isNotRotated());
+
+    /**
+     * Can be in any orientation except upside down; i.e., top side of the block facing down.
+     */
+    IAlignmentLimits NOT_UPSIDE_DOWN = (direction, rotation, flip) -> direction.offsetY != 0
+            || (flip.isVerticallyFliped() ? !rotation.isNotRotated() : !rotation.isUpsideDown());
+
+    /**
+     * Front side of the block must be facing up.
+     */
+    IAlignmentLimits FACING_UP = (direction, rotation, flip) -> direction == ForgeDirection.UP;
+
     boolean isNewExtendedFacingValid(ForgeDirection direction, Rotation rotation, Flip flip);
 
     default boolean isNewExtendedFacingValid(ExtendedFacing alignment) {

src/main/java/com/gtnewhorizon/structurelib/core/StructureLibCore.java

@@ -1,34 +1,20 @@
 package com.gtnewhorizon.structurelib.core;
 
+import java.util.Arrays;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
 
-import org.apache.logging.log4j.LogManager;
-import org.apache.logging.log4j.Logger;
-
 import com.gtnewhorizon.gtnhmixins.IEarlyMixinLoader;
-import com.gtnewhorizon.structurelib.mixins.Mixins;
 
 import cpw.mods.fml.relauncher.IFMLLoadingPlugin;
 
+@IFMLLoadingPlugin.MCVersion("1.7.10")
 public class StructureLibCore implements IFMLLoadingPlugin, IEarlyMixinLoader {
 
-    public static final Logger log = LogManager.getLogger("StructureLibCore");
-
-    @Override
-    public String getMixinConfig() {
-        return "mixins.structurelib.early.json";
-    }
-
-    @Override
-    public List<String> getMixins(Set<String> loadedCoreMods) {
-        return Mixins.getEarlyMixins(loadedCoreMods);
-    }
-
     @Override
     public String[] getASMTransformerClass() {
-        return new String[0];
+        return null;
     }
 
     @Override
@@ -50,4 +36,14 @@ public class StructureLibCore implements IFMLLoadingPlugin, IEarlyMixinLoader {
     public String getAccessTransformerClass() {
         return null;
     }
+
+    @Override
+    public String getMixinConfig() {
+        return "mixins.structurelib.early.json";
+    }
+
+    @Override
+    public List<String> getMixins(Set<String> loadedCoreMods) {
+        return Arrays.asList("blockChangeNotifier.MixinForgeHooks", "blockChangeNotifier.MixinWorld");
+    }
 }

src/main/java/com/gtnewhorizon/structurelib/item/ItemConstructableTrigger.java

@@ -9,10 +9,7 @@ import java.util.List;
 
 import net.minecraft.client.renderer.texture.IIconRegister;
 import net.minecraft.entity.player.EntityPlayer;
-import net.minecraft.item.Item;
 import net.minecraft.item.ItemStack;
-import net.minecraft.nbt.NBTTagCompound;
-import net.minecraft.nbt.NBTTagInt;
 import net.minecraft.util.IIcon;
 import net.minecraft.util.StatCollector;
 import net.minecraft.world.World;
@@ -23,29 +20,15 @@ import com.gtnewhorizon.structurelib.StructureLib;
 import com.gtnewhorizon.structurelib.alignment.constructable.ChannelDataAccessor;
 import com.gtnewhorizon.structurelib.alignment.constructable.ConstructableUtility;
 
-public class ItemConstructableTrigger extends Item {
-
-    private static final String TAG_MODE = "mode";
+public class ItemConstructableTrigger extends ModeToggleableItem {
 
     private static final IIcon[] textures = new IIcon[3];
 
-    public enum TriggerMode {
-        BUILDING,
-        UPDATING,
-        REMOVING
-    }
-
     public ItemConstructableTrigger() {
         setUnlocalizedName("structurelib.constructableTrigger");
         setCreativeTab(StructureLib.creativeTab);
     }
 
-    public static void cycleMode(ItemStack held) {
-        if (held.getTagCompound() == null) held.setTagCompound(new NBTTagCompound());
-        if (!held.getTagCompound().hasKey(TAG_MODE)) held.getTagCompound().setTag(TAG_MODE, new NBTTagInt(0));
-        held.getTagCompound().setInteger(TAG_MODE, (held.getTagCompound().getInteger(TAG_MODE) + 1) % 3);
-    }
-
     @Override
     public void registerIcons(IIconRegister register) {
         textures[0] = register.registerIcon(MOD_ID + ":constructableTrigger/BUILDING");
@@ -89,15 +72,6 @@ public class ItemConstructableTrigger extends Item {
                 + StatCollector.translateToLocal("item.structurelib.constructableTrigger.modes." + mode);
     }
 
-    public static TriggerMode getMode(ItemStack held) {
-        if (held == null || !held.hasTagCompound() || !held.getTagCompound().hasKey(TAG_MODE)) {
-            // default behavior
-            return TriggerMode.BUILDING;
-        }
-        // get user-defined mode
-        return TriggerMode.values()[held.getTagCompound().getInteger(TAG_MODE)];
-    }
-
     @Override
     public ItemStack onItemRightClick(ItemStack stack, World world, EntityPlayer player) {
         if (!world.isRemote && getMovingObjectPositionFromPlayer(world, player, true) == null) {

src/main/java/com/gtnewhorizon/structurelib/item/ModeToggleableItem.java

@@ -0,0 +1,32 @@
+package com.gtnewhorizon.structurelib.item;
+
+import net.minecraft.item.Item;
+import net.minecraft.item.ItemStack;
+import net.minecraft.nbt.NBTTagCompound;
+import net.minecraft.nbt.NBTTagInt;
+
+public class ModeToggleableItem extends Item {
+
+    public enum TriggerMode {
+        BUILDING,
+        UPDATING,
+        REMOVING
+    }
+
+    public static TriggerMode getMode(ItemStack held) {
+        if (held == null || !held.hasTagCompound() || !held.getTagCompound().hasKey(TAG_MODE)) {
+            // default behavior
+            return TriggerMode.BUILDING;
+        }
+        // get user-defined mode
+        return TriggerMode.values()[held.getTagCompound().getInteger(TAG_MODE)];
+    }
+
+    public static void cycleMode(ItemStack held) {
+        if (held.getTagCompound() == null) held.setTagCompound(new NBTTagCompound());
+        if (!held.getTagCompound().hasKey(TAG_MODE)) held.getTagCompound().setTag(TAG_MODE, new NBTTagInt(0));
+        held.getTagCompound().setInteger(TAG_MODE, (held.getTagCompound().getInteger(TAG_MODE) + 1) % 3);
+    }
+
+    protected static final String TAG_MODE = "mode";
+}

src/main/java/com/gtnewhorizon/structurelib/mixins/Mixins.java

@@ -1,188 +0,0 @@
-package com.gtnewhorizon.structurelib.mixins;
-
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Collections;
-import java.util.List;
-import java.util.Set;
-import java.util.function.Supplier;
-
-import com.gtnewhorizon.structurelib.core.StructureLibCore;
-
-import cpw.mods.fml.relauncher.FMLLaunchHandler;
-
-public enum Mixins {
-
-    BLOCK_CHANGE_NOTIFIER(new Builder("Block Change Notifier").setPhase(Phase.EARLY)
-            .addMixinClasses("blockChangeNotifier.MixinForgeHooks", "blockChangeNotifier.MixinWorld")
-            .addTargetedMod(TargetedMod.VANILLA).setSide(Side.BOTH).setApplyIf(() -> true));
-
-    private final List<String> mixinClasses;
-    private final List<TargetedMod> targetedMods;
-    private final List<TargetedMod> excludedMods;
-    private final Supplier<Boolean> applyIf;
-    private final Phase phase;
-    private final Side side;
-
-    Mixins(Builder builder) {
-        this.mixinClasses = builder.mixinClasses;
-        this.targetedMods = builder.targetedMods;
-        this.excludedMods = builder.excludedMods;
-        this.applyIf = builder.applyIf;
-        this.phase = builder.phase;
-        this.side = builder.side;
-        if (this.mixinClasses.isEmpty()) {
-            throw new RuntimeException("No mixin class specified for Mixin : " + this.name());
-        }
-        if (this.targetedMods.isEmpty()) {
-            throw new RuntimeException("No targeted mods specified for Mixin : " + this.name());
-        }
-        if (this.applyIf == null) {
-            throw new RuntimeException("No ApplyIf function specified for Mixin : " + this.name());
-        }
-        if (this.phase == null) {
-            throw new RuntimeException("No Phase specified for Mixin : " + this.name());
-        }
-        if (this.side == null) {
-            throw new RuntimeException("No Side function specified for Mixin : " + this.name());
-        }
-    }
-
-    public static List<String> getEarlyMixins(Set<String> loadedCoreMods) {
-        final List<String> mixins = new ArrayList<>();
-        final List<String> notLoading = new ArrayList<>();
-        for (Mixins mixin : Mixins.values()) {
-            if (mixin.phase == Phase.EARLY) {
-                if (mixin.shouldLoad(loadedCoreMods, Collections.emptySet())) {
-                    mixins.addAll(mixin.mixinClasses);
-                } else {
-                    notLoading.addAll(mixin.mixinClasses);
-                }
-            }
-        }
-        StructureLibCore.log.info("Not loading the following EARLY mixins: {}", notLoading.toString());
-        return mixins;
-    }
-
-    public static List<String> getLateMixins(Set<String> loadedMods) {
-        // NOTE: Any targetmod here needs a modid, not a coremod id
-        final List<String> mixins = new ArrayList<>();
-        final List<String> notLoading = new ArrayList<>();
-        for (Mixins mixin : Mixins.values()) {
-            if (mixin.phase == Phase.LATE) {
-                if (mixin.shouldLoad(Collections.emptySet(), loadedMods)) {
-                    mixins.addAll(mixin.mixinClasses);
-                } else {
-                    notLoading.addAll(mixin.mixinClasses);
-                }
-            }
-        }
-        StructureLibCore.log.info("Not loading the following LATE mixins: {}", notLoading.toString());
-        return mixins;
-    }
-
-    private boolean shouldLoadSide() {
-        return side == Side.BOTH || (side == Side.SERVER && FMLLaunchHandler.side().isServer())
-                || (side == Side.CLIENT && FMLLaunchHandler.side().isClient());
-    }
-
-    private boolean allModsLoaded(List<TargetedMod> targetedMods, Set<String> loadedCoreMods, Set<String> loadedMods) {
-        if (targetedMods.isEmpty()) return false;
-
-        for (TargetedMod target : targetedMods) {
-            if (target == TargetedMod.VANILLA) continue;
-
-            // Check coremod first
-            if (!loadedCoreMods.isEmpty() && target.coreModClass != null
-                    && !loadedCoreMods.contains(target.coreModClass))
-                return false;
-            else if (!loadedMods.isEmpty() && target.modId != null && !loadedMods.contains(target.modId)) return false;
-        }
-
-        return true;
-    }
-
-    private boolean noModsLoaded(List<TargetedMod> targetedMods, Set<String> loadedCoreMods, Set<String> loadedMods) {
-        if (targetedMods.isEmpty()) return true;
-
-        for (TargetedMod target : targetedMods) {
-            if (target == TargetedMod.VANILLA) continue;
-
-            // Check coremod first
-            if (!loadedCoreMods.isEmpty() && target.coreModClass != null
-                    && loadedCoreMods.contains(target.coreModClass))
-                return false;
-            else if (!loadedMods.isEmpty() && target.modId != null && loadedMods.contains(target.modId)) return false;
-        }
-
-        return true;
-    }
-
-    private boolean shouldLoad(Set<String> loadedCoreMods, Set<String> loadedMods) {
-        return (shouldLoadSide() && applyIf.get()
-                && allModsLoaded(targetedMods, loadedCoreMods, loadedMods)
-                && noModsLoaded(excludedMods, loadedCoreMods, loadedMods));
-    }
-
-    private static class Builder {
-
-        private final String name;
-        private final List<String> mixinClasses = new ArrayList<>();
-        private final List<TargetedMod> targetedMods = new ArrayList<>();
-        private final List<TargetedMod> excludedMods = new ArrayList<>();
-        private Supplier<Boolean> applyIf = null;
-        private Phase phase = null;
-        private Side side = null;
-
-        public Builder(String name) {
-            this.name = name;
-        }
-
-        public Builder addMixinClasses(String... mixinClasses) {
-            this.mixinClasses.addAll(Arrays.asList(mixinClasses));
-            return this;
-        }
-
-        public Builder setPhase(Phase phase) {
-            if (this.phase != null) {
-                throw new RuntimeException("Trying to define Phase twice for " + this.name);
-            }
-            this.phase = phase;
-            return this;
-        }
-
-        public Builder setSide(Side side) {
-            if (this.side != null) {
-                throw new RuntimeException("Trying to define Side twice for " + this.name);
-            }
-            this.side = side;
-            return this;
-        }
-
-        public Builder setApplyIf(Supplier<Boolean> applyIf) {
-            this.applyIf = applyIf;
-            return this;
-        }
-
-        public Builder addTargetedMod(TargetedMod mod) {
-            this.targetedMods.add(mod);
-            return this;
-        }
-
-        public Builder addExcludedMod(TargetedMod mod) {
-            this.excludedMods.add(mod);
-            return this;
-        }
-    }
-
-    private enum Side {
-        BOTH,
-        CLIENT,
-        SERVER
-    }
-
-    private enum Phase {
-        EARLY,
-        LATE,
-    }
-}

src/main/java/com/gtnewhorizon/structurelib/net/StructureProjectorCycleModeMessage.java

@@ -1,37 +0,0 @@
-package com.gtnewhorizon.structurelib.net;
-
-import net.minecraft.entity.player.EntityPlayerMP;
-import net.minecraft.item.ItemStack;
-
-import com.gtnewhorizon.structurelib.item.ItemConstructableTrigger;
-
-import cpw.mods.fml.common.network.simpleimpl.IMessage;
-import cpw.mods.fml.common.network.simpleimpl.IMessageHandler;
-import cpw.mods.fml.common.network.simpleimpl.MessageContext;
-import io.netty.buffer.ByteBuf;
-
-public class StructureProjectorCycleModeMessage implements IMessage {
-
-    @Override
-    public void fromBytes(ByteBuf buf) {
-        // no op
-    }
-
-    @Override
-    public void toBytes(ByteBuf buf) {
-        // no op
-    }
-
-    public static class Handler implements IMessageHandler<StructureProjectorCycleModeMessage, IMessage> {
-
-        @Override
-        public IMessage onMessage(StructureProjectorCycleModeMessage message, MessageContext ctx) {
-            EntityPlayerMP player = ctx.getServerHandler().playerEntity;
-            final ItemStack held = player.getHeldItem();
-            if (held != null && held.getItem() instanceof ItemConstructableTrigger) {
-                ItemConstructableTrigger.cycleMode(held);
-            }
-            return null;
-        }
-    }
-}

src/main/java/com/gtnewhorizon/structurelib/structure/IStructureDefinition.java

@@ -379,7 +379,7 @@ public interface IStructureDefinition<T> {
                     basePositionC,
                     hintsOnly ? ignoreBlockUnloaded((e, w, x, y, z, a, b, c) -> {
                         e.spawnHint(object, world, x, y, z, trigger);
-                        if (ChannelDataAccessor.hasSubChannel(trigger, StructureLibAPI.CHANNEL_SHOW_ERROR)
+                        if (ChannelDataAccessor.hasSubChannel(trigger, "show_error")
                                 && !e.couldBeValid(object, world, x, y, z, trigger)) {
                             StructureLibAPI.markHintParticleError(StructureLib.getCurrentPlayer(), world, x, y, z);
                         }

src/main/java/com/gtnewhorizon/structurelib/structure/IStructureElement.java

@@ -2,7 +2,7 @@ package com.gtnewhorizon.structurelib.structure;
 
 import static com.gtnewhorizon.structurelib.StructureLib.LOGGER;
 import static com.gtnewhorizon.structurelib.StructureLib.PANIC_MODE;
-import static com.gtnewhorizon.structurelib.item.ItemConstructableTrigger.TriggerMode.REMOVING;
+import static com.gtnewhorizon.structurelib.item.ModeToggleableItem.TriggerMode.REMOVING;
 import static com.gtnewhorizon.structurelib.structure.StructureUtility.checkForRemoving;
 
 import java.util.Arrays;

src/main/java/com/gtnewhorizon/structurelib/structure/StructureUtility.java

@@ -2,31 +2,12 @@ package com.gtnewhorizon.structurelib.structure;
 
 import static com.gtnewhorizon.structurelib.StructureLib.LOGGER;
 import static com.gtnewhorizon.structurelib.StructureLib.PANIC_MODE;
-import static com.gtnewhorizon.structurelib.item.ItemConstructableTrigger.TriggerMode.BUILDING;
-import static com.gtnewhorizon.structurelib.item.ItemConstructableTrigger.TriggerMode.REMOVING;
-import static com.gtnewhorizon.structurelib.item.ItemConstructableTrigger.TriggerMode.UPDATING;
+import static com.gtnewhorizon.structurelib.item.ModeToggleableItem.TriggerMode.*;
 import static java.lang.Integer.MIN_VALUE;
 
-import java.util.Arrays;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.Comparator;
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Map;
+import java.util.*;
 import java.util.Map.Entry;
-import java.util.Objects;
-import java.util.Set;
-import java.util.TreeMap;
-import java.util.TreeSet;
-import java.util.function.BiConsumer;
-import java.util.function.BiFunction;
-import java.util.function.BiPredicate;
-import java.util.function.Consumer;
-import java.util.function.Function;
-import java.util.function.Predicate;
-import java.util.function.Supplier;
+import java.util.function.*;
 
 import javax.annotation.Nullable;
 
@@ -50,6 +31,7 @@ import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.tuple.Pair;
 
 import com.google.common.collect.ImmutableList;
+import com.gtnewhorizon.structurelib.IStructureCompat;
 import com.gtnewhorizon.structurelib.StructureEvent.StructureElementVisitedEvent;
 import com.gtnewhorizon.structurelib.StructureLib;
 import com.gtnewhorizon.structurelib.StructureLibAPI;
@@ -62,9 +44,7 @@ import com.gtnewhorizon.structurelib.structure.adders.ITileAdder;
 import com.gtnewhorizon.structurelib.util.ItemStackPredicate;
 import com.gtnewhorizon.structurelib.util.ItemStackPredicate.NBTMode;
 import com.gtnewhorizon.structurelib.util.Vec3Impl;
-import com.gtnewhorizon.structurelib.xmod.ServerUtilitiesCompat;
 
-import cpw.mods.fml.common.Loader;
 import cpw.mods.fml.common.registry.GameRegistry;
 
 /**
@@ -153,8 +133,6 @@ public class StructureUtility {
 
     private static final String NICE_CHARS = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcdefghijklmnopqrstuvwxyz=|!@#$%&()[]{};:<>/?_,.*^'`";
 
-    private static final boolean isSULoaded = Loader.isModLoaded("serverutilities");
-
     @SuppressWarnings("rawtypes")
     private static final Map<Vec3Impl, IStructureNavigate> STEP = new HashMap<>();
 
@@ -409,23 +387,31 @@ public class StructureUtility {
                 }
             }
         }
-        if (mode == REMOVING || !s.takeOne(stack, false)) {
-            // If we're in removing mode, or if the user didn't have the block in their inventory, and we're in some
+        if (mode == REMOVING) {
+            // We're in removing mode, so let's check some stuff
+            if (world.isAirBlock(x, y, z)) {
+                return PlaceResult.SKIP;
+            }
+            ItemStack toGive = new ItemStack(world.getBlock(x, y, z));
+            toGive.setItemDamage(world.getBlock(x, y, z).getDamageValue(world, x, y, z));
+            if (!checkPermission(world, actor, x, y, z)) {
+                return PlaceResult.REJECT;
+            }
+            world.setBlockToAir(x, y, z);
+            if (!tryGiveOrDropItem(world, actor, toGive)) {
+                // We're in removing mode and something went wrong while trying to give the player the block we removed,
+                // let's just fail for now
+                return PlaceResult.REJECT;
+            }
+        } else if (!s.takeOne(stack, false)) {
+            // If the user didn't have the block in their inventory, and we're in some
             // other mode, let's check some stuff
             if (world.isAirBlock(x, y, z)) {
                 return PlaceResult.SKIP;
             }
             ItemStack toGive = new ItemStack(world.getBlock(x, y, z));
             toGive.setItemDamage(world.getBlock(x, y, z).getDamageValue(world, x, y, z));
-            if (mode == REMOVING && !checkPermission(world, actor, x, y, z)) {
-                return PlaceResult.REJECT;
-            }
             world.setBlockToAir(x, y, z);
-            if (mode == REMOVING && !tryGiveOrDropItem(world, actor, toGive)) {
-                // We're in removing mode and something went wrong while trying to give the player the block we removed,
-                // let's just fail for now
-                return PlaceResult.REJECT;
-            }
         }
         return PlaceResult.ACCEPT;
     }
@@ -569,22 +555,30 @@ public class StructureUtility {
                 return PlaceResult.REJECT;
             }
         }
-        if (mode == REMOVING || !s.takeOne(stack, false)) {
+        if (mode == REMOVING) {
             if (world.isAirBlock(x, y, z)) {
                 return PlaceResult.SKIP;
             }
-            // If the user didn't have the item in their inventory, or we're in removing mode, we set it to air
+            // If we're in removing mode, we set it to air
             ItemStack toGive = new ItemStack(world.getBlock(x, y, z));
             toGive.setItemDamage(world.getBlock(x, y, z).getDamageValue(world, x, y, z));
-            if (mode == REMOVING && !checkPermission(world, actor, x, y, z)) {
+            if (!checkPermission(world, actor, x, y, z)) {
                 return PlaceResult.REJECT;
             }
             world.setBlockToAir(x, y, z);
-            if (mode == REMOVING && !tryGiveOrDropItem(world, actor, toGive)) {
+            if (!tryGiveOrDropItem(world, actor, toGive)) {
                 // We were in removing mode and something went wrong while trying to give the player the block we
                 // ...removed, let's just fail for now
                 return PlaceResult.REJECT;
             }
+        } else if (!s.takeOne(stack, false)) {
+            if (world.isAirBlock(x, y, z)) {
+                return PlaceResult.SKIP;
+            }
+            // If the user didn't have the item in their inventory, we set it to air
+            ItemStack toGive = new ItemStack(world.getBlock(x, y, z));
+            toGive.setItemDamage(world.getBlock(x, y, z).getDamageValue(world, x, y, z));
+            world.setBlockToAir(x, y, z);
         }
         return PlaceResult.ACCEPT;
     }
@@ -768,7 +762,20 @@ public class StructureUtility {
      * given tier, then player will be allowed to use multiple kinds of blocks, but their tier is guaranteed to be the
      * same.
      * <p>
-     * <b>Example Implementation:</b>
+     * <h4>WARNING</h4> <b>You SHOULD NOT return notSet from your tierExtractor.</b> If you do so, we will have this
+     * chain of events:
+     * <ul>
+     * <li>at check start, tier is reset to notSet
+     * <li>the tier extractor returns notSet for first block, so since ofBlocksTiered finds your current tier is notSet,
+     * and the new block's tier is the same as that, so it's accepted
+     * <li>at 2nd, 3rd..., same thing in 2 happens
+     * <li>at last occurrence, player placed a valid block with a tier not notSet. ofBlocksTiered now sets your current
+     * tier to this tier, and accept the block
+     * <li>check got notified structure is sound, and tier is not notSet. it marks the structure as complete and start
+     * doing its business
+     * <li>Player enjoy a (probably) hilariously shaped multi and (probably) reduced build cost.
+     * </ul>
+     * <h4>Example Implementation</h4>
      * <p>
      * Assume you have 16 tier, each map to one particular block's 16 different meta. You will usually want something
      * like this
@@ -795,7 +802,7 @@ public class StructureUtility {
      * }
      * </pre>
      *
-     * Important bits:
+     * Important bits of this example implementation:
      * <ul>
      * <li>The supplied ITierConverter returns null for an invalid block</li>
      * <li>Possible tier returned by ITierConverter is Integer object 0 to 15.</li>
@@ -804,19 +811,8 @@ public class StructureUtility {
      * <li>notSet is never a tier returned by ITierConverter.</li>
      * </ul>
      * <p>
-     * <p>
-     * <b>You SHOULD NOT return notSet from your tierExtractor.</b> If you do so, we will have this chain of events:
-     * <ul>
-     * <li>at check start, tier is reset to notSet
-     * <li>the tier extractor returns notSet for first block, so since ofBlocksTiered finds your current tier is notSet,
-     * and the new block's tier is the same as that, so it's accepted
-     * <li>at 2nd, 3rd..., same thing in 2 happens
-     * <li>at last occurrence, player placed a valid block with a tier not notSet. ofBlocksTiered now sets your current
-     * tier to this tier, and accept the block
-     * <li>check got notified structure is sound, and tier is not notSet. it marks the structure as complete and start
-     * doing its business
-     * <li>Player enjoy a (probably) hilariously shaped multi and (probably) reduced build cost.
-     * </ul>
+     * As a friendly reminder, the above characteristics are only for this simply demo, not as a general restriction
+     * imposed by ofBlocksTiered.
      *
      * @param tierExtractor a function to extract tier info from a block. This function can return null and will never
      *                      be passed a null block or an invalid block meta. If this function returns null, then the
@@ -906,10 +902,14 @@ public class StructureUtility {
                 Block block = world.getBlock(x, y, z);
                 int meta = world.getBlockMetadata(x, y, z);
                 TIER tier = tierExtractor.convert(block, meta);
-                if (mode != REMOVING && (Objects.equals(tier, tierExtractor.convert(hint.getKey(), hint.getValue()))))
-                    return PlaceResult.SKIP;
-                if (mode == REMOVING && (!isInAllKnownTiers(block) && !world.isAirBlock(x, y, z))) {
-                    return PlaceResult.REJECT;
+                if (mode == REMOVING) {
+                    if (!isInAllKnownTiers(block) && !world.isAirBlock(x, y, z)) {
+                        return PlaceResult.REJECT;
+                    }
+                } else {
+                    if ((Objects.equals(tier, tierExtractor.convert(hint.getKey(), hint.getValue())))) {
+                        return PlaceResult.SKIP;
+                    }
                 }
                 return StructureUtility.survivalPlaceBlock(
                         hint.getKey(),
@@ -2048,7 +2048,6 @@ public class StructureUtility {
             @Deprecated
             public PlaceResult survivalPlaceBlock(T t, World world, int x, int y, int z, ItemStack trigger,
                     IItemSource s, EntityPlayerMP actor, Consumer<IChatComponent> chatter) {
-                ItemConstructableTrigger.TriggerMode mode = ItemConstructableTrigger.getMode(trigger);
                 if (predicate.test(t))
                     return downstream.survivalPlaceBlock(t, world, x, y, z, trigger, s, actor, chatter);
                 return placeResultWhenDisabled;
@@ -2057,7 +2056,6 @@ public class StructureUtility {
             @Override
             public PlaceResult survivalPlaceBlock(T t, World world, int x, int y, int z, ItemStack trigger,
                     AutoPlaceEnvironment env) {
-                ItemConstructableTrigger.TriggerMode mode = ItemConstructableTrigger.getMode(trigger);
                 if (predicate.test(t)) return downstream.survivalPlaceBlock(t, world, x, y, z, trigger, env);
                 return placeResultWhenDisabled;
             }
@@ -3464,8 +3462,8 @@ public class StructureUtility {
 
     public static boolean checkPermission(World world, EntityPlayer actor, int x, int y, int z) {
         boolean res = true;
-        if (isSULoaded) {
-            res = ServerUtilitiesCompat.checkPermission(world, actor, x, z);
+        if (StructureLib.COMPAT instanceof IStructureCompat isc) {
+            res = isc.checkServerUtilitiesPermission(world, actor, x, z);
         }
         res = res && !world.getBlock(x, y, z).isAssociatedBlock(Blocks.bedrock);
         // maybe check mining level who knows :shrug:

src/main/java/com/gtnewhorizon/structurelib/xmod/ServerUtilitiesCompat.java

@@ -1,29 +0,0 @@
-package com.gtnewhorizon.structurelib.xmod;
-
-import net.minecraft.entity.player.EntityPlayer;
-import net.minecraft.world.World;
-
-import cpw.mods.fml.common.Optional;
-import serverutils.data.ClaimedChunks;
-import serverutils.lib.data.ForgePlayer;
-import serverutils.lib.data.ForgeTeam;
-import serverutils.lib.data.Universe;
-import serverutils.lib.math.ChunkDimPos;
-
-public class ServerUtilitiesCompat {
-
-    @Optional.Method(modid = "serverutilities")
-    public static boolean checkPermission(World world, EntityPlayer actor, int x, int z) {
-        final ForgeTeam owningTeam = ClaimedChunks.instance
-                .getChunkTeam(new ChunkDimPos(x >> 4, z >> 4, world.provider.dimensionId));
-        if (owningTeam == null) {
-            return true;
-        }
-        final ForgePlayer currentPlayer = new ForgePlayer(
-                Universe.get(),
-                actor.getUniqueID(),
-                actor.getCommandSenderName());
-        return owningTeam.isAlly(currentPlayer) || owningTeam.isMember(currentPlayer);
-    }
-
-}

src/main/javadoc/overview.html

@@ -133,6 +133,16 @@ StructureLib API documentation.
     Usually there is no reason to reimplement this on your own.
 </p>
 
+<h2>{@link com.gtnewhorizon.structurelib.item.ModeToggleableItem}</h2>
+<p>
+    This class is the base class for {@link com.gtnewhorizon.structurelib.item.ItemConstructableTrigger} that defines
+    the <code>TriggerMode</code>s for the {@link com.gtnewhorizon.structurelib.item.ItemConstructableTrigger}. There are
+    3 modes, <code>BUILDING</code>, <code>UPDATING</code>, and <code>REMOVING</code>. Each of these modes does as they
+    say, where building will build a new multi from scratch, updating will remove existing an existing structure and
+    replace it with new components (think upgrading glass on a multi, changing from a tier 1 to tier 2 of a multi, etc),
+    and removing will just straight up remove the multi.
+</p>
+
 <h2><a href="#channels" id="channels">Channels</a></h2>
 
 <p>