refactor(listener): replace the inventory lock feature with a game only cancel listener

common/src/main/java/net/onelitefeather/cygnus/common/ListenerHandling.java

@@ -2,12 +2,14 @@
 
 import net.minestom.server.event.Event;
 import net.minestom.server.event.EventNode;
+import net.minestom.server.event.inventory.InventoryPreClickEvent;
 import net.minestom.server.event.item.ItemDropEvent;
 import net.minestom.server.event.player.PlayerBlockBreakEvent;
 import net.minestom.server.event.player.PlayerBlockInteractEvent;
 import net.minestom.server.event.player.PlayerBlockPlaceEvent;
 import net.minestom.server.event.player.PlayerSwapItemEvent;
 import net.minestom.server.event.trait.CancellableEvent;
+import net.minestom.server.inventory.PlayerInventory;
 
 import java.util.function.Consumer;
 
@@ -35,4 +37,18 @@ default void registerCancelListener(EventNode<Event> eventNode) {
         eventNode.addListener(PlayerSwapItemEvent.class, CANCELLABLE_EVENT::accept);
         eventNode.addListener(PlayerBlockInteractEvent.class, CANCELLABLE_EVENT::accept);
     }
+
+    /**
+     * Keeps players from moving the items in their own inventory, so the game items stay in the
+     * slots the game put them in. Clicks in an opened inventory, like the spectator menu, are left
+     * to that inventory. Not part of {@link #registerCancelListener(EventNode)}, the setup needs
+     * its players to move their items.
+     *
+     * @param eventNode the event node to register the listener
+     */
+    default void registerInventoryLock(EventNode<Event> eventNode) {
+        eventNode.addListener(InventoryPreClickEvent.class, event -> {
+            if (event.getInventory() instanceof PlayerInventory) event.setCancelled(true);
+        });
+    }
 }

common/src/test/java/net/onelitefeather/cygnus/common/ListenerHandlingTest.java

@@ -1,11 +1,20 @@
 package net.onelitefeather.cygnus.common;
 
+import net.kyori.adventure.text.Component;
+import net.minestom.server.coordinate.Pos;
+import net.minestom.server.entity.Player;
+import net.minestom.server.event.EventDispatcher;
 import net.minestom.server.event.GlobalEventHandler;
+import net.minestom.server.event.inventory.InventoryPreClickEvent;
 import net.minestom.server.event.item.ItemDropEvent;
 import net.minestom.server.event.player.PlayerBlockBreakEvent;
 import net.minestom.server.event.player.PlayerBlockInteractEvent;
 import net.minestom.server.event.player.PlayerBlockPlaceEvent;
 import net.minestom.server.event.player.PlayerSwapItemEvent;
+import net.minestom.server.instance.Instance;
+import net.minestom.server.inventory.Inventory;
+import net.minestom.server.inventory.InventoryType;
+import net.minestom.server.inventory.click.Click;
 import net.minestom.testing.Env;
 import net.minestom.testing.extension.MicrotusExtension;
 import org.jetbrains.annotations.NotNull;
@@ -28,5 +37,25 @@ void testCancelListenerCreation(@NotNull Env env) {
         assertTrue(eventHandler.hasListener(ItemDropEvent.class));
         assertTrue(eventHandler.hasListener(PlayerSwapItemEvent.class));
         assertTrue(eventHandler.hasListener(PlayerBlockInteractEvent.class));
+        assertFalse(eventHandler.hasListener(InventoryPreClickEvent.class));
+    }
+
+    @Test
+    void testOnlyOwnInventoryClicksAreCancelled(@NotNull Env env) {
+        ListenerHandling listenerHandling = new ListenerHandling() {};
+        GlobalEventHandler eventHandler = env.process().eventHandler();
+        listenerHandling.registerInventoryLock(eventHandler);
+        Instance instance = env.createFlatInstance();
+        Player player = env.createPlayer(instance, new Pos(0, 40, 0));
+
+        InventoryPreClickEvent own = new InventoryPreClickEvent(player.getInventory(), player, new Click.Left(0));
+        InventoryPreClickEvent opened = new InventoryPreClickEvent(
+                new Inventory(InventoryType.CHEST_1_ROW, Component.text("Menu")), player, new Click.Left(0));
+        EventDispatcher.call(own);
+        EventDispatcher.call(opened);
+
+        assertTrue(own.isCancelled());
+        assertFalse(opened.isCancelled());
+        env.destroyInstance(instance, true);
     }
 }

game/src/main/java/net/onelitefeather/cygnus/Cygnus.java

@@ -86,7 +86,6 @@
 import net.onelitefeather.cygnus.phase.RestartPhase;
 import net.onelitefeather.cygnus.phase.WaitingPhase;
 import net.onelitefeather.cygnus.player.CygnusPlayer;
-import net.onelitefeather.cygnus.player.InventoryLock;
 import net.onelitefeather.cygnus.possession.PossessionFeature;
 import net.onelitefeather.cygnus.resourcepack.ResourcePackService;
 import net.onelitefeather.cygnus.sanity.SanityService;
@@ -234,7 +233,6 @@ sanityService, new HuntedTabWitness(new TracingCreekWitness(sanityService, this.
                                 MinecraftServer.getConnectionManager()::getOnlinePlayerByUuid), this.jumpscareManager, this.staminaService, tickSections);
                 this.features = Stream.concat(this.resourcePackService.stream(), Stream.of(
                         new EpilepsyDisclaimer(),
-                        new InventoryLock(),
                         this.slenderTakeover,
                         this.spectatorService,
                         // Not part of the OverlayModule: the sound is the feedback a hit owes the player
@@ -336,6 +334,7 @@ private void initListener(Team spectatorTeam) {
             this.scoreboardDisplay.sync(this.teamService);
         });
         registerCancelListener(manager);
+        registerInventoryLock(manager);
     }
 
     private void registerGameListener() {