public abstract class AbstractDelegateExtent extends java.lang.Object implements Extent
Extent
s that merely passes extents onto another.Modifier | Constructor and Description |
---|---|
protected |
AbstractDelegateExtent(Extent extent)
Create a new instance.
|
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). |
protected Operation |
commitBefore() |
Entity |
createEntity(Location location,
BaseEntity entity)
Create an entity at the given location.
|
boolean |
fullySupports3DBiomes()
Check if this extent fully supports 3D biomes.
|
BiomeType |
getBiome(BlockVector3 position)
Get the biome at the given location.
|
BlockState |
getBlock(BlockVector3 position)
Get a snapshot of the block at the given location.
|
java.util.List<? extends Entity> |
getEntities()
Get a list of all entities.
|
java.util.List<? extends Entity> |
getEntities(Region region)
Get a list of all entities within the given region.
|
Extent |
getExtent()
Get the extent.
|
BaseBlock |
getFullBlock(BlockVector3 position)
Get a immutable snapshot of the block at the given location.
|
BlockVector3 |
getMaximumPoint()
Get the maximum point in the extent.
|
BlockVector3 |
getMinimumPoint()
Get the minimum point in the extent.
|
boolean |
setBiome(BlockVector3 position,
BiomeType biome)
Set the biome.
|
<T extends BlockStateHolder<T>> |
setBlock(BlockVector3 location,
T block)
Change the block at the given location to the given block.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getBiome
setBiome
protected AbstractDelegateExtent(Extent extent)
extent
- the extentpublic Extent getExtent()
public BlockState getBlock(BlockVector3 position)
InputExtent
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.
getBlock
in interface InputExtent
position
- position of the blockpublic BaseBlock getFullBlock(BlockVector3 position)
InputExtent
getFullBlock
in interface InputExtent
position
- position of the blockpublic <T extends BlockStateHolder<T>> boolean setBlock(BlockVector3 location, T block) throws WorldEditException
OutputExtent
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.
setBlock
in interface OutputExtent
location
- position of the blockblock
- block to setWorldEditException
- thrown on an error@Nullable public Entity createEntity(Location location, BaseEntity entity)
Extent
createEntity
in interface Extent
location
- the locationentity
- the entitypublic java.util.List<? extends Entity> getEntities()
Extent
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.
getEntities
in interface Extent
public java.util.List<? extends Entity> getEntities(Region region)
Extent
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.
getEntities
in interface Extent
region
- the region in which entities must be containedpublic boolean fullySupports3DBiomes()
OutputExtent
If false
, the extent only visually reads biomes from y = 0
.
The biomes will still be set in 3D, but the client will only see the one at
y = 0
. It is up to the caller to determine if they want to set that
biome instead, or simply warn the actor.
fullySupports3DBiomes
in interface OutputExtent
public BiomeType getBiome(BlockVector3 position)
InputExtent
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.
getBiome
in interface InputExtent
position
- the (x, y, z) location to check the biome atpublic boolean setBiome(BlockVector3 position, BiomeType biome)
OutputExtent
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.
setBiome
in interface OutputExtent
position
- the (x, y, z) location to set the biome atbiome
- the biome to set topublic BlockVector3 getMinimumPoint()
Extent
If the extent is unbounded, then a large (negative) value may be returned.
getMinimumPoint
in interface Extent
public BlockVector3 getMaximumPoint()
Extent
If the extent is unbounded, then a large (positive) value may be returned.
getMaximumPoint
in interface Extent
protected Operation commitBefore()
@Nullable public final Operation commit()
OutputExtent
Operation
that should be called to tie up loose ends
(such as to commit changes in a buffer).commit
in interface OutputExtent