li.cil.tis3d.common.module

Class ModuleKeypad

java.lang.Object

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

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

li.cil.tis3d.common.module.ModuleKeypad

All Implemented Interfaces:

Module, Rotatable

public final class ModuleKeypad
extends AbstractModuleRotatable

Field Summary

Fields

Modifier and Type	Field and Description
static float	KEYS_SIZE_U
static float	KEYS_SIZE_V
static float	KEYS_SIZE_V_LAST
static float	KEYS_STEP_U
static float	KEYS_STEP_V
static float	KEYS_U0
static float	KEYS_V0
static java.lang.String	TAG_VALUE

Constructor Summary

Constructors

Constructor and Description
ModuleKeypad(Casing casing, Face face)

Method Summary

Modifier and Type	Method and Description
boolean	onActivate(net.minecraft.entity.player.EntityPlayer player, net.minecraft.util.EnumHand hand, float hitX, float hitY, float hitZ) Called when a player right-clicks the module while installed in a casing.
void	onData(net.minecraft.nbt.NBTTagCompound nbt) Called with NBT 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	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.AbstractModuleRotatable

getFacing, hitToUV, rotateForRendering, setFacing

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

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

Field Detail

TAG_VALUE

public static final java.lang.String TAG_VALUE

See Also:

Constant Field Values

KEYS_U0

public static final float KEYS_U0

See Also:

Constant Field Values

KEYS_V0

public static final float KEYS_V0

See Also:

Constant Field Values

KEYS_SIZE_U

public static final float KEYS_SIZE_U

See Also:

Constant Field Values

KEYS_SIZE_V

public static final float KEYS_SIZE_V

See Also:

Constant Field Values

KEYS_SIZE_V_LAST

public static final float KEYS_SIZE_V_LAST

See Also:

Constant Field Values

KEYS_STEP_U

public static final float KEYS_STEP_U

See Also:

Constant Field Values

KEYS_STEP_V

public static final float KEYS_STEP_V

See Also:

Constant Field Values

Constructor Detail

ModuleKeypad

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

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.

onActivate

public boolean onActivate(net.minecraft.entity.player.EntityPlayer player,
                          net.minecraft.util.EnumHand hand,
                          float hitX,
                          float hitY,
                          float hitZ)

Description copied from interface: Module

Called when a player right-clicks the module while installed in a casing.

The face is implicitly given by the face the module is installed in, as is the world via the casing's world.

Note that there should be some way in which a click can be ignored, e.g. by a player sneaking, otherwise the module cannot be removed from the casing by hand.

Specified by:

onActivate in interface Module

Overrides:

onActivate in class AbstractModule

Parameters:

player - the player that clicked the module.

hand - the hand the player used to activate the module.

hitX - the relative x position that was clicked.

hitY - the relative y position that was clicked.

hitZ - the relative z position that was clicked.

Returns:

true if the click was handled, false otherwise.

onData

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

Description copied from interface: Module

Called with NBT 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:

nbt - the received data.

See Also:

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

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.