Categorized inventory gui priority

Author: NichtStudioCode

invui/src/main/java/xyz/xenondevs/invui/gui/AbstractGui.java

@@ -15,6 +15,7 @@
 import xyz.xenondevs.invui.internal.util.SlotUtils;
 import xyz.xenondevs.invui.inventory.Inventory;
 import xyz.xenondevs.invui.inventory.ObscuredInventory;
+import xyz.xenondevs.invui.inventory.OperationCategory;
 import xyz.xenondevs.invui.inventory.event.ItemPreUpdateEvent;
 import xyz.xenondevs.invui.inventory.event.PlayerUpdateReason;
 import xyz.xenondevs.invui.inventory.event.UpdateReason;
@@ -242,7 +243,7 @@ private void handleInvItemShift(Click click, Inventory inventory, int slot) {
         // move into the first inventory that accepts the item, sorted by priority
         var inventories = window.getGuis().stream()
             .flatMap(gui -> gui.getInventories(inventory).stream())
-            .sorted(Comparator.comparingInt(Inventory::getGuiPriority).reversed())
+            .sorted(Comparator.<Inventory>comparingInt(inv -> inv.getGuiPriority(OperationCategory.ADD)).reversed())
             .toList();
 
         int leftOverAmount = putIntoFirstInventory(updateReason, clicked, inventories);
@@ -354,8 +355,8 @@ private void handleInvBundleSelect(Player player, Inventory inventory, int slot,
 
     /**
      * Puts the given {@link ItemStack} into the first inventory that accepts it, starting with the
-     * {@link Inventory#getGuiPriority() highest priority} inventory. If one inventory accepts any amount
-     * of items, further inventories will not be queried, meaning that an item stack will not be split
+     * {@link Inventory#getGuiPriority(OperationCategory)} for {@link OperationCategory#ADD} highest priority inventory.
+     * If one inventory accepts any amount of items, further inventories will not be queried, meaning that an item stack will not be split
      * across multiple inventories.
      *
      * @param updateReason the update reason to use
@@ -364,7 +365,13 @@ private void handleInvBundleSelect(Player player, Inventory inventory, int slot,
      * @return the amount of items that are left over
      */
     protected int putIntoFirstInventory(UpdateReason updateReason, ItemStack itemStack, Inventory... ignored) {
-        return putIntoFirstInventory(updateReason, itemStack, getInventories(ignored));
+        return putIntoFirstInventory(
+            updateReason,
+            itemStack, 
+            getInventories(ignored).stream()
+                .sorted(Comparator.<Inventory>comparingInt(inv -> inv.getGuiPriority(OperationCategory.ADD)).reversed())
+                .toList()
+        );
     }
 
     /**
@@ -389,13 +396,12 @@ protected int putIntoFirstInventory(UpdateReason updateReason, ItemStack itemSta
     }
 
     /**
-     * Gets a map of all inventories and their visible slots in this gui, ignoring the specified inventories,
-     * sorted by their {@link Inventory#getGuiPriority()}, with the highest priorities coming first.
+     * Gets a map of all inventories and their visible slots in this gui, ignoring the specified inventories.
      *
      * @param ignored the inventories to ignore
      * @return a map of all inventories and their visible slots
      */
-    private SequencedMap<Inventory, Set<Integer>> getAllActiveInventorySlots(Inventory... ignored) {
+    private Map<? extends Inventory, Set<Integer>> getAllActiveInventorySlots(Inventory... ignored) {
         if (isFrozen())
             return Collections.emptySortedMap();
 
@@ -424,18 +430,16 @@ private SequencedMap<Inventory, Set<Integer>> getAllActiveInventorySlots(Invento
             }
         }
 
-        return slots.entrySet().stream()
-            .sorted(Comparator.<Map.Entry<Inventory, Set<Integer>>>comparingInt(entry -> entry.getKey().getGuiPriority()).reversed())
-            .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue, (a, b) -> a, LinkedHashMap::new));
+        return slots;
     }
 
     @Override
