li.cil.oc.api

Class IMC

java.lang.Object

li.cil.oc.api.IMC

public final class IMC
extends java.lang.Object

This is a pure utility class to more comfortably register things that can only be registered using IMC.

Use this if you have some kind of abstraction layer in place anyway, and can safely use the API without class not found exceptions and such, and don't want to put together the IMC messages manually.

This also servers to document of all IMC messages OpenComputers handles.

Feel free to copy these functions into your own code, just please don't copy this class while keeping the package name, to avoid conflicts if this class gets updated.

Method Summary

Modifier and Type	Method and Description
static void	blacklistHost(java.lang.String name, java.lang.Class host, net.minecraft.item.ItemStack stack) Blacklist an item for a specified host.
static void	blacklistPeripheral(java.lang.Class peripheral) Blacklist a ComputerCraft peripheral from being wrapped by OpenComputers' built-in driver for ComputerCraft peripherals.
static void	registerAssemblerFilter(java.lang.String callback) Register a callback that is used as a filter for assembler templates.
static void	registerAssemblerTemplate(java.lang.String name, java.lang.String select, java.lang.String validate, java.lang.String assemble, java.lang.Class host, int[] containerTiers, int[] upgradeTiers, java.lang.Iterable<org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.Integer>> componentSlots) Register a new template for the assembler.
static void	registerDisassemblerTemplate(java.lang.String name, java.lang.String select, java.lang.String disassemble) Register a new template for the disassembler.
static void	registerInkProvider(java.lang.String callback) Register a provider for ink usable in the 3D printer.
static void	registerItemCharge(java.lang.String name, java.lang.String canCharge, java.lang.String charge) Register a handler for items that can be charged.
static void	registerToolDurabilityProvider(java.lang.String callback) Register a callback for providing tool durability information.
static void	registerWrenchTool(java.lang.String callback) Register a callback handling a wrench tool.
static void	registerWrenchToolCheck(java.lang.String callback) Register a callback for checking if an item is a wrench.

Methods inherited from class java.lang.Object

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

Method Detail

registerAssemblerFilter

public static void registerAssemblerFilter(java.lang.String callback)

Register a callback that is used as a filter for assembler templates. Any templates that require a base item that is rejected by any registered filter will be disabled. For example, if a filter rejects the computer case item stacks, robots can not be assembled.

Signature of callbacks must be:

 boolean callback(ItemStack stack)
 

Callbacks must be declared as packagePath.className.methodName. For example: com.example.Integration.callbackMethod.

Parameters:

callback - the callback to register as a filtering method.

registerAssemblerTemplate

public static void registerAssemblerTemplate(java.lang.String name,
                                             java.lang.String select,
                                             java.lang.String validate,
                                             java.lang.String assemble,
                                             java.lang.Class host,
                                             int[] containerTiers,
                                             int[] upgradeTiers,
                                             java.lang.Iterable<org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.Integer>> componentSlots)

Register a new template for the assembler.

Signature of callbacks must be:

 boolean select(ItemStack stack)
 Object[] validate(IInventory inventory)
 Object[] assemble(IInventory inventory)
 

Values in the array returned by validate must be one of the following:

 // Valid or not.
 new Object[]{Boolean}
 // Valid or not, text for progess bar.
 new Object[]{Boolean, IChatComponent}
 // Valid or not, text for progess bar, warnings for start button tooltip (one per line).
 new Object[]{Boolean, IChatComponent, IChatComponent[]}
 

Values in the array returned by assemble must be one of the following:

 // The assembled device.
 new Object[]{ItemStack}
 // The assembled device and energy cost (which also determines assembly duration).
 new Object[]{ItemStack, Number}
 

Callbacks must be declared as packagePath.className.methodName. For example: com.example.Integration.callbackMethod.

Parameters:

name - the name of the device created using the template. Optional, only used in logging.

select - callback used to determine if the template applies to a base item. For example, the robot template returns true from this if the passed item stack is a computer case.

validate - callback used to determine if the template configuration is valid. Once a template is valid assembly can be started, but not before.

assemble - callback used to apply a template and create a device from it.

host - the class of the device being assembled, i.e. the host class for the components being installed in the device. Used for filtering eligible components. See blacklistHost(java.lang.String, java.lang.Class, net.minecraft.item.ItemStack).

containerTiers - the tiers of the container slots provided by the template. The length determines the number of containers. Maximum number is three.

upgradeTiers - the tiers of the upgrade slots provided by the template. The length determines the number of upgrades. Maximum number is nine.

componentSlots - the types and tiers of component slots provided by this template. May contain null entries to skip slots (slots are ordered top-to-bottom, left-to-right). For example, a robot template with only two card slots will pass null for the third component slot. Up to nine.

registerDisassemblerTemplate

public static void registerDisassemblerTemplate(java.lang.String name,
                                                java.lang.String select,
                                                java.lang.String disassemble)

