forestry.storage

Class BackpackInterface

java.lang.Object

forestry.storage.BackpackInterface

All Implemented Interfaces:

IBackpackInterface

public class BackpackInterface
extends java.lang.Object
implements IBackpackInterface

Constructor Summary

Constructors

Constructor and Description
BackpackInterface()

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.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getBackpackAcceptedItems()
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BackpackInterface

public BackpackInterface()

Method Detail

getBackpackAcceptedItems

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getBackpackAcceptedItems()

addItemToForestryBackpack

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

Description copied from interface: IBackpackInterface

Add an accepted item to a Forestry backpack.

Specified by:

addItemToForestryBackpack in interface IBackpackInterface

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

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

Description copied from interface: IBackpackInterface

Register a backpack definition with a given uid.

Specified by:

registerBackpackDefinition in interface IBackpackInterface

getBackpackDefinition

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

Description copied from interface: IBackpackInterface

Get a backpack definition with a given uid.

Specified by:

getBackpackDefinition in interface IBackpackInterface

createBackpack

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

Description copied from interface: IBackpackInterface

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

Specified by:

createBackpack in interface IBackpackInterface

Parameters:

backpackUid - The unique ID of the backpack.

type - Type of backpack.

Returns:

Created backpack item.

createNaturalistBackpack

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

Description copied from interface: IBackpackInterface

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

Specified by:

createNaturalistBackpack in interface IBackpackInterface

Parameters:

backpackUid - The unique ID of the backpack.

speciesRoot - The species root.

Returns:

Created backpack item.

createBackpackFilter

public IBackpackFilterConfigurable createBackpackFilter()

Description copied from interface: IBackpackInterface

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

Specified by:

createBackpackFilter in interface IBackpackInterface

createNaturalistBackpackFilter

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

Description copied from interface: IBackpackInterface

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

Specified by:

createNaturalistBackpackFilter in interface IBackpackInterface

Parameters:

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

Returns:

a new backpack filter for the specified species root

See Also:

IBackpackInterface.createNaturalistBackpack(String, ISpeciesRoot)