From ed0362a4aef4fd5078ae307ae0ed1b25f8021577 Mon Sep 17 00:00:00 2001 From: Zach Brown Date: Tue, 28 Aug 2018 23:04:06 -0400 Subject: [PATCH] Inventory#removeItemAnySlot diff --git a/src/main/java/org/bukkit/inventory/Inventory.java b/src/main/java/org/bukkit/inventory/Inventory.java index 5a38d8f13..01fe217df 100644 --- a/src/main/java/org/bukkit/inventory/Inventory.java +++ b/src/main/java/org/bukkit/inventory/Inventory.java @@ -125,6 +125,34 @@ public interface Inventory extends Iterable { @NotNull public HashMap removeItem(@NotNull ItemStack... items) throws IllegalArgumentException; + // Paper start + /** + * Searches all possible inventory slots in order to remove the given ItemStacks. + *

+ * Similar to {@link Inventory#removeItem(ItemStack...)} in behavior, except this + * method will check all possible slots in the inventory, rather than just the main + * storage contents. + *

+ * It will try to remove 'as much as possible' from the types and amounts + * you give as arguments. + *

+ * The returned HashMap contains what it couldn't remove, where the key is + * the index of the parameter, and the value is the ItemStack at that + * index of the varargs parameter. If all the given ItemStacks are + * removed, it will return an empty HashMap. + *

+ * It is known that in some implementations this method will also set the + * inputted argument amount to the number of that item not removed from + * slots. + * + * @param items The ItemStacks to remove + * @return A HashMap containing items that couldn't be removed. + * @throws IllegalArgumentException if items is null + */ + @NotNull + public HashMap removeItemAnySlot(@NotNull ItemStack... items) throws IllegalArgumentException; + // Paper end + /** * Returns all ItemStacks from the inventory * -- 2.26.2