com.sk89q.worldedit.extent

Interface OutputExtent

All Known Subinterfaces:

Clipboard, Extent, ReorderingExtent, World

All Known Implementing Classes:

AbstractDelegateExtent, AbstractLoggingExtent, AbstractWorld, BlockArrayClipboard, BlockBagExtent, BlockChangeLimiter, BlockQuirkExtent, BlockTransformExtent, BukkitWorld, ChangeSetExtent, ChunkLoadingExtent, DataValidatorExtent, EditSession, FastModeExtent, ForgetfulExtentBuffer, LastAccessExtentCache, LocalWorld, LocalWorldAdapter, MaskingExtent, MultiStageReorder, NullExtent, NullWorld, SurvivalModeExtent

public interface OutputExtent

Accepts block and entity changes.

Method Summary

Modifier and Type	Method and Description
Operation	commit() Return an Operation that should be called to tie up loose ends (such as to commit changes in a buffer).
boolean	setBiome(Vector2D position, BaseBiome biome) Set the biome.
boolean	setBlock(Vector position, BaseBlock block) Change the block at the given location to the given block.

Method Detail

setBlock

boolean setBlock(Vector position,
                 BaseBlock block)
          throws WorldEditException

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.

Parameters:

position - 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

setBiome

boolean setBiome(Vector2D position,
                 BaseBiome biome)

Set the biome.

Parameters:

position - the (x, z) location to set the biome at

biome - the biome to set to

Returns:

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

commit

@Nullable
Operation commit()

Return an Operation that should be called to tie up loose ends (such as to commit changes in a buffer).

Returns:

an operation or null if there is none to execute