li.cil.tis3d.common.module

Class ModuleBundledRedstone

java.lang.Object

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

li.cil.tis3d.api.prefab.module.AbstractModuleRotatable

li.cil.tis3d.common.module.ModuleBundledRedstone

All Implemented Interfaces:

Module, BundledRedstone, Rotatable

public final class ModuleBundledRedstone
extends AbstractModuleRotatable
implements BundledRedstone

Constructor Summary

Constructors

Constructor and Description
ModuleBundledRedstone(Casing casing, Face face)

Method Summary

Modifier and Type	Method and Description
short	getBundledRedstoneInput(int channel) Get the current bundled input value on the specified channel.
int	getBundledRedstoneOutput(int channel) Get the current bundled redstone output on the specified channel.
void	onData(io.netty.buffer.ByteBuf data) Called with data sent from the remote instance of the module.
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	onEnabled() Called when the multi-block of casings the module is installed in is enabled, or when the module was installed into an enabled casing.
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	setBundledRedstoneInput(int channel, short value) Set the new bundled input value on the specified channel.
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.AbstractModuleRotatable

getFacing, hitToUV, rotateForRendering, setFacing

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

cancelRead, cancelWrite, getCasing, getFace, getPlayerLookAt, isPlayerLookingAt, isVisible, onActivate, onData, onDisposed, 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, onDisposed, onInstalled, onUninstalled

Constructor Detail

ModuleBundledRedstone

public ModuleBundledRedstone(Casing casing,
                             Face face)

Method Detail

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

onEnabled

public void onEnabled()

Description copied from interface: Module

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

Note that this is only called on the server.

Specified by:

onEnabled in interface Module

Overrides:

onEnabled 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.

onData

public void onData(io.netty.buffer.ByteBuf data)

Description copied from interface: Module

Called with data sent from the remote instance of the module.

This can be called on both the server and the client, depending on which side sent the message (i.e. the client can send messages to the server this way and vice versa).

Specified by:

onData in interface Module

Overrides:

onData in class AbstractModule

Parameters:

data - the received data.

See Also:

Casing.sendData(Face, ByteBuf, byte), Casing.sendData(Face, ByteBuf)

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.

Note that the enabled is the same as Casing.isEnabled(), it is merely passed along for backwards compatibility from before the time that getter existed.

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 AbstractModuleRotatable

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 AbstractModuleRotatable

Parameters:

nbt - the tag to save the state to.

getBundledRedstoneOutput

public int getBundledRedstoneOutput(int channel)

Description copied from interface: BundledRedstone

Get the current bundled redstone output on the specified channel.

Specified by:

getBundledRedstoneOutput in interface BundledRedstone

Parameters:

channel - the bundle channel to get the value of.

Returns:

the current redstone output on the channel.

setBundledRedstoneInput

public void setBundledRedstoneInput(int channel,
                                    short value)

Description copied from interface: BundledRedstone

Set the new bundled input value on the specified channel.

Specified by:

setBundledRedstoneInput in interface BundledRedstone

Parameters:

channel - the bundled channel to set the value of.

value - the new input value on the channel.

getBundledRedstoneInput

public short getBundledRedstoneInput(int channel)

Description copied from interface: BundledRedstone

Get the current bundled input value on the specified channel.

Specified by:

getBundledRedstoneInput in interface BundledRedstone

Parameters:

channel - the bundled channel to get the input value of.

Returns:

the current input value on the channel