ability to open synced ui from client & baubles test

Author: brachy84

src/main/java/com/cleanroommc/modularui/ClientProxy.java

@@ -1,32 +1,43 @@
 package com.cleanroommc.modularui;
 
 import com.cleanroommc.modularui.drawable.DrawableSerialization;
+import com.cleanroommc.modularui.factory.GuiFactories;
+import com.cleanroommc.modularui.factory.inventory.InventoryTypes;
 import com.cleanroommc.modularui.holoui.HoloScreenEntity;
 import com.cleanroommc.modularui.holoui.ScreenEntityRender;
 import com.cleanroommc.modularui.keybind.KeyBindHandler;
 import com.cleanroommc.modularui.overlay.OverlayManager;
 import com.cleanroommc.modularui.screen.ClientScreenHandler;
 import com.cleanroommc.modularui.test.EventHandler;
 import com.cleanroommc.modularui.test.OverlayTest;
+import com.cleanroommc.modularui.test.TestItem;
 import com.cleanroommc.modularui.theme.ThemeManager;
 import com.cleanroommc.modularui.theme.ThemeReloadCommand;
 
 import net.minecraft.client.Minecraft;
 import net.minecraft.client.resources.IReloadableResourceManager;
+import net.minecraft.client.settings.KeyBinding;
 import net.minecraft.util.Timer;
 import net.minecraftforge.client.ClientCommandHandler;
+import net.minecraftforge.client.settings.KeyConflictContext;
 import net.minecraftforge.common.MinecraftForge;
+import net.minecraftforge.fml.client.registry.ClientRegistry;
 import net.minecraftforge.fml.client.registry.RenderingRegistry;
 import net.minecraftforge.fml.common.event.FMLPostInitializationEvent;
 import net.minecraftforge.fml.common.event.FMLPreInitializationEvent;
+import net.minecraftforge.fml.common.eventhandler.SubscribeEvent;
+import net.minecraftforge.fml.common.gameevent.InputEvent;
 import net.minecraftforge.fml.relauncher.Side;
 import net.minecraftforge.fml.relauncher.SideOnly;
 
