appeng.api.storage

Interface IStorageHelper

public interface IStorageHelper

Method Summary

Modifier and Type	Method and Description
<T extends IAEStack<T>,C extends IStorageChannel<T>> C	getStorageChannel(java.lang.Class<C> channel) Fetch the factory instance for a specific storage channel.
ICraftingLink	loadCraftingLink(net.minecraft.nbt.NBTTagCompound data, ICraftingRequester req) load a crafting link from nbt data.
void	postChanges(IStorageGrid gs, net.minecraft.item.ItemStack removedCell, net.minecraft.item.ItemStack addedCell, IActionSource src) Posts alteration of stored items to the provided IStorageGrid.
<T extends IAEStack<T>> T	poweredExtraction(IEnergySource energy, IMEInventory<T> inv, T request, IActionSource src, Actionable mode) Extracts items from a IMEInventory respecting power requirements.
<T extends IAEStack<T>> T	poweredInsert(IEnergySource energy, IMEInventory<T> inv, T input, IActionSource src, Actionable mode) Inserts items into a IMEInventory respecting power requirements.
<T extends IAEStack<T>,C extends IStorageChannel<T>> void	registerStorageChannel(java.lang.Class<C> channel, C factory) Register a new storage channel.
java.util.Collection<IStorageChannel<? extends IAEStack<?>>>	storageChannels() An unmodifiable collection of all registered factory instance.

Method Detail

registerStorageChannel

@Nonnull
<T extends IAEStack<T>,C extends IStorageChannel<T>> void registerStorageChannel(@Nonnull
                                                                                           java.lang.Class<C> channel,
                                                                                           @Nonnull
                                                                                           C factory)

Register a new storage channel. AE2 already provides native channels for IAEItemStack and IAEFluidStack. Each IAEStack subtype can only have a single factory instance. Overwriting is not intended. Each subtype should be a direct one, this might be enforced at any time. Channel class and factory instance can be used interchangeable as identifier. In most cases the factory instance is used as key as having direct access the methods is more beneficial compared to being forced to query the registry each time. Caching the factory instance in a field or local variable is perfectly for performance reasons. But do not use any AE2 internal field as they can change randomly between releases.

Parameters:

channel - The channel type, must be a subtype of IStorageChannel

factory - An instance implementing the channel, must be be an instance of channel

getStorageChannel

@Nonnull
<T extends IAEStack<T>,C extends IStorageChannel<T>> C getStorageChannel(@Nonnull
                                                                                   java.lang.Class<C> channel)

Fetch the factory instance for a specific storage channel. Channel must be a direct subtype of IStorageChannel.

Parameters:

channel - The channel type

Returns:

the factory instance

Throws:

java.lang.NullPointerException - when fetching an unregistered channel.

storageChannels

@Nonnull
java.util.Collection<IStorageChannel<? extends IAEStack<?>>> storageChannels()

An unmodifiable collection of all registered factory instance. This is mainly used as helper to let storage grids construct their internal storage for each type.

loadCraftingLink

ICraftingLink loadCraftingLink(net.minecraft.nbt.NBTTagCompound data,
                               ICraftingRequester req)

load a crafting link from nbt data.

Parameters:

data - to be loaded data

Returns:

crafting link

poweredExtraction

<T extends IAEStack<T>> T poweredExtraction(IEnergySource energy,
                                            IMEInventory<T> inv,
                                            T request,
                                            IActionSource src,
                                            Actionable mode)

Extracts items from a IMEInventory respecting power requirements.

Parameters:

energy - Energy source.

inv - Inventory to extract from.

request - Requested item and count.

src - Action source.

mode - Simulate or modulate

Returns:

extracted items or null of nothing was extracted.

poweredInsert

<T extends IAEStack<T>> T poweredInsert(IEnergySource energy,
                                        IMEInventory<T> inv,
                                        T input,
                                        IActionSource src,
                                        Actionable mode)

Inserts items into a IMEInventory respecting power requirements.

Parameters:

energy - Energy source.

inv - Inventory to insert into.

request - Items to insert.

src - Action source.

mode - Simulate or modulate

Returns:

items not inserted or null if everything was inserted.

postChanges

void postChanges(@Nonnull
                 IStorageGrid gs,
                 @Nonnull
                 net.minecraft.item.ItemStack removedCell,
                 @Nonnull
                 net.minecraft.item.ItemStack addedCell,
                 @Nonnull
                 IActionSource src)

Posts alteration of stored items to the provided IStorageGrid. This can be used by cell containers to notify the grid of storage cell changes.

Parameters:

gs - the storage grid.

removedCell - the removed cell itemstack

addedCell - the added cell itemstack

src - the action source