Package com.loohp.limbo.inventory

Class AbstractInventory

java.lang.Object
com.loohp.limbo.inventory.AbstractInventory
All Implemented Interfaces:
Inventory, Iterable<ItemStack>
Direct Known Subclasses:
AnvilInventory, CustomInventory, PlayerInventory
public abstract class AbstractInventory extends Object implements Inventory

  • Field Details

  • Constructor Details

  • Method Details

    • updateInventory

      public void updateInventory(Player player)
      Specified by:
      updateInventory in interface Inventory

    • updateInventory

      public void updateInventory()
      Specified by:
      updateInventory in interface Inventory

    • getLocation

      public Location getLocation()
      Description copied from interface: Inventory
      Get the location of the block or entity which corresponds to this inventory. May return null if this container was custom created or is a virtual / subcontainer.
      Specified by:
      getLocation in interface Inventory
      Returns:
      location or null if not applicable.

    • getSize

      public int getSize()
      Description copied from interface: Inventory
      Returns the size of the inventory
      Specified by:
      getSize in interface Inventory
      Returns:
      The size of the inventory

    • getMaxStackSize

      public int getMaxStackSize()
      Description copied from interface: Inventory
      Returns the maximum stack size for an ItemStack in this inventory.
      Specified by:
      getMaxStackSize in interface Inventory
      Returns:
      The maximum size for an ItemStack in this inventory.

    • setMaxStackSize

      public void setMaxStackSize(int size)
      Description copied from interface: Inventory
      This method allows you to change the maximum stack size for an inventory.

      Caveats:

      • Not all inventories respect this value.
      • Stacks larger than 127 may be clipped when the world is saved.
      • This value is not guaranteed to be preserved; be sure to set it before every time you want to set a slot over the max stack size.
      • Stacks larger than the default max size for this type of inventory may not display correctly in the client.
      Specified by:
      setMaxStackSize in interface Inventory
      Parameters:
      size - The new maximum stack size for items in this inventory.

    • getItem

      public ItemStack getItem(int index)
      Description copied from interface: Inventory
      Returns the ItemStack found in the slot at the given index
      Specified by:
      getItem in interface Inventory
      Parameters:
      index - The index of the Slot's ItemStack to return
      Returns:
      The ItemStack in the slot

    • setItem

      public void setItem(int index, ItemStack item)
      Description copied from interface: Inventory
      Stores the ItemStack at the given index of the inventory.
      Specified by:
      setItem in interface Inventory
      Parameters:
      index - The index where to put the ItemStack
      item - The ItemStack to set

    • firstPartial

      public int firstPartial(net.kyori.adventure.key.Key material)

    • addItem

      public HashMap<Integer,ItemStack> addItem(ItemStack... items) throws IllegalArgumentException
      Description copied from interface: Inventory
      Stores the given ItemStacks in the inventory. This will try to fill existing stacks and empty slots as well as it can.

      The returned HashMap contains what it couldn't store, where the key is the index of the parameter, and the value is the ItemStack at that index of the varargs parameter. If all items are stored, it will return an empty HashMap.

      If you pass in ItemStacks which exceed the maximum stack size for the Material, first they will be added to partial stacks where Material.getMaxStackSize() is not exceeded, up to Material.getMaxStackSize(). When there are no partial stacks left stacks will be split on Inventory.getMaxStackSize() allowing you to exceed the maximum stack size for that material.

      It is known that in some implementations this method will also set the inputted argument amount to the number of that item not placed in slots.

      Specified by:
      addItem in interface Inventory
      Parameters:
      items - The ItemStacks to add
      Returns:
      A HashMap containing items that didn't fit.
      Throws:
      IllegalArgumentException - if items or any element in it is null

    • removeItem

      public HashMap<Integer,ItemStack> removeItem(ItemStack... items) throws IllegalArgumentException
      Description copied from interface: Inventory
      Removes the given ItemStacks from the inventory.

      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.

      Specified by:
      removeItem in interface Inventory
      Parameters:
      items - The ItemStacks to remove
      Returns:
      A HashMap containing items that couldn't be removed.
      Throws:
      IllegalArgumentException - if items is null

    • getContents

      public ItemStack[] getContents()
      Description copied from interface: Inventory
      Returns all ItemStacks from the inventory
      Specified by:
      getContents in interface Inventory
      Returns:
      An array of ItemStacks from the inventory. Individual items may be null.

    • setContents

      public void setContents(ItemStack[] items) throws IllegalArgumentException
      Description copied from interface: Inventory
      Completely replaces the inventory's contents. Removes all existing contents and replaces it with the ItemStacks given in the array.
      Specified by:
      setContents in interface Inventory
      Parameters:
      items - A complete replacement for the contents; the length must be less than or equal to Inventory.getSize().
      Throws:
      IllegalArgumentException - If the array has more items than the inventory.

    • getStorageContents

      public ItemStack[] getStorageContents()
      Description copied from interface: Inventory
      Return the contents from the section of the inventory where items can reasonably be expected to be stored. In most cases this will represent the entire inventory, but in some cases it may exclude armor or result slots.
      It is these contents which will be used for add / contains / remove methods which look for a specific stack.
      Specified by:
      getStorageContents in interface Inventory
      Returns:
      inventory storage contents. Individual items may be null.

    • setStorageContents

      public void setStorageContents(ItemStack[] items) throws IllegalArgumentException
      Description copied from interface: Inventory
      Put the given ItemStacks into the storage slots
      Specified by:
      setStorageContents in interface Inventory
      Parameters:
      items - The ItemStacks to use as storage contents
      Throws:
      IllegalArgumentException - If the array has more items than the inventory.

    • contains

      public boolean contains(net.kyori.adventure.key.Key material) throws IllegalArgumentException
      Description copied from interface: Inventory
      Checks if the inventory contains any ItemStacks with the given material.
      Specified by:
      contains in interface Inventory
      Parameters:
      material - The material to check for
      Returns:
      true if an ItemStack is found with the given Material
      Throws:
      IllegalArgumentException - if material is null

    • contains

      public boolean contains(ItemStack item)
      Description copied from interface: Inventory
      Checks if the inventory contains any ItemStacks matching the given ItemStack.

      This will only return true if both the type and the amount of the stack match.

      Specified by:
      contains in interface Inventory
      Parameters:
      item - The ItemStack to match against
      Returns:
      false if item is null, true if any exactly matching ItemStacks were found

    • contains

      public boolean contains(net.kyori.adventure.key.Key material, int amount) throws IllegalArgumentException
      Description copied from interface: Inventory
      Checks if the inventory contains any ItemStacks with the given material, adding to at least the minimum amount specified.
      Specified by:
      contains in interface Inventory
      Parameters:
      material - The material to check for
      amount - The minimum amount
      Returns:
      true if amount is less than 1, true if enough ItemStacks were found to add to the given amount
      Throws:
      IllegalArgumentException - if material is null

    • contains

      public boolean contains(ItemStack item, int amount)
      Description copied from interface: Inventory
      Checks if the inventory contains at least the minimum amount specified of exactly matching ItemStacks.

      An ItemStack only counts if both the type and the amount of the stack match.

      Specified by:
      contains in interface Inventory
      Parameters:
      item - the ItemStack to match against
      amount - how many identical stacks to check for
      Returns:
      false if item is null, true if amount less than 1, true if amount of exactly matching ItemStacks were found
      See Also:

    • containsAtLeast

      public boolean containsAtLeast(ItemStack item, int amount)
      Description copied from interface: Inventory
      Checks if the inventory contains ItemStacks matching the given ItemStack whose amounts sum to at least the minimum amount specified.
      Specified by:
      containsAtLeast in interface Inventory
      Parameters:
      item - the ItemStack to match against
      amount - the minimum amount
      Returns:
      false if item is null, true if amount less than 1, true if enough ItemStacks were found to add to the given amount

    • all

      public HashMap<Integer,? extends ItemStack> all(net.kyori.adventure.key.Key material) throws IllegalArgumentException
      Description copied from interface: Inventory
      Returns a HashMap with all slots and ItemStacks in the inventory with the given Material.

      The HashMap contains entries where, the key is the slot index, and the value is the ItemStack in that slot. If no matching ItemStack with the given Material is found, an empty map is returned.

      Specified by:
      all in interface Inventory
      Parameters:
      material - The material to look for
      Returns:
      A HashMap containing the slot index, ItemStack pairs
      Throws:
      IllegalArgumentException - if material is null

    • all

      public HashMap<Integer,? extends ItemStack> all(ItemStack item)
      Description copied from interface: Inventory
      Finds all slots in the inventory containing any ItemStacks with the given ItemStack. This will only match slots if both the type and the amount of the stack match

      The HashMap contains entries where, the key is the slot index, and the value is the ItemStack in that slot. If no matching ItemStack with the given Material is found, an empty map is returned.

      Specified by:
      all in interface Inventory
      Parameters:
      item - The ItemStack to match against
      Returns:
      A map from slot indexes to item at index

    • first

      public int first(net.kyori.adventure.key.Key material) throws IllegalArgumentException
      Description copied from interface: Inventory
      Finds the first slot in the inventory containing an ItemStack with the given material
      Specified by:
      first in interface Inventory
      Parameters:
      material - The material to look for
      Returns:
      The slot index of the given Material or -1 if not found
      Throws:
      IllegalArgumentException - if material is null

    • first

      public int first(ItemStack item)
      Description copied from interface: Inventory
      Returns the first slot in the inventory containing an ItemStack with the given stack. This will only match a slot if both the type and the amount of the stack match
      Specified by:
      first in interface Inventory
      Parameters:
      item - The ItemStack to match against
      Returns:
      The slot index of the given ItemStack or -1 if not found

    • firstEmpty

      public int firstEmpty()
      Description copied from interface: Inventory
      Returns the first empty Slot.
      Specified by:
      firstEmpty in interface Inventory
      Returns:
      The first empty Slot found, or -1 if no empty slots.

    • isEmpty

      public boolean isEmpty()
      Description copied from interface: Inventory
      Check whether or not this inventory is empty. An inventory is considered to be empty if there are no ItemStacks in any slot of this inventory.
      Specified by:
      isEmpty in interface Inventory
      Returns:
      true if empty, false otherwise

    • remove

      public void remove(net.kyori.adventure.key.Key material) throws IllegalArgumentException
      Description copied from interface: Inventory
      Removes all stacks in the inventory matching the given material.
      Specified by:
      remove in interface Inventory
      Parameters:
      material - The material to remove
      Throws:
      IllegalArgumentException - if material is null

    • remove

      public void remove(ItemStack item)
      Description copied from interface: Inventory
      Removes all stacks in the inventory matching the given stack.

      This will only match a slot if both the type and the amount of the stack match

      Specified by:
      remove in interface Inventory
      Parameters:
      item - The ItemStack to match against

    • clear

      public void clear(int index)
      Description copied from interface: Inventory
      Clears out a particular slot in the index.
      Specified by:
      clear in interface Inventory
      Parameters:
      index - The index to empty.

    • clear

      public void clear()
      Description copied from interface: Inventory
      Clears out the whole Inventory.
      Specified by:
      clear in interface Inventory

    • getViewers

      public Set<Player> getViewers()
      Description copied from interface: Inventory
      Gets a list of players viewing the inventory. Note that a player is considered to be viewing their own inventory and internal crafting screen even when said inventory is not open. They will normally be considered to be viewing their inventory even when they have a different inventory screen open, but it's possible for customized inventory screens to exclude the viewer's inventory, so this should never be assumed to be non-empty.
      Specified by:
      getViewers in interface Inventory
      Returns:
      A set of HumanEntities who are viewing this Inventory.

    • getType

      public InventoryType getType()
      Description copied from interface: Inventory
      Returns what type of inventory this is.
      Specified by:
      getType in interface Inventory
      Returns:
      The InventoryType representing the type of inventory.

    • getHolder

      public InventoryHolder getHolder()
      Description copied from interface: Inventory
      Gets the block or entity belonging to the open inventory
      Specified by:
      getHolder in interface Inventory
      Returns:
      The holder of the inventory; null if it has no holder.

    • iterator

      public ListIterator<ItemStack> iterator()
      Specified by:
      iterator in interface Inventory
      Specified by:
      iterator in interface Iterable<ItemStack>

    • iterator

      public ListIterator<ItemStack> iterator(int index)
      Description copied from interface: Inventory
      Returns an iterator starting at the given index. If the index is positive, then the first call to next() will return the item at that index; if it is negative, the first call to previous will return the item at index (getSize() + index).
      Specified by:
      iterator in interface Inventory
      Parameters:
      index - The index.
      Returns:
      An iterator.

    • getUnsafe

      @Deprecated public AbstractInventory.Unsafe getUnsafe()
      Deprecated.
      Specified by:
      getUnsafe in interface Inventory