buildcraft.api.inventory

Interface IItemTransactor

All Known Subinterfaces:

IItemTransactor.IItemExtractable, IItemTransactor.IItemInsertable

All Known Implementing Classes:

AbstractInvItemTransactor, AutomaticProvidingTransactor, InjectableWrapper, InventoryWrapper, ItemHandlerFiltered, ItemHandlerSimple, ItemHandlerWrapper, NoSpaceTransactor, SidedInventoryWrapper, TransactorEntityArrow, TransactorEntityItem

public interface IItemTransactor

A simple way to define something that deals with item insertion and extraction, without caring about slots.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IItemTransactor.IItemExtractable
static interface	IItemTransactor.IItemInsertable

Method Summary

Modifier and Type	Method and Description
default boolean	canFullyAccept(net.minecraft.item.ItemStack stack)
default boolean	canPartiallyAccept(net.minecraft.item.ItemStack stack)
net.minecraft.item.ItemStack	extract(IStackFilter filter, int min, int max, boolean simulate) Extracts a number of items that match the given filter
net.minecraft.item.ItemStack	insert(net.minecraft.item.ItemStack stack, boolean allOrNone, boolean simulate)
default net.minecraft.util.NonNullList<net.minecraft.item.ItemStack>	insert(net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> stacks, boolean simulate) Similar to insert(ItemStack, boolean, boolean) but probably be more efficient at inserting lots of items.

Method Detail

insert

@Nonnull
net.minecraft.item.ItemStack insert(@Nonnull
                                             net.minecraft.item.ItemStack stack,
                                             boolean allOrNone,
                                             boolean simulate)

Parameters:

stack - The stack to insert. Must not be null!

allOrNone - If true then either the entire stack will be used or none of it.

simulate - If true then the in-world state of this will not be changed.

Returns:

The overflow stack. Will be ItemStack.EMPTY if all of it was accepted.

insert

default net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> insert(net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> stacks,
                                                                            boolean simulate)

Similar to insert(ItemStack, boolean, boolean) but probably be more efficient at inserting lots of items.

Parameters:

stacks - The stacks to insert. Must not be null!

simulate - If true then the in-world state of this will not be changed.

Returns:

The overflow stacks. Will be an empty list if all of it was accepted.

extract

@Nonnull
net.minecraft.item.ItemStack extract(@Nullable
                                              IStackFilter filter,
                                              int min,
                                              int max,
                                              boolean simulate)

Extracts a number of items that match the given filter

Parameters:

filter - The filter that MUST be met by the extracted stack. Null means no filter - it can be any item.

min - The minimum number of items to extract, or 0 if not enough items can be extracted

max - The maximum number of items to extract.

simulate - If true then the in-world state of this will not be changed.

Returns:

The stack that was extracted, or ItemStack.EMPTY if it could not be.

canFullyAccept

default boolean canFullyAccept(@Nonnull
                               net.minecraft.item.ItemStack stack)

canPartiallyAccept

default boolean canPartiallyAccept(@Nonnull
                                   net.minecraft.item.ItemStack stack)