li.cil.tis3d.common.integration.minecraft

Class FurnaceSerialInterfaceProvider

java.lang.Object

li.cil.tis3d.common.integration.minecraft.FurnaceSerialInterfaceProvider

All Implemented Interfaces:

SerialInterfaceProvider

public final class FurnaceSerialInterfaceProvider
extends java.lang.Object
implements SerialInterfaceProvider

Constructor Summary

Constructors

Constructor and Description
FurnaceSerialInterfaceProvider()

Method Summary

Modifier and Type	Method and Description
SerialProtocolDocumentationReference	getDocumentationReference() A reference to a manual entry describing the protocol used by the SerialInterface generated by this provider.
SerialInterface	interfaceFor(net.minecraft.world.World world, net.minecraft.util.math.BlockPos position, net.minecraft.util.math.Direction side) Creates a new serial interface instance for the specified position.
boolean	isValid(net.minecraft.world.World world, net.minecraft.util.math.BlockPos position, net.minecraft.util.math.Direction side, SerialInterface serialInterface) Tests whether the specified serial interface is still valid for the specified position.
boolean	worksWith(net.minecraft.world.World world, net.minecraft.util.math.BlockPos position, net.minecraft.util.math.Direction side) Checks whether the provider supports the specified block position.

Methods inherited from class java.lang.Object

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

Constructor Detail

FurnaceSerialInterfaceProvider

public FurnaceSerialInterfaceProvider()

Method Detail

worksWith

public boolean worksWith(net.minecraft.world.World world,
                         net.minecraft.util.math.BlockPos position,
                         net.minecraft.util.math.Direction side)

Description copied from interface: SerialInterfaceProvider

Checks whether the provider supports the specified block position.

Specified by:

worksWith in interface SerialInterfaceProvider

Parameters:

world - the world containing the position.

position - the position in question.

side - the side of the position in question.

Returns:

whether a SerialInterface can be provided for the position.

interfaceFor

public SerialInterface interfaceFor(net.minecraft.world.World world,
                                    net.minecraft.util.math.BlockPos position,
                                    net.minecraft.util.math.Direction side)

Description copied from interface: SerialInterfaceProvider

Creates a new serial interface instance for the specified position.

Specified by:

interfaceFor in interface SerialInterfaceProvider

Parameters:

world - the world containing the position.

position - the position in question.

side - the side of the position in question.

Returns:

the interface to use for communicating with the position.

getDocumentationReference

public SerialProtocolDocumentationReference getDocumentationReference()

Description copied from interface: SerialInterfaceProvider

A reference to a manual entry describing the protocol used by the SerialInterface generated by this provider.

It is generally recommended to have one provider per interface / protocol type. In case you decide you'd like to have one multi-interface provider, you'll need to put all your documentation in that one manual entry, or use it as an index.

While it is legal to return null here, it is strongly discouraged to not have a manual entry for a protocol used by a serial interface, since this will make it nearly impossible for the player to figure out how to use the interface.

The links returned from all registered providers will be listed in the serial protocol overview page in the TIS-3D manual as an automatically populated list.

Specified by:

getDocumentationReference in interface SerialInterfaceProvider

Returns:

the description of the link to the manual page for the interface's protocol.

isValid

public boolean isValid(net.minecraft.world.World world,
                       net.minecraft.util.math.BlockPos position,
                       net.minecraft.util.math.Direction side,
                       SerialInterface serialInterface)

Description copied from interface: SerialInterfaceProvider

Tests whether the specified serial interface is still valid for the specified position.

This is used by the serial port module to determine whether a new serial interface instance has to be constructed for the specified position, or whether an existing one can be re-used. This avoids resetting the serial interfaces state in case of an adjacent block change.

Generally this this should return false if the interface is not once provided by this provider, or more generally, if it is the same kind of serial interface that would be created via SerialInterfaceProvider.interfaceFor(World, BlockPos, Direction), otherwise this should return true.

Specified by:

isValid in interface SerialInterfaceProvider

Parameters:

world - the world containing the position.

position - the position in question.

side - the side of the position in question.

serialInterface - the interface to validate.

Returns:

true if the interface is still valid, false if a new one should be created.