Package com.ldtteam.structurize.placement

Class AbstractBlueprintIterator

java.lang.Object

com.ldtteam.structurize.placement.AbstractBlueprintIterator

All Implemented Interfaces:

IBlueprintIterator

Direct Known Subclasses:

AbstractBlueprintIteratorWrapper, BlueprintIteratorDefault, BlueprintIteratorHilbert, BlueprintIteratorInwardCircle, BlueprintIteratorInwardCircleHeight, BlueprintIteratorRandom

public abstract class AbstractBlueprintIterator
extends Object
implements IBlueprintIterator

This is the blueprint iterator. It's a helper class used to track the progress of one iteration over the structure.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AbstractBlueprintIterator.Result	The different results when advancing the structure.

Field Summary

Fields

Modifier and Type	Field	Description
static final net.minecraft.core.BlockPos	NULL_POS	The position we use as our uninitialized value.
protected final net.minecraft.core.BlockPos.MutableBlockPos	prevProgressPos	The previous position before the current progress position.
protected final net.minecraft.core.BlockPos.MutableBlockPos	progressPos	The Structure position we are at.
protected final net.minecraft.core.BlockPos	size	The size of the structure.

Constructor Summary

Constructors

Constructor	Description
AbstractBlueprintIterator(IStructureHandler structureHandler)	Initialize the blueprint iterator with the structure handler.
AbstractBlueprintIterator(IStructureHandler structureHandler, net.minecraft.core.BlockPos size)	Initialize the blueprint iterator with the structure handler.

Method Summary

Modifier and Type	Method	Description
AbstractBlueprintIterator.Result	decrement(net.minecraftforge.common.util.TriPredicate<BlueprintPositionInfo,net.minecraft.core.BlockPos,IStructureHandler> skipCondition)	Decrement the structure with a certain skipCondition (jump over blocks that fulfill skipCondition).
BlueprintPositionInfo	getBluePrintPositionInfo(net.minecraft.core.BlockPos localPos)	Get the blueprint info from the position.
net.minecraft.core.BlockPos	getPrevProgressPos()	Get the last position before the progress pos of the iterator.
net.minecraft.core.BlockPos	getProgressPos()	Get the progress pos of the iterator.
net.minecraft.core.BlockPos	getSize()	Get the size of the blueprint which is iterated over
protected IStructureHandler	getStructureHandler()
boolean	hasEntities()	Retrieve whether the iterator is taking entities into account as well
void	includeEntities()	Set the iterator to include entities.
AbstractBlueprintIterator.Result	increment(net.minecraftforge.common.util.TriPredicate<BlueprintPositionInfo,net.minecraft.core.BlockPos,IStructureHandler> skipCondition)	Increment the structure with a certain skipCondition (jump over blocks that fulfill skipCondition).
boolean	isRemoving()	Retrieve whether we're removing blocks at the moment
void	reset()	Reset the progressPos.
void	setProgressPos(net.minecraft.core.BlockPos localPosition)	Change the current progressPos.
void	setRemoving()	Set the iterator to removal mode.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ldtteam.structurize.placement.IBlueprintIterator

decrement, increment

Field Details

NULL_POS

public static final net.minecraft.core.BlockPos NULL_POS

The position we use as our uninitialized value.

progressPos

protected final net.minecraft.core.BlockPos.MutableBlockPos progressPos

The Structure position we are at. Defaulted to NULL_POS.

prevProgressPos

protected final net.minecraft.core.BlockPos.MutableBlockPos prevProgressPos

The previous position before the current progress position.

size

protected final net.minecraft.core.BlockPos size

The size of the structure.

Constructor Details

AbstractBlueprintIterator

public AbstractBlueprintIterator(IStructureHandler structureHandler)

Initialize the blueprint iterator with the structure handler.

Parameters:

structureHandler - the structure handler.

AbstractBlueprintIterator

public AbstractBlueprintIterator(IStructureHandler structureHandler,
 net.minecraft.core.BlockPos size)

Initialize the blueprint iterator with the structure handler.

Parameters:

size - the size.

structureHandler - the structure handler.

Method Details

increment

public AbstractBlueprintIterator.Result increment(net.minecraftforge.common.util.TriPredicate<BlueprintPositionInfo,net.minecraft.core.BlockPos,IStructureHandler> skipCondition)

Description copied from interface: IBlueprintIterator

Increment the structure with a certain skipCondition (jump over blocks that fulfill skipCondition).

Specified by:

increment in interface IBlueprintIterator

Parameters:

skipCondition - the skipCondition.

Returns:

Result of increment.

decrement

public AbstractBlueprintIterator.Result decrement(net.minecraftforge.common.util.TriPredicate<BlueprintPositionInfo,net.minecraft.core.BlockPos,IStructureHandler> skipCondition)

Description copied from interface: IBlueprintIterator

Decrement the structure with a certain skipCondition (jump over blocks that fulfill skipCondition).

Specified by:

decrement in interface IBlueprintIterator

Parameters:

skipCondition - the skipCondition.

Returns:

Result of decrement.

setProgressPos

public void setProgressPos(net.minecraft.core.BlockPos localPosition)

Description copied from interface: IBlueprintIterator

Change the current progressPos. Used when loading progress.

Specified by:

setProgressPos in interface IBlueprintIterator

Parameters:

localPosition - new progressPos.

getBluePrintPositionInfo

public BlueprintPositionInfo getBluePrintPositionInfo(net.minecraft.core.BlockPos localPos)

Description copied from interface: IBlueprintIterator

Get the blueprint info from the position.

Specified by:

getBluePrintPositionInfo in interface IBlueprintIterator

Parameters:

localPos - the position.

Returns:

the info object.

includeEntities

public void includeEntities()

Description copied from interface: IBlueprintIterator

Set the iterator to include entities.

Specified by:

includeEntities in interface IBlueprintIterator

hasEntities

public boolean hasEntities()

Description copied from interface: IBlueprintIterator

Retrieve whether the iterator is taking entities into account as well

Specified by:

hasEntities in interface IBlueprintIterator

Returns:

whether the iterator is taking entities into account as well

setRemoving

public void setRemoving()

Description copied from interface: IBlueprintIterator

Set the iterator to removal mode.

Specified by:

setRemoving in interface IBlueprintIterator

isRemoving

public boolean isRemoving()

Description copied from interface: IBlueprintIterator

Retrieve whether we're removing blocks at the moment

Specified by:

isRemoving in interface IBlueprintIterator

Returns:

Whether we are removing blocks at the moment

reset

public void reset()

Description copied from interface: IBlueprintIterator

Reset the progressPos.

Specified by:

reset in interface IBlueprintIterator

getSize

public net.minecraft.core.BlockPos getSize()

Description copied from interface: IBlueprintIterator

Get the size of the blueprint which is iterated over

Specified by:

getSize in interface IBlueprintIterator

Returns:

the size

getProgressPos

public net.minecraft.core.BlockPos getProgressPos()

Description copied from interface: IBlueprintIterator

Get the progress pos of the iterator.

Specified by:

getProgressPos in interface IBlueprintIterator

Returns:

the progress pos.

getPrevProgressPos

public net.minecraft.core.BlockPos getPrevProgressPos()

Description copied from interface: IBlueprintIterator

Get the last position before the progress pos of the iterator.

Specified by:

getPrevProgressPos in interface IBlueprintIterator

Returns:

the prev progress pos.

getStructureHandler

protected IStructureHandler getStructureHandler()