com.sk89q.worldedit.extent.reorder

Class MultiStageReorder

java.lang.Object

com.sk89q.worldedit.extent.AbstractDelegateExtent

com.sk89q.worldedit.extent.reorder.MultiStageReorder

All Implemented Interfaces:

Extent, InputExtent, OutputExtent, ReorderingExtent

public class MultiStageReorder
extends AbstractDelegateExtent
implements ReorderingExtent

Re-orders blocks into several stages.

Constructor Summary

Constructors

Constructor and Description
MultiStageReorder(Extent extent) Create a new instance when the re-ordering is enabled.
MultiStageReorder(Extent extent, boolean enabled) Create a new instance.

Method Summary

Modifier and Type	Method and Description
Operation	commitBefore()
boolean	isEnabled() Return whether re-ordering is enabled.
boolean	setBlock(Vector location, BaseBlock block) Change the block at the given location to the given block.
void	setEnabled(boolean enabled) Set whether re-ordering is enabled.

Methods inherited from class com.sk89q.worldedit.extent.AbstractDelegateExtent

commit, createEntity, getBiome, getBlock, getEntities, getEntities, getExtent, getLazyBlock, getMaximumPoint, getMinimumPoint, setBiome

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sk89q.worldedit.extent.Extent

createEntity, getEntities, getEntities, getMaximumPoint, getMinimumPoint

Methods inherited from interface com.sk89q.worldedit.extent.InputExtent

getBiome, getBlock, getLazyBlock

Methods inherited from interface com.sk89q.worldedit.extent.OutputExtent

commit, setBiome

Constructor Detail

MultiStageReorder

public MultiStageReorder(Extent extent,
                         boolean enabled)

Create a new instance.

Parameters:

extent - the extent

enabled - true to enable

MultiStageReorder

public MultiStageReorder(Extent extent)

Create a new instance when the re-ordering is enabled.

Parameters:

extent - the extent

Method Detail

isEnabled

public boolean isEnabled()

Return whether re-ordering is enabled.

Returns:

true if re-ordering is enabled

setEnabled

public void setEnabled(boolean enabled)

Set whether re-ordering is enabled.

Parameters:

enabled - true if re-ordering is enabled

setBlock

public boolean setBlock(Vector location,
                        BaseBlock block)
                 throws WorldEditException

Description copied from interface: OutputExtent

Change the block at the given location to the given block. The operation may not tie the given BaseBlock to the world, so future changes to the BaseBlock do not affect the world until this method is called again.

The return value of this method indicates whether the change was probably successful. It may not be successful if, for example, the location is out of the bounds of the extent. It may be unsuccessful if the block passed is the same as the one in the world. However, the return value is only an estimation and it may be incorrect, but it could be used to count, for example, the approximate number of changes.

Specified by:

setBlock in interface OutputExtent

Overrides:

setBlock in class AbstractDelegateExtent

Parameters:

location - position of the block

block - block to set

Returns:

true if the block was successfully set (return value may not be accurate)

Throws:

WorldEditException - thrown on an error

commitBefore

public Operation commitBefore()

Overrides:

commitBefore in class AbstractDelegateExtent