li.cil.oc.api.driver

Interface SidedBlock

All Known Implementing Classes:

DriverSidedBlock, DriverSidedTileEntity

public interface SidedBlock

Interface for side-aware block component drivers.

This driver type is used for components that are blocks, i.e. that can be placed in the world, but cannot be modified to or don't want to have their TileEntity implement one of the interfaces for environments (Environment or SidedEnvironment).

A block driver is used by Adapter blocks to check its neighbors and whether those neighbors should be treated as components or not. If a driver is present, it will be used to create a ManagedEnvironment that is managed by the adapter.

Note that it is possible to write one driver that supports as many different blocks as you wish. I'd recommend writing one per device (type), though, to keep things modular.

Note that side-aware block drivers are queried before regular block drivers, because they are more specific.

Method Summary

Modifier and Type	Method and Description
ManagedEnvironment	createEnvironment(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, net.minecraft.util.EnumFacing side) Create a new managed environment interfacing the specified block.
boolean	worksWith(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, net.minecraft.util.EnumFacing side) Used to determine the block types this driver handles.

Method Detail

worksWith

boolean worksWith(net.minecraft.world.World world,
                  net.minecraft.util.math.BlockPos pos,
                  net.minecraft.util.EnumFacing side)

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.

Parameters:

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

pos - the position coordinate of the block to check.

side - the side of the block to check.

Returns:

true if the block is supported; false otherwise.

createEnvironment

ManagedEnvironment createEnvironment(net.minecraft.world.World world,
                                     net.minecraft.util.math.BlockPos pos,
                                     net.minecraft.util.EnumFacing side)

Create a new managed environment interfacing the specified block.

This is used to connect the component to the component network when it is detected next to an Adapter. Components that are not part of the component network probably don't make much sense (can't think of any uses at this time), but you may still opt to not implement this - i.e. it is safe to return null here.

This is expected to return a new instance each time it is called. The created instance's life cycle is managed by the Adapter block that caused its creation.

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

Parameters:

world - the world containing the block to get the environment for.

pos - the position coordinate of the block to check.

side - the side of the block to check.

Returns:

the environment for the block at that location.