li.cil.oc.api

Class Driver

java.lang.Object

li.cil.oc.api.Driver

public final class Driver
extends java.lang.Object

This API allows registering new drivers with the mod.

Drivers are used to make items and third-party blocks available in the mod's component network, and optionally to user programs. If you implement a new block that should interact with the mod's component network it is enough to have it implement Environment - no driver is needed in that case.

Note that these methods should not be called in the pre-init phase, since the API.driver may not have been initialized at that time. Only start calling these methods in the init phase or later.

See Also:

Network, Block, Item

Method Summary

Modifier and Type	Method and Description
static void	add(Block driver) Registers a new block driver.
static void	add(Converter converter) Registers a new type converter.
static void	add(Item driver) Registers a new item driver.
static java.util.Collection<Block>	blockDrivers() Get a list of all registered block drivers.
static Item	driverFor(net.minecraft.item.ItemStack stack) Looks up a driver for the specified item stack.
static Item	driverFor(net.minecraft.item.ItemStack stack, java.lang.Class<? extends EnvironmentHost> host) Looks up a driver for the specified item stack.
static Block	driverFor(net.minecraft.world.World world, net.minecraft.util.BlockPos pos) Looks up a driver for the block at the specified position in the specified world.
static java.util.Collection<Item>	itemDrivers() Get a list of all registered item drivers.

Methods inherited from class java.lang.Object

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

Method Detail

add

public static void add(Block driver)

Registers a new block driver.

Whenever the neighboring blocks of an Adapter block change, it checks if there exists a driver for the changed block, and if it is configured to interface that block type connects it to the component network.

This must be called in the init phase, not the pre- or post-init phases.

Parameters:

driver - the driver to register.

add

public static void add(Item driver)

Registers a new item driver.

Item components can inserted into a computers component slots. They have to specify their type, to determine into which slots they can fit.

This must be called in the init phase, not the pre- or post-init phases.

Parameters:

driver - the driver to register.

add

public static void add(Converter converter)

Registers a new type converter.

Type converters are used to automatically convert values returned from callbacks to a "simple" format that can be pushed to any architecture.

This must be called in the init phase, not the pre- or post-init phases.

Parameters:

converter - the converter to register.

driverFor

public static Block driverFor(net.minecraft.world.World world,
                              net.minecraft.util.BlockPos pos)

Looks up a driver for the block at the specified position in the specified world.

Note that several drivers for a single block can exist. Because of this block drivers are always encapsulated in a 'compound' driver, which is what will be returned here. In other words, you should will not get actual instances of drivers registered via add(li.cil.oc.api.driver.Block).

Parameters:

world - the world containing the block.

pos - the position of the block.

Returns:

a driver for the block, or null if there is none.

driverFor

public static Item driverFor(net.minecraft.item.ItemStack stack,
                             java.lang.Class<? extends EnvironmentHost> host)

Looks up a driver for the specified item stack.

Note that unlike for blocks, there can always only be one item driver per item. If there are multiple ones, the first one that was registered will be used.

Parameters:

stack - the item stack to get a driver for.

host - the type that will host the environment created by returned driver.

Returns:

a driver for the item, or null if there is none.

driverFor

public static Item driverFor(net.minecraft.item.ItemStack stack)

Looks up a driver for the specified item stack.

Note that unlike for blocks, there can always only be one item driver per item. If there are multiple ones, the first one that was registered will be used.

This is a context-agnostic variant used mostly for "house-keeping" stuff, such as querying slot types and tier.

Parameters:

stack - the item stack to get a driver for.

Returns:

a driver for the item, or null if there is none.

blockDrivers

public static java.util.Collection<Block> blockDrivers()

Get a list of all registered block drivers.

This is intended to allow checking for particular drivers using more customized logic, and in particular to check for drivers with the EnvironmentAware interface.

The returned collection is read-only.

Returns:

the list of all registered block drivers.

itemDrivers

public static java.util.Collection<Item> itemDrivers()

Get a list of all registered item drivers.

This is intended to allow checking for particular drivers using more customized logic, and in particular to check for drivers with the EnvironmentAware interface.

The returned collection is read-only.

Returns:

the list of all registered item drivers.