li.cil.tis3d.common.module

Class ModuleInfrared

java.lang.Object

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

li.cil.tis3d.common.module.ModuleInfrared

All Implemented Interfaces:

InfraredReceiver, Module, net.minecraftforge.common.capabilities.ICapabilityProvider

public final class ModuleInfrared
extends AbstractModule
implements net.minecraftforge.common.capabilities.ICapabilityProvider, InfraredReceiver

Constructor Summary

Constructors

Constructor and Description
ModuleInfrared(Casing casing, Face face)

Method Summary

Modifier and Type	Method and Description
<T> T	getCapability(net.minecraftforge.common.capabilities.Capability<T> capability, net.minecraft.util.EnumFacing facing)
boolean	hasCapability(net.minecraftforge.common.capabilities.Capability<?> capability, net.minecraft.util.EnumFacing facing)
void	onBeforeWriteComplete(Port port) Called from a pipe this module is writing to when the data is being read.
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	onInfraredPacket(InfraredPacket packet, net.minecraft.util.math.RayTraceResult hit) Called when an infrared packet collides with this.
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

Constructor Detail

ModuleInfrared

public ModuleInfrared(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

onBeforeWriteComplete

public void onBeforeWriteComplete(Port port)

Description copied from interface: Module

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

The key difference to Module.onWriteComplete(Port) is that this is called directly during the read operation, so this may be called before or after the module's Module.step() for the current cycle. As such, no operations which might influence number of required cycles for the current transfer operation should be performed in this method. It may be used to cancel other write operations to write a value only once, for example, or to update some other internal state before a read operation completes (used by the stack module for example, to ensure the correct value is being popped).

Specified by:

onBeforeWriteComplete in interface Module

Overrides:

onBeforeWriteComplete in class AbstractModule

Parameters:

port - the port on which the write operation will be completed.

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.

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

hasCapability

public boolean hasCapability(@Nonnull
                             net.minecraftforge.common.capabilities.Capability<?> capability,
                             @Nullable
                             net.minecraft.util.EnumFacing facing)

Specified by:

hasCapability in interface net.minecraftforge.common.capabilities.ICapabilityProvider

getCapability

@Nullable
public <T> T getCapability(@Nonnull
                                     net.minecraftforge.common.capabilities.Capability<T> capability,
                                     @Nullable
                                     net.minecraft.util.EnumFacing facing)

Specified by:

getCapability in interface net.minecraftforge.common.capabilities.ICapabilityProvider

onInfraredPacket

public void onInfraredPacket(InfraredPacket packet,
                             net.minecraft.util.math.RayTraceResult hit)

Description copied from interface: InfraredReceiver

Called when an infrared packet collides with this.

Specified by:

onInfraredPacket in interface InfraredReceiver

Parameters:

packet - the packet that collided with this.

hit - the information on the hit.