Package alexiil.mc.lib.attributes.item.impl

Class CombinedGroupedItemInvView

java.lang.Object
alexiil.mc.lib.attributes.item.impl.CombinedGroupedItemInvView
All Implemented Interfaces:
AbstractItemInvView, GroupedItemInvView
Direct Known Subclasses:
CombinedGroupedItemInv
public class CombinedGroupedItemInvView
extends java.lang.Object
implements GroupedItemInvView
A combined version of multiple GroupedItemInvView's.

  • Constructor Details

  • Method Details

    • getAmount

      public int getAmount​(ItemFilter filter)
      Specified by:
      getAmount in interface GroupedItemInvView
      Returns:
      A count of all the ItemStack's that match the given filter.

    • getAmount

      public int getAmount​(net.minecraft.item.ItemStack stack)
      Specified by:
      getAmount in interface GroupedItemInvView
      Parameters:
      stack - The stack to check for. Cannot be empty.
      Returns:
      The total amount of the given stack that is stored in this inventory.

    • getSpace

      public int getSpace​(net.minecraft.item.ItemStack stack)
      Specified by:
      getSpace in interface GroupedItemInvView
      Returns:
      The total space that could store the given stack, not including space that is currently taken up by the stack (so this should change with GroupedItemInvView.getAmount(ItemFilter)).

    • getCapacity

      public int getCapacity​(net.minecraft.item.ItemStack stack)
      Specified by:
      getCapacity in interface GroupedItemInvView
      Parameters:
      stack - The stack to check for. Must not be empty.
      Returns:
      The total space that is available (right now!) to store the given stack.

    • getTotalCapacity

      public int getTotalCapacity()
      Specified by:
      getTotalCapacity in interface GroupedItemInvView
      Returns:
      The total capacity for every ItemStack that can be stored in this inventory.

      NOTE: This value might not be equal to the sum of GroupedItemInvView.getCapacity(ItemStack) over GroupedItemInvView.getStoredStacks()!

    • getStatistics

      public GroupedItemInvView.ItemInvStatistic getStatistics​(ItemFilter filter)
      Specified by:
      getStatistics in interface GroupedItemInvView
      Parameters:
      filter - The filter to check on.
      Returns:
      Statistics about the currently stored amount, capacity, and space for everything that matches the given filter.

    • getStoredStacks

      public java.util.Set<net.minecraft.item.ItemStack> getStoredStacks()
      Specified by:
      getStoredStacks in interface GroupedItemInvView
      Returns:
      a set containing all of the ItemStack's that are stored in the inventory. NOTE: This must return a set using one of the Hash.Strategy's in ItemStackCollections otherwise comparison methods won't work correctly!

    • getChangeValue

      public int getChangeValue()
      Specified by:
      getChangeValue in interface AbstractItemInvView
      Returns:
      A value that indicates whether an inventory might have changed if it differs from the last value returned. This number doesn't have to start at 0, but it must change every time that the inventory is changed, although it can change even without any observable changes to this inventory.

      Inventories that don't support this might increment the change number every time that this is called - so you should never write a loop that depends on the returned value settling down on a particular value.

      Inventories that support listeners highly encouraged to support this - by definition if an inventory knows when it changed then it should be able to count the number of changes. It is also implied that any changes to this value will also invoke every registered InvMarkDirtyListener.

      The default implementation returns an ever-increasing value.

    • addListener

      public ListenerToken addListener​(ItemInvAmountChangeListener listener, ListenerRemovalToken removalToken)
      Description copied from interface: GroupedItemInvView
      Adds the given listener to this inventory, such that the ItemInvAmountChangeListener.onChange(GroupedItemInvView, ItemStack, int, int) will be called every time that this inventory changes. However if this inventory doesn't support listeners then this will return a null token.

      The default implementation refuses to accept any listeners, but implementations are highly encouraged to override this if they are able to!

      Specified by:
      addListener in interface GroupedItemInvView
      removalToken - A token that will be called whenever the given listener is removed from this inventory (or if this inventory itself is unloaded or otherwise invalidated).
      Returns:
      A token that represents the listener, or null if the listener could not be added.