Rewrite GUIs with ModularUI (#1381)

* Base work for ModularUI compat

* Remove useless interface

* Add almost all the widgets

* Invert method

* Refactor NEI stack placement positions

* NEI handlers on ModularUI

* Add some more docs

* AdvDebugStructureWriter

* Fix NEI progressbar not working

* PrimitiveBlastFurnace

* clean

* derp

* clean

* spotlessApply

* Boilers

* Buffers

* clean

* N by N slots containers

* Fix boilers not having bucket interaction
Put opening UI to individual MetaTEs

* Maintenance Hatch

* clean

* spotlessApply

* Add dependency

* IndustrialApiary

* Adapt to ModularUI change

* Base work for covers & fix crash with MP

* Fix crash with server

* Rewrite base work for covers

* Send initial cover data on cover GUI open
so that the time of showing incorrect data will be eliminated

* Covers part 1

* Rename package: ModularUI -> modularui

* Rename class: GT_UIInfo -> GT_UIInfos

* Fix build

* Covers part2

* Fix missing client check with tile UI & fix title overlap

* CoverTabLine

* Move cover window creators to inner class

* Fix crash with null base TE

* Close GUI when tile is broken

* Color cover window with tile colorization

* Change signature of addUIWidgets

* FluidFilter cover, FluidDisplaySlotWidget, BasicTank, BasicGenerator, Output Hatch, MicrowaveEnergyTransmitter, Teleporter, DigitalChest, DigitalTank

* Add title tab

* Move package: modularui -> modularui/widget

* Programmed circuit + IConfigurationCircuitSupport

* clean

* VolumetricFlask

* Remove integrated circuit overlay from recipe input slots

* Input Hatch & Quadruple Input Hatch

* Multiblock

* Deprecate old cover GUI

* BasicMachines

* Finish BasicMachine & NEI

* Expand DTPF NEI to 9 slots

* Fix ME input bus on MP

* Move AESlotWidget to public class

* Move GT_Recipe_Map constructors with mNEIUnificateOutput to setter method

* Move SteamTexture.Variant to outer enum

* Switch to remote repository

* oops

* Update MUI

* Update MUI

* Minor refactor for change amount buttons

* Display items and fluids that exceed usual count

* blah

* use +=, why didn't I do this

* Update MUI

* Move ModularUI to Base (#1510)

* Move ModularUI to Base
* Move most of the ModularUI functionality to `BaseTileEntity` (and `CoverableTileEntity`)
* `CommonMetaTileEntity` delegates ato the MetaTileEntity
* Added several interfaces (with defaults) to indicate if a tile/metatile override/implement certain behaviors.
* Moved `IConfigurationCircuitSupport` interface such that it will work with BaseTileEntity or a MetaTileEntity

* Address reviews

Co-authored-by: miozune <miozune@gmail.com>

* Update MUI

* Minor changes to NEI

* Return :facepalm:

* IGetTabIconSet override

* Some more changes to NEI

* Merge texture getter interfaces to new class GUITextureSet

* Remove BBF structure picture as it's auto-buildable now

* Make unified title tab style of texture angular

* Expose some boiler texture getters for addon

* Fix crash with cover GUI on pipe

* Lower the number of recipe per page for DTPF & update MUI

* Update MUI

* Fix crash with middle-clicking slot on circuit selection GUI

* Fix circuit selection window not syncing item from base machine

* Merge GT_NEI_AssLineHandler into GT_NEI_DefaultHandler

* Update MUI

* Add in TecTech multi message

* Allow changing the way of binding player inventory

* Update MUI

* Update MUI

* Update MUI

* Update MUI

* Update MUI

* Make MUI non-transitive to allow addons to use their own version

* Force enable mixin

* Format fluid amount tooltip

* Add GUITextureSet.STEAM

* Add guard against null ModularWindow creation

* Add constructors for Muffler Hatch with inventory

* Fix output slot on digital chest and tank allowing insertion

* Don't log null ModularWindow

* Add default implementation for IHasWorldObjectAndCoords#openGUI

* Make openGTTileEntityUI accept MultiTE & cleanup

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

2 files changed, 230 insertions, 31 deletions

diff --git a/src/main/java/gregtech/common/tileentities/storage/GT_MetaTileEntity_DigitalChestBase.java b/src/main/java/gregtech/common/tileentities/storage/GT_MetaTileEntity_DigitalChestBase.java
index 28ff39315e..747116400a 100644
--- a/src/main/java/gregtech/common/tileentities/storage/GT_MetaTileEntity_DigitalChestBase.java
+++ b/src/main/java/gregtech/common/tileentities/storage/GT_MetaTileEntity_DigitalChestBase.java
@@ -4,17 +4,23 @@ import static gregtech.api.enums.Textures.BlockIcons.MACHINE_CASINGS;
 import static gregtech.api.enums.Textures.BlockIcons.OVERLAY_SCHEST;
 import static gregtech.api.enums.Textures.BlockIcons.OVERLAY_SCHEST_GLOW;
 
+import com.gtnewhorizons.modularui.api.screen.ModularWindow;
+import com.gtnewhorizons.modularui.api.screen.UIBuildContext;
+import com.gtnewhorizons.modularui.common.widget.DrawableWidget;
+import com.gtnewhorizons.modularui.common.widget.SlotWidget;
+import com.gtnewhorizons.modularui.common.widget.TextWidget;
 import cpw.mods.fml.common.Optional;
 import gregtech.api.GregTech_API;
 import gregtech.api.enums.GT_Values;
+import gregtech.api.gui.modularui.GT_UIInfos;
+import gregtech.api.gui.modularui.GT_UITextures;
 import gregtech.api.interfaces.ITexture;
+import gregtech.api.interfaces.modularui.IAddUIWidgets;
 import gregtech.api.interfaces.tileentity.IGregTechTileEntity;
 import gregtech.api.metatileentity.implementations.GT_MetaTileEntity_TieredMachineBlock;
 import gregtech.api.objects.AE2DigitalChestHandler;
 import gregtech.api.render.TextureFactory;
 import gregtech.api.util.GT_Utility;
-import gregtech.common.gui.GT_Container_QuantumChest;
-import gregtech.common.gui.GT_GUIContainer_QuantumChest;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -22,7 +28,6 @@ import mcp.mobius.waila.api.IWailaConfigHandler;
 import mcp.mobius.waila.api.IWailaDataAccessor;
 import net.minecraft.entity.player.EntityPlayer;
 import net.minecraft.entity.player.EntityPlayerMP;
-import net.minecraft.entity.player.InventoryPlayer;
 import net.minecraft.item.ItemStack;
 import net.minecraft.nbt.NBTTagCompound;
 import net.minecraft.tileentity.TileEntity;
@@ -33,7 +38,7 @@ import net.minecraftforge.common.util.Constants;
 
 @Optional.Interface(iface = "appeng.api.storage.IMEMonitor", modid = "appliedenergistics2", striprefs = true)
 public abstract class GT_MetaTileEntity_DigitalChestBase extends GT_MetaTileEntity_TieredMachineBlock
-        implements appeng.api.storage.IMEMonitor<appeng.api.storage.data.IAEItemStack> {
+        implements appeng.api.storage.IMEMonitor<appeng.api.storage.data.IAEItemStack>, IAddUIWidgets {
     protected boolean mVoidOverflow = false;
     protected boolean mDisableFilter;
     public boolean voidBreak;
@@ -194,16 +199,6 @@ public abstract class GT_MetaTileEntity_DigitalChestBase extends GT_MetaTileEnti
     }
 
     @Override
-    public Object getServerGUI(int aID, InventoryPlayer aPlayerInventory, IGregTechTileEntity aBaseMetaTileEntity) {
-        return new GT_Container_QuantumChest(aPlayerInventory, aBaseMetaTileEntity);
-    }
-
-    @Override
-    public Object getClientGUI(int aID, InventoryPlayer aPlayerInventory, IGregTechTileEntity aBaseMetaTileEntity) {
-        return new GT_GUIContainer_QuantumChest(aPlayerInventory, aBaseMetaTileEntity, getLocalName());
-    }
-
-    @Override
     public ITexture[][][] getTextureSet(ITexture[] aTextures) {
         return new ITexture[0][0][0];
     }
@@ -360,7 +355,7 @@ public abstract class GT_MetaTileEntity_DigitalChestBase extends GT_MetaTileEnti
 
     @Override
     public boolean onRightclick(IGregTechTileEntity aBaseMetaTileEntity, EntityPlayer aPlayer) {
-        if (!aBaseMetaTileEntity.isClientSide()) aBaseMetaTileEntity.openGUI(aPlayer);
+        GT_UIInfos.openGTTileEntityUI(aBaseMetaTileEntity, aPlayer);
         return true;
     }
 
@@ -543,4 +538,37 @@ public abstract class GT_MetaTileEntity_DigitalChestBase extends GT_MetaTileEnti
         tag.setInteger("itemCount", realItemCount);
         tag.setTag("itemType", is.writeToNBT(new NBTTagCompound()));
     }
+
+    @Override
+    public boolean useModularUI() {
+        return true;
+    }
+
+    @Override
+    public void addUIWidgets(ModularWindow.Builder builder, UIBuildContext buildContext) {
+        builder.widget(new DrawableWidget()
+                        .setDrawable(GT_UITextures.PICTURE_SCREEN_BLACK)
+                        .setPos(7, 16)
+                        .setSize(71, 45))
+                .widget(new SlotWidget(inventoryHandler, 0)
+                        .setBackground(getGUITextureSet().getItemSlot(), GT_UITextures.OVERLAY_SLOT_IN)
+                        .setPos(79, 16))
+                .widget(new SlotWidget(inventoryHandler, 1)
+                        .setAccess(true, false)
+                        .setBackground(getGUITextureSet().getItemSlot(), GT_UITextures.OVERLAY_SLOT_OUT)
+                        .setPos(79, 52))
+                .widget(SlotWidget.phantom(inventoryHandler, 2)
+                        .disableInteraction()
+                        .setBackground(GT_UITextures.TRANSPARENT)
+                        .setPos(59, 42))
+                .widget(new TextWidget("Item Amount")
+                        .setDefaultColor(COLOR_TEXT_WHITE.get())
+                        .setPos(10, 20))
+                .widget(TextWidget.dynamicString(() -> GT_Utility.parseNumberToString(
+                                this instanceof GT_MetaTileEntity_QuantumChest
+                                        ? ((GT_MetaTileEntity_QuantumChest) this).mItemCount
+                                        : 0))
+                        .setDefaultColor(COLOR_TEXT_WHITE.get())
+                        .setPos(10, 30));
+    }
 }
diff --git a/src/main/java/gregtech/common/tileentities/storage/GT_MetaTileEntity_DigitalTankBase.java b/src/main/java/gregtech/common/tileentities/storage/GT_MetaTileEntity_DigitalTankBase.java
index 2a996e050a..a4d1f1113f 100644
--- a/src/main/java/gregtech/common/tileentities/storage/GT_MetaTileEntity_DigitalTankBase.java
+++ b/src/main/java/gregtech/common/tileentities/storage/GT_MetaTileEntity_DigitalTankBase.java
@@ -1,21 +1,31 @@
 package gregtech.common.tileentities.storage;
 
 import static gregtech.api.enums.Textures.BlockIcons.*;
-
-import gregtech.api.gui.GT_Container_DigitalTank;
-import gregtech.api.gui.GT_GUIContainer_DigitalTank;
+import static gregtech.api.metatileentity.BaseTileEntity.TOOLTIP_DELAY;
+
+import com.gtnewhorizons.modularui.api.screen.ModularWindow;
+import com.gtnewhorizons.modularui.api.screen.UIBuildContext;
+import com.gtnewhorizons.modularui.common.internal.network.NetworkUtils;
+import com.gtnewhorizons.modularui.common.widget.CycleButtonWidget;
+import com.gtnewhorizons.modularui.common.widget.DrawableWidget;
+import com.gtnewhorizons.modularui.common.widget.SlotWidget;
+import com.gtnewhorizons.modularui.common.widget.TextWidget;
+import gregtech.api.gui.modularui.GT_UIInfos;
+import gregtech.api.gui.modularui.GT_UITextures;
+import gregtech.api.interfaces.IFluidAccess;
 import gregtech.api.interfaces.ITexture;
 import gregtech.api.interfaces.metatileentity.IFluidLockable;
+import gregtech.api.interfaces.modularui.IAddUIWidgets;
 import gregtech.api.interfaces.tileentity.IGregTechTileEntity;
 import gregtech.api.metatileentity.implementations.GT_MetaTileEntity_BasicTank;
 import gregtech.api.render.TextureFactory;
 import gregtech.api.util.GT_Utility;
+import gregtech.common.gui.modularui.widget.FluidDisplaySlotWidget;
 import java.util.List;
 import mcp.mobius.waila.api.IWailaConfigHandler;
 import mcp.mobius.waila.api.IWailaDataAccessor;
 import net.minecraft.entity.player.EntityPlayer;
 import net.minecraft.entity.player.EntityPlayerMP;
-import net.minecraft.entity.player.InventoryPlayer;
 import net.minecraft.item.ItemStack;
 import net.minecraft.nbt.NBTTagCompound;
 import net.minecraft.tileentity.TileEntity;
@@ -28,7 +38,8 @@ import net.minecraftforge.fluids.FluidStack;
 import net.minecraftforge.fluids.FluidTankInfo;
 import net.minecraftforge.fluids.IFluidHandler;
 
-public abstract class GT_MetaTileEntity_DigitalTankBase extends GT_MetaTileEntity_BasicTank implements IFluidLockable {
+public abstract class GT_MetaTileEntity_DigitalTankBase extends GT_MetaTileEntity_BasicTank
+        implements IFluidLockable, IAddUIWidgets {
     public boolean mOutputFluid = false, mVoidFluidPart = false, mVoidFluidFull = false, mLockFluid = false;
     protected String lockedFluidName = null;
     private boolean voidBreak;
@@ -235,7 +246,7 @@ public abstract class GT_MetaTileEntity_DigitalTankBase extends GT_MetaTileEntit
 
     @Override
     public boolean onRightclick(IGregTechTileEntity aBaseMetaTileEntity, EntityPlayer aPlayer) {
-        if (!aBaseMetaTileEntity.isClientSide()) aBaseMetaTileEntity.openGUI(aPlayer);
+        GT_UIInfos.openGTTileEntityUI(aBaseMetaTileEntity, aPlayer);
         return true;
     }
 
@@ -273,16 +284,6 @@ public abstract class GT_MetaTileEntity_DigitalTankBase extends GT_MetaTileEntit
     }
 
     @Override
-    public Object getServerGUI(int aID, InventoryPlayer aPlayerInventory, IGregTechTileEntity aBaseMetaTileEntity) {
-        return new GT_Container_DigitalTank(aPlayerInventory, aBaseMetaTileEntity);
-    }
-
-    @Override
-    public Object getClientGUI(int aID, InventoryPlayer aPlayerInventory, IGregTechTileEntity aBaseMetaTileEntity) {
-        return new GT_GUIContainer_DigitalTank(aPlayerInventory, aBaseMetaTileEntity, getLocalName());
-    }
-
-    @Override
     public void onPreTick(IGregTechTileEntity aBaseMetaTileEntity, long aTick) {
         if (aBaseMetaTileEntity.isServerSide()) {
             if (isFluidChangingAllowed() && getFillableStack() != null && getFillableStack().amount <= 0)
@@ -476,4 +477,174 @@ public abstract class GT_MetaTileEntity_DigitalTankBase extends GT_MetaTileEntit
         if (fluid != null) tag.setTag("mFluid", fluid.writeToNBT(new NBTTagCompound()));
         else if (tag.hasKey("mFluid")) tag.removeTag("mFluid");
     }
+
+    @Override
+    public boolean useModularUI() {
+        return true;
+    }
+
+    @Override
+    public void addUIWidgets(ModularWindow.Builder builder, UIBuildContext buildContext) {
+        builder.widget(new DrawableWidget()
+                        .setDrawable(GT_UITextures.PICTURE_SCREEN_BLACK)
+                        .setPos(7, 16)
+                        .setSize(71, 45))
+                .widget(new SlotWidget(inventoryHandler, getInputSlot())
+                        .setBackground(getGUITextureSet().getItemSlot(), GT_UITextures.OVERLAY_SLOT_IN)
+                        .setPos(79, 16))
+                .widget(new SlotWidget(inventoryHandler, getOutputSlot())
+                        .setAccess(true, false)
+                        .setBackground(getGUITextureSet().getItemSlot(), GT_UITextures.OVERLAY_SLOT_OUT)
+                        .setPos(79, 43))
+                .widget(new FluidDisplaySlotWidget(inventoryHandler, getStackDisplaySlot())
+                        .setFluidAccessConstructor(() -> constructFluidAccess(false))
+                        .setIHasFluidDisplay(this)
+                        .setCanDrain(true)
+                        .setCanFill(!isDrainableStackSeparate())
+                        .setActionRealClick(FluidDisplaySlotWidget.Action.TRANSFER)
+                        .setActionDragAndDrop(FluidDisplaySlotWidget.Action.LOCK)
+                        .setBeforeRealClick((clickData, widget) -> {
+                            if (NetworkUtils.isClient()) {
+                                // propagate display item content to actual fluid stored in this tank
+                                setDrainableStack(GT_Utility.getFluidFromDisplayStack(
+                                        widget.getMcSlot().getStack()));
+                            }
+                            return true;
+                        })
+                        .setBackground(GT_UITextures.TRANSPARENT)
+                        .setPos(58, 41))
+                .widget(new TextWidget("Liquid Amount")
+                        .setDefaultColor(COLOR_TEXT_WHITE.get())
+                        .setPos(10, 20))
+                .widget(TextWidget.dynamicString(
+                                () -> GT_Utility.parseNumberToString(mFluid != null ? mFluid.amount : 0))
+                        .setDefaultColor(COLOR_TEXT_WHITE.get())
+                        .setPos(10, 30))
+                .widget(new CycleButtonWidget()
+                        .setToggle(() -> mOutputFluid, val -> {
+                            mOutputFluid = val;
+                            if (!mOutputFluid) {
+                                GT_Utility.sendChatToPlayer(
+                                        buildContext.getPlayer(),
+                                        GT_Utility.trans("262", "Fluid Auto Output Disabled"));
+                            } else {
+                                GT_Utility.sendChatToPlayer(
+                                        buildContext.getPlayer(), GT_Utility.trans("263", "Fluid Auto Output Enabled"));
+                            }
+                        })
+                        .setVariableBackground(GT_UITextures.BUTTON_STANDARD_TOGGLE)
+                        .setStaticTexture(GT_UITextures.OVERLAY_BUTTON_AUTOOUTPUT_FLUID)
+                        .setGTTooltip(() -> mTooltipCache.getData("GT5U.machines.digitaltank.autooutput.tooltip"))
+                        .setTooltipShowUpDelay(TOOLTIP_DELAY)
+                        .setPos(7, 63)
+                        .setSize(18, 18))
+                .widget(new CycleButtonWidget()
+                        .setToggle(() -> mLockFluid, val -> {
+                            mLockFluid = val;
+
+                            String inBrackets;
+                            if (mLockFluid) {
+                                if (mFluid == null) {
+                                    setLockedFluidName(null);
+                                    inBrackets = GT_Utility.trans(
+                                            "264", "currently none, will be locked to the next that is put in");
+                                } else {
+                                    setLockedFluidName(
+                                            getDrainableStack().getFluid().getName());
+                                    inBrackets = getDrainableStack().getLocalizedName();
+                                }
+                                GT_Utility.sendChatToPlayer(
+                                        buildContext.getPlayer(),
+                                        String.format(
+                                                "%s (%s)", GT_Utility.trans("265", "1 specific Fluid"), inBrackets));
+                            } else {
+                                setLockedFluidName(null);
+                                GT_Utility.sendChatToPlayer(
+                                        buildContext.getPlayer(), GT_Utility.trans("266", "Lock Fluid Mode Disabled"));
+                            }
+                        })
+                        .setVariableBackground(GT_UITextures.BUTTON_STANDARD_TOGGLE)
+                        .setStaticTexture(GT_UITextures.OVERLAY_BUTTON_LOCK)
+                        .setGTTooltip(() -> mTooltipCache.getData("GT5U.machines.digitaltank.lockfluid.tooltip"))
+                        .setTooltipShowUpDelay(TOOLTIP_DELAY)
+                        .setPos(25, 63)
+                        .setSize(18, 18))
+                .widget(new CycleButtonWidget()
+                        .setToggle(() -> mAllowInputFromOutputSide, val -> {
+                            mAllowInputFromOutputSide = val;
+                            if (!mAllowInputFromOutputSide) {
+                                GT_Utility.sendChatToPlayer(buildContext.getPlayer(), GT_Utility.getTrans("096"));
+                            } else {
+                                GT_Utility.sendChatToPlayer(buildContext.getPlayer(), GT_Utility.getTrans("095"));
+                            }
+                        })
+                        .setVariableBackground(GT_UITextures.BUTTON_STANDARD_TOGGLE)
+                        .setStaticTexture(GT_UITextures.OVERLAY_BUTTON_INPUT_FROM_OUTPUT_SIDE)
+                        .setGTTooltip(() -> mTooltipCache.getData("GT5U.machines.digitaltank.inputfromoutput.tooltip"))
+                        .setTooltipShowUpDelay(TOOLTIP_DELAY)
+                        .setPos(43, 63)
+                        .setSize(18, 18))
+                .widget(new CycleButtonWidget()
+                        .setToggle(() -> mVoidFluidPart, val -> {
+                            mVoidFluidPart = val;
+                            if (!mVoidFluidPart) {
+                                GT_Utility.sendChatToPlayer(
+                                        buildContext.getPlayer(),
+                                        GT_Utility.trans("267", "Overflow Voiding Mode Disabled"));
+                            } else {
+                                GT_Utility.sendChatToPlayer(
+                                        buildContext.getPlayer(),
+                                        GT_Utility.trans("268", "Overflow Voiding Mode Enabled"));
+                            }
+                        })
+                        .setVariableBackground(GT_UITextures.BUTTON_STANDARD_TOGGLE)
+                        .setStaticTexture(GT_UITextures.OVERLAY_BUTTON_VOID_EXCESS)
+                        .setGTTooltip(() -> mTooltipCache.getData("GT5U.machines.digitaltank.voidoverflow.tooltip"))
+                        .setTooltipShowUpDelay(TOOLTIP_DELAY)
+                        .setPos(151, 7)
+                        .setSize(18, 18))
+                .widget(new CycleButtonWidget()
+                        .setToggle(() -> mVoidFluidFull, val -> {
+                            mVoidFluidFull = val;
+                            if (!mVoidFluidFull) {
+                                GT_Utility.sendChatToPlayer(
+                                        buildContext.getPlayer(), GT_Utility.trans("269", "Void Full Mode Disabled"));
+                            } else {
+                                GT_Utility.sendChatToPlayer(
+                                        buildContext.getPlayer(), GT_Utility.trans("270", "Void Full Mode Enabled"));
+                            }
+                        })
+                        .setVariableBackground(GT_UITextures.BUTTON_STANDARD_TOGGLE)
+                        .setStaticTexture(GT_UITextures.OVERLAY_BUTTON_VOID_ALL)
+                        .setGTTooltip(() -> mTooltipCache.getData("GT5U.machines.digitaltank.voidfull.tooltip"))
+                        .setTooltipShowUpDelay(TOOLTIP_DELAY)
+                        .setPos(151, 25)
+                        .setSize(18, 18));
+    }
+
+    @Override
+    protected IFluidAccess constructFluidAccess(boolean aIsFillableStack) {
+        return new DigitalTankFluidAccess(this, aIsFillableStack);
+    }
+
+    static class DigitalTankFluidAccess extends BasicTankFluidAccess {
+
+        public DigitalTankFluidAccess(GT_MetaTileEntity_BasicTank aTank, boolean aIsFillableStack) {
+            super(aTank, aIsFillableStack);
+        }
+
+        @Override
+        public void set(FluidStack stack) {
+            super.set(stack);
+            ((GT_MetaTileEntity_DigitalTankBase) mTank).onEmptyingContainerWhenEmpty();
+        }
+
+        @Override
+        public int getRealCapacity() {
+            return ((GT_MetaTileEntity_DigitalTankBase) mTank).getRealCapacity();
+        }
+
+        @Override
+        public void verifyFluidStack() {}
+    }
 }