Implement kits placing items in specific slots (#5794)

TiagoFar78 · JRoy · web-flow · commit 6ab56d2fe854 · 2026-02-07T05:50:39.000Z
Closes #5535 --------- Co-authored-by: Josh Roy <10731363+JRoy@users.noreply.github.com>
diff --git a/Essentials/src/main/java/com/earth2me/essentials/Kit.java b/Essentials/src/main/java/com/earth2me/essentials/Kit.java
@@ -26,6 +26,7 @@
 import java.util.GregorianCalendar;
 import java.util.List;
 import java.util.Map;
+import java.util.HashMap;
 import java.util.logging.Level;
 
 import static com.earth2me.essentials.I18n.tlLiteral;
@@ -174,10 +175,11 @@ public boolean expandItems(final User user, final List<String> items) throws Exc
             final boolean allowUnsafe = ess.getSettings().allowUnsafeEnchantments();
             final boolean autoEquip = ess.getSettings().isKitAutoEquip();
             final List<ItemStack> itemList = new ArrayList<>();
+            final Map<Integer, ItemStack> itemsWithSlot = new HashMap<>();
             final List<String> commandQueue = new ArrayList<>();
             final List<String> moneyQueue = new ArrayList<>();
             final String currencySymbol = ess.getSettings().getCurrencySymbol().isEmpty() ? "$" : ess.getSettings().getCurrencySymbol();
-            for (final String kitItem : output.getLines()) {
+            for (String kitItem : output.getLines()) {
                 if (kitItem.startsWith("$") || kitItem.startsWith(currencySymbol)) {
                     moneyQueue.add(NumberUtil.sanitizeCurrencyString(kitItem, ess));
                     continue;
@@ -191,6 +193,16 @@ public boolean expandItems(final User user, final List<String> items) throws Exc
                     continue;
                 }
 
+                int itemSlot = -1;
+                if (kitItem.startsWith("slot:")) {
+                    final int spaceIndex = kitItem.indexOf(" ");
+                    if (spaceIndex != -1) {
+                        final String slotStr = kitItem.substring("slot:".length(), spaceIndex);
+                        itemSlot = NumberUtil.isInt(slotStr) ? Integer.parseInt(slotStr) : -1;
+                        kitItem = kitItem.substring(spaceIndex + 1);
+                    }
+                }
+
                 final ItemStack stack;
                 final SerializationProvider serializationProvider = ess.provider(SerializationProvider.class);
 
@@ -218,22 +230,35 @@ public boolean expandItems(final User user, final List<String> items) throws Exc
                     stack = metaStack.getItemStack();
                 }
 
-                itemList.add(stack);
+                if (itemSlot == -1 || itemsWithSlot.containsKey(itemSlot)) {
+                    itemList.add(stack);
+                } else {
+                    itemsWithSlot.put(itemSlot, stack);
+                }
             }
 
             final int maxStackSize = user.isAuthorized("essentials.oversizedstacks") ? ess.getSettings().getOversizedStackSize() : 0;
             final boolean isDropItemsIfFull = ess.getSettings().isDropItemsIfFull();
 
-            final KitPreExpandItemsEvent itemsEvent = new KitPreExpandItemsEvent(user, kitName, itemList);
-            Bukkit.getPluginManager().callEvent(itemsEvent);
+            final List<ItemStack> totalItems = new ArrayList<>(itemList);
+            totalItems.addAll(itemsWithSlot.values());
 
-            final ItemStack[] itemArray = itemList.toArray(new ItemStack[0]);
-
-            if (!isDropItemsIfFull && !Inventories.hasSpace(user.getBase(), maxStackSize, autoEquip, itemArray)) {
+            final KitPreExpandItemsEvent itemsEvent = new KitPreExpandItemsEvent(user, kitName, totalItems);
+            Bukkit.getPluginManager().callEvent(itemsEvent);
+            final ItemStack[] totalItemsArray = totalItems.toArray(new ItemStack[0]);
+            if (!isDropItemsIfFull && !Inventories.hasSpace(user.getBase(), maxStackSize, autoEquip, totalItemsArray)) {
                 user.sendTl("kitInvFullNoDrop");
                 return false;
             }
 
+            for (Map.Entry<Integer, ItemStack> itemWithSlot : itemsWithSlot.entrySet()) {
+                final ItemStack leftover = Inventories.addItem(user.getBase(), maxStackSize, itemWithSlot.getValue(), itemWithSlot.getKey());
+                if (leftover != null) {
+                    itemList.add(leftover);
+                }
+            }
+
+            final ItemStack[] itemArray = itemList.toArray(new ItemStack[0]);
             final Map<Integer, ItemStack> leftover = Inventories.addItem(user.getBase(), maxStackSize, autoEquip, itemArray);
             if (!isDropItemsIfFull && !leftover.isEmpty()) {
                 // Inventories#hasSpace should prevent this state from EVER being reached; If it does, something has gone terribly wrong, and we should just give up and hope people report it :(
diff --git a/Essentials/src/main/java/com/earth2me/essentials/commands/Commandcreatekit.java b/Essentials/src/main/java/com/earth2me/essentials/commands/Commandcreatekit.java
@@ -51,13 +51,14 @@ public void run(final Server server, final User user, final String commandLabel,
             useSerializationProvider = false;
         }
 
-        for (ItemStack is : items) {
+        for (int i = 0; i < items.length; i++) {
+            final ItemStack is = items[i];
             if (is != null && is.getType() != null && is.getType() != Material.AIR) {
                 final String serialized;
                 if (useSerializationProvider) {
-                    serialized = "@" + Base64Coder.encodeLines(serializationProvider.serializeItem(is));
+                    serialized = "slot:" + i + " @" + Base64Coder.encodeLines(serializationProvider.serializeItem(is));
                 } else {
-                    serialized = ess.getItemDb().serialize(is);
+                    serialized = "slot:" + i + " " + ess.getItemDb().serialize(is);
                 }
                 list.add(serialized);
             }
diff --git a/Essentials/src/main/java/com/earth2me/essentials/craftbukkit/Inventories.java b/Essentials/src/main/java/com/earth2me/essentials/craftbukkit/Inventories.java
@@ -142,6 +142,35 @@ public static Map<Integer, ItemStack> addItem(final Player player, final int max
         return addItem(player, maxStack, false, items);
     }
 
+    public static ItemStack addItem(final Player player, final int maxStack, ItemStack item, int slot) {
+        final int itemMax = Math.max(maxStack, item.getMaxStackSize());
+
+        ItemStack existing = player.getInventory().getItem(slot);
+        final int existingAmount;
+        if (isEmpty(existing)) {
+            existing = item.clone();
+            existingAmount = 0;
+        } else {
+            existingAmount = existing.getAmount();
+        }
+
+        if (!item.isSimilar(existing)) {
+            return item;
+        }
+
+        final int amount = item.getAmount();
+        if (amount + existingAmount <= itemMax) {
+            existing.setAmount(amount + existingAmount);
+            player.getInventory().setItem(slot, existing);
+            return null;
+        }
+
+        existing.setAmount(itemMax);
+        player.getInventory().setItem(slot, existing);
+        item.setAmount(amount + existingAmount - itemMax);
+        return item;
+    }
+
     public static Map<Integer, ItemStack> addItem(final Player player, final int maxStack, final boolean allowArmor, ItemStack... items) {
         items = normalizeItems(cloneItems(items));
         final Map<Integer, ItemStack> leftover = new HashMap<>();

Original file line number	Diff line number	Diff line change
`@@ -51,13 +51,14 @@ public void run(final Server server, final User user, final String commandLabel,`
`51`	`51`	`useSerializationProvider = false;`
`52`	`52`	`}`
`53`	`53`
`54`		`- for (ItemStack is : items) {`
	`54`	`+ for (int i = 0; i < items.length; i++) {`
	`55`	`+ final ItemStack is = items[i];`
`55`	`56`	`if (is != null && is.getType() != null && is.getType() != Material.AIR) {`
`56`	`57`	`final String serialized;`
`57`	`58`	`if (useSerializationProvider) {`
`58`		`- serialized = "@" + Base64Coder.encodeLines(serializationProvider.serializeItem(is));`
	`59`	`+ serialized = "slot:" + i + " @" + Base64Coder.encodeLines(serializationProvider.serializeItem(is));`
`59`	`60`	`} else {`
`60`		`- serialized = ess.getItemDb().serialize(is);`
	`61`	`+ serialized = "slot:" + i + " " + ess.getItemDb().serialize(is);`
`61`	`62`	`}`
`62`	`63`	`list.add(serialized);`
`63`	`64`	`}`