appeng.api.storage

Interface IMEInventory<StackType extends IAEStack>

All Known Subinterfaces:

ICellInventory, ICellInventoryHandler, IMEInventoryHandler<StackType>, IMEMonitor<T>, IPortableCell

All Known Implementing Classes:

MEMonitorHandler

public interface IMEInventory<StackType extends IAEStack>

AE's Equivalent to IInventory, used to reading contents, and manipulating contents of ME Inventories.

Implementations should COMPLETELY ignore stack size limits from an external view point, Meaning that you can inject Integer.MAX_VALUE items and it should work as defined, or be able to extract Integer.MAX_VALUE and have it work as defined, Translations to MC's max stack size are external to the AE API.

If you want to request a stack of an item, you should should determine that prior to requesting the stack from the inventory.

Method Summary

Modifier and Type	Method and Description
StackType	extractItems(StackType request, Actionable mode, BaseActionSource src) Extract the specified item from the ME Inventory
IItemList<StackType>	getAvailableItems(IItemList<StackType> out) request a full report of all available items, storage.
StorageChannel	getChannel()
StackType	injectItems(StackType input, Actionable type, BaseActionSource src) Store new items, or simulate the addition of new items into the ME Inventory.

Method Detail

injectItems

StackType injectItems(StackType input,
                      Actionable type,
                      BaseActionSource src)

Store new items, or simulate the addition of new items into the ME Inventory.

Parameters:

input - item to add.

type - action type

src - action source

Returns:

returns the number of items not added.

extractItems

StackType extractItems(StackType request,
                       Actionable mode,
                       BaseActionSource src)

Extract the specified item from the ME Inventory

Parameters:

request - item to request ( with stack size. )

mode - simulate, or perform action?

Returns:

returns the number of items extracted, null

getAvailableItems

IItemList<StackType> getAvailableItems(IItemList<StackType> out)

request a full report of all available items, storage.

Parameters:

out - the IItemList the results will be written too

Returns:

returns same list that was passed in, is passed out

getChannel

StorageChannel getChannel()

Returns:

the type of channel your handler should be part of