buildcraft.api.filler

Interface IFillerPattern

All Superinterfaces:

IGuiSlot, IStatement

All Known Implementing Classes:

Pattern, PatternBox, PatternClear, PatternFill, PatternFlatten, PatternFrame, PatternHorizon, PatternNone, PatternPyramid, PatternShape2d, PatternShape2dArc, PatternShape2dCircle, PatternShape2dHexagon, PatternShape2dOctagon, PatternShape2dPentagon, PatternShape2dSemiCircle, PatternShape2dSquare, PatternShape2dTriangle, PatternSphere, PatternSpherePart, PatternStairs

public interface IFillerPattern
extends IStatement

A type of statement that is used for filler patterns.

Method Summary

Modifier and Type	Method and Description
FilledTemplate	createTemplate(IFillerStatementContainer filler, IStatementParameter[] params)
IFillerPattern[]	getPossible() This returns a group of related statements.
ISprite	getSprite() Note that this sprite *must* be stitched to the texture atlas, as it is drawn on the side of the filler block.

Methods inherited from interface buildcraft.api.statements.IStatement

createParameter, createParameter, isPossibleOrdered, maxParameters, minParameters, rotateLeft

Methods inherited from interface buildcraft.api.statements.IGuiSlot

getDescription, getTooltip, getUniqueTag

Method Detail

createTemplate

@Nullable
FilledTemplate createTemplate(IFillerStatementContainer filler,
                                        IStatementParameter[] params)

Parameters:

filler - The filler to create the pattern for.
NOTE: This method should never be called when IFillerStatementContainer.hasBox() returns false

Returns:

The template to fill, or null if this shouldn't make a template for the given filer.

getPossible

IFillerPattern[] 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

getSprite

ISprite getSprite()

Note that this sprite *must* be stitched to the texture atlas, as it is drawn on the side of the filler block.

Specified by:

getSprite in interface IGuiSlot

Returns:

A sprite to show in a GUI or in-world (so this must be stitched into the block texture atlas), or null if this should not render a sprite.