buildcraft.lib.statement

Class StatementWrapper

java.lang.Object

buildcraft.lib.statement.StatementWrapper

All Implemented Interfaces:

IConvertable, IGuiSlot, IStatement, java.lang.Comparable<StatementWrapper>

Direct Known Subclasses:

ActionWrapper, TriggerWrapper

public abstract class StatementWrapper
extends java.lang.Object
implements IStatement, java.lang.Comparable<StatementWrapper>

Field Summary

Fields

Modifier and Type	Field and Description
IStatement	delegate
EnumPipePart	sourcePart Used to determine the background colour of triggers and actions.

Constructor Summary

Constructors

Constructor and Description
StatementWrapper(IStatement delegate, EnumPipePart sourcePart)

Method Summary

Modifier and Type	Method and Description
int	compareTo(StatementWrapper o)
<T> T	convertTo(java.lang.Class<T> clazz) Attempts to convert this object to the given class.
IStatementParameter	createParameter(int index) Create parameters for the statement.
boolean	equals(java.lang.Object obj)
java.lang.String	getDescription() Return the description in the UI.
net.minecraft.tileentity.TileEntity	getNeighbourTile(IStatementContainer source)
abstract StatementWrapper[]	getPossible() This returns a group of related statements.
ISprite	getSprite()
java.util.List<java.lang.String>	getTooltip()
java.lang.String	getUniqueTag() Every statement needs a unique tag, it should be in the format of "<modid>:<name>".
int	hashCode()
boolean	isPossibleOrdered()
int	maxParameters() Return the maximum number of parameter this statement can have, 0 if none.
int	minParameters() Return the minimum number of parameter this statement can have, 0 if none.
IStatement	rotateLeft() This returns the statement after a left rotation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface buildcraft.api.statements.IStatement

createParameter

Field Detail

delegate

public final IStatement delegate

sourcePart

public final EnumPipePart sourcePart

Used to determine the background colour of triggers and actions.

Constructor Detail

StatementWrapper

public StatementWrapper(IStatement delegate,
                        EnumPipePart sourcePart)

Method Detail

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

See Also:

IGuiSlot.getUniqueTag()

maxParameters

public int maxParameters()

Description copied from interface: IStatement

Return the maximum number of parameter this statement can have, 0 if none.

Specified by:

maxParameters in interface IStatement

See Also:

IStatement.maxParameters()

minParameters

public int minParameters()

Description copied from interface: IStatement

Return the minimum number of parameter this statement can have, 0 if none.

Specified by:

minParameters in interface IStatement

See Also:

IStatement.minParameters()

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

See Also:

IGuiSlot.getDescription()

createParameter

public IStatementParameter createParameter(int index)

Description copied from interface: IStatement

Create parameters for the statement.

Specified by:

createParameter in interface IStatement

See Also:

IStatement.createParameter(int)

rotateLeft

public IStatement rotateLeft()

Description copied from interface: IStatement

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

Specified by:

rotateLeft in interface IStatement

See Also:

IStatement.rotateLeft()

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.

See Also:

IGuiSlot.getSprite()

getNeighbourTile

public net.minecraft.tileentity.TileEntity getNeighbourTile(IStatementContainer source)

getPossible

public abstract StatementWrapper[] getPossible()

Description copied from interface: IStatement

This returns a group of related statements. For example "redstone signal input" should probably return an array of "RS_SIGNAL_ON" and "RS_SIGNAL_OFF". It is recommended to return an array containing this object.

Specified by:

getPossible in interface IStatement

isPossibleOrdered

public boolean isPossibleOrdered()

Specified by:

isPossibleOrdered in interface IStatement

getTooltip

public java.util.List<java.lang.String> getTooltip()

Specified by:

getTooltip in interface IGuiSlot

Returns:

The full tooltip for the UI.

convertTo

public <T> T convertTo(java.lang.Class<T> clazz)

Description copied from interface: IConvertable

Attempts to convert this object to the given class. Returns this object if it is already an instance of the given class, a separate object if it can be converted, or null if no conversion is possible.

Specified by:

convertTo in interface IConvertable

compareTo

public int compareTo(StatementWrapper o)

Specified by:

compareTo in interface java.lang.Comparable<StatementWrapper>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object