Class ForgetfulExtentBuffer
- All Implemented Interfaces:
Filter
,Extent
,InputExtent
,OutputExtent
,BiomePattern
,Pattern
Extent
and allows later retrieval for
actual application of the changes.
This buffer will not attempt to return results from the buffer when
accessor methods (such as AbstractDelegateExtent.getBlock(BlockVector3)
) are called.
-
Field Summary
Fields inherited from class com.sk89q.worldedit.extent.AbstractDelegateExtent
extent
-
Constructor Summary
ConstructorDescriptionForgetfulExtentBuffer
(Extent delegate) Create a new extent buffer that will buffer every change.ForgetfulExtentBuffer
(Extent delegate, Mask mask) Create a new extent buffer that will buffer changes that meet the criteria of the given mask. -
Method Summary
Modifier and TypeMethodDescriptionapplyBiome
(BlockVector3 pos) Return aBiomeType
for the given position.applyBlock
(BlockVector3 pos) Return aBaseBlock
for the given position.asRegion()
Return a region representation of this buffer.fork()
Fork this for use by another thread - Typically filters are simple and don't need to create another copy to be thread safe hereboolean
boolean
boolean
setBiome
(BlockVector3 position, BiomeType biome) Set the biome.<B extends BlockStateHolder<B>>
booleansetBlock
(BlockVector3 location, B block) Change the block at the given location to the given block.Methods inherited from class com.sk89q.worldedit.extent.AbstractDelegateExtent
addPostProcessor, addProcessor, apply, cancel, commit, commitBefore, countBlocks, countBlocks, createEntity, createEntity, disableHistory, disableQueue, enableQueue, fullySupports3DBiomes, getBiome, getBiomeType, getBlock, getBlock, getBlockDistribution, getBlockDistributionWithData, getBrightness, getEmittedLight, getEntities, getEntities, getExtent, getFullBlock, getFullBlock, getMaximumPoint, getMaxY, getMinimumPoint, getMinY, getSkyLight, isWorld, relight, relightBlock, relightSky, removeEntity, replaceBlocks, replaceBlocks, replaceBlocks, setBlock, setBlockLight, setBlocks, setBlocks, setBlocks, setChangeSet, setSkyLight, tile, 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.function.pattern.BiomePattern
apply
Methods inherited from interface com.sk89q.worldedit.extent.Extent
addCaves, addOre, addOres, addSchems, apply, center, contains, contains, enableHistory, generate, getHighestTerrainBlock, getHighestTerrainBlock, getNearestSurfaceLayer, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, lazyCopy, regenerateChunk, spawnResource
Methods inherited from interface com.fastasyncworldedit.core.queue.Filter
appliesChunk, appliesLayer, applyChunk, finishChunk, join
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, setTile
Methods inherited from interface com.sk89q.worldedit.function.pattern.Pattern
apply, apply, applyBlock, size
-
Constructor Details
-
ForgetfulExtentBuffer
Create a new extent buffer that will buffer every change.- Parameters:
delegate
- the delegate extent forInputExtent.getBlock(BlockVector3)
, etc. calls
-
ForgetfulExtentBuffer
Create a new extent buffer that will buffer changes that meet the criteria of the given mask.- Parameters:
delegate
- the delegate extent forInputExtent.getBlock(BlockVector3)
, etc. callsmask
- the mask
-
-
Method Details
-
isQueueEnabled
public boolean isQueueEnabled()- Specified by:
isQueueEnabled
in interfaceExtent
- Overrides:
isQueueEnabled
in classAbstractDelegateExtent
-
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 givenBlockStateHolder
to the world, so future changes to theBlockStateHolder
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 interfaceOutputExtent
- Overrides:
setBlock
in classAbstractDelegateExtent
- Parameters:
location
- position of the blockblock
- block to set- Returns:
- true if the block was successfully set (return value may not be accurate)
- Throws:
WorldEditException
- thrown on an error
-
setBiome
Description copied from interface:OutputExtent
Set the biome.As implementation varies per Minecraft version, this may set more than this position's biome. On versions prior to 1.15, this will set the entire column. On later versions it will set the 4x4x4 cube.
- Specified by:
setBiome
in interfaceOutputExtent
- Overrides:
setBiome
in classAbstractDelegateExtent
- Parameters:
position
- the (x, y, z) location to set the biome atbiome
- the biome to set to- Returns:
- true if the biome was successfully set (return value may not be accurate)
-
setBiome
- Specified by:
setBiome
in interfaceOutputExtent
- Overrides:
setBiome
in classAbstractDelegateExtent
-
applyBlock
Description copied from interface:Pattern
Return aBaseBlock
for the given position.- Specified by:
applyBlock
in interfacePattern
- Parameters:
pos
- the position- Returns:
- a block
-
applyBiome
Description copied from interface:BiomePattern
Return aBiomeType
for the given position.- Specified by:
applyBiome
in interfaceBiomePattern
- Parameters:
pos
- the position- Returns:
- a biome
-
asRegion
Return a region representation of this buffer.- Returns:
- a region
-
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
-