li.cil.oc.api.prefab

Class DriverSidedBlock

java.lang.Object

li.cil.oc.api.prefab.DriverSidedBlock

All Implemented Interfaces:

SidedBlock

public abstract class DriverSidedBlock
extends java.lang.Object
implements SidedBlock

If you wish to create a block component for a third-party block, i.e. a block for which you do not control the tile entity, such as vanilla blocks, you will need a block driver.

This prefab allows creating a driver that works for a specified list of item stacks (to support different blocks with the same id but different metadata values).

You still have to provide the implementation for creating its environment, if any.

To limit sidedness, I recommend overriding worksWith(World, int, int, int, ForgeDirection) and calling super.worksWith in addition to the side check.

See Also:

ManagedEnvironment

Field Summary

Fields

Modifier and Type	Field and Description
protected net.minecraft.item.ItemStack[]	blocks

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DriverSidedBlock(net.minecraft.item.ItemStack... blocks)

Method Summary

Modifier and Type	Method and Description
protected boolean	worksWith(net.minecraft.block.Block referenceBlock, int referenceMetadata)
boolean	worksWith(net.minecraft.world.World world, int x, int y, int z, net.minecraftforge.common.util.ForgeDirection side) Used to determine the block types this driver handles.

Methods inherited from class java.lang.Object

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

Methods inherited from interface li.cil.oc.api.driver.SidedBlock

createEnvironment

Field Detail

blocks

protected final net.minecraft.item.ItemStack[] blocks

Constructor Detail

DriverSidedBlock

protected DriverSidedBlock(net.minecraft.item.ItemStack... blocks)

Method Detail

worksWith

public boolean worksWith(net.minecraft.world.World world,
                         int x,
                         int y,
                         int z,
                         net.minecraftforge.common.util.ForgeDirection side)

Description copied from interface: SidedBlock

Used to determine the block types this driver handles.

This is used to determine which driver to use for a block placed next to an Adapter block. Note that the return value should not change over time; if it does, though, an already installed component will not be removed, since this value is only checked when scanning blocks. You can force this by sending a neighbor block change notification.

The side is relative to the block, i.e. "south" is the side of the block facing south.

Specified by:

worksWith in interface SidedBlock

Parameters:

world - the world in which the block to check lives.

x - the X coordinate of the block to check.

y - the Y coordinate of the block to check.

z - the Z coordinate of the block to check.

side - the side of the block to check.

Returns:

true if the block is supported; false otherwise.

worksWith

protected boolean worksWith(net.minecraft.block.Block referenceBlock,
                            int referenceMetadata)