Update inventory utils

- fix inconsistencies with the offhand
- add index to id translations for missing screens
- add some documentation

closes #5598
closes #3762

Author: Wide-Cat

src/main/java/meteordevelopment/meteorclient/commands/commands/DropCommand.java

@@ -44,8 +44,8 @@ public void build(LiteralArgumentBuilder<CommandSource> builder) {
 
         // Main Inv
         builder.then(literal("inventory").executes(context -> drop(player -> {
-            for (int i = 9; i < player.getInventory().getMainStacks().size(); i++) {
-                InvUtils.drop().slotMain(i - 9);
+            for (int i = 0; i < 27; i++) {
+                InvUtils.drop().slotMain(i);
             }
         })));
 

src/main/java/meteordevelopment/meteorclient/systems/modules/player/AutoEat.java

@@ -193,7 +193,7 @@ private void eat() {
     }
 
     private void stopEating() {
-        changeSlot(prevSlot);
+        if (prevSlot != SlotUtils.OFFHAND) changeSlot(prevSlot);
         setPressed(false);
 
         eating = false;

src/main/java/meteordevelopment/meteorclient/utils/player/FindItemResult.java

@@ -9,6 +9,10 @@
 
 import static meteordevelopment.meteorclient.MeteorClient.mc;
 
+/**
+ * @param slot  The slot index
+ * @param count The number of items in the slot
+ */
 public record FindItemResult(int slot, int count) {
     public boolean found() {
         return slot != -1;

src/main/java/meteordevelopment/meteorclient/utils/player/InvUtils.java

@@ -7,15 +7,21 @@
 
 import meteordevelopment.meteorclient.mixininterface.IClientPlayerInteractionManager;
 import net.minecraft.block.BlockState;
+import net.minecraft.entity.EquipmentSlot;
 import net.minecraft.item.Item;
 import net.minecraft.item.ItemStack;
 import net.minecraft.screen.ScreenHandler;
 import net.minecraft.screen.slot.SlotActionType;
+import org.jetbrains.annotations.Range;
 
 import java.util.function.Predicate;
 
 import static meteordevelopment.meteorclient.MeteorClient.mc;
 
+/**
+ * Util class for dealing inventories and the items in them.
+ * See {@link SlotUtils} for details on how slots are referenced.
+ */
 public class InvUtils {
     private static final Action ACTION = new Action();
     public static int previousSlot = -1;
@@ -224,22 +230,28 @@ public Action fromId(int id) {
             return this;
         }
 
+        /**
+         * @param index The index of one of the slots within the inventory
+         */
         public Action from(int index) {
             return fromId(SlotUtils.indexToId(index));
         }
 
-        public Action fromHotbar(int i) {
+        public Action fromHotbar(@Range(from = 0, to = 8) int i) {
             return from(SlotUtils.HOTBAR_START + i);
         }
 
         public Action fromOffhand() {
             return from(SlotUtils.OFFHAND);
         }
 
-        public Action fromMain(int i) {
+        public Action fromMain(@Range(from = 0, to = 26) int i) {
             return from(SlotUtils.MAIN_START + i);
         }
 
+        /**
+         * @param i The entity slot id of one of the four humanoid armor pieces, as defined in {@link EquipmentSlot}
+         */
         public Action fromArmor(int i) {
             return from(SlotUtils.ARMOR_START + (3 - i));
         }
@@ -251,22 +263,28 @@ public void toId(int id) {
             run();
         }
 
+        /**
+         * @param index The index of one of the slots within the inventory
+         */
         public void to(int index) {
             toId(SlotUtils.indexToId(index));
         }
 
-        public void toHotbar(int i) {
+        public void toHotbar(@Range(from = 0, to = 8) int i) {
             to(SlotUtils.HOTBAR_START + i);
         }
 
         public void toOffhand() {
             to(SlotUtils.OFFHAND);
         }
 
-        public void toMain(int i) {
+        public void toMain(@Range(from = 0, to = 26) int i) {
             to(SlotUtils.MAIN_START + i);
         }
 
+        /**
+         * @param i The entity slot id of one of the four humanoid armor pieces, as defined in {@link EquipmentSlot}
+         */
         public void toArmor(int i) {
             to(SlotUtils.ARMOR_START + (3 - i));
         }
@@ -278,22 +296,28 @@ public void slotId(int id) {
             run();
         }
 
+        /**
+         * @param index The index of one of the slots within the inventory
+         */
         public void slot(int index) {
             slotId(SlotUtils.indexToId(index));
         }
 
-        public void slotHotbar(int i) {
+        public void slotHotbar(@Range(from = 0, to = 8) int i) {
             slot(SlotUtils.HOTBAR_START + i);
         }
 
         public void slotOffhand() {
             slot(SlotUtils.OFFHAND);
         }
 
-        public void slotMain(int i) {
+        public void slotMain(@Range(from = 0, to = 26) int i) {
             slot(SlotUtils.MAIN_START + i);
         }
 
+        /**
+         * @param i The entity slot id of one of the four humanoid armor pieces, as defined in {@link EquipmentSlot}
+         */
         public void slotArmor(int i) {
             slot(SlotUtils.ARMOR_START + (3 - i));
         }

src/main/java/meteordevelopment/meteorclient/utils/player/SlotUtils.java

@@ -9,32 +9,48 @@
 import meteordevelopment.meteorclient.mixin.HorseScreenHandlerAccessor;
 import meteordevelopment.meteorclient.mixin.ItemGroupsAccessor;
 import net.minecraft.client.gui.screen.ingame.CreativeInventoryScreen;
+import net.minecraft.client.network.ClientPlayerInteractionManager;
 import net.minecraft.entity.mob.SkeletonHorseEntity;
 import net.minecraft.entity.mob.ZombieHorseEntity;
-import net.minecraft.entity.passive.AbstractDonkeyEntity;
-import net.minecraft.entity.passive.AbstractHorseEntity;
-import net.minecraft.entity.passive.HorseEntity;
-import net.minecraft.entity.passive.LlamaEntity;
+import net.minecraft.entity.passive.*;
+import net.minecraft.entity.player.PlayerEntity;
 import net.minecraft.registry.Registries;
 import net.minecraft.screen.*;
+import net.minecraft.screen.slot.Slot;
+import net.minecraft.screen.slot.SlotActionType;
 
 import static meteordevelopment.meteorclient.MeteorClient.mc;
 
 public class SlotUtils {
+    /**
+     * These constants refer to the slot index of relevant player slots. They are used when dealing directly with the
+     * player inventory - e.g. {@code mc.player.getInventory().getSelectedSlot()} returns the slot index of your
+     * selected slot (i.e. main hand).
+     *
+     * @see net.minecraft.entity.player.PlayerInventory
+     * @see Slot#index
+     */
     public static final int HOTBAR_START = 0;
     public static final int HOTBAR_END = 8;
-
-    public static final int OFFHAND = 45;
-
     public static final int MAIN_START = 9;
     public static final int MAIN_END = 35;
-
     public static final int ARMOR_START = 36;
     public static final int ARMOR_END = 39;
+    public static final int OFFHAND = 40;
 
     private SlotUtils() {
     }
 
+    /**
+     * Slot ids are used when inventory interactions have to be communicated to the server - you'll only find references
+     * to slot ids when dealing with screen handlers or slot/inventory packets. All the methods in this class are used
+     * to translate slot indices to the ids for each handled screen.
+     *
+     * @see <a href="https://minecraft.wiki/w/Java_Edition_protocol/Inventory">the minecraft.wiki page</a> for every slot id
+     * @see ClientPlayerInteractionManager#clickSlot(int, int, int, SlotActionType, PlayerEntity)
+     * @see ScreenHandler#internalOnSlotClick(int, int, SlotActionType, PlayerEntity)
+     * @see Slot#id
+     */
     public static int indexToId(int i) {
         if (mc.player == null) return -1;
         ScreenHandler handler = mc.player.currentScreenHandler;
@@ -60,18 +76,21 @@ public static int indexToId(int i) {
         if (handler instanceof LecternScreenHandler) return lectern();
         if (handler instanceof LoomScreenHandler) return loom(i);
         if (handler instanceof StonecutterScreenHandler) return stonecutter(i);
+        if (handler instanceof CrafterScreenHandler) return crafter(i);
+        if (handler instanceof SmithingScreenHandler) return smithingTable(i);
 
         return -1;
     }
 
     private static int survivalInventory(int i) {
         if (isHotbar(i)) return 36 + i;
         if (isArmor(i)) return 5 + (i - 36);
+        if (i == OFFHAND) return 45;
         return i;
     }
 
     private static int creativeInventory(int i) {
-        if (!(mc.currentScreen instanceof CreativeInventoryScreen) || CreativeInventoryScreenAccessor.meteor$getSelectedTab() != Registries.ITEM_GROUP.get(ItemGroupsAccessor.meteor$getInventory()))
+        if (CreativeInventoryScreenAccessor.meteor$getSelectedTab() != Registries.ITEM_GROUP.get(ItemGroupsAccessor.meteor$getInventory()))
             return -1;
         return survivalInventory(i);
     }
@@ -143,7 +162,8 @@ private static int horse(ScreenHandler handler, int i) {
             int strength = llamaEntity.getStrength();
             if (isHotbar(i)) return (2 + 3 * strength) + 28 + i;
             if (isMain(i)) return (2 + 3 * strength) + 1 + (i - 9);
-        } else if (entity instanceof HorseEntity || entity instanceof SkeletonHorseEntity || entity instanceof ZombieHorseEntity) {
+        } else if (entity instanceof HorseEntity || entity instanceof SkeletonHorseEntity
+            || entity instanceof ZombieHorseEntity || entity instanceof CamelEntity) {
             if (isHotbar(i)) return 29 + i;
             if (isMain(i)) return 2 + (i - 9);
         } else if (entity instanceof AbstractDonkeyEntity abstractDonkeyEntity) {
@@ -183,17 +203,29 @@ private static int stonecutter(int i) {
         return -1;
     }
 
+    private static int crafter(int i) {
+        if (isHotbar(i)) return 36 + i;
+        if (isMain(i)) return i;
+        return -1;
+    }
+
+    private static int smithingTable(int i) {
+        if (isHotbar(i)) return 31 + i;
+        if (isMain(i)) return 4 + (i - 9);
+        return -1;
+    }
+
     // Utils
 
-    public static boolean isHotbar(int i) {
-        return i >= HOTBAR_START && i <= HOTBAR_END;
+    public static boolean isHotbar(int slotIndex) {
+        return slotIndex >= HOTBAR_START && slotIndex <= HOTBAR_END;
     }
 
-    public static boolean isMain(int i) {
-        return i >= MAIN_START && i <= MAIN_END;
+    public static boolean isMain(int slotIndex) {
+        return slotIndex >= MAIN_START && slotIndex <= MAIN_END;
     }
 
-    public static boolean isArmor(int i) {
-        return i >= ARMOR_START && i <= ARMOR_END;
+    public static boolean isArmor(int slotIndex) {
+        return slotIndex >= ARMOR_START && slotIndex <= ARMOR_END;
     }
 }