+import org.lwjgl.input.Keyboard;
+
 @SideOnly(Side.CLIENT)
 @SuppressWarnings("unused")
 public class ClientProxy extends CommonProxy {
 
     private final Timer timer60Fps = new Timer(60f);
+    public static KeyBinding testKey;
 
     @Override
     void preInit(FMLPreInitializationEvent event) {
@@ -38,6 +49,8 @@ void preInit(FMLPreInitializationEvent event) {
 
         if (ModularUIConfig.enableTestGuis) {
             MinecraftForge.EVENT_BUS.register(EventHandler.class);
+            testKey = new KeyBinding("key.test", KeyConflictContext.IN_GAME, Keyboard.KEY_NUMPAD4, "key.categories.modularui");
+            ClientRegistry.registerKeyBinding(testKey);
         }
         if (ModularUIConfig.enableTestOverlays) {
             OverlayTest.init();
@@ -60,6 +73,19 @@ void postInit(FMLPostInitializationEvent event) {
         ((IReloadableResourceManager) Minecraft.getMinecraft().getResourceManager()).registerReloadListener(new ThemeManager());
     }
 
+    @SubscribeEvent
+    public void onKeyboard(InputEvent.KeyInputEvent event) {
+        if (testKey.isPressed() && ModularUI.isBaubleLoaded()) {
+            InventoryTypes.BAUBLES.visitAll(Minecraft.getMinecraft().player, (type, index, stack) -> {
+                if (stack.getItem() instanceof TestItem) {
+                    GuiFactories.playerInventory().openFromBaublesClient(index);
+                    return true;
+                }
+                return false;
+            });
+        }
+    }
+
     @Override
     public Timer getTimer60Fps() {
         return this.timer60Fps;

src/main/java/com/cleanroommc/modularui/CommonProxy.java

@@ -1,12 +1,12 @@
 package com.cleanroommc.modularui;
 
-import com.cleanroommc.modularui.factory.*;
+import com.cleanroommc.modularui.factory.GuiFactories;
+import com.cleanroommc.modularui.factory.GuiManager;
 import com.cleanroommc.modularui.holoui.HoloScreenEntity;
 import com.cleanroommc.modularui.network.NetworkHandler;
 import com.cleanroommc.modularui.screen.ModularContainer;
 import com.cleanroommc.modularui.test.ItemEditorGui;
 import com.cleanroommc.modularui.test.TestBlock;
-
 import com.cleanroommc.modularui.value.sync.ModularSyncManager;
 
 import net.minecraft.util.Timer;
@@ -29,7 +29,7 @@
 public class CommonProxy {
 
     void preInit(FMLPreInitializationEvent event) {
-        MinecraftForge.EVENT_BUS.register(CommonProxy.class);
+        MinecraftForge.EVENT_BUS.register(this);
         MinecraftForge.EVENT_BUS.register(GuiManager.class);
 
         if (ModularUIConfig.enableTestGuis) {
@@ -54,7 +54,7 @@ public Timer getTimer60Fps() {
     }
 
     @SubscribeEvent
-    public static void registerBlocks(RegistryEvent.Register<EntityEntry> event) {
+    public void registerBlocks(RegistryEvent.Register<EntityEntry> event) {
         IForgeRegistry<EntityEntry> registry = event.getRegistry();
         registry.register(EntityEntryBuilder.create()
                 .id("modular_screen", 0)
@@ -65,7 +65,7 @@ public static void registerBlocks(RegistryEvent.Register<EntityEntry> event) {
     }
 
     @SubscribeEvent
-    public static void onCloseContainer(PlayerContainerEvent.Open event) {
+    public void onCloseContainer(PlayerContainerEvent.Open event) {
         if (event.getContainer() instanceof ModularContainer container) {
             ModularSyncManager syncManager = container.getSyncManager();
             if (syncManager != null) {
@@ -75,7 +75,7 @@ public static void onCloseContainer(PlayerContainerEvent.Open event) {
     }
 
     @SubscribeEvent
-    public static void onConfigChange(ConfigChangedEvent.OnConfigChangedEvent event) {
+    public void onConfigChange(ConfigChangedEvent.OnConfigChangedEvent event) {
         if (event.getModID().equals(ModularUI.ID)) {
             ConfigManager.sync(ModularUI.ID, Config.Type.INSTANCE);
         }

src/main/java/com/cleanroommc/modularui/factory/AbstractUIFactory.java

@@ -4,10 +4,10 @@
 import com.cleanroommc.modularui.api.UIFactory;
 import com.cleanroommc.modularui.screen.ModularPanel;
 import com.cleanroommc.modularui.screen.ModularScreen;
-
 import com.cleanroommc.modularui.screen.UISettings;
 import com.cleanroommc.modularui.value.sync.PanelSyncManager;
 
+import net.minecraft.client.entity.EntityPlayerSP;
 import net.minecraft.entity.player.EntityPlayer;
 import net.minecraft.entity.player.EntityPlayerMP;
 
@@ -20,7 +20,13 @@ public abstract class AbstractUIFactory<T extends GuiData> implements UIFactory<
     protected static EntityPlayerMP verifyServerSide(EntityPlayer player) {
         if (player == null) throw new NullPointerException("Can't open UI for null player!");
         if (player instanceof EntityPlayerMP entityPlayerMP) return entityPlayerMP;
-        throw new IllegalStateException("Synced GUI must be opened from server side!");
+        throw new IllegalStateException("Expected server player to open UI on server!");
+    }
+
+    protected static EntityPlayerSP verifyClientSide(EntityPlayer player) {
+        if (player == null) throw new NullPointerException("Can't open UI for null player!");
+        if (player instanceof EntityPlayerSP entityPlayerMP) return entityPlayerMP;
+        throw new IllegalStateException("Expected client player to open UI on client side!");
     }
 
     private final String name;

src/main/java/com/cleanroommc/modularui/factory/GuiManager.java

@@ -6,7 +6,12 @@
 import com.cleanroommc.modularui.api.UIFactory;
 import com.cleanroommc.modularui.network.NetworkHandler;
 import com.cleanroommc.modularui.network.packets.OpenGuiPacket;
-import com.cleanroommc.modularui.screen.*;
+import com.cleanroommc.modularui.screen.GuiContainerWrapper;
+import com.cleanroommc.modularui.screen.GuiScreenWrapper;
+import com.cleanroommc.modularui.screen.ModularContainer;
+import com.cleanroommc.modularui.screen.ModularPanel;
+import com.cleanroommc.modularui.screen.ModularScreen;
+import com.cleanroommc.modularui.screen.UISettings;
 import com.cleanroommc.modularui.value.sync.PanelSyncManager;
 import com.cleanroommc.modularui.widget.WidgetTree;
 
@@ -28,6 +33,7 @@
 import io.netty.buffer.Unpooled;
 import it.unimi.dsi.fastutil.objects.Object2ObjectMap;
 import it.unimi.dsi.fastutil.objects.Object2ObjectOpenHashMap;
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.ArrayList;
@@ -90,8 +96,9 @@ public static <T extends GuiData> void open(@NotNull UIFactory<T> factory, @NotN
         MinecraftForge.EVENT_BUS.post(new PlayerContainerEvent.Open(player, container));
     }
 
+    @ApiStatus.Internal
     @SideOnly(Side.CLIENT)
-    public static <T extends GuiData> void open(int windowId, @NotNull UIFactory<T> factory, @NotNull PacketBuffer data, @NotNull EntityPlayerSP player) {
+    public static <T extends GuiData> void openFromClient(int windowId, @NotNull UIFactory<T> factory, @NotNull PacketBuffer data, @NotNull EntityPlayerSP player) {
         T guiData = factory.readGuiData(player, data);
         UISettings settings = new UISettings();
         settings.defaultCanInteractWith(factory, guiData);
@@ -112,6 +119,13 @@ public static <T extends GuiData> void open(int windowId, @NotNull UIFactory<T>
         player.openContainer = guiContainer.inventorySlots;
     }
 
+    @SideOnly(Side.CLIENT)
+    public static <T extends GuiData> void openFromClient(@NotNull UIFactory<T> factory, @NotNull T guiData) {
+        PacketBuffer buffer = new PacketBuffer(Unpooled.buffer());
+        factory.writeGuiData(guiData, buffer);
+        NetworkHandler.sendToServer(new OpenGuiPacket<>(0, factory, buffer));
+    }
+
     @SideOnly(Side.CLIENT)
     static void openScreen(ModularScreen screen, UISettings settings) {
         screen.getContext().setSettings(settings);

src/main/java/com/cleanroommc/modularui/factory/PlayerInventoryGuiFactory.java

@@ -3,13 +3,14 @@
 import com.cleanroommc.modularui.ModularUI;
 import com.cleanroommc.modularui.api.IGuiHolder;
 import com.cleanroommc.modularui.factory.inventory.InventoryType;
-
 import com.cleanroommc.modularui.factory.inventory.InventoryTypes;
+import com.cleanroommc.modularui.utils.Platform;
 
 import net.minecraft.entity.player.EntityPlayer;
 import net.minecraft.network.PacketBuffer;
-
 import net.minecraft.util.EnumHand;
+import net.minecraftforge.fml.relauncher.Side;
+import net.minecraftforge.fml.relauncher.SideOnly;
 
 import org.jetbrains.annotations.NotNull;
 
@@ -40,6 +41,30 @@ public void open(EntityPlayer player, InventoryType type, int index) {
         GuiManager.open(this, new PlayerInventoryGuiData(player, type, index), verifyServerSide(player));
     }
 
+    @SideOnly(Side.CLIENT)
+    public void openFromPlayerInventoryClient(int index) {
+        GuiManager.openFromClient(this, new PlayerInventoryGuiData(Platform.getClientPlayer(), InventoryTypes.PLAYER, index));
+    }
+
+    @SideOnly(Side.CLIENT)
+    public void openFromHandClient(EnumHand hand) {
+        openFromPlayerInventoryClient(hand == EnumHand.OFF_HAND ? 40 : Platform.getClientPlayer().inventory.currentItem);
+    }
+
+    @SideOnly(Side.CLIENT)
+    public void openFromBaublesClient(int index) {
+        if (!ModularUI.isBaubleLoaded()) {
+            throw new IllegalArgumentException("Can't open UI for baubles item when bauble is not loaded!");
+        }
+        GuiManager.openFromClient(
+                this, new PlayerInventoryGuiData(Platform.getClientPlayer(), InventoryTypes.BAUBLES, index));
+    }
+
+    @SideOnly(Side.CLIENT)
+    public void openClient(InventoryType type, int index) {
+        GuiManager.openFromClient(this, new PlayerInventoryGuiData(Platform.getClientPlayer(), type, index));
+    }
+
     private PlayerInventoryGuiFactory() {
         super("mui:player_inv");
     }

src/main/java/com/cleanroommc/modularui/factory/SidedTileEntityGuiFactory.java

@@ -1,13 +1,16 @@
 package com.cleanroommc.modularui.factory;
 
 import com.cleanroommc.modularui.api.IGuiHolder;
+import com.cleanroommc.modularui.utils.Platform;
 
 import net.minecraft.entity.player.EntityPlayer;
 import net.minecraft.entity.player.EntityPlayerMP;
 import net.minecraft.network.PacketBuffer;
 import net.minecraft.tileentity.TileEntity;
 import net.minecraft.util.EnumFacing;
 import net.minecraft.util.math.BlockPos;
+import net.minecraftforge.fml.relauncher.Side;
+import net.minecraftforge.fml.relauncher.SideOnly;
 
 import org.jetbrains.annotations.NotNull;
 
@@ -19,15 +22,8 @@ public class SidedTileEntityGuiFactory extends AbstractUIFactory<SidedPosGuiData
 
     public <T extends TileEntity & IGuiHolder<SidedPosGuiData>> void open(EntityPlayer player, T tile, EnumFacing facing) {
         Objects.requireNonNull(player);
-        Objects.requireNonNull(tile);
         Objects.requireNonNull(facing);
-        if (tile.isInvalid()) {
-            throw new IllegalArgumentException("Can't open invalid TileEntity GUI!");
-        }
-        if (player.world != tile.getWorld()) {
-            throw new IllegalArgumentException("TileEntity must be in same dimension as the player!");
-        }
-        BlockPos pos = tile.getPos();
+        BlockPos pos = TileEntityGuiFactory.getPosFromTile(tile);
         SidedPosGuiData data = new SidedPosGuiData(player, pos.getX(), pos.getY(), pos.getZ(), facing);
         GuiManager.open(this, data, (EntityPlayerMP) player);
     }
@@ -40,6 +36,22 @@ public void open(EntityPlayer player, BlockPos pos, EnumFacing facing) {
         GuiManager.open(this, data, (EntityPlayerMP) player);
     }
 
+    @SideOnly(Side.CLIENT)
+    public <T extends TileEntity & IGuiHolder<SidedPosGuiData>> void openClient(T tile, EnumFacing facing) {
+        Objects.requireNonNull(facing);
+        BlockPos pos = TileEntityGuiFactory.getPosFromTile(tile);
+        SidedPosGuiData data = new SidedPosGuiData(Platform.getClientPlayer(), pos.getX(), pos.getY(), pos.getZ(), facing);
+        GuiManager.openFromClient(this, data);
+    }
+
+    @SideOnly(Side.CLIENT)
+    public void openClient(BlockPos pos, EnumFacing facing) {
+        Objects.requireNonNull(pos);
+        Objects.requireNonNull(facing);
+        SidedPosGuiData data = new SidedPosGuiData(Platform.getClientPlayer(), pos.getX(), pos.getY(), pos.getZ(), facing);
+        GuiManager.openFromClient(this, data);
+    }
+
     private SidedTileEntityGuiFactory() {
         super("mui:sided_tile");
     }

src/main/java/com/cleanroommc/modularui/factory/SimpleGuiFactory.java

@@ -1,10 +1,13 @@
 package com.cleanroommc.modularui.factory;
 
 import com.cleanroommc.modularui.api.IGuiHolder;
+import com.cleanroommc.modularui.api.MCHelper;
 
 import net.minecraft.entity.player.EntityPlayer;
 import net.minecraft.entity.player.EntityPlayerMP;
 import net.minecraft.network.PacketBuffer;
+import net.minecraftforge.fml.relauncher.Side;
+import net.minecraftforge.fml.relauncher.SideOnly;
 
 import org.jetbrains.annotations.NotNull;
 
@@ -50,6 +53,11 @@ public void open(EntityPlayerMP player) {
         GuiManager.open(this, new GuiData(player), player);
     }
 
+    @SideOnly(Side.CLIENT)
+    public void openClient() {
+        GuiManager.openFromClient(this, new GuiData(MCHelper.getPlayer()));
+    }
+
     @Override
     public void writeGuiData(GuiData guiData, PacketBuffer buffer) {}
 

src/main/java/com/cleanroommc/modularui/factory/TileEntityGuiFactory.java

@@ -1,12 +1,16 @@
 package com.cleanroommc.modularui.factory;
 
 import com.cleanroommc.modularui.api.IGuiHolder;
+import com.cleanroommc.modularui.api.MCHelper;
+import com.cleanroommc.modularui.utils.Platform;
 
 import net.minecraft.entity.player.EntityPlayer;
 import net.minecraft.entity.player.EntityPlayerMP;
 import net.minecraft.network.PacketBuffer;
 import net.minecraft.tileentity.TileEntity;
 import net.minecraft.util.math.BlockPos;
+import net.minecraftforge.fml.relauncher.Side;
+import net.minecraftforge.fml.relauncher.SideOnly;
 
 import org.jetbrains.annotations.NotNull;
 
@@ -22,14 +26,7 @@ private TileEntityGuiFactory() {
 
     public <T extends TileEntity & IGuiHolder<PosGuiData>> void open(EntityPlayer player, T tile) {
         Objects.requireNonNull(player);
-        Objects.requireNonNull(tile);
-        if (tile.isInvalid()) {
-            throw new IllegalArgumentException("Can't open invalid TileEntity GUI!");
-        }
-        if (player.world != tile.getWorld()) {
-            throw new IllegalArgumentException("TileEntity must be in same dimension as the player!");
-        }
-        BlockPos pos = tile.getPos();
+        BlockPos pos = getPosFromTile(tile);
         PosGuiData data = new PosGuiData(player, pos.getX(), pos.getY(), pos.getZ());
         GuiManager.open(this, data, (EntityPlayerMP) player);
     }
@@ -41,6 +38,18 @@ public void open(EntityPlayer player, BlockPos pos) {
         GuiManager.open(this, data, (EntityPlayerMP) player);
     }
 
+    @SideOnly(Side.CLIENT)
+    public <T extends TileEntity & IGuiHolder<PosGuiData>> void openClient(T tile) {
+        BlockPos pos = getPosFromTile(tile);
+        GuiManager.openFromClient(this, new PosGuiData(MCHelper.getPlayer(), pos.getX(), pos.getY(), pos.getZ()));
+    }
+
+    @SideOnly(Side.CLIENT)
+    public void openClient(BlockPos pos) {
+        Objects.requireNonNull(pos);
+        GuiManager.openFromClient(this, new PosGuiData(MCHelper.getPlayer(), pos.getX(), pos.getY(), pos.getZ()));
+    }
+
     @Override
     public @NotNull IGuiHolder<PosGuiData> getGuiHolder(PosGuiData data) {
         return Objects.requireNonNull(castGuiHolder(data.getTileEntity()), "Found TileEntity is not a gui holder!");
@@ -62,4 +71,15 @@ public void writeGuiData(PosGuiData guiData, PacketBuffer buffer) {
     public @NotNull PosGuiData readGuiData(EntityPlayer player, PacketBuffer buffer) {
         return new PosGuiData(player, buffer.readVarInt(), buffer.readVarInt(), buffer.readVarInt());
     }
+
+    public static BlockPos getPosFromTile(TileEntity tile) {
+        Objects.requireNonNull(tile);
+        if (tile.isInvalid()) {
+            throw new IllegalArgumentException("Can't open invalid TileEntity GUI!");
+        }
+        if (Platform.getClientPlayer().world != tile.getWorld()) {
+            throw new IllegalArgumentException("TileEntity must be in same dimension as the player!");
+        }
+        return tile.getPos();
+    }
 }