net.minecraftforge.items

Class ItemStackHandler

java.lang.Object

net.minecraftforge.items.ItemStackHandler

All Implemented Interfaces:

INBTSerializable<NBTTagCompound>, IItemHandler, IItemHandlerModifiable

public class ItemStackHandler
extends java.lang.Object
implements IItemHandler, IItemHandlerModifiable, INBTSerializable<NBTTagCompound>

Field Summary

Fields

Modifier and Type	Field and Description
protected NonNullList<ItemStack>	stacks

Constructor Summary

Constructors

Constructor and Description
ItemStackHandler()
ItemStackHandler(int size)
ItemStackHandler(NonNullList<ItemStack> stacks)

Method Summary

Modifier and Type	Method and Description
void	deserializeNBT(NBTTagCompound nbt)
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.
protected int	getStackLimit(int slot, ItemStack stack)
ItemStack	insertItem(int slot, ItemStack stack, boolean simulate) Inserts an ItemStack into the given slot and return the remainder.
protected void	onContentsChanged(int slot)
protected void	onLoad()
NBTTagCompound	serializeNBT()
void	setSize(int size)
void	setStackInSlot(int slot, ItemStack stack) Overrides the stack in the given slot.
protected void	validateSlotIndex(int slot)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

stacks

protected NonNullList<ItemStack> stacks

Constructor Detail

ItemStackHandler

public ItemStackHandler()

ItemStackHandler

public ItemStackHandler(int size)

ItemStackHandler

public ItemStackHandler(NonNullList<ItemStack> stacks)

Method Detail

setSize

public void setSize(int size)

setStackInSlot

public void setStackInSlot(int slot,
                           ItemStack stack)

Description copied from interface: IItemHandlerModifiable

Overrides the stack in the given slot. This method is used by the standard Forge helper methods and classes. It is not intended for general use by other mods, and the handler may throw an error if it is called unexpectedly.

Specified by:

setStackInSlot in interface IItemHandlerModifiable

Parameters:

slot - Slot to modify

stack - ItemStack to set slot to (may be null)

getSlots

public int getSlots()

Description copied from interface: IItemHandler

Returns the number of slots available

Specified by:

getSlots in interface IItemHandler

Returns:

The number of slots available

getStackInSlot

public ItemStack getStackInSlot(int slot)

Description copied from interface: IItemHandler

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

Specified by:

getStackInSlot in interface IItemHandler

Parameters:

slot - Slot to query

Returns:

ItemStack in given slot. May be null.

insertItem

public ItemStack insertItem(int slot,
                            ItemStack stack,
                            boolean simulate)

Description copied from interface: IItemHandler

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()

Specified by:

insertItem in interface IItemHandler

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

public ItemStack extractItem(int slot,
                             int amount,
                             boolean simulate)

Description copied from interface: IItemHandler

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().

Specified by:

extractItem in interface IItemHandler

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

public int getSlotLimit(int slot)

Description copied from interface: IItemHandler

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

Specified by:

getSlotLimit in interface IItemHandler

Parameters:

slot - Slot to query.

Returns:

The maximum stack size allowed in the slot.

getStackLimit

protected int getStackLimit(int slot,
                            ItemStack stack)

serializeNBT

public NBTTagCompound serializeNBT()

Specified by:

serializeNBT in interface INBTSerializable<NBTTagCompound>

deserializeNBT

public void deserializeNBT(NBTTagCompound nbt)

Specified by:

deserializeNBT in interface INBTSerializable<NBTTagCompound>

validateSlotIndex

protected void validateSlotIndex(int slot)

onLoad

protected void onLoad()

onContentsChanged

protected void onContentsChanged(int slot)