Forge direction (#1895)

* ForgeDirection

Also refactor the clusterfuck that was `getCoordinateScan`

Co-authored by: Jason Mitchell <mitchej@gmail.com>

* Fix rendering of Frame Boxes

Frame boxes needed their own implementation of getTexture with int connexion mask,
which is returning an error texture for the MetaTileEntity, because pipes (FrameBox
**is** a pipe) do use this method to return different textures based on connexion
status.

---------

Co-authored-by: Léa Gris <lea.gris@noiraude.net>

1 files changed, 48 insertions, 50 deletions

diff --git a/src/main/java/gregtech/api/multitileentity/multiblock/base/Controller.java b/src/main/java/gregtech/api/multitileentity/multiblock/base/Controller.java
index 9fdac059da..a4fbb9f61e 100644
--- a/src/main/java/gregtech/api/multitileentity/multiblock/base/Controller.java
+++ b/src/main/java/gregtech/api/multitileentity/multiblock/base/Controller.java
@@ -2,7 +2,6 @@ package gregtech.api.multitileentity.multiblock.base;
 
 import static com.gtnewhorizon.structurelib.structure.StructureUtility.ofChain;
 import static gregtech.GT_Mod.GT_FML_LOGGER;
-import static gregtech.api.enums.GT_Values.ALL_VALID_SIDES;
 import static gregtech.api.multitileentity.enums.GT_MultiTileComponentCasing.*;
 import static gregtech.loaders.preload.GT_Loader_MultiTileEntities.COMPONENT_CASING_REGISTRY;
 import static mcp.mobius.waila.api.SpecialChars.*;
@@ -289,10 +288,8 @@ public abstract class Controller<T extends Controller<T>> extends MultiTileBasic
         if (outputTanks != null) registerFluidInventory("controller", "controller", outputTanks, Inventory.OUTPUT);
 
         structureOkay = nbt.getBoolean(NBT.STRUCTURE_OK);
-        extendedFacing = ExtendedFacing.of(
-            ForgeDirection.getOrientation(getFrontFacing()),
-            Rotation.byIndex(nbt.getByte(NBT.ROTATION)),
-            Flip.byIndex(nbt.getByte(NBT.FLIP)));
+        extendedFacing = ExtendedFacing
+            .of(getFrontFacing(), Rotation.byIndex(nbt.getByte(NBT.ROTATION)), Flip.byIndex(nbt.getByte(NBT.FLIP)));
 
         loadUpgradeInventoriesFromNBT(nbt);
         loadUpgradeTanksFromNBT(nbt);
@@ -308,10 +305,10 @@ public abstract class Controller<T extends Controller<T>> extends MultiTileBasic
             .getTagList(NBT.UPGRADE_INVENTORIES_INPUT, Constants.NBT.TAG_COMPOUND);
         for (int i = 0; i < listInputInventories.tagCount(); i++) {
             final NBTTagCompound nbtInv = listInputInventories.getCompoundTagAt(i);
-            String invUUID = nbtInv.getString(NBT.UPGRADE_INVENTORY_UUID);
-            String invName = nbtInv.getString(NBT.UPGRADE_INVENTORY_NAME);
-            int invSize = nbtInv.getInteger(NBT.UPGRADE_INVENTORY_SIZE);
-            IItemHandlerModifiable inv = new ItemStackHandler(invSize);
+            final String invUUID = nbtInv.getString(NBT.UPGRADE_INVENTORY_UUID);
+            final String invName = nbtInv.getString(NBT.UPGRADE_INVENTORY_NAME);
+            final int invSize = nbtInv.getInteger(NBT.UPGRADE_INVENTORY_SIZE);
+            final IItemHandlerModifiable inv = new ItemStackHandler(invSize);
             loadInventory(nbtInv, inv, NBT.INV_INPUT_LIST);
             registerInventory(invName, invUUID, invSize, Inventory.INPUT);
         }
@@ -320,9 +317,9 @@ public abstract class Controller<T extends Controller<T>> extends MultiTileBasic
             .getTagList(NBT.UPGRADE_INVENTORIES_OUTPUT, Constants.NBT.TAG_COMPOUND);
         for (int i = 0; i < listOutputInventories.tagCount(); i++) {
             final NBTTagCompound nbtInv = listOutputInventories.getCompoundTagAt(i);
-            String invUUID = nbtInv.getString(NBT.UPGRADE_INVENTORY_UUID);
-            String invName = nbtInv.getString(NBT.UPGRADE_INVENTORY_NAME);
-            int invSize = nbtInv.getInteger(NBT.UPGRADE_INVENTORY_SIZE);
+            final String invUUID = nbtInv.getString(NBT.UPGRADE_INVENTORY_UUID);
+            final String invName = nbtInv.getString(NBT.UPGRADE_INVENTORY_NAME);
+            final int invSize = nbtInv.getInteger(NBT.UPGRADE_INVENTORY_SIZE);
             IItemHandlerModifiable inv = new ItemStackHandler(invSize);
             loadInventory(nbtInv, inv, NBT.INV_OUTPUT_LIST);
             registerInventory(invName, invUUID, invSize, Inventory.OUTPUT);
@@ -532,8 +529,8 @@ public abstract class Controller<T extends Controller<T>> extends MultiTileBasic
     }
 
     @Override
-    public boolean onWrenchRightClick(EntityPlayer aPlayer, ItemStack tCurrentItem, byte wrenchSide, float aX, float aY,
-        float aZ) {
+    public boolean onWrenchRightClick(EntityPlayer aPlayer, ItemStack tCurrentItem, ForgeDirection wrenchSide, float aX,
+        float aY, float aZ) {
         if (wrenchSide != getFrontFacing())
             return super.onWrenchRightClick(aPlayer, tCurrentItem, wrenchSide, aX, aY, aZ);
         if (aPlayer.isSneaking()) {
@@ -548,19 +545,19 @@ public abstract class Controller<T extends Controller<T>> extends MultiTileBasic
     }
 
     @Override
-    public void registerCoveredPartOnSide(final int aSide, IMultiBlockPart part) {
-        if (aSide < 0 || aSide >= 6) return;
+    public void registerCoveredPartOnSide(final ForgeDirection side, IMultiBlockPart part) {
+        if (side == ForgeDirection.UNKNOWN) return;
 
-        final LinkedList<WeakReference<IMultiBlockPart>> registeredCovers = registeredCoveredParts.get(aSide);
+        final LinkedList<WeakReference<IMultiBlockPart>> registeredCovers = registeredCoveredParts.get(side.ordinal());
         // TODO: Make sure that we're not already registered on this side
         registeredCovers.add(new WeakReference<>(part));
     }
 
     @Override
-    public void unregisterCoveredPartOnSide(final int aSide, IMultiBlockPart aPart) {
-        if (aSide < 0 || aSide >= 6) return;
+    public void unregisterCoveredPartOnSide(final ForgeDirection side, IMultiBlockPart aPart) {
+        if (side == ForgeDirection.UNKNOWN) return;
 
-        final LinkedList<WeakReference<IMultiBlockPart>> coveredParts = registeredCoveredParts.get(aSide);
+        final LinkedList<WeakReference<IMultiBlockPart>> coveredParts = registeredCoveredParts.get(side.ordinal());
         final Iterator<WeakReference<IMultiBlockPart>> it = coveredParts.iterator();
         while (it.hasNext()) {
             final IMultiBlockPart part = (it.next()).get();
@@ -579,9 +576,10 @@ public abstract class Controller<T extends Controller<T>> extends MultiTileBasic
     }
 
     private boolean tickCovers() {
-        for (byte side : ALL_VALID_SIDES) {
+        for (final ForgeDirection side : ForgeDirection.VALID_DIRECTIONS) {
             // TODO: Tick controller covers, if any
-            final LinkedList<WeakReference<IMultiBlockPart>> coveredParts = this.registeredCoveredParts.get(side);
+            final LinkedList<WeakReference<IMultiBlockPart>> coveredParts = this.registeredCoveredParts
+                .get(side.ordinal());
             final Iterator<WeakReference<IMultiBlockPart>> it = coveredParts.iterator();
             while (it.hasNext()) {
                 final IMultiBlockPart part = (it.next()).get();
@@ -626,19 +624,19 @@ public abstract class Controller<T extends Controller<T>> extends MultiTileBasic
     }
 
     @Override
-    public final boolean isFacingValid(byte aFacing) {
-        return canSetToDirectionAny(ForgeDirection.getOrientation(aFacing));
+    public final boolean isFacingValid(ForgeDirection facing) {
+        return canSetToDirectionAny(facing);
     }
 
     @Override
     public void onFacingChange() {
-        toolSetDirection(ForgeDirection.getOrientation(getFrontFacing()));
+        toolSetDirection(getFrontFacing());
         onStructureChange();
     }
 
     @Override
-    public boolean allowCoverOnSide(byte aSide, GT_ItemStack aCoverID) {
-        return facing.compareTo(ForgeDirection.getOrientation(aSide)) != 0;
+    public boolean allowCoverOnSide(ForgeDirection side, GT_ItemStack aCoverID) {
+        return side != facing;
     }
 
     @Override
@@ -672,14 +670,14 @@ public abstract class Controller<T extends Controller<T>> extends MultiTileBasic
     }
 
     @Override
-    public FluidStack getDrainableFluid(byte aSide) {
-        return getDrainableFluid(aSide, null);
+    public FluidStack getDrainableFluid(ForgeDirection side) {
+        return getDrainableFluid(side, null);
     }
 
     @Override
-    public FluidStack getDrainableFluid(byte aSide, Fluid fluidToDrain) {
+    public FluidStack getDrainableFluid(ForgeDirection side, Fluid fluidToDrain) {
         final IFluidTank tank = getFluidTankDrainable(
-            aSide,
+            side,
             fluidToDrain == null ? null : new FluidStack(fluidToDrain, 0));
         return tank == null ? null : tank.getFluid();
     }
@@ -1054,22 +1052,22 @@ public abstract class Controller<T extends Controller<T>> extends MultiTileBasic
         return tanks.toArray(new FluidTankGT[0]);
     }
 
-    protected IFluidTank getFluidTankFillable(MultiBlockPart aPart, byte aSide, FluidStack aFluidToFill) {
-        return getFluidTankFillable(aPart.getFrontFacing(), aSide, aFluidToFill);
+    protected IFluidTank getFluidTankFillable(MultiBlockPart aPart, ForgeDirection side, FluidStack aFluidToFill) {
+        return getFluidTankFillable(side, aFluidToFill);
     }
 
-    protected IFluidTank getFluidTankDrainable(MultiBlockPart aPart, byte aSide, FluidStack aFluidToDrain) {
-        return getFluidTankDrainable(aPart.getFrontFacing(), aSide, aFluidToDrain);
+    protected IFluidTank getFluidTankDrainable(MultiBlockPart aPart, ForgeDirection side, FluidStack aFluidToDrain) {
+        return getFluidTankDrainable(side, aFluidToDrain);
     }
 
-    protected IFluidTank[] getFluidTanks(MultiBlockPart aPart, byte aSide) {
-        return getFluidTanks(aSide);
+    protected IFluidTank[] getFluidTanks(MultiBlockPart aPart, ForgeDirection side) {
+        return getFluidTanks(side);
     }
 
     @Override
     public int fill(MultiBlockPart aPart, ForgeDirection aDirection, FluidStack aFluid, boolean aDoFill) {
         if (aFluid == null || aFluid.amount <= 0) return 0;
-        final IFluidTank tTank = getFluidTankFillable(aPart, (byte) aDirection.ordinal(), aFluid);
+        final IFluidTank tTank = getFluidTankFillable(aPart, aDirection, aFluid);
         if (tTank == null) return 0;
         final int rFilledAmount = tTank.fill(aFluid, aDoFill);
         if (rFilledAmount > 0 && aDoFill) hasInventoryChanged = true;
@@ -1079,7 +1077,7 @@ public abstract class Controller<T extends Controller<T>> extends MultiTileBasic
     @Override
     public FluidStack drain(MultiBlockPart aPart, ForgeDirection aDirection, FluidStack aFluid, boolean aDoDrain) {
         if (aFluid == null || aFluid.amount <= 0) return null;
-        final IFluidTank tTank = getFluidTankDrainable(aPart, (byte) aDirection.ordinal(), aFluid);
+        final IFluidTank tTank = getFluidTankDrainable(aPart, aDirection, aFluid);
         if (tTank == null || tTank.getFluid() == null
             || tTank.getFluidAmount() == 0
             || !tTank.getFluid()
@@ -1093,7 +1091,7 @@ public abstract class Controller<T extends Controller<T>> extends MultiTileBasic
     @Override
     public FluidStack drain(MultiBlockPart aPart, ForgeDirection aDirection, int aAmountToDrain, boolean aDoDrain) {
         if (aAmountToDrain <= 0) return null;
-        final IFluidTank tTank = getFluidTankDrainable(aPart, (byte) aDirection.ordinal(), null);
+        final IFluidTank tTank = getFluidTankDrainable(aPart, aDirection, null);
         if (tTank == null || tTank.getFluid() == null || tTank.getFluidAmount() == 0) return null;
         final FluidStack rDrained = tTank.drain(aAmountToDrain, aDoDrain);
         if (rDrained != null && aDoDrain) markInventoryBeenModified();
@@ -1103,7 +1101,7 @@ public abstract class Controller<T extends Controller<T>> extends MultiTileBasic
     @Override
     public boolean canFill(MultiBlockPart aPart, ForgeDirection aDirection, Fluid aFluid) {
         if (aFluid == null) return false;
-        final IFluidTank tTank = getFluidTankFillable(aPart, (byte) aDirection.ordinal(), new FluidStack(aFluid, 0));
+        final IFluidTank tTank = getFluidTankFillable(aPart, aDirection, new FluidStack(aFluid, 0));
         return tTank != null && (tTank.getFluid() == null || tTank.getFluid()
             .getFluid() == aFluid);
     }
@@ -1111,14 +1109,14 @@ public abstract class Controller<T extends Controller<T>> extends MultiTileBasic
     @Override
     public boolean canDrain(MultiBlockPart aPart, ForgeDirection aDirection, Fluid aFluid) {
         if (aFluid == null) return false;
-        final IFluidTank tTank = getFluidTankDrainable(aPart, (byte) aDirection.ordinal(), new FluidStack(aFluid, 0));
+        final IFluidTank tTank = getFluidTankDrainable(aPart, aDirection, new FluidStack(aFluid, 0));
         return tTank != null && (tTank.getFluid() != null && tTank.getFluid()
             .getFluid() == aFluid);
     }
 
     @Override
     public FluidTankInfo[] getTankInfo(MultiBlockPart aPart, ForgeDirection aDirection) {
-        final IFluidTank[] tTanks = getFluidTanks(aPart, (byte) aDirection.ordinal());
+        final IFluidTank[] tTanks = getFluidTanks(aPart, aDirection);
         if (tTanks == null || tTanks.length <= 0) return GT_Values.emptyFluidTankInfo;
         final FluidTankInfo[] rInfo = new FluidTankInfo[tTanks.length];
         for (int i = 0; i < tTanks.length; i++) rInfo[i] = new FluidTankInfo(tTanks[i]);
@@ -1143,15 +1141,15 @@ public abstract class Controller<T extends Controller<T>> extends MultiTileBasic
     // #region Energy
     @Override
     public PowerLogic getPowerLogic(IMultiBlockPart part, ForgeDirection side) {
-        if (!(this instanceof PowerLogicHost)) {
+        if (!(this instanceof PowerLogicHost powerLogicHost)) {
             return null;
         }
 
-        if (ForgeDirection.getOrientation(part.getFrontFacing()) != side) {
+        if (part.getFrontFacing() != side) {
             return null;
         }
 
-        return ((PowerLogicHost) this).getPowerLogic(side);
+        return powerLogicHost.getPowerLogic(side);
     }
     // #endregion Energy
 
@@ -1294,7 +1292,7 @@ public abstract class Controller<T extends Controller<T>> extends MultiTileBasic
     }
 
     @Override
-    public int[] getAccessibleSlotsFromSide(MultiBlockPart aPart, byte aSide) {
+    public int[] getAccessibleSlotsFromSide(MultiBlockPart aPart, ForgeDirection side) {
         final TIntList tList = new TIntArrayList();
         final Map<String, IItemHandlerModifiable> multiBlockInventory = getMultiBlockInventory(aPart);
         if (multiBlockInventory == null) return tList.toArray();
@@ -1318,7 +1316,7 @@ public abstract class Controller<T extends Controller<T>> extends MultiTileBasic
     }
 
     @Override
-    public boolean canInsertItem(MultiBlockPart aPart, int aSlot, ItemStack aStack, byte aSide) {
+    public boolean canInsertItem(MultiBlockPart aPart, int aSlot, ItemStack aStack, ForgeDirection side) {
         final Pair<IItemHandlerModifiable, Integer> tInv = getInventory(aPart, aSlot);
         if (tInv == null) return false;
 
@@ -1334,7 +1332,7 @@ public abstract class Controller<T extends Controller<T>> extends MultiTileBasic
     }
 
     @Override
-    public boolean canExtractItem(MultiBlockPart aPart, int aSlot, ItemStack aStack, byte aSide) {
+    public boolean canExtractItem(MultiBlockPart aPart, int aSlot, ItemStack aStack, ForgeDirection side) {
         final Pair<IItemHandlerModifiable, Integer> tInv = getInventory(aPart, aSlot);
         if (tInv == null) return false;
 
@@ -1738,7 +1736,7 @@ public abstract class Controller<T extends Controller<T>> extends MultiTileBasic
     }
 
     @Override
-    public boolean hasGui(byte aSide) {
+    public boolean hasGui(ForgeDirection side) {
         return true;
     }