Interface InventoryUtility.ItemStackExtractor

  • Enclosing class:
    InventoryUtility

    public static interface InventoryUtility.ItemStackExtractor
    • Method Detail

      • takeFromStack

        int takeFromStack​(java.util.function.Predicate<ItemStack> predicate,
                          boolean simulate,
                          int count,
                          InventoryUtility.ItemStackCounter store,
                          ItemStack source,
                          ItemStack filter,
                          EntityPlayerMP player)
        Extract a particular type of item. The extractor can choose to not return all items contained within this item as long as it makes sense, but the author should inform the player of this.

        Whether this method does recursive extraction is at the discretion of implementor.

        Parameters:
        predicate - the main filtering predicate. never null. It's assumed predicate always returns true on filter, if that is not null
        store - where to store extracted items. Should increment the
        source - from where an extraction should be attempted
        filter - stack to extract. should not be mutated! match the NBT tag using EXACT mode. might be null.
        simulate - true if only query but does not actually remove
        player - executor of extraction, or null if from a machine
        Returns:
        amount extracted, or -1 if this is not implemented
      • getItem

        default int getItem​(ItemStack source,
                            ItemStack toExtract,
                            boolean simulate,
                            EntityPlayerMP player)
        Extract a particular type of item. The extractor can choose to not return all items contained within this item as long as it makes sense, but the author should inform the player of this.

        Whether this method does recursive extraction is at the discretion of implementor.

        Parameters:
        source - from where an extraction should be attempted
        toExtract - stack to extract. should not be mutated! match the NBT tag using EXACT mode.
        simulate - true if only query but does not actually remove
        player - executor of extraction, or null if from a machine
        Returns:
        amount extracted, or -1 if this is not implemented