li.cil.oc.api.detail

Interface DriverAPI

public interface DriverAPI

Method Summary

Modifier and Type	Method and Description
void	add(Block driver) Registers a new driver for a block component.
void	add(Converter converter) Registers a new type converter.
void	add(EnvironmentProvider provider) Register a new environment provider.
void	add(InventoryProvider provider) Register a new inventory provider.
void	add(Item driver) Registers a new driver for an item component.
java.util.Collection<Block>	blockDrivers() Get a list of all registered block drivers.
Item	driverFor(net.minecraft.item.ItemStack stack) Looks up a driver for the specified item stack.
Item	driverFor(net.minecraft.item.ItemStack stack, java.lang.Class<? extends EnvironmentHost> host) Looks up a driver for the specified item stack.
Block	driverFor(net.minecraft.world.World world, int x, int y, int z) Looks up a driver for the block at the specified position in the specified world.
java.lang.Class<?>	environmentFor(net.minecraft.item.ItemStack stack) Looks up the environment associated with the specified item stack.
net.minecraft.inventory.IInventory	inventoryFor(net.minecraft.item.ItemStack stack, net.minecraft.entity.player.EntityPlayer player) Get an inventory implementation providing access to an item inventory.
java.util.Collection<Item>	itemDrivers() Get a list of all registered item drivers.

Method Detail

add

void add(Block driver)

Registers a new driver for a block component.

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 for a block component.

add

void add(Item driver)

Registers a new driver for an item component.

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 for an item component.

add

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.

add

void add(EnvironmentProvider provider)

Register a new environment provider.

Environment providers are used for mapping item stacks to the type of environment that will be created by the stack, either by it being placed in the world and acting as a block component, or by being placed in an component inventory and created by the item's driver.

Parameters:

provider - the provider to register.

add

void add(InventoryProvider provider)

Register a new inventory provider.

Inventory providers are used for accessing item inventories using the inventory controller upgrade, for example.

Parameters:

provider - the provider to register.

driverFor

Block driverFor(net.minecraft.world.World world,
                int x,
                int y,
                int z)

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.

x - the X coordinate of the block.

y - the Y coordinate of the block.

z - the Z coordinate of the block.

Returns:

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

driverFor

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

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.

environmentFor

java.lang.Class<?> environmentFor(net.minecraft.item.ItemStack stack)

Looks up the environment associated with the specified item stack.

This will use the registered EnvironmentProviders to find an environment type for the specified item stack. If none can be found, returns null.

Parameters:

stack - the item stack to get the environment type for.

Returns:

the type of environment associated with the stack, or null.

inventoryFor

net.minecraft.inventory.IInventory inventoryFor(net.minecraft.item.ItemStack stack,
                                                net.minecraft.entity.player.EntityPlayer player)

Get an inventory implementation providing access to an item inventory.

This will use the registered InventoryProviders to find an inventory implementation providing access to the specified stack. If none can be found, returns null.

Note that the specified player may be null, but will usually be the fake player of the agent making use of this API.

Parameters:

stack - the item stack to get the inventory access for.

player - the player holding the item. May be null.

Returns:

the inventory implementation interfacing the stack, or null.

blockDrivers

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.

The returned collection is read-only.

Returns:

the list of all registered block drivers.

itemDrivers

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.

The returned collection is read-only.

Returns:

the list of all registered item drivers.