Package com.sk89q.worldedit.extent

Class MaskingExtent

java.lang.Object

com.sk89q.worldedit.extent.AbstractDelegateExtent

com.sk89q.worldedit.extent.MaskingExtent

All Implemented Interfaces:

Filter, IBatchProcessor, Extent, InputExtent, OutputExtent

public class MaskingExtent
extends AbstractDelegateExtent
implements IBatchProcessor, Filter

Requires that all mutating methods pass a given Mask.

Field Summary

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

extent

Constructor Summary

Constructors

Constructor	Description
MaskingExtent(Extent extent, Mask mask)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
void	applyBlock(FilterBlock block)	Make changes to the block here - e.g., block.setId(...) - Note: Performance is critical here
Extent	construct(Extent child)	Convert this processor into an Extent based processor instead of a queue batch based on.
Filter	fork()	Fork this for use by another thread - Typically filters are simple and don't need to create another copy to be thread safe here
Mask	getMask()	Get the mask.
ProcessorScope	getScope()	Default to CUSTOM ProcessorScope as we want custom processors people add to be before we write history, but after FAWE does it's own stuff.
IChunkSet	processSet(IChunk chunk, IChunkGet get, IChunkSet set)	Process a chunk that has been set.
boolean	setBiome(int x, int y, int z, BiomeType biome)
<B extends BlockStateHolder<B>> boolean	setBlock(BlockVector3 location, B block)	Change the block at the given location to the given block.
void	setMask(Mask mask)	Set a mask.

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

addPostProcessor, addProcessor, cancel, commit, commitBefore, createEntity, disableHistory, disableQueue, enableQueue, fullySupports3DBiomes, getBiome, getBiomeType, getBlock, getBlock, getBrightness, getEmittedLight, getEntities, getEntities, getExtent, getFullBlock, getFullBlock, getMaximumPoint, getMaxY, getMinimumPoint, getMinY, getSkyLight, isQueueEnabled, relight, relightBlock, relightSky, removeEntity, setBiome, setBlock, setBlockLight, setChangeSet, setSkyLight, setTile, toString

Methods inherited from class java.lang.Object

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

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

addCaves, addOre, addOres, addSchems, apply, apply, center, contains, contains, countBlocks, countBlocks, enableHistory, generate, getBlockDistribution, getBlockDistributionWithData, getHighestTerrainBlock, getHighestTerrainBlock, getNearestSurfaceLayer, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, isWorld, lazyCopy, regenerateChunk, replaceBlocks, replaceBlocks, replaceBlocks, setBlocks, setBlocks, setBlocks, spawnResource

Methods inherited from interface com.fastasyncworldedit.core.queue.Filter

appliesChunk, appliesLayer, applyChunk, finishChunk, join

Methods inherited from interface com.fastasyncworldedit.core.queue.IBatchProcessor

flush, join, joinPost, postProcess, postProcessSet, processGet, remove, trimNBT, trimY

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

getBiome, getBrightness, getEmittedLight, getHeightMap, getOpacity, getOpacity, getSkyLight

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

setBiome, setBlockLight, setHeightMap, setSkyLight

Constructor Details

MaskingExtent

public MaskingExtent(Extent extent,
 Mask mask)

Create a new instance.

Parameters:

extent - the extent

mask - the mask

Method Details

getMask

public Mask getMask()

Get the mask.

Returns:

the mask

setMask

public void setMask(Mask mask)

Set a mask.

Parameters:

mask - a mask

setBlock

public <B extends BlockStateHolder<B>> boolean setBlock(BlockVector3 location,
 B 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 BlockStateHolder to the world, so future changes to the BlockStateHolder 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

setBiome

public boolean setBiome(int x,
 int y,
 int z,
 BiomeType biome)

Specified by:

setBiome in interface OutputExtent

Overrides:

setBiome in class AbstractDelegateExtent

processSet

public IChunkSet processSet(IChunk chunk,
 IChunkGet get,
 IChunkSet set)

Description copied from interface: IBatchProcessor

Process a chunk that has been set.

Specified by:

processSet in interface IBatchProcessor

applyBlock

public void applyBlock(FilterBlock block)

Description copied from interface: Filter

Make changes to the block here
- e.g., block.setId(...)
- Note: Performance is critical here

Specified by:

applyBlock in interface Filter

construct

public Extent construct(Extent child)

Description copied from interface: IBatchProcessor

Convert this processor into an Extent based processor instead of a queue batch based on.

Specified by:

construct in interface IBatchProcessor

fork

public Filter fork()

Description copied from interface: Filter

Fork this for use by another thread - Typically filters are simple and don't need to create another copy to be thread safe here

Specified by:

fork in interface Filter

Returns:

this

getScope

public ProcessorScope getScope()

Description copied from interface: IBatchProcessor

Default to CUSTOM ProcessorScope as we want custom processors people add to be before we write history, but after FAWE does it's own stuff.

Specified by:

getScope in interface IBatchProcessor