public class BlockArrayClipboard extends java.lang.Object implements Clipboard
BaseBlocks and
other data as lists or maps.| Constructor and Description |
|---|
BlockArrayClipboard(Region region)
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). |
Entity |
createEntity(Location location,
BaseEntity entity)
Create an entity at the given location.
|
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.
|
BlockVector3 |
getDimensions()
Get the dimensions of the copy, which is at minimum (1, 1, 1).
|
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.
|
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.
|
BlockVector3 |
getOrigin()
Get the origin point from which the copy was made from.
|
Region |
getRegion()
Get the bounding region of this extent.
|
boolean |
hasBiomes()
Returns true if the clipboard has biome data.
|
boolean |
setBiome(BlockVector3 position,
BiomeType biome)
Set the biome.
|
<B extends BlockStateHolder<B>> |
setBlock(BlockVector3 position,
B block)
Change the block at the given location to the given block.
|
void |
setOrigin(BlockVector3 origin)
Set the origin point from which the copy was made from.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetBiomefullySupports3DBiomes, setBiomepublic BlockArrayClipboard(Region region)
The origin will be placed at the region's lowest minimum point.
region - the bounding regionpublic Region getRegion()
ClipboardImplementations should return a copy of the region.
public BlockVector3 getOrigin()
Clipboardpublic void setOrigin(BlockVector3 origin)
Clipboardpublic BlockVector3 getDimensions()
ClipboardgetDimensions in interface Clipboardpublic BlockVector3 getMinimumPoint()
ExtentIf the extent is unbounded, then a large (negative) value may be returned.
getMinimumPoint in interface Extentpublic BlockVector3 getMaximumPoint()
ExtentIf the extent is unbounded, then a large (positive) value may be returned.
getMaximumPoint in interface Extentpublic java.util.List<? extends Entity> getEntities(Region region)
ExtentIf 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 Extentregion - the region in which entities must be containedpublic java.util.List<? extends Entity> getEntities()
ExtentIf 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@Nullable public Entity createEntity(Location location, BaseEntity entity)
ExtentcreateEntity in interface Extentlocation - the locationentity - the entitypublic BlockState getBlock(BlockVector3 position)
InputExtentIf 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
Patterns and so on.
getBlock in interface InputExtentposition - position of the blockpublic BaseBlock getFullBlock(BlockVector3 position)
InputExtentgetFullBlock in interface InputExtentposition - position of the blockpublic <B extends BlockStateHolder<B>> boolean setBlock(BlockVector3 position, B block) throws WorldEditException
OutputExtentBlockStateHolder 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 OutputExtentposition - position of the blockblock - block to setWorldEditException - thrown on an errorpublic boolean hasBiomes()
ClipboardInputExtent.getBiome(BlockVector3)
strongly suggests returning BiomeTypes.OCEAN instead of null
if biomes aren't present.public BiomeType getBiome(BlockVector3 position)
InputExtentIf 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 InputExtentposition - the (x, y, z) location to check the biome atpublic boolean setBiome(BlockVector3 position, BiomeType biome)
OutputExtentAs 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 OutputExtentposition - the (x, y, z) location to set the biome atbiome - the biome to set to@Nullable public Operation commit()
OutputExtentOperation that should be called to tie up loose ends
(such as to commit changes in a buffer).commit in interface OutputExtent