buildcraft.core.statements

Class BCStatement

java.lang.Object

buildcraft.core.statements.BCStatement

All Implemented Interfaces:

IConvertable, IGuiSlot, IStatement

Direct Known Subclasses:

ActionExtractionPreset, ActionMachineControl, ActionPipeColor, ActionPipeDirection, ActionPipeSignal, ActionPowerPulsar, ActionRedstoneOutput, Pattern, TriggerEnginePowerStage, TriggerFluidContainer, TriggerFluidContainerLevel, TriggerInventory, TriggerInventoryLevel, TriggerLightSensor, TriggerMachine, TriggerPipeSignal, TriggerPower, TriggerRedstoneInput, TriggerTrue

public abstract class BCStatement
extends java.lang.Object
implements IStatement

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	uniqueTag

Constructor Summary

Constructors

Constructor and Description
BCStatement(java.lang.String... uniqueTag) UniqueTag accepts multiple possible tags, use this feature to migrate to more standardised tags if needed, otherwise just pass a single string.

Method Summary

Modifier and Type	Method and Description
IStatementParameter	createParameter(int index) Create parameters for the statement.
protected static <P extends IStatementParameter> P	getParam(int index, IStatementParameter[] params, P _default)
IStatement[]	getPossible() This returns a group of related statements.
java.lang.String	getUniqueTag() Every statement needs a unique tag, it should be in the format of "<modid>:<name>".
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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface buildcraft.api.statements.IStatement

createParameter, isPossibleOrdered

Methods inherited from interface buildcraft.api.statements.IGuiSlot

getDescription, getSprite, getTooltip

Methods inherited from interface buildcraft.api.core.IConvertable

convertTo

Field Detail

uniqueTag

protected final java.lang.String uniqueTag

Constructor Detail

BCStatement

public BCStatement(java.lang.String... uniqueTag)

UniqueTag accepts multiple possible tags, use this feature to migrate to more standardised tags if needed, otherwise just pass a single string. The first passed string will be the one used when saved to disk.

Parameters:

uniqueTag -

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

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

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

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

getPossible

public IStatement[] 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

createParameter

public IStatementParameter createParameter(int index)

Description copied from interface: IStatement

Create parameters for the statement.

Specified by:

createParameter in interface IStatement

getParam

protected static <P extends IStatementParameter> P getParam(int index,
                                                            IStatementParameter[] params,
                                                            P _default)