li.cil.oc.api.detail

Interface ItemAPI

public interface ItemAPI

Method Summary

Modifier and Type	Method and Description
ItemInfo	get(net.minecraft.item.ItemStack stack) Get a descriptor object for the block or item represented by the specified item stack.
ItemInfo	get(java.lang.String name) Get a descriptor object for the block or item with the specified name.
net.minecraft.item.ItemStack	registerEEPROM(java.lang.String name, byte[] code, byte[] data, boolean readonly) Register a single custom EEPROM.
net.minecraft.item.ItemStack	registerFloppy(java.lang.String name, net.minecraft.item.EnumDyeColor color, java.util.concurrent.Callable<FileSystem> factory) Deprecated. use registerFloppy(String, EnumDyeColor, Callable, boolean) instead.
net.minecraft.item.ItemStack	registerFloppy(java.lang.String name, net.minecraft.item.EnumDyeColor color, java.util.concurrent.Callable<FileSystem> factory, boolean doRecipeCycling) Register a single loot floppy disk.

Method Detail

get

ItemInfo get(java.lang.String name)

Get a descriptor object for the block or item with the specified name.

The names are the same as the ones used in the recipe files. An info object can be used to retrieve both the block and item instance of the item, if available. It can also be used to create a new item stack of the item.

Parameters:

name - the name of the item to get the descriptor for.

Returns:

the descriptor for the item with the specified name, or null if there is no such item.

get

ItemInfo get(net.minecraft.item.ItemStack stack)

Get a descriptor object for the block or item represented by the specified item stack.

Parameters:

stack - the stack to get the descriptor for.

Returns:

the descriptor for the specified item stack, or null if the stack is not a valid OpenComputers item or block.

registerFloppy

@Deprecated
net.minecraft.item.ItemStack registerFloppy(java.lang.String name,
                                                        net.minecraft.item.EnumDyeColor color,
                                                        java.util.concurrent.Callable<FileSystem> factory)

Deprecated. use registerFloppy(String, EnumDyeColor, Callable, boolean) instead.

Register a single loot floppy disk.

The disk will be listed in the creative tab of OpenComputers.

The specified factory callable will be used to generate a new file system when the loot disk is used as a component. The specified name will be used as the label for the loot disk, as well as the identifier to select the corresponding factory method, so choose wisely.

To use some directory in your mod JAR as the directory provided by the loot disk, use FileSystem.fromClass(java.lang.Class<?>, java.lang.String, java.lang.String) in your callable.

Call this in the init phase or later, not in pre-init.

Parameters:

name - the label and identifier to use for the loot disk.

color - the color of the disk, as a Minecraft color.

factory - the callable to call for creating file system instances.

Returns:

an item stack representing the registered loot disk, to allow adding a recipe for your loot disk, for example.

registerFloppy

net.minecraft.item.ItemStack registerFloppy(java.lang.String name,
                                            net.minecraft.item.EnumDyeColor color,
                                            java.util.concurrent.Callable<FileSystem> factory,
                                            boolean doRecipeCycling)

Register a single loot floppy disk.

The disk will be listed in the creative tab of OpenComputers.

The specified factory callable will be used to generate a new file system when the loot disk is used as a component. The specified name will be used as the label for the loot disk, as well as the identifier to select the corresponding factory method, so choose wisely.

To use some directory in your mod JAR as the directory provided by the loot disk, use FileSystem.fromClass(java.lang.Class<?>, java.lang.String, java.lang.String) in your callable.

If doRecipeCycling is true, the floppy disk will be included in the floppy disk recipe cycle if that is enabled.

Call this in the init phase or later, not in pre-init.

Parameters:

name - the label and identifier to use for the loot disk.

color - the color of the disk, as a Minecraft color.

factory - the callable to call for creating file system instances.

doRecipeCycling - whether to include this floppy disk in floppy disk cycling.

Returns:

an item stack representing the registered loot disk, to allow adding a recipe for your loot disk, for example.

registerEEPROM

net.minecraft.item.ItemStack registerEEPROM(java.lang.String name,
                                            byte[] code,
                                            byte[] data,
                                            boolean readonly)

Register a single custom EEPROM.

The EEPROM will be listed in the creative tab of OpenComputers.

The EEPROM will be initialized with the specified code and data byte arrays. For script code (e.g. a Lua script) use String.getBytes("UTF-8"). You can omit any of the arguments by passing null.

Call this in the init phase or later, not in pre-init.

Parameters:

name - the label of the EEPROM.

code - the code section of the EEPROM.

data - the data section of the EEPROM.

readonly - whether the code section is read-only.

Returns:

an item stack representing the registered EEPROM, to allow adding a recipe for your custom BIOS, for example.