Class AbstractDelegateExtent
- All Implemented Interfaces:
Extent
,InputExtent
,OutputExtent
- Direct Known Subclasses:
AbstractBufferingExtent
,BiomeQuirkExtent
,BlockBagExtent
,BlockChangeLimiter
,BlockQuirkExtent
,BlockTranslateExtent
,ChangeSetExtent
,ChunkLoadingExtent
,DataValidatorExtent
,DisallowedBlocksExtent
,ForgetfulExtentBuffer
,HistoryExtent
,LastAccessExtentCache
,LimitExtent
,MaskingExtent
,PassthroughExtent
,ProcessedWEExtent
,ResettableExtent
,SideEffectExtent
,SlowExtent
,StripNBTExtent
,SurvivalModeExtent
,TracingExtent
,WatchdogTickingExtent
Extent
s that merely passes extents onto another.-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddPostProcessor
(IBatchProcessor processor) addProcessor
(IBatchProcessor processor) Have an extent processed - Either block (Extent) processing or chunk processing<T extends Filter>
Tboolean
cancel()
commit()
Return anOperation
that should be called to tie up loose ends (such as to commit changes in a buffer).protected Operation
int
countBlocks
(Region region, Mask searchMask) Count the number of blocks of a list of types in a region.int
countBlocks
(Region region, Set<BaseBlock> searchBlocks) Count the number of blocks of a list of types in a region.createEntity
(Location location, BaseEntity entity) Create an entity at the given location.createEntity
(Location location, BaseEntity entity, UUID uuid) Create an entity at the given location, forcing a UUID onto the entity Only use if you are aware of the consequences of forcing a UUID to an entity.void
void
boolean
Check if this extent fully supports 3D biomes.getBiome
(BlockVector3 position) Get the biome at the given location.getBiomeType
(int x, int y, int z) getBlock
(int x, int y, int z) getBlock
(BlockVector3 position) Get a snapshot of the block at the given location.getBlockDistribution
(Region region) Get the block distribution inside a region.getBlockDistributionWithData
(Region region) Get the block distribution (with data values) inside a region.int
getBrightness
(int x, int y, int z) int
getEmittedLight
(int x, int y, int z) Get a list of all entities.getEntities
(Region region) Get a list of all entities within the given region.Get the extent.getFullBlock
(int x, int y, int z) getFullBlock
(BlockVector3 position) Get an immutable snapshot of the block at the given location.Get the maximum point in the extent.int
getMaxY()
Get the minimum point in the extent.int
getMinY()
int
getSkyLight
(int x, int y, int z) boolean
boolean
isWorld()
boolean
relight
(int x, int y, int z) boolean
relightBlock
(int x, int y, int z) boolean
relightSky
(int x, int y, int z) void
removeEntity
(int x, int y, int z, UUID uuid) Create an entity at the given location.int
replaceBlocks
(Region region, Mask mask, Pattern pattern) Replaces all the blocks matching a given mask, within a given region, to a block returned by a given pattern.<B extends BlockStateHolder<B>>
intreplaceBlocks
(Region region, Set<BaseBlock> filter, B replacement) Replaces all the blocks matching a given filter, within a given region, to a block returned by a given pattern.int
replaceBlocks
(Region region, Set<BaseBlock> filter, Pattern pattern) Replaces all the blocks matching a given filter, within a given region, to a block returned by a given pattern.boolean
boolean
setBiome
(BlockVector3 position, BiomeType biome) Set the biome.<T extends BlockStateHolder<T>>
booleansetBlock
(int x, int y, int z, T block) <T extends BlockStateHolder<T>>
booleansetBlock
(BlockVector3 position, T block) Change the block at the given location to the given block.void
setBlockLight
(int x, int y, int z, int value) <B extends BlockStateHolder<B>>
intSets all the blocks inside a region to a given block type.int
Sets all the blocks inside a region to a given pattern.int
setBlocks
(Set<BlockVector3> vset, Pattern pattern) void
setChangeSet
(AbstractChangeSet changeSet) void
setSkyLight
(int x, int y, int z, int value) boolean
tile
(int x, int y, int z, FaweCompoundTag tile) Sets a tile/block entity at the given location.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, center, contains, contains, enableHistory, generate, getHighestTerrainBlock, getHighestTerrainBlock, getNearestSurfaceLayer, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, lazyCopy, regenerateChunk, spawnResource
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
-
Field Details
-
extent
-
-
Constructor Details
-
AbstractDelegateExtent
Create a new instance.- Parameters:
extent
- the extent
-
-
Method Details
-
getExtent
Get the extent.- Returns:
- the extent
-
getBlock
Description copied from interface:InputExtent
Get a snapshot of the block at the given location.If the given position is out of the bounds of the extent, then the behavior is undefined (an air block could be returned). However,
null
should not be returned.The returned block is immutable and is a snapshot of the block at the time of call. It has no position attached to it, so it could be reused in
Pattern
s and so on.- Specified by:
getBlock
in interfaceInputExtent
- Parameters:
position
- position of the block- Returns:
- the block
-
getBlock
- Specified by:
getBlock
in interfaceInputExtent
-
getFullBlock
Description copied from interface:InputExtent
Get an immutable snapshot of the block at the given location.- Specified by:
getFullBlock
in interfaceInputExtent
- Parameters:
position
- position of the block- Returns:
- the block
-
getFullBlock
- Specified by:
getFullBlock
in interfaceInputExtent
-
getMinimumPoint
Description copied from interface:Extent
Get the minimum point in the extent.If the extent is unbounded, then a large (negative) value may be returned.
- Specified by:
getMinimumPoint
in interfaceExtent
- Returns:
- the minimum point
-
getMaximumPoint
Description copied from interface:Extent
Get the maximum point in the extent.If the extent is unbounded, then a large (positive) value may be returned.
- Specified by:
getMaximumPoint
in interfaceExtent
- Returns:
- the maximum point
-
getEntities
Description copied from interface:Extent
Get a list of all entities within the given region.If the extent is not wholly loaded (i.e. a world being simulated in the game will not have every chunk loaded), then this list may not be incomplete.
- Specified by:
getEntities
in interfaceExtent
- Parameters:
region
- the region in which entities must be contained- Returns:
- a list of entities
-
getEntities
Description copied from interface:Extent
Get a list of all entities.If the extent is not wholly loaded (i.e. a world being simulated in the game will not have every chunk loaded), then this list may not be incomplete.
- Specified by:
getEntities
in interfaceExtent
- Returns:
- a list of entities
-
createEntity
Description copied from interface:Extent
Create an entity at the given location.- Specified by:
createEntity
in interfaceExtent
- Parameters:
location
- the locationentity
- the entity- Returns:
- a reference to the created entity, or null if the entity could not be created
-
createEntity
Description copied from interface:Extent
Create an entity at the given location, forcing a UUID onto the entity Only use if you are aware of the consequences of forcing a UUID to an entity.- Specified by:
createEntity
in interfaceExtent
- Parameters:
location
- the locationentity
- the entityuuid
- UUID to force the entity to have- Returns:
- a reference to the created entity, or null if the entity could not be created
-
commit
Description copied from interface:OutputExtent
Return anOperation
that should be called to tie up loose ends (such as to commit changes in a buffer).- Specified by:
commit
in interfaceExtent
- Specified by:
commit
in interfaceOutputExtent
- Returns:
- an operation or null if there is none to execute
-
cancel
public boolean cancel() -
removeEntity
Description copied from interface:Extent
Create an entity at the given location.- Specified by:
removeEntity
in interfaceExtent
- Parameters:
x
- the x coordinatey
- the y coordinatez
- the z coordinateuuid
- the unique identifier of the entity
-
isQueueEnabled
public boolean isQueueEnabled()- Specified by:
isQueueEnabled
in interfaceExtent
-
enableQueue
public void enableQueue()- Specified by:
enableQueue
in interfaceExtent
-
disableQueue
public void disableQueue()- Specified by:
disableQueue
in interfaceExtent
-
isWorld
public boolean isWorld() -
getBlockDistribution
Description copied from interface:Extent
Get the block distribution inside a region.- Specified by:
getBlockDistribution
in interfaceExtent
- Parameters:
region
- a region- Returns:
- the results
-
getBlockDistributionWithData
Description copied from interface:Extent
Get the block distribution (with data values) inside a region.- Specified by:
getBlockDistributionWithData
in interfaceExtent
- Parameters:
region
- a region- Returns:
- the results
-
getMaxY
public int getMaxY() -
countBlocks
Description copied from interface:Extent
Count the number of blocks of a list of types in a region.- Specified by:
countBlocks
in interfaceExtent
- Parameters:
region
- the regionsearchBlocks
- the list of blocks to search- Returns:
- the number of blocks that matched the block
-
countBlocks
Description copied from interface:Extent
Count the number of blocks of a list of types in a region.- Specified by:
countBlocks
in interfaceExtent
- Parameters:
region
- the regionsearchMask
- mask to match- Returns:
- the number of blocks that matched the mask
-
setBlocks
public <B extends BlockStateHolder<B>> int setBlocks(Region region, B block) throws MaxChangedBlocksException Description copied from interface:Extent
Sets all the blocks inside a region to a given block type.- Specified by:
setBlocks
in interfaceExtent
- Parameters:
region
- the regionblock
- the block- Returns:
- number of blocks affected
- Throws:
MaxChangedBlocksException
- thrown if too many blocks are changed
-
setBlocks
Description copied from interface:Extent
Sets all the blocks inside a region to a given pattern.- Specified by:
setBlocks
in interfaceExtent
- Parameters:
region
- the regionpattern
- the pattern that provides the replacement block- Returns:
- number of blocks affected
- Throws:
MaxChangedBlocksException
- thrown if too many blocks are changed
-
replaceBlocks
public <B extends BlockStateHolder<B>> int replaceBlocks(Region region, Set<BaseBlock> filter, B replacement) throws MaxChangedBlocksException Description copied from interface:Extent
Replaces all the blocks matching a given filter, within a given region, to a block returned by a given pattern.- Specified by:
replaceBlocks
in interfaceExtent
- Parameters:
region
- the region to replace the blocks withinfilter
- a list of block types to match, or null to useExistingBlockMask
replacement
- the replacement block- Returns:
- number of blocks affected
- Throws:
MaxChangedBlocksException
- thrown if too many blocks are changed
-
replaceBlocks
public int replaceBlocks(Region region, Set<BaseBlock> filter, Pattern pattern) throws MaxChangedBlocksException Description copied from interface:Extent
Replaces all the blocks matching a given filter, within a given region, to a block returned by a given pattern.- Specified by:
replaceBlocks
in interfaceExtent
- Parameters:
region
- the region to replace the blocks withinfilter
- a list of block types to match, or null to useExistingBlockMask
pattern
- the pattern that provides the new blocks- Returns:
- number of blocks affected
- Throws:
MaxChangedBlocksException
- thrown if too many blocks are changed
-
replaceBlocks
public int replaceBlocks(Region region, Mask mask, Pattern pattern) throws MaxChangedBlocksException Description copied from interface:Extent
Replaces all the blocks matching a given mask, within a given region, to a block returned by a given pattern.- Specified by:
replaceBlocks
in interfaceExtent
- Parameters:
region
- the region to replace the blocks withinmask
- the mask that blocks must matchpattern
- the pattern that provides the new blocks- Returns:
- number of blocks affected
- Throws:
MaxChangedBlocksException
- thrown if too many blocks are changed
-
setBlocks
-
getMinY
public int getMinY() -
relight
public boolean relight(int x, int y, int z) -
relightBlock
public boolean relightBlock(int x, int y, int z) - Specified by:
relightBlock
in interfaceExtent
-
relightSky
public boolean relightSky(int x, int y, int z) - Specified by:
relightSky
in interfaceExtent
-
addProcessor
Description copied from interface:Extent
Have an extent processed - Either block (Extent) processing or chunk processing- Specified by:
addProcessor
in interfaceExtent
- Parameters:
processor
-- Returns:
- processed Extent
-
addPostProcessor
- Specified by:
addPostProcessor
in interfaceExtent
-
disableHistory
- Specified by:
disableHistory
in interfaceExtent
-
apply
-
commitBefore
-
getBiome
Description copied from interface:InputExtent
Get the biome at the given location.If there is no biome available, then the ocean biome should be returned.
As implementation varies per Minecraft version, this may not exactly get this positions biome. On versions prior to 1.15, this will get the entire column. On later versions it will get the 4x4x4 cube's biome.
- Specified by:
getBiome
in interfaceInputExtent
- Parameters:
position
- the (x, y, z) location to check the biome at- Returns:
- the biome at the location
- See Also:
-
getBiomeType
- Specified by:
getBiomeType
in interfaceInputExtent
-
getEmittedLight
public int getEmittedLight(int x, int y, int z) - Specified by:
getEmittedLight
in interfaceInputExtent
-
getSkyLight
public int getSkyLight(int x, int y, int z) - Specified by:
getSkyLight
in interfaceInputExtent
-
getBrightness
public int getBrightness(int x, int y, int z) - Specified by:
getBrightness
in interfaceInputExtent
-
setChangeSet
-
setBlock
public <T extends BlockStateHolder<T>> boolean setBlock(BlockVector3 position, T 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
- Parameters:
position
- 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
-
setBlock
public <T extends BlockStateHolder<T>> boolean setBlock(int x, int y, int z, T block) throws WorldEditException - Specified by:
setBlock
in interfaceOutputExtent
- Throws:
WorldEditException
-
tile
Description copied from interface:OutputExtent
Sets a tile/block entity at the given location.- Specified by:
tile
in interfaceOutputExtent
- Parameters:
x
- the x positiony
- the y positionz
- the z positiontile
- the tile/block entity to set- Returns:
true
if the tile/block entity was placed- Throws:
WorldEditException
-
fullySupports3DBiomes
public boolean fullySupports3DBiomes()Description copied from interface:OutputExtent
Check if this extent fully supports 3D biomes.If
false
, the extent only visually reads biomes fromy = 0
. The biomes will still be set in 3D, but the client will only see the one aty = 0
. It is up to the caller to determine if they want to set that biome instead, or simply warn the actor.- Specified by:
fullySupports3DBiomes
in interfaceOutputExtent
- Returns:
- if the extent fully supports 3D biomes
-
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
- 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
-
setBlockLight
public void setBlockLight(int x, int y, int z, int value) - Specified by:
setBlockLight
in interfaceOutputExtent
-
setSkyLight
public void setSkyLight(int x, int y, int z, int value) - Specified by:
setSkyLight
in interfaceOutputExtent
-
toString
-