buildcraft.transport.statements

Class TriggerParameterSignal

java.lang.Object

buildcraft.transport.statements.TriggerParameterSignal

All Implemented Interfaces:

IConvertable, IGuiSlot, IStatementParameter

public class TriggerParameterSignal
extends java.lang.Object
implements IStatementParameter

Nested Class Summary

Nested classes/interfaces inherited from interface buildcraft.api.statements.IStatementParameter

IStatementParameter.DrawType

Field Summary

Fields

Modifier and Type	Field and Description
boolean	active
net.minecraft.item.EnumDyeColor	colour
static TriggerParameterSignal	EMPTY

Method Summary

Modifier and Type	Method and Description
static TriggerParameterSignal	get(boolean active, net.minecraft.item.EnumDyeColor colour)
java.lang.String	getDescription() Return the description in the UI.
net.minecraft.item.ItemStack	getItemStack()
TriggerParameterSignal[]	getPossible(IStatementContainer source)
ISprite	getSprite()
java.lang.String	getUniqueTag() Every statement needs a unique tag, it should be in the format of "<modid>:<name>".
TriggerParameterSignal	onClick(IStatementContainer source, IStatement stmt, net.minecraft.item.ItemStack stack, StatementMouseClick mouse) Return a non-null value to be set as the statement parameter if you handled the mouse click and do not want all possible values to be shown, or null if you did nothing and wish to show all possible values.
static TriggerParameterSignal	readFromBuf(net.minecraft.network.PacketBuffer buffer)
static TriggerParameterSignal	readFromNbt(net.minecraft.nbt.NBTTagCompound nbt)
IStatementParameter	rotateLeft() This returns the parameter after a left rotation.
void	writeToBuf(net.minecraft.network.PacketBuffer buffer) Writes this parameter to the given PacketBuffer.
void	writeToNbt(net.minecraft.nbt.NBTTagCompound nbt)

Methods inherited from class java.lang.Object

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

Methods inherited from interface buildcraft.api.statements.IStatementParameter

getDrawType, isPossibleOrdered

Methods inherited from interface buildcraft.api.statements.IGuiSlot

getTooltip

Methods inherited from interface buildcraft.api.core.IConvertable

convertTo

Field Detail

EMPTY

public static final TriggerParameterSignal EMPTY

active

public final boolean active

colour

@Nullable
public final net.minecraft.item.EnumDyeColor colour

Method Detail

get

public static TriggerParameterSignal get(boolean active,
                                         net.minecraft.item.EnumDyeColor colour)

readFromNbt

public static TriggerParameterSignal readFromNbt(net.minecraft.nbt.NBTTagCompound nbt)

writeToNbt

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

Specified by:

writeToNbt in interface IStatementParameter

readFromBuf

public static TriggerParameterSignal readFromBuf(net.minecraft.network.PacketBuffer buffer)

writeToBuf

public void writeToBuf(net.minecraft.network.PacketBuffer buffer)

Description copied from interface: IStatementParameter

Writes this parameter to the given PacketBuffer. The default implementation writes out the value of IStatementParameter.writeToNbt(NBTTagCompound), and that will be passed back into StatementManager.IParameterReader.readFromNbt(NBTTagCompound).

It is likely that implementors can write a more compact form of themselves, so they are encouraged to override this and also register an StatementManager.IParamReaderBuf in StatementManager.registerParameter(String, IParamReaderBuf) or StatementManager.registerParameter(IParameterReader, IParamReaderBuf)

Specified by:

writeToBuf in interface IStatementParameter

getItemStack

@Nonnull
public net.minecraft.item.ItemStack getItemStack()

Specified by:

getItemStack in interface IStatementParameter

Returns:

An ItemStack to render for this parameter, or ItemStack.EMPTY if this should not render an ItemStack.

getSprite

public ISprite getSprite()

Specified by:

getSprite in interface IGuiSlot

Returns:

A sprite to show in a GUI, or null if this should not render a sprite.

onClick

public TriggerParameterSignal onClick(IStatementContainer source,
                                      IStatement stmt,
                                      net.minecraft.item.ItemStack stack,
                                      StatementMouseClick mouse)

Description copied from interface: IStatementParameter

Return a non-null value to be set as the statement parameter if you handled the mouse click and do not want all possible values to be shown, or null if you did nothing and wish to show all possible values.

Specified by:

onClick in interface IStatementParameter

See Also:

IStatementParameter.getPossible(IStatementContainer)

getDescription

public java.lang.String getDescription()

Description copied from interface: IGuiSlot

Return the description in the UI. Note that this should NEVER be called directly, instead this acts as a bridge for IGuiSlot.getTooltip(). (As such this might return null or throw an exception)

Specified by:

getDescription in interface IGuiSlot

getUniqueTag

public java.lang.String getUniqueTag()

Description copied from interface: IGuiSlot

Every statement needs a unique tag, it should be in the format of "<modid>:<name>".

Specified by:

getUniqueTag in interface IGuiSlot

Returns:

the unique id

rotateLeft

public IStatementParameter rotateLeft()

Description copied from interface: IStatementParameter

This returns the parameter after a left rotation. Used in particular in blueprints orientation.

Specified by:

rotateLeft in interface IStatementParameter

getPossible

public TriggerParameterSignal[] getPossible(IStatementContainer source)

Specified by:

getPossible in interface IStatementParameter

Returns:

An array of all the possible alternative params for this state. Note that the return array may contain null if you want to space out the values.