net.minecraftforge.items

Interface IItemHandler

All Known Subinterfaces:

IItemHandlerModifiable

All Known Implementing Classes:

CombinedInvWrapper, EmptyHandler, EntityArmorInvWrapper, EntityEquipmentInvWrapper, EntityHandsInvWrapper, InvWrapper, ItemStackHandler, PlayerArmorInvWrapper, PlayerInvWrapper, PlayerMainInvWrapper, PlayerOffhandInvWrapper, RangedWrapper, SidedInvWrapper, VanillaDoubleChestItemHandler, VanillaHopperItemHandler

public interface IItemHandler

Method Summary

Modifier and Type	Method and Description
ItemStack	extractItem(int slot, int amount, boolean simulate) Extracts an ItemStack from the given slot.
int	getSlotLimit(int slot) Retrieves the maximum stack size allowed to exist in the given slot.
int	getSlots() Returns the number of slots available
ItemStack	getStackInSlot(int slot) Returns the ItemStack in a given slot.
ItemStack	insertItem(int slot, ItemStack stack, boolean simulate) Inserts an ItemStack into the given slot and return the remainder.

Method Detail

getSlots

int getSlots()

Returns the number of slots available

Returns:

The number of slots available

getStackInSlot

@Nonnull
ItemStack getStackInSlot(int slot)

Returns the ItemStack in a given slot. The result's stack size may be greater than the itemstacks max size. If the result is null, then the slot is empty. If the result is not null but the stack size is zero, then it represents an empty slot that will only accept* a specific itemstack.

IMPORTANT: This ItemStack MUST NOT be modified. This method is not for altering an inventories contents. Any implementers who are able to detect modification through this method should throw an exception.

SERIOUSLY: DO NOT MODIFY THE RETURNED ITEMSTACK

Parameters:

slot - Slot to query

Returns:

ItemStack in given slot. May be null.

insertItem

@Nonnull
ItemStack insertItem(int slot,
                               @Nonnull
                               ItemStack stack,
                               boolean simulate)

Inserts an ItemStack into the given slot and return the remainder. The ItemStack should not be modified in this function! Note: This behaviour is subtly different from IFluidHandlers.fill()

Parameters:

slot - Slot to insert into.

stack - ItemStack to insert.

simulate - If true, the insertion is only simulated

Returns:

The remaining ItemStack that was not inserted (if the entire stack is accepted, then return ItemStack.EMPTY). May be the same as the input ItemStack if unchanged, otherwise a new ItemStack.

extractItem

@Nonnull
ItemStack extractItem(int slot,
                                int amount,
                                boolean simulate)

Extracts an ItemStack from the given slot. The returned value must be null if nothing is extracted, otherwise it's stack size must not be greater than amount or the itemstacks getMaxStackSize().

Parameters:

slot - Slot to extract from.

amount - Amount to extract (may be greater than the current stacks max limit)

simulate - If true, the extraction is only simulated

Returns:

ItemStack extracted from the slot, must be ItemStack.EMPTY, if nothing can be extracted

getSlotLimit

int getSlotLimit(int slot)

Retrieves the maximum stack size allowed to exist in the given slot.

Parameters:

slot - Slot to query.

Returns:

The maximum stack size allowed in the slot.