allow customization of canInteractWith() (supersede #101)

Author: brachy84

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

@@ -72,7 +72,7 @@ public static <T extends GuiData> void open(@NotNull UIFactory<T> factory, @NotN
         PanelSyncManager syncManager = new PanelSyncManager();
         ModularPanel panel = factory.createPanel(guiData, syncManager);
         WidgetTree.collectSyncValues(syncManager, panel);
-        ModularContainer container = new ModularContainer(player, syncManager, panel.getName());
+        ModularContainer container = new ModularContainer(player, syncManager, panel.getName(), guiData);
         // sync to client
         player.getNextWindowId();
         player.closeContainer();
@@ -98,7 +98,7 @@ public static <T extends GuiData> void open(int windowId, @NotNull UIFactory<T>
         WidgetTree.collectSyncValues(syncManager, panel);
         ModularScreen screen = factory.createScreen(guiData, panel);
         screen.getContext().setJeiSettings(jeiSettings);
-        ModularContainer container = new ModularContainer(player, syncManager, panel.getName());
+        ModularContainer container = new ModularContainer(player, syncManager, panel.getName(), guiData);
         IMuiScreen wrapper = factory.createScreenWrapper(container, screen);
         if (!(wrapper.getGuiScreen() instanceof GuiContainer guiContainer)) {
             throw new IllegalStateException("The wrapping screen must be a GuiContainer for synced GUIs!");

src/main/java/com/cleanroommc/modularui/screen/ContainerCustomizer.java

@@ -17,6 +17,7 @@
 import org.jetbrains.annotations.Nullable;
 
 import java.util.Objects;
+import java.util.function.Predicate;
 
 /**
  * Sometimes you need special behaviour. This class allows you to override common methods from {@link net.minecraft.inventory.Container Container}.
@@ -30,6 +31,7 @@ public class ContainerCustomizer {
     private static final int RIGHT_MOUSE = 1;
 
     private ModularContainer container;
+    private Predicate<EntityPlayer> canInteractWith;
 
     void initialize(ModularContainer container) {
         this.container = container;
@@ -42,6 +44,14 @@ public ModularContainer getContainer() {
         return container;
     }
 
+    public Predicate<EntityPlayer> getCanInteractWith() {
+        return canInteractWith;
+    }
+
+    public void setCanInteractWith(Predicate<EntityPlayer> canInteractWith) {
+        this.canInteractWith = canInteractWith;
+    }
+
     public void onContainerClosed() {}
 
     public @NotNull ItemStack slotClick(int slotId, int mouseButton, @NotNull ClickType clickTypeIn, EntityPlayer player) {

src/main/java/com/cleanroommc/modularui/screen/ModularContainer.java

@@ -2,6 +2,8 @@
 
 import com.cleanroommc.modularui.ModularUI;
 import com.cleanroommc.modularui.core.mixin.ContainerAccessor;
+import com.cleanroommc.modularui.factory.GuiData;
+import com.cleanroommc.modularui.factory.PosGuiData;
 import com.cleanroommc.modularui.network.NetworkUtils;
 import com.cleanroommc.modularui.value.sync.ModularSyncManager;
 import com.cleanroommc.modularui.value.sync.PanelSyncManager;
@@ -29,6 +31,7 @@
 import org.jetbrains.annotations.Nullable;
 
 import java.util.*;
+import java.util.function.Predicate;
 
 @Interface(modid = ModularUI.BOGO_SORT, iface = "com.cleanroommc.bogosorter.api.ISortableContainer")
 public class ModularContainer extends Container implements ISortableContainer {
@@ -46,19 +49,34 @@ public static ModularContainer getCurrent(EntityPlayer player) {
     private final List<ModularSlot> slots = new ArrayList<>();
     private final List<ModularSlot> shiftClickSlots = new ArrayList<>();
     private ContainerCustomizer containerCustomizer;
+    private Predicate<EntityPlayer> canInteractWith;
 
     @SideOnly(Side.CLIENT)
     private ModularScreen optionalScreen;
 
-    public ModularContainer(EntityPlayer player, PanelSyncManager panelSyncManager, String mainPanelName) {
+    public ModularContainer(EntityPlayer player, PanelSyncManager panelSyncManager, String mainPanelName, GuiData guiData) {
         this.player = player;
         this.syncManager = new ModularSyncManager(this);
         this.syncManager.construct(mainPanelName, panelSyncManager);
         this.containerCustomizer = panelSyncManager.getContainerCustomizer();
         if (this.containerCustomizer == null) {
             this.containerCustomizer = new ContainerCustomizer();
+            panelSyncManager.setContainerCustomizer(this.containerCustomizer);
         }
         this.containerCustomizer.initialize(this);
+        if (this.containerCustomizer.getCanInteractWith() == null) {
+            if (guiData instanceof PosGuiData posGuiData) {
+                panelSyncManager.canInteractWithinDefaultRange(posGuiData);
+            } else {
+                // store current pos of player
+                // gui will close when the player somehow moves away while the gui is open
+                double x = guiData.getPlayer().posX;
+                double y = guiData.getPlayer().posY;
+                double z = guiData.getPlayer().posZ;
+                panelSyncManager.canInteractWithinDefaultRange(x, y, z);
+            }
+        }
+        this.canInteractWith = this.containerCustomizer.getCanInteractWith();
         sortShiftClickSlots();
     }
 
@@ -190,9 +208,13 @@ public List<ModularSlot> getShiftClickSlots() {
         return Collections.unmodifiableList(this.shiftClickSlots);
     }
 
+    public void setCanInteractWith(Predicate<EntityPlayer> canInteractWith) {
+        this.canInteractWith = canInteractWith;
+    }
+
     @Override
     public boolean canInteractWith(@NotNull EntityPlayer playerIn) {
-        return true;
+        return this.canInteractWith.test(playerIn);
     }
 
     @Override

src/main/java/com/cleanroommc/modularui/value/sync/PanelSyncManager.java

@@ -2,6 +2,7 @@
 
 import com.cleanroommc.modularui.ModularUI;
 import com.cleanroommc.modularui.api.IPanelHandler;
+import com.cleanroommc.modularui.factory.PosGuiData;
 import com.cleanroommc.modularui.screen.ContainerCustomizer;
 import com.cleanroommc.modularui.screen.ModularContainer;
 import com.cleanroommc.modularui.widgets.slot.ModularSlot;
@@ -10,6 +11,7 @@
 import net.minecraft.entity.player.EntityPlayer;
 import net.minecraft.item.ItemStack;
 import net.minecraft.network.PacketBuffer;
+import net.minecraft.util.math.BlockPos;
 import net.minecraftforge.items.wrapper.PlayerMainInvWrapper;
 
 import it.unimi.dsi.fastutil.objects.Object2ObjectArrayMap;
@@ -21,9 +23,12 @@
 import java.io.IOException;
 import java.util.*;
 import java.util.function.Consumer;
+import java.util.function.Predicate;
 
 public class PanelSyncManager {
 
+    private static final double DEFAULT_INTERACT_RANGE = 8.0;
+
     private final Map<String, SyncHandler> syncHandlers = new Object2ObjectLinkedOpenHashMap<>();
     private final Map<String, SlotGroup> slotGroups = new Object2ObjectOpenHashMap<>();
     private final Map<SyncHandler, String> reverseSyncHandlers = new Object2ObjectOpenHashMap<>();
@@ -127,6 +132,11 @@ public ContainerCustomizer getContainerCustomizer() {
     }
 
     public void setContainerCustomizer(ContainerCustomizer containerCustomizer) {
+        if (this.containerCustomizer != null &&
+                this.containerCustomizer.getCanInteractWith() != null &&
+                containerCustomizer.getCanInteractWith() == null) {
+            containerCustomizer.setCanInteractWith(this.containerCustomizer.getCanInteractWith());
+        }
         this.containerCustomizer = containerCustomizer;
     }
 
@@ -254,6 +264,36 @@ public PanelSyncManager addCloseListener(Consumer<EntityPlayer> listener) {
         return this;
     }
 
+    public PanelSyncManager canInteractWith(Predicate<EntityPlayer> canInteractWith) {
+        if (this.containerCustomizer == null) this.containerCustomizer = new ContainerCustomizer();
+        this.containerCustomizer.setCanInteractWith(canInteractWith);
+        return this;
+    }
+
+    public PanelSyncManager canInteractWithinRange(double x, double y, double z, double range) {
+        return canInteractWith(player -> player.getDistanceSq(x, y, z) <= range * range);
+    }
+
+    public PanelSyncManager canInteractWithinRange(BlockPos pos, double range) {
+        return canInteractWith(player -> player.getDistanceSqToCenter(pos) <= range * range);
+    }
+
+    public PanelSyncManager canInteractWithinRange(PosGuiData guiData, double range) {
+        return canInteractWithinRange(guiData.getX() + 0.5, guiData.getY() + 0.5, guiData.getZ() + 0.5, range);
+    }
+
+    public PanelSyncManager canInteractWithinDefaultRange(double x, double y, double z) {
+        return canInteractWithinRange(x, y, z, DEFAULT_INTERACT_RANGE);
+    }
+
+    public PanelSyncManager canInteractWithinDefaultRange(BlockPos pos) {
+        return canInteractWithinRange(pos, DEFAULT_INTERACT_RANGE);
+    }
+
+    public PanelSyncManager canInteractWithinDefaultRange(PosGuiData guiData) {
+        return canInteractWithinRange(guiData, DEFAULT_INTERACT_RANGE);
+    }
+
     public SlotGroup getSlotGroup(String name) {
         return this.slotGroups.get(name);
     }