Package com.ldtteam.structurize.placement

Class AbstractBlueprintIteratorWrapper

java.lang.Object

com.ldtteam.structurize.placement.AbstractBlueprintIterator

com.ldtteam.structurize.placement.AbstractBlueprintIteratorWrapper

All Implemented Interfaces:

IBlueprintIterator

public abstract class AbstractBlueprintIteratorWrapper
extends AbstractBlueprintIterator

This is a base class for BlueprintIterators based on a delegated iterator All methods are implemented through the delegate. Subclasses are expected to override one or multiple of the methods, to override logic

Nested Class Summary

Nested classes/interfaces inherited from class com.ldtteam.structurize.placement.AbstractBlueprintIterator

AbstractBlueprintIterator.Result

Field Summary

Fields

Modifier and Type	Field	Description
protected IBlueprintIterator	delegate	The delegate blueprint iterator

Fields inherited from class com.ldtteam.structurize.placement.AbstractBlueprintIterator

NULL_POS, prevProgressPos, progressPos, size

Constructor Summary

Constructors

Constructor	Description
AbstractBlueprintIteratorWrapper(AbstractBlueprintIterator delegate)	Initialise the blueprint iterator with a delegate blueprint iterator

Method Summary

Modifier and Type	Method	Description
AbstractBlueprintIterator.Result	decrement()	Decrement method, create in implementation.
BlueprintPositionInfo	getBluePrintPositionInfo(net.minecraft.core.BlockPos localPos)	Get the blueprint info from the position.
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
boolean	hasEntities()	Retrieve whether the iterator is taking entities into account as well
void	includeEntities()	Set the iterator to include entities.
AbstractBlueprintIterator.Result	increment()	Increment method, create in implementation.
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 com.ldtteam.structurize.placement.AbstractBlueprintIterator

decrement, getPrevProgressPos, getStructureHandler, increment

Methods inherited from class java.lang.Object

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

Field Details

delegate

protected IBlueprintIterator delegate

The delegate blueprint iterator

Constructor Details

AbstractBlueprintIteratorWrapper

public AbstractBlueprintIteratorWrapper(AbstractBlueprintIterator delegate)

Initialise the blueprint iterator with a delegate blueprint iterator

Parameters:

delegate - The delegate blueprint iterator

Method Details

increment

public AbstractBlueprintIterator.Result increment()

Description copied from interface: IBlueprintIterator

Increment method, create in implementation.

Returns:

increment the structure position (y++).

decrement

public AbstractBlueprintIterator.Result decrement()

Description copied from interface: IBlueprintIterator

Decrement method, create in implementation.

Returns:

decrement the structure position (y--).

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

Overrides:

setProgressPos in class AbstractBlueprintIterator

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

Overrides:

getBluePrintPositionInfo in class AbstractBlueprintIterator

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

Overrides:

includeEntities in class AbstractBlueprintIterator

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

Overrides:

hasEntities in class AbstractBlueprintIterator

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

Overrides:

setRemoving in class AbstractBlueprintIterator

isRemoving

public boolean isRemoving()

Description copied from interface: IBlueprintIterator

Retrieve whether we're removing blocks at the moment

Specified by:

isRemoving in interface IBlueprintIterator

Overrides:

isRemoving in class AbstractBlueprintIterator

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

Overrides:

reset in class AbstractBlueprintIterator

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

Overrides:

getSize in class AbstractBlueprintIterator

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

Overrides:

getProgressPos in class AbstractBlueprintIterator

Returns:

the progress pos.