forestry.api.storage

Interface IBackpackInterface

All Known Implementing Classes:

BackpackInterface

public interface IBackpackInterface

The Backpack Interface allows you to add items to Forestry backpacks or create your own backpacks.

To create your own backpack, create an IBackpackDefinition. Backpack definitions have a filter, which you can create here with createBackpackFilter() or createNaturalistBackpackFilter(String) or create your own.

After you've registered your backpack definition, create the item with createBackpack(String, EnumBackpackType) or createNaturalistBackpack(String, ISpeciesRoot) and then register the returned item with GameRegistry.register(IForgeRegistryEntry) like any other item.

Method Summary

Modifier and Type	Method and Description
void	addItemToForestryBackpack(java.lang.String backpackUid, net.minecraft.item.ItemStack itemStack) Add an accepted item to a Forestry backpack.
net.minecraft.item.Item	createBackpack(java.lang.String backpackUid, EnumBackpackType type) Creates a backpack with the given UID and type, returning the item.
IBackpackFilterConfigurable	createBackpackFilter() Makes a new configurable backpack filter.
net.minecraft.item.Item	createNaturalistBackpack(java.lang.String backpackUid, ISpeciesRoot speciesRoot) Create a backpack that can hold items from a specific ISpeciesRoot.
java.util.function.Predicate<net.minecraft.item.ItemStack>	createNaturalistBackpackFilter(java.lang.String speciesRootUid) Makes a new naturalist backpack filter.
IBackpackDefinition	getBackpackDefinition(java.lang.String backpackUid) Get a backpack definition with a given uid.
void	registerBackpackDefinition(java.lang.String backpackUid, IBackpackDefinition definition) Register a backpack definition with a given uid.

Method Detail

addItemToForestryBackpack

void addItemToForestryBackpack(java.lang.String backpackUid,
                               net.minecraft.item.ItemStack itemStack)

Add an accepted item to a Forestry backpack.

Parameters:

backpackUid - The unique ID of the Forestry backpack. See BackpackManager for valid UIDs.

itemStack - The itemStack that the backpack should accept. OreDictionary.WILDCARD_VALUE can be used for meta value.

registerBackpackDefinition

void registerBackpackDefinition(java.lang.String backpackUid,
                                IBackpackDefinition definition)

Register a backpack definition with a given uid.

getBackpackDefinition

@Nullable
IBackpackDefinition getBackpackDefinition(java.lang.String backpackUid)

Get a backpack definition with a given uid.

createBackpack

net.minecraft.item.Item createBackpack(java.lang.String backpackUid,
                                       EnumBackpackType type)

Creates a backpack with the given UID and type, returning the item. The backpack's definition must first be registered with registerBackpackDefinition(String, IBackpackDefinition).

Parameters:

backpackUid - The unique ID of the backpack.

type - Type of backpack.

Returns:

Created backpack item.

createNaturalistBackpack

net.minecraft.item.Item createNaturalistBackpack(java.lang.String backpackUid,
                                                 ISpeciesRoot speciesRoot)

Create a backpack that can hold items from a specific ISpeciesRoot. The backpack's definition must first be registered with registerBackpackDefinition(String, IBackpackDefinition).

Parameters:

backpackUid - The unique ID of the backpack.

speciesRoot - The species root.

Returns:

Created backpack item.

createBackpackFilter

IBackpackFilterConfigurable createBackpackFilter()

Makes a new configurable backpack filter. Useful for implementing IBackpackDefinition.

createNaturalistBackpackFilter

java.util.function.Predicate<net.minecraft.item.ItemStack> createNaturalistBackpackFilter(java.lang.String speciesRootUid)

Makes a new naturalist backpack filter. Only accepts items from a specific ISpeciesRoot. Useful for implementing IBackpackDefinition for naturalist's backpacks.

Parameters:

speciesRootUid - The species root's unique ID. See ISpeciesRoot.getUID().

Returns:

a new backpack filter for the specified species root

See Also:

createNaturalistBackpack(String, ISpeciesRoot)