buildcraft.builders.filler.pattern

Class FillerPattern

java.lang.Object

buildcraft.builders.filler.pattern.FillerPattern

All Implemented Interfaces:

IFillerPattern

Direct Known Subclasses:

PatternBox, PatternClear, PatternCylinder, PatternFill, PatternFlatten, PatternHorizon, PatternPyramid, PatternStairs

public abstract class FillerPattern
extends java.lang.Object
implements IFillerPattern

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	FillerPattern.PatternIterator

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Set<FillerPattern>	patterns

Constructor Summary

Constructors

Constructor and Description
FillerPattern(java.lang.String tag)

Method Summary

Methods

Modifier and Type	Method and Description
IPatternIterator	createPatternIterator(net.minecraft.tileentity.TileEntity tile, IBox box, net.minecraftforge.common.util.ForgeDirection orientation) Creates the object that does the pattern iteration.
static boolean	empty(int xMin, int yMin, int zMin, int xMax, int yMax, int zMax, net.minecraft.world.World world) Attempt to remove the blocks in the area.
static boolean	fill(int xMin, int yMin, int zMin, int xMax, int yMax, int zMax, net.minecraft.item.ItemStack stackToPlace, net.minecraft.world.World world) Attempt to fill blocks in the area.
static boolean	flatten(int xMin, int yMin, int zMin, int xMax, int yMax, int zMax, net.minecraft.world.World world, net.minecraft.item.ItemStack stackToPlace) Attempt to fill the area defined by the box, from the top down.
java.lang.String	getDisplayName()
net.minecraft.util.IIcon	getIcon()
java.lang.String	getUniqueTag()
boolean	iteratePattern(net.minecraft.tileentity.TileEntity tile, IBox box, net.minecraft.item.ItemStack stackToPlace) stackToPlace contains the next item that can be place in the world.
void	registerIcon(net.minecraft.client.renderer.texture.IIconRegister iconRegister)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

patterns

public static final java.util.Set<FillerPattern> patterns

Constructor Detail

FillerPattern

public FillerPattern(java.lang.String tag)

Method Detail

iteratePattern

public boolean iteratePattern(net.minecraft.tileentity.TileEntity tile,
                     IBox box,
                     net.minecraft.item.ItemStack stackToPlace)

stackToPlace contains the next item that can be place in the world. Null if there is none. IteratePattern is responsible to decrementing the stack size if needed. Return true when the iteration process is finished.

getDisplayName

public java.lang.String getDisplayName()

Specified by:

getDisplayName in interface IFillerPattern

getUniqueTag

public java.lang.String getUniqueTag()

Specified by:

getUniqueTag in interface IFillerPattern

registerIcon

public void registerIcon(net.minecraft.client.renderer.texture.IIconRegister iconRegister)

getIcon

public net.minecraft.util.IIcon getIcon()

Specified by:

getIcon in interface IFillerPattern

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

createPatternIterator

public IPatternIterator createPatternIterator(net.minecraft.tileentity.TileEntity tile,
                                     IBox box,
                                     net.minecraftforge.common.util.ForgeDirection orientation)

Description copied from interface: IFillerPattern

Creates the object that does the pattern iteration. This object may be state-full and will be used until the pattern is done or changes.

Specified by:

createPatternIterator in interface IFillerPattern

Parameters:

tile - the Filler

box - the area to fill

orientation - not currently used, but may be in the future (the filler needs some orientation code)

Returns:

fill

public static boolean fill(int xMin,
           int yMin,
           int zMin,
           int xMax,
           int yMax,
           int zMax,
           net.minecraft.item.ItemStack stackToPlace,
           net.minecraft.world.World world)

Attempt to fill blocks in the area. Return false if the process failed.

empty

public static boolean empty(int xMin,
            int yMin,
            int zMin,
            int xMax,
            int yMax,
            int zMax,
            net.minecraft.world.World world)

Attempt to remove the blocks in the area. Return false if is the process failed.

flatten

public static boolean flatten(int xMin,
              int yMin,
              int zMin,
              int xMax,
              int yMax,
              int zMax,
              net.minecraft.world.World world,
              net.minecraft.item.ItemStack stackToPlace)

Attempt to fill the area defined by the box, from the top down. This differs from Fill in how it handles blockage and the order of iteration. Return false if is the process failed.