Add an option to reverse transfer scan order

Author: NotRyken

changelog.md

@@ -2,9 +2,15 @@
 
 ## 2.2.0
 
+Note: this version includes networking changes, servers and clients must be upgraded together.
+
+- Added an option to reverse the default transfer iteration order
 - Added an option to arrange buttons horizontally rather than vertically
 - Added support for creating separate class policies for unique inventory titles
 - Added a per-policy option to anchor buttons to the reference slot instead of the GUI edge
+
+## 2.1.8
+
 - Fixed detection of CTRL/CMD keys in 1.21.9-11
 
 ## 2.1.7

common/src/main/java/dev/terminalmc/clientsort/client/config/Config.java

@@ -113,6 +113,9 @@ public enum ExtraSlotScope {
         public static final boolean bundlesUseLeftClickDefault = false;
         public boolean bundlesUseLeftClick = bundlesUseLeftClickDefault;
 
+        public static final boolean transferReverseOrderDefault = true;
+        public boolean transferReverseOrder = transferReverseOrderDefault;
+
         // Matching options
 
         public static final boolean alwaysMatchByTypeDefault = false;

common/src/main/java/dev/terminalmc/clientsort/client/gui/screen/config/ClothScreenProvider.java

@@ -183,11 +183,16 @@ else if (val > Config.Options.AUTO_OP_DELAY_MAX)
                 )
                 .setTooltip(localized("option", "bundlesUseLeftClick.tooltip"))
                 .setDefaultValue(Config.Options.bundlesUseLeftClickDefault)
