me.desht.pneumaticcraft.common.item

Enum ItemRegistry

java.lang.Object

java.lang.Enum<ItemRegistry>

me.desht.pneumaticcraft.common.item.ItemRegistry

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ItemRegistry>, IItemRegistry

public enum ItemRegistry
extends java.lang.Enum<ItemRegistry>
implements IItemRegistry

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<IInventoryItem>	inventoryItems

Method Summary

Modifier and Type	Method and Description
void	addTooltip(EnumUpgrade upgrade, java.util.List<net.minecraft.util.text.ITextComponent> tooltip) Can be used for custom upgrade items to handle tooltips.
boolean	doesItemMatchFilter(net.minecraft.item.ItemStack filterStack, net.minecraft.item.ItemStack stack, boolean checkDurability, boolean checkNBT, boolean checkModSimilarity) Convenience method to check if an item matches a given filter item.
static ItemRegistry	getInstance()
int	getModifiedVolume(net.minecraft.item.ItemStack stack, int originalVolume) Get the modified volume for a given item, based on the volume modifiers registered with IItemRegistry.registerPneumaticVolumeModifier(ItemVolumeModifier).
ISpawnerCoreStats	getSpawnerCoreStats(net.minecraft.item.ItemStack stack) Get some information for the given Spawner Core item.
java.util.List<net.minecraft.item.ItemStack>	getStacksInItem(net.minecraft.item.ItemStack item) Get a list of the items contained in the given item.
IAirHandlerItem.Provider	makeItemAirHandlerProvider(net.minecraft.item.ItemStack stack, float maxPressure) Create an instance of PneumaticCraft's default item air handler provider, suitable for returning from IForgeItem.initCapabilities(ItemStack, CompoundNBT).
void	registerInventoryItem(IInventoryItem handler) Register a third-party class that can contain items.
void	registerMagnetSuppressor(IMagnetSuppressor suppressor) Register a magnet suppressor; an object which can prevent the Magnet Upgrade from pulling in (usually item) entities.
void	registerPneumaticVolumeModifier(ItemVolumeModifier modifierFunc) Register a handler to modify the effective volume of a pneumatic item (i.e.
void	registerUpgradeAcceptor(IUpgradeAcceptor upgradeAcceptor) Register an item or block as being able to accept PneumaticCraft upgrades.
boolean	shouldSuppressMagnet(net.minecraft.entity.Entity e)
static ItemRegistry	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ItemRegistry[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final ItemRegistry INSTANCE

Field Detail

inventoryItems

public final java.util.List<IInventoryItem> inventoryItems

Method Detail

values

public static ItemRegistry[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ItemRegistry c : ItemRegistry.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ItemRegistry valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getInstance

public static ItemRegistry getInstance()

registerInventoryItem

public void registerInventoryItem(@Nonnull
                                  IInventoryItem handler)

Description copied from interface: IItemRegistry

Register a third-party class that can contain items. This is intended for classes from other mods - if it's your class, just make it implement IInventoryItem directly.

Specified by:

registerInventoryItem in interface IItemRegistry

Parameters:

handler - instance of any class that implements IInventoryItem

registerUpgradeAcceptor

public void registerUpgradeAcceptor(@Nonnull
                                    IUpgradeAcceptor upgradeAcceptor)

Description copied from interface: IItemRegistry

Register an item or block as being able to accept PneumaticCraft upgrades.

Specified by:

registerUpgradeAcceptor in interface IItemRegistry

Parameters:

upgradeAcceptor - the upgrade acceptor

addTooltip

public void addTooltip(EnumUpgrade upgrade,
                       java.util.List<net.minecraft.util.text.ITextComponent> tooltip)

Description copied from interface: IItemRegistry

Can be used for custom upgrade items to handle tooltips. This will work for implementors registered via IItemRegistry.registerUpgradeAcceptor(IUpgradeAcceptor). This is intended to be called from Item.appendHoverText(ItemStack, World, List, ITooltipFlag) method to display which machines and/or items accept it.

Specified by:

addTooltip in interface IItemRegistry

Parameters:

upgrade - the upgrade item

tooltip - the tooltip string list to append to

registerMagnetSuppressor

public void registerMagnetSuppressor(IMagnetSuppressor suppressor)

Description copied from interface: IItemRegistry

Register a magnet suppressor; an object which can prevent the Magnet Upgrade from pulling in (usually item) entities.

Specified by:

registerMagnetSuppressor in interface IItemRegistry

Parameters:

suppressor - a suppressor object

doesItemMatchFilter

public boolean doesItemMatchFilter(@Nonnull
                                   net.minecraft.item.ItemStack filterStack,
                                   @Nonnull
                                   net.minecraft.item.ItemStack stack,
                                   boolean checkDurability,
                                   boolean checkNBT,
                                   boolean checkModSimilarity)

Description copied from interface: IItemRegistry

Convenience method to check if an item matches a given filter item. Note that the filtering item (the first parameter) could be a Tag Filter or other instance of ITagFilteringItem, so parameter order is important; provide the filtering item first, and the item to check second.

Specified by:

doesItemMatchFilter in interface IItemRegistry

Parameters:

filterStack - the item to check against

stack - the item being checked

checkDurability - true if item durability should be taken into account

checkNBT - true if item NBT should be taken into account

checkModSimilarity - true to just match by the two items' mod IDs

Returns:

true if the item passes the filter test, false otherwise

registerPneumaticVolumeModifier

public void registerPneumaticVolumeModifier(ItemVolumeModifier modifierFunc)

Description copied from interface: IItemRegistry

Register a handler to modify the effective volume of a pneumatic item (i.e. one that holds air/pressure).

Specified by:

registerPneumaticVolumeModifier in interface IItemRegistry

Parameters:

modifierFunc - a volume modifier function

getSpawnerCoreStats

public ISpawnerCoreStats getSpawnerCoreStats(net.minecraft.item.ItemStack stack)

Description copied from interface: IItemRegistry

Get some information for the given Spawner Core item.

Specified by:

getSpawnerCoreStats in interface IItemRegistry

Parameters:

stack - an ItemStack, which must be a Spawner Core

Returns:

a spawner core stats object, to query and manipulate the item

makeItemAirHandlerProvider

public IAirHandlerItem.Provider makeItemAirHandlerProvider(net.minecraft.item.ItemStack stack,
                                                           float maxPressure)

Description copied from interface: IItemRegistry

Create an instance of PneumaticCraft's default item air handler provider, suitable for returning from IForgeItem.initCapabilities(ItemStack, CompoundNBT).

You can use this method for your own air-handling items, provided that your item implements IPressurizableItem. If you want to avoid a hard dependency on PneumaticCraft, then create your own custom implementation of IAirHandlerItem, and attach that implementation to your item via AttachCapabilitiesEvent.

Specified by:

makeItemAirHandlerProvider in interface IItemRegistry

Parameters:

stack - the ItemStack

maxPressure - the maximum pressure allowed for the item

Returns:

an implementation of IAirHandler

shouldSuppressMagnet

public boolean shouldSuppressMagnet(net.minecraft.entity.Entity e)

getModifiedVolume

public int getModifiedVolume(net.minecraft.item.ItemStack stack,
                             int originalVolume)

Description copied from interface: IItemRegistry

Get the modified volume for a given item, based on the volume modifiers registered with IItemRegistry.registerPneumaticVolumeModifier(ItemVolumeModifier).

Specified by:

getModifiedVolume in interface IItemRegistry

Parameters:

stack - the ItemStack to check

originalVolume - the original volume, which is the item's base volume, possibly already modified by Volume Upgrades

Returns:

the modified volume

getStacksInItem

public java.util.List<net.minecraft.item.ItemStack> getStacksInItem(@Nonnull
                                                                    net.minecraft.item.ItemStack item)

Get a list of the items contained in the given item. This uses the IInventoryItem interface.

Parameters:

item - the item to check

Returns:

a list of the items contained within the given item