buildcraft.api.statements

Interface IStatement

All Superinterfaces:

IConvertable, IGuiSlot

All Known Subinterfaces:

IAction, IActionExternal, IActionInternal, IActionInternalSided, IActionSingle, IFillerPattern, IFillerPatternShape, ITrigger, ITriggerExternal, ITriggerInternal, ITriggerInternalSided

All Known Implementing Classes:

ActionExtractionPreset, ActionMachineControl, ActionPipeColor, ActionPipeDirection, ActionPipeSignal, ActionPowerPulsar, ActionRedstoneOutput, ActionWrapper, ActionWrapper.ActionWrapperExternal, ActionWrapper.ActionWrapperInternal, ActionWrapper.ActionWrapperInternalSided, BCStatement, Pattern, PatternBox, PatternClear, PatternFill, PatternFrame, PatternNone, PatternPyramid, PatternShape2d, PatternShape2dArc, PatternShape2dCircle, PatternShape2dHexagon, PatternShape2dOctagon, PatternShape2dPentagon, PatternShape2dSemiCircle, PatternShape2dSquare, PatternShape2dTriangle, PatternSphere, PatternSpherePart, PatternStairs, StatementWrapper, TriggerEnginePowerStage, TriggerFluidContainer, TriggerFluidContainerLevel, TriggerInventory, TriggerInventoryLevel, TriggerLightSensor, TriggerMachine, TriggerPipeSignal, TriggerPower, TriggerRedstoneInput, TriggerTrue, TriggerWrapper, TriggerWrapper.TriggerWrapperExternal, TriggerWrapper.TriggerWrapperInternal, TriggerWrapper.TriggerWrapperInternalSided

public interface IStatement
extends IGuiSlot

Designates some sort of statement. Most of the time you should implement ITriggerExternal, ITriggerInternal, IActionExternal or IActionInternal though.

Method Summary

Modifier and Type	Method and Description
IStatementParameter	createParameter(int index) Create parameters for the statement.
default IStatementParameter	createParameter(IStatementParameter old, int index) Creates a parameter for the given index, optionally returning the old param if it is still valid.
IStatement[]	getPossible() This returns a group of related statements.
default 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 interface buildcraft.api.statements.IGuiSlot

getDescription, getSprite, getTooltip, getUniqueTag

Methods inherited from interface buildcraft.api.core.IConvertable

convertTo

Method Detail

maxParameters

int maxParameters()

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

minParameters

int minParameters()

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

createParameter

IStatementParameter createParameter(int index)

Create parameters for the statement.

createParameter

default IStatementParameter createParameter(IStatementParameter old,
                                            int index)

Creates a parameter for the given index, optionally returning the old param if it is still valid. By default this checks the classes of the old and new parameters, however it is sensible to override this check in case the parameters given no longer match. For example if you return StatementParameterItemStack from createParameter(int) and require the stack to match a filter, but the incoming stack might not.

Parameters:

old -

index -

Returns:

rotateLeft

IStatement rotateLeft()

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

getPossible

IStatement[] getPossible()

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.

isPossibleOrdered

default boolean isPossibleOrdered()