li.cil.tis3d.common.module

Class ModuleSerialPort

java.lang.Object

li.cil.tis3d.api.prefab.module.AbstractModule

li.cil.tis3d.common.module.ModuleSerialPort

All Implemented Interfaces:

Module, BlockChangeAware

public final class ModuleSerialPort
extends AbstractModule
implements BlockChangeAware

The stack module can be used to store a number of values to be retrieved later on. It operates as LIFO queue, providing the top element to all ports but a single value can only be read from one port.

While it is not full, it will receive data on all ports and push them back.

Constructor Summary

Constructors

Constructor and Description
ModuleSerialPort(Casing casing, Face face)

Method Summary

Modifier and Type	Method and Description
void	onDisabled() Called when the multi-block of casings the module is installed in is disabled, or when the module was removed from an enabled casing.
void	onNeighborBlockChange(net.minecraft.block.Block neighborBlock) Called when a block adjacent to the hosting Casing changes.
void	onWriteComplete(Port port) Called from a pipe this module is writing to when the data was read.
void	readFromNBT(net.minecraft.nbt.NBTTagCompound nbt) Restore the state of the module from the specified NBT compound.
void	render(boolean enabled, float partialTicks) Called to allow the module to render dynamic content on the casing it is installed in.
void	step() Advance the state of the module.
void	writeToNBT(net.minecraft.nbt.NBTTagCompound nbt) Save the state of the module to the specified NBT compound.

Methods inherited from class li.cil.tis3d.api.prefab.module.AbstractModule

cancelRead, cancelWrite, getCasing, getFace, getPlayerLookAt, hitToUV, isPlayerLookingAt, isVisible, onActivate, onData, onData, onDisposed, onEnabled, onInstalled, onUninstalled

Methods inherited from class java.lang.Object

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

Methods inherited from interface li.cil.tis3d.api.module.Module

getCasing, getFace, onActivate, onData, onData, onDisposed, onEnabled, onInstalled, onUninstalled

Constructor Detail

ModuleSerialPort

public ModuleSerialPort(Casing casing,
                        Face face)

Method Detail

onNeighborBlockChange

public void onNeighborBlockChange(net.minecraft.block.Block neighborBlock)

Description copied from interface: BlockChangeAware

Called when a block adjacent to the hosting Casing changes.

Specified by:

onNeighborBlockChange in interface BlockChangeAware

Parameters:

neighborBlock - the block that changed.

step

public void step()

Description copied from interface: Module

Advance the state of the module.

This is called by the controller of the system the module is part of each tick the system is running.

Specified by:

step in interface Module

Overrides:

step in class AbstractModule

onDisabled

public void onDisabled()

Description copied from interface: Module

Called when the multi-block of casings the module is installed in is disabled, or when the module was removed from an enabled casing.

Modules should use this to reset their state, so that cycling power of a controller resets the whole multi-block system.

Note that this is only called on the server.

Specified by:

onDisabled in interface Module

Overrides:

onDisabled in class AbstractModule

onWriteComplete

public void onWriteComplete(Port port)

Description copied from interface: Module

Called from a pipe this module is writing to when the data was read.

This allows completing the operation in the same tick in which the read operation was completed. This is particularly useful when writing to multiple ports at a time but the written value may only be read once; in this case the remaining writes can be canceled in this callback.

Specified by:

onWriteComplete in interface Module

Overrides:

onWriteComplete in class AbstractModule

Parameters:

port - the port on which the write operation was completed.

render

public void render(boolean enabled,
                   float partialTicks)

Description copied from interface: Module

Called to allow the module to render dynamic content on the casing it is installed in.

The render state will be adjusted to take into account the face the module is installed in, i.e. rendering from (0, 0, 0) to (1, 1, 0) will render the full quad of face of the casing the module is installed in.

Specified by:

render in interface Module

Overrides:

render in class AbstractModule

Parameters:

enabled - whether the module is currently enabled.

partialTicks - the partial time elapsed in this tick.

readFromNBT

public void readFromNBT(net.minecraft.nbt.NBTTagCompound nbt)

Description copied from interface: Module

Restore the state of the module from the specified NBT compound.

Specified by:

readFromNBT in interface Module

Overrides:

readFromNBT in class AbstractModule

Parameters:

nbt - the tag to load the state from.

writeToNBT

public void writeToNBT(net.minecraft.nbt.NBTTagCompound nbt)

Description copied from interface: Module

Save the state of the module to the specified NBT compound.

Specified by:

writeToNBT in interface Module

Overrides:

writeToNBT in class AbstractModule

Parameters:

nbt - the tag to save the state to.