-    public SequencedCollection<? extends Inventory> getInventories(Inventory... ignored) {
+    public Collection<? extends Inventory> getInventories(Inventory... ignored) {
         if (!ignoreObscuredInventorySlots)
-            return Collections.unmodifiableSequencedCollection(getAllActiveInventorySlots(ignored).sequencedKeySet());
+            return Collections.unmodifiableCollection(getAllActiveInventorySlots(ignored).keySet());
 
         ArrayList<Inventory> inventories = new ArrayList<>();
-        for (Map.Entry<Inventory, Set<Integer>> entry : getAllActiveInventorySlots(ignored).entrySet()) {
+        for (Map.Entry<? extends Inventory, Set<Integer>> entry : getAllActiveInventorySlots(ignored).entrySet()) {
             Inventory inventory = entry.getKey();
             Set<Integer> slots = entry.getValue();
             inventories.add(new ObscuredInventory(inventory, slot -> !slots.contains(slot)));

invui/src/main/java/xyz/xenondevs/invui/gui/Gui.java

@@ -622,16 +622,16 @@ default void setGui(char key, Gui gui) {
 
     /**
      * Gets an unmodifiable sequenced collection of all inventories visible in this gui,
-     * including those that are part of nested guis, ignoring the specified inventories,
-     * sorted by their {@link Inventory#getGuiPriority()}, with the highest priorities coming first.
+     * including those that are part of nested guis, ignoring the specified inventories.
+     * Slots that are embedded multiple times are only returned once.
      * If {@link #isIgnoreObscuredInventorySlots()} is true, the obscured slots will not be visible
      * in the returned inventories.
      * If the gui or any nested gui containing an inventory is frozen, those slots will also not be visible.
      *
      * @param ignored the inventories to ignore
      * @return a sequenced collection of all inventories visible in this gui
      */
-    SequencedCollection<? extends Inventory> getInventories(Inventory... ignored);
+    Collection<? extends Inventory> getInventories(Inventory... ignored);
 
     //<editor-fold desc="fill methods">
 

invui/src/main/java/xyz/xenondevs/invui/inventory/CompositeInventory.java

@@ -62,7 +62,7 @@ private static int calculateSize(Collection<? extends Inventory> inventories) {
     }
 
     @Override
-    public int[] getIterationOrder(IterationOrderCategory category) {
+    public int[] getIterationOrder(OperationCategory category) {
         int[] iterationOrder = new int[getSize()];
         int i = 0;
         int offset = 0;
@@ -212,7 +212,7 @@ public boolean hasEventHandlers() {
     }
 
     @Override
-    public void setIterationOrder(IterationOrderCategory category, int[] iterationOrder) {
+    public void setIterationOrder(OperationCategory category, int[] iterationOrder) {
         throw new UnsupportedOperationException("Iteration order needs to be set in the backing inventories");
     }
 

invui/src/main/java/xyz/xenondevs/invui/inventory/Inventory.java

@@ -57,14 +57,15 @@ public sealed abstract class Inventory permits VirtualInventory, CompositeInvent
     private @Nullable List<Consumer<InventoryClickEvent>> clickHandlers;
     private @Nullable List<Consumer<ItemPreUpdateEvent>> preUpdateHandlers;
     private @Nullable List<Consumer<ItemPostUpdateEvent>> postUpdateHandlers;
-    private int guiPriority = 0;
-    private final Map<IterationOrderCategory, int[]> iterationOrders;
+    private final Map<OperationCategory, int[]> iterationOrders;
+    private final Map<OperationCategory, Integer> guiPriorities;
 
     @SuppressWarnings("unchecked")
     public Inventory(int size) {
         this.size = size;
         viewers = new Set[size];
-        iterationOrders = CollectionUtils.newEnumMap(IterationOrderCategory.class, k -> IntStream.range(0, size).toArray());
+        iterationOrders = CollectionUtils.newEnumMap(OperationCategory.class, k -> IntStream.range(0, size).toArray());
+        guiPriorities = CollectionUtils.newEnumMap(OperationCategory.class, k -> 0);
     }
 
     /**
@@ -81,7 +82,7 @@ public int getSize() {
      *
      * @param iterationOrder The new iteration order. Must include all slots and no duplicates.
      */
-    public void setIterationOrder(IterationOrderCategory category, int[] iterationOrder) {
+    public void setIterationOrder(OperationCategory category, int[] iterationOrder) {
         if (iterationOrder.length != size)
             throw new IllegalArgumentException("Iteration order size must match inventory size");
 
@@ -102,7 +103,7 @@ public void setIterationOrder(IterationOrderCategory category, int[] iterationOr
      * @param category The category of iteration operations
      * @return The current iteration order.
      */
-    public int[] getIterationOrder(IterationOrderCategory category) {
+    public int[] getIterationOrder(OperationCategory category) {
         return iterationOrders.get(category).clone();
     }
 
@@ -111,7 +112,7 @@ public int[] getIterationOrder(IterationOrderCategory category) {
      * such as {@link #addItem(UpdateReason, ItemStack)} or {@link #collectSimilar(UpdateReason, ItemStack, int)}.
      */
     public void reverseIterationOrder() {
-        for (var category : IterationOrderCategory.values()) {
+        for (var category : OperationCategory.values()) {
             reverseIterationOrder(category);
         }
     }
@@ -121,7 +122,7 @@ public void reverseIterationOrder() {
      *
      * @param category The category of operations where the iteration order should be reversed
      */
-    public void reverseIterationOrder(IterationOrderCategory category) {
+    public void reverseIterationOrder(OperationCategory category) {
         setIterationOrder(category, ArrayUtils.reversed(getIterationOrder(category)));
     }
 
@@ -511,25 +512,37 @@ public void callPostUpdateEvent(@Nullable UpdateReason updateReason, int slot, @
     }
 
     /**
-     * Gets the priority for click actions in a {@link Gui}, such as shift clicking or cursor collection
-     * with multiple {@link Inventory VirtualInventories}.
+     * Gets the gui priority for operations of the given category.
+     * This priority is used to determine the order in which operations are applied to gui-embedded inventories.
      *
      * @return The priority for click actions, {@link Inventory VirtualInventories} with
      * a higher priority get prioritized.
      */
-    public int getGuiPriority() {
-        return guiPriority;
+    public int getGuiPriority(OperationCategory category) {
+        return guiPriorities.get(category);
     }
 
     /**
-     * Sets the priority for click actions in a {@link Gui}, such as shift-clicking or cursor collection
-     * with multiple {@link Inventory VirtualInventories}.
+     * Sets the gui priority for all operation types.
+     * This priority is used to determine the order in which operations are applied to gui-embedded inventories.
      *
-     * @param guiPriority The priority for click actions, {@link Inventory VirtualInventories} with
-     *                    a higher priority get prioritized.
+     * @param priority The priority
      */
-    public void setGuiPriority(int guiPriority) {
-        this.guiPriority = guiPriority;
+    public void setGuiPriority(int priority) {
+        for (var category : OperationCategory.values()) {
+            setGuiPriority(category, priority);
+        }
+    }
+    
+    /**
+     * Sets the gui priority for operations of the given category.
+     * This priority is used to determine the order in which operations are applied to gui-embedded inventories.
+     *
+     * @param category The category of operations to set the priority for.
+     * @param priority The priority
+     */
+    public void setGuiPriority(OperationCategory category, int priority) {
+        guiPriorities.put(category, priority);
     }
 
     /**
@@ -1016,7 +1029,7 @@ private int addToPartialSlots(
         int amountLeft,
         @Nullable ItemStack[] items
     ) {
-        for (int slot : getIterationOrder(IterationOrderCategory.ADD)) {
+        for (int slot : getIterationOrder(OperationCategory.ADD)) {
             if (amountLeft <= 0)
                 break;
 
@@ -1059,7 +1072,7 @@ private int addToEmptySlots(
         int amountLeft,
         @Nullable ItemStack[] items
     ) {
-        for (int slot : getIterationOrder(IterationOrderCategory.ADD)) {
+        for (int slot : getIterationOrder(OperationCategory.ADD)) {
             if (amountLeft <= 0)
                 break;
 
@@ -1177,7 +1190,7 @@ public int simulateSingleAdd(@Nullable ItemStack itemStack) {
         int amountLeft = itemStack.getAmount();
 
         // find all slots where the item partially fits
-        for (int slot : getIterationOrder(IterationOrderCategory.ADD)) {
+        for (int slot : getIterationOrder(OperationCategory.ADD)) {
             if (amountLeft == 0)
                 break;
 
@@ -1194,7 +1207,7 @@ public int simulateSingleAdd(@Nullable ItemStack itemStack) {
         }
 
         // remaining items would be added to empty slots
-        for (int slot : getIterationOrder(IterationOrderCategory.ADD)) {
+        for (int slot : getIterationOrder(OperationCategory.ADD)) {
             if (amountLeft == 0)
                 break;
 
@@ -1256,7 +1269,7 @@ public int collectSimilar(@Nullable UpdateReason updateReason, ItemStack templat
             @Nullable ItemStack[] items = getUnsafeItems();
 
             // find partial slots and take items from there
-            for (int slot : getIterationOrder(IterationOrderCategory.COLLECT)) {
+            for (int slot : getIterationOrder(OperationCategory.COLLECT)) {
                 ItemStack currentStack = items[slot];
                 if (currentStack == null || currentStack.getAmount() >= maxStackSize || !template.isSimilar(currentStack))
                     continue;
@@ -1267,7 +1280,7 @@ public int collectSimilar(@Nullable UpdateReason updateReason, ItemStack templat
             }
 
             // only taking from partial stacks wasn't enough, take from a full slot
-            for (int slot : getIterationOrder(IterationOrderCategory.COLLECT)) {
+            for (int slot : getIterationOrder(OperationCategory.COLLECT)) {
                 ItemStack currentStack = items[slot];
                 if (currentStack == null || currentStack.getAmount() < maxStackSize || !template.isSimilar(currentStack))
                     continue;
@@ -1292,7 +1305,7 @@ public int removeIf(@Nullable UpdateReason updateReason, Predicate<ItemStack> pr
         @Nullable ItemStack[] items = getUnsafeItems();
 
         int removed = 0;
-        for (int slot : getIterationOrder(IterationOrderCategory.OTHER)) {
+        for (int slot : getIterationOrder(OperationCategory.OTHER)) {
             ItemStack item = items[slot];
             if (item != null && predicate.test(item.clone()) && setItem(updateReason, slot, null)) {
                 removed += item.getAmount();
@@ -1314,7 +1327,7 @@ public int removeFirst(@Nullable UpdateReason updateReason, int amount, Predicat
         @Nullable ItemStack[] items = getUnsafeItems();
 
         int leftOver = amount;
-        for (int slot : getIterationOrder(IterationOrderCategory.OTHER)) {
+        for (int slot : getIterationOrder(OperationCategory.OTHER)) {
             ItemStack item = items[slot];
             if (item != null && predicate.test(item.clone())) {
                 leftOver -= takeFrom(updateReason, slot, leftOver);
@@ -1336,7 +1349,7 @@ public int removeSimilar(@Nullable UpdateReason updateReason, ItemStack itemStac
         @Nullable ItemStack[] items = getUnsafeItems();
 
         int removed = 0;
-        for (int slot : getIterationOrder(IterationOrderCategory.OTHER)) {
+        for (int slot : getIterationOrder(OperationCategory.OTHER)) {
             ItemStack item = items[slot];
             if (item != null && item.isSimilar(itemStack) && setItem(updateReason, slot, null)) {
                 removed += item.getAmount();
@@ -1358,7 +1371,7 @@ public int removeFirstSimilar(@Nullable UpdateReason updateReason, int amount, I
         @Nullable ItemStack[] items = getUnsafeItems();
 
         int leftOver = amount;
-        for (int slot : getIterationOrder(IterationOrderCategory.OTHER)) {
+        for (int slot : getIterationOrder(OperationCategory.OTHER)) {
             ItemStack item = items[slot];
             if (item != null && item.isSimilar(itemStack)) {
                 leftOver -= takeFrom(updateReason, slot, leftOver);

invui/src/main/java/xyz/xenondevs/invui/inventory/ObscuredInventory.java

@@ -52,7 +52,7 @@ private static int calculateSize(Inventory inventory, IntPredicate isObscured) {
     }
 
     @Override
-    public int[] getIterationOrder(IterationOrderCategory category) {
+    public int[] getIterationOrder(OperationCategory category) {
         int[] iterationOrder = new int[slots.length];
         int i = 0;
         for (int slot : inventory.getIterationOrder(category)) {
@@ -156,17 +156,17 @@ public boolean hasEventHandlers() {
     }
 
     @Override
-    public int getGuiPriority() {
-        return inventory.getGuiPriority();
+    public int getGuiPriority(OperationCategory category) {
+        return inventory.getGuiPriority(category);
     }
 
     @Override
-    public void setIterationOrder(IterationOrderCategory category, int[] iterationOrder) {
+    public void setIterationOrder(OperationCategory category, int[] iterationOrder) {
         throw new UnsupportedOperationException("Iteration order needs to be set in the backing inventory");
     }
 
     @Override
-    public void setGuiPriority(int guiPriority) {
+    public void setGuiPriority(int priority) {
         throw new UnsupportedOperationException("Gui priority needs to be set in the backing inventory");
     }
 

invui/src/main/java/xyz/xenondevs/invui/inventory/IterationOrderCategory.java renamed to invui/src/main/java/xyz/xenondevs/invui/inventory/OperationCategory.java

@@ -6,9 +6,9 @@
 import java.util.function.Predicate;
 
 /**
- * Category of functions that iterate over slots in the inventory.
+ * Category of inventory-related operations.
  */
-public enum IterationOrderCategory {
+public enum OperationCategory {
 
     /**
      * Operations that add items to the inventory, such as {@link Inventory#addItem(UpdateReason, ItemStack)}. 

invui/src/main/java/xyz/xenondevs/invui/inventory/VirtualInventory.java

@@ -160,7 +160,10 @@ public VirtualInventory(int size) {
      */
     public VirtualInventory(VirtualInventory inventory) {
         this(inventory.uuid, inventory.size, ItemUtils.clone(inventory.items), inventory.maxStackSizes.clone());
-        setGuiPriority(inventory.getGuiPriority());
+        for (var category : OperationCategory.values()) {
+            setIterationOrder(category, inventory.getIterationOrder(category));
+            setGuiPriority(category, inventory.getGuiPriority(category));
+        }
         setPreUpdateHandlers(inventory.getPreUpdateHandlers());
         setPostUpdateHandlers(inventory.getPostUpdateHandlers());
         setResizeHandlers(inventory.getResizeHandlers());

invui/src/main/java/xyz/xenondevs/invui/window/AbstractSplitWindow.java

@@ -9,7 +9,7 @@
 import xyz.xenondevs.invui.gui.SlotElement;
 import xyz.xenondevs.invui.internal.menu.CustomContainerMenu;
 import xyz.xenondevs.invui.inventory.Inventory;
-import xyz.xenondevs.invui.inventory.IterationOrderCategory;
+import xyz.xenondevs.invui.inventory.OperationCategory;
 import xyz.xenondevs.invui.inventory.ReferencingInventory;
 
 import java.util.function.Supplier;
@@ -57,8 +57,9 @@ protected AbstractGui supplyLowerGui(Player viewer) {
             if (lowerGuiSupplier == null) {
                 AbstractGui gui = (AbstractGui) Gui.empty(9, 4);
                 Inventory inv = ReferencingInventory.fromPlayerStorageContents(viewer.getInventory());
-                inv.reverseIterationOrder(IterationOrderCategory.ADD);
-                inv.setGuiPriority(Integer.MAX_VALUE); // expected vanilla-like behavior: shift-click moves between upper and lower inv
+                inv.reverseIterationOrder(OperationCategory.ADD); // shift-clicking moves to bottom right
+                inv.setGuiPriority(OperationCategory.ADD, Integer.MAX_VALUE); // shift-click always moves between upper and lower inv
+                inv.setGuiPriority(OperationCategory.COLLECT, Integer.MIN_VALUE); // double-click collects from lower inv last
                 gui.fillRectangle(0, 0, 9, inv, true);
                 return gui;
             }