-                .setSaveConsumer(val -> {
-                    options.bundlesUseLeftClick = val;
-                    if (val)
-                        CreativeSearchOrder.tryRefreshStackPositionMap();
-                })
+                .setSaveConsumer(val -> options.bundlesUseLeftClick = val)
+                .build());
+
+        general.addEntry(eb.startBooleanToggle(
+                        localized("option", "transferReverseOrder"),
+                        options.transferReverseOrder
+                )
+                .setTooltip(localized("option", "transferReverseOrder.tooltip"))
+                .setDefaultValue(Config.Options.transferReverseOrderDefault)
+                .setSaveConsumer(val -> options.transferReverseOrder = val)
                 .build());
 
         general.addEntry(eb.startBooleanToggle(

common/src/main/java/dev/terminalmc/clientsort/client/inventory/operator/client/ClientSurvivalOperator.java

@@ -33,6 +33,7 @@
 
 import java.util.ArrayDeque;
 import java.util.BitSet;
+import java.util.function.Function;
 
 import static dev.terminalmc.clientsort.ClientSort.debug;
 import static dev.terminalmc.clientsort.client.config.Config.options;
@@ -504,7 +505,11 @@ protected void transfer(Slot[] originSlots) {
 
         // Work backwards from the end of the source slot array, looking for a
         // nonempty stack
-        for (int i = originSlots.length - 1; i >= 0; i--) {
+        boolean reversed = options().transferReverseOrder;
+        int start = reversed ? originSlots.length - 1 : 0;
+        Function<Integer,Boolean> end = reversed ? (i) -> i >= 0 : (i) -> i < originSlots.length;
+        Function<Integer,Integer> step = reversed ? (i) -> i - 1 : (i) -> i + 1;
+        for (int i = start; end.apply(i); i = step.apply(i)) {
             Slot srcSlot = originSlots[i];
             ItemStack srcStack = originStacks[i];
 

common/src/main/java/dev/terminalmc/clientsort/client/inventory/operator/server/ServerOperator.java

@@ -133,7 +133,8 @@ protected void fillStacks() {
         ClientPlatformServices.getInstance().sendToServer(new StackFillPayload(
                 screen.getMenu().containerId,
                 srcSlotIds,
-                dstSlotIds
+                dstSlotIds,
+                options().transferReverseOrder
         ));
     }
 
@@ -192,7 +193,8 @@ private void transfer(@Nullable Slot[] overrideSlots) {
         ClientPlatformServices.getInstance().sendToServer(new TransferPayload(
                 screen.getMenu().containerId,
                 srcSlotIds,
-                dstSlotIds
+                dstSlotIds,
+                options().transferReverseOrder
         ));
     }
 

common/src/main/java/dev/terminalmc/clientsort/network/handler/StackFillHandler.java

@@ -30,6 +30,8 @@
 import net.minecraft.world.inventory.Slot;
 import net.minecraft.world.item.ItemStack;
 
+import java.util.function.Function;
+
 import static dev.terminalmc.clientsort.ClientSort.getObj;
 import static dev.terminalmc.clientsort.network.handler.validate.SchemaValidator.validateSlotArray;
 
@@ -56,7 +58,7 @@ public static void handle(
                     validateSlotArray(player, menu, payload.srcSlotIds());
                     validateSlotArray(player, menu, payload.dstSlotIds());
                 },
-                (menu) -> fillStacks(server, menu, payload.srcSlotIds(), payload.dstSlotIds()),
+                (menu) -> fillStacks(server, menu, payload.srcSlotIds(), payload.dstSlotIds(), payload.reversed()),
                 StackFillPayload.TYPE,
                 StackFillResultPayload.TYPE,
                 (result, message) -> new StackFillResultPayload(result.code, message)
@@ -67,11 +69,15 @@ private static void fillStacks(
             MinecraftServer server,
             AbstractContainerMenu menu,
             int[] srcSlotIds,
-            int[] dstSlotIds
+            int[] dstSlotIds,
+            boolean reversed
     ) throws PayloadHandlerException {
         // Work backwards from the end of the source array, looking for a
         // nonempty stack
-        for (int i = srcSlotIds.length - 1; i >= 0; i--) {
+        int start = reversed ? srcSlotIds.length - 1 : 0;
+        Function<Integer,Boolean> end = reversed ? (i) -> i >= 0 : (i) -> i < srcSlotIds.length;
+        Function<Integer,Integer> step = reversed ? (i) -> i - 1 : (i) -> i + 1;
+        for (int i = start; end.apply(i); i = step.apply(i)) {
             int srcSlotId = srcSlotIds[i];
             Slot srcSlot = menu.slots.get(srcSlotId);
             ItemStack srcStack = srcSlot.getItem();

common/src/main/java/dev/terminalmc/clientsort/network/handler/TransferHandler.java

@@ -30,6 +30,8 @@
 import net.minecraft.world.inventory.Slot;
 import net.minecraft.world.item.ItemStack;
 
+import java.util.function.Function;
+
 import static dev.terminalmc.clientsort.ClientSort.getObj;
 import static dev.terminalmc.clientsort.network.handler.validate.SchemaValidator.validateSlotArray;
 
@@ -56,7 +58,13 @@ public static void handle(
                     validateSlotArray(player, menu, payload.srcSlotIds());
                     validateSlotArray(player, menu, payload.dstSlotIds());
                 },
-                (menu) -> transfer(server, menu, payload.srcSlotIds(), payload.dstSlotIds()),
+                (menu) -> transfer(
+                        server,
+                        menu,
+                        payload.srcSlotIds(),
+                        payload.dstSlotIds(),
+                        payload.reversed()
+                ),
                 TransferPayload.TYPE,
                 TransferResultPayload.TYPE,
                 (result, message) -> new TransferResultPayload(result.code, message)
@@ -67,11 +75,15 @@ private static void transfer(
             MinecraftServer server,
             AbstractContainerMenu menu,
             int[] srcSlotIds,
-            int[] dstSlotIds
+            int[] dstSlotIds,
+            boolean reversed
     ) throws PayloadHandlerException {
         // Work backwards from the end of the source array, looking for a
         // nonempty stack
-        for (int i = srcSlotIds.length - 1; i >= 0; i--) {
+        int start = reversed ? srcSlotIds.length - 1 : 0;
+        Function<Integer, Boolean> end = reversed ? (i) -> i >= 0 : (i) -> i < srcSlotIds.length;
+        Function<Integer, Integer> step = reversed ? (i) -> i - 1 : (i) -> i + 1;
+        for (int i = start; end.apply(i); i = step.apply(i)) {
             int srcSlotId = srcSlotIds[i];
             Slot srcSlot = menu.slots.get(srcSlotId);
             ItemStack srcStack = srcSlot.getItem();

common/src/main/java/dev/terminalmc/clientsort/network/payload/StackFillPayload.java

@@ -32,7 +32,12 @@
  * @param srcSlotIds     a sub-array of slots to take items from.
  * @param dstSlotIds     a sub-array of slots to place items in.
  */
-public record StackFillPayload(int srcContainerId, int[] srcSlotIds, int[] dstSlotIds)
+public record StackFillPayload(
+        int srcContainerId,
+        int[] srcSlotIds,
+        int[] dstSlotIds,
+        boolean reversed
+)
         implements CustomPacketPayload {
 
     public static final StreamCodec<RegistryFriendlyByteBuf, int[]> VAR_INT_ARRAY =
@@ -57,6 +62,8 @@ public void encode(
                     StackFillPayload::srcSlotIds,
                     VAR_INT_ARRAY,
                     StackFillPayload::dstSlotIds,
+                    ByteBufCodecs.BOOL,
+                    StackFillPayload::reversed,
                     StackFillPayload::new
             );
 

common/src/main/java/dev/terminalmc/clientsort/network/payload/TransferPayload.java

@@ -32,7 +32,7 @@
  * @param srcSlotIds     a sub-array of slots to take items from.
  * @param dstSlotIds     a sub-array of slots to place items in.
  */
-public record TransferPayload(int srcContainerId, int[] srcSlotIds, int[] dstSlotIds)
+public record TransferPayload(int srcContainerId, int[] srcSlotIds, int[] dstSlotIds, boolean reversed)
         implements CustomPacketPayload {
 
     public static final StreamCodec<RegistryFriendlyByteBuf, int[]> VAR_INT_ARRAY =
@@ -57,6 +57,8 @@ public void encode(
                     TransferPayload::srcSlotIds,
                     VAR_INT_ARRAY,
                     TransferPayload::dstSlotIds,
+                    ByteBufCodecs.BOOL,
+                    TransferPayload::reversed,
                     TransferPayload::new
             );
 

common/src/main/resources/assets/clientsort/lang/en_us.json

@@ -92,6 +92,8 @@
   "option.clientsort.extraSlotScope": "Extra Slot Scope",
   "option.clientsort.bundlesUseLeftClick": "Bundles use Left Click",
   "option.clientsort.bundlesUseLeftClick.tooltip": "In 1.21.2+, bundles use left-click to load, which can interfere with inventory actions. If playing on a 1.21.2+ server, enable this option.",
+  "option.clientsort.transferReverseOrder": "Transfer Reverse Order",
+  "option.clientsort.transferReverseOrder.tooltip": "Whether to scan the source inventory backwards in transfer operations.",
   "option.clientsort.showDebugInfo": "Show Debug Info",
   "option.clientsort.showDebugInfo.tooltip": "Whether to show debug info on the GUI and enable debug logging. Value will reset when you restart the game.",