Register a new template for the disassembler.

The disassemble callback gets passed the item stack to disassemble, and a list of inferred ingredients (based on crafting recipes). This is useful for not having to compute those yourself when you just want to add a number of items from an internal inventory to the output (e.g. for servers it's the components in the server).

Signature of callbacks must be:

 boolean select(ItemStack stack)
 ItemStack[] disassemble(ItemStack stack, ItemStack[] ingredients)
 

Callbacks must be declared as packagePath.className.methodName. For example: com.example.Integration.callbackMethod.

Parameters:

name - the name of the handler (e.g. name of the item being handled). Optional, only used in logging.

select - callback used to determine if the template applies to an item.

disassemble - callback used to apply a template and extract ingredients from an item.

registerToolDurabilityProvider

public static void registerToolDurabilityProvider(java.lang.String callback)

Register a callback for providing tool durability information.

If your provider does not handle a tool/item, return Double.NaN to indicate that another provider should be queried. The first value that isn't NaN will be used as the durability.

The returned value must be the relative durability of the tool, in a range of [0,1], with 0 being broken, 1 being new/fully repaired.

Signature of callbacks must be:

 double callback(ItemStack stack)
 

Callbacks must be declared as packagePath.className.methodName. For example: com.example.Integration.callbackMethod.

Parameters:

callback - the callback to register as a durability provider.

registerWrenchTool

public static void registerWrenchTool(java.lang.String callback)

Register a callback handling a wrench tool.

These are used when determining whether an item is a wrench tool, when interacting with certain blocks while the player is holding such an item, for example to avoid rotating blocks when opening their GUI.

The returned value must be true if the wrench was used/usable, false otherwise.

Signature of callbacks must be:

 boolean callback(EntityPlayer player, BlockPos pos, boolean changeDurability)
 

Callbacks must be declared as packagePath.className.methodName. For example: com.example.Integration.callbackMethod.

Parameters:

callback - the callback to register as a wrench tool handler.

registerWrenchToolCheck

public static void registerWrenchToolCheck(java.lang.String callback)

Register a callback for checking if an item is a wrench.

This is used to determine whether certain item stacks are wrench items, which is used, for example, when "itemizing" a drone.

The returned value must true if the item stack is a wrench, false otherwise.

Signature of callbacks must be:

 boolean callback(ItemStack stack)
 

Callbacks must be declared as packagePath.className.methodName. For example: com.example.Integration.callbackMethod.

Parameters:

callback - the callback to register as a wrench tool tester.

registerItemCharge

public static void registerItemCharge(java.lang.String name,
                                      java.lang.String canCharge,
                                      java.lang.String charge)

Register a handler for items that can be charged.

This is used by the charger to determine whether items can be charged by it (canCharge) and to actually charge them (charge).

Note that OpenComputers comes with a few built-in handlers for third- party charged items, such as Redstone Flux and IndustrialCraft 2.

Signature of callbacks must be:

 boolean canCharge(ItemStack stack)
 double charge(ItemStack stack, double amount, boolean simulate)
 

Callbacks must be declared as packagePath.className.methodName. For example: com.example.Integration.callbackMethod.

Parameters:

name - the name of the energy system/item type handled.

canCharge - the callback to register for checking chargeability.

charge - the callback to register for charging items.

registerInkProvider

public static void registerInkProvider(java.lang.String callback)

Register a provider for ink usable in the 3D printer.

Default providers in OpenComputers are one for the ink cartridges as well as one for arbitrary dyes (via the OreDictionary).

Use this to make other items usable as ink in the 3D printer. Return a value larger than zero to indicate you handled the provided item stack, with the value being the amount of ink provided by the stack.

Signature of callbacks must be:

 int callback(ItemStack stack)
 

Callbacks must be declared as packagePath.className.methodName. For example: com.example.Integration.callbackMethod.

Parameters:

callback - the callback to register as an ink provider.

blacklistPeripheral

public static void blacklistPeripheral(java.lang.Class peripheral)

Blacklist a ComputerCraft peripheral from being wrapped by OpenComputers' built-in driver for ComputerCraft peripherals.

Use this if you provide a driver for something that is a peripheral and wish to avoid conflicts in the registered callbacks, for example.

Parameters:

peripheral - the class of the peripheral to blacklist.

blacklistHost

public static void blacklistHost(java.lang.String name,
                                 java.lang.Class host,
                                 net.minecraft.item.ItemStack stack)

Blacklist an item for a specified host.

This can be used to prevent certain components to be installed in select devices, via the devices class. For example, this is used to prevent components that would not be functional in certain devices to be installed in those devices, such as graphics cards in micro-controllers.

The host class is the class of the environment the component would be installed in, e.g. Tablet.

Parameters:

name - the name of the component being blacklisted.

host - the class of the host to blacklist the component for.

stack - the item stack representing the blacklisted component.