Package com.fastasyncworldedit.core.extent.clipboard

Class EmptyClipboard

java.lang.Object

com.fastasyncworldedit.core.extent.clipboard.EmptyClipboard

All Implemented Interfaces:

Clipboard, Extent, InputExtent, OutputExtent, Closeable, Flushable, AutoCloseable, Iterable<BlockVector3>

public final class EmptyClipboard
extends Object
implements Clipboard

Method Summary

Modifier and Type	Method	Description
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.
BlockVector3	getDimensions()	Get the dimensions of the copy, which is at minimum (1, 1, 1).
BaseBlock	getFullBlock(BlockVector3 position)	Get an immutable snapshot of the block at the given location.
int[]	getHeightMap(HeightMapType type)
static EmptyClipboard	getInstance()
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.
void	removeEntity(Entity entity)	Remove entity from clipboard.
boolean	setBiome(int x, int y, int z, BiomeType biome)
boolean	setBiome(BlockVector3 position, BiomeType biome)	Set the biome.
boolean	setBlock(int x, int y, int z, BlockStateHolder block)
boolean	setBlock(BlockVector3 position, BlockStateHolder 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.
boolean	setTile(int x, int y, int z, CompoundTag tile)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sk89q.worldedit.extent.clipboard.Clipboard

apply, close, flush, getArea, getHeight, getLength, getURI, getVolume, getWidth, hasBiomes, iterator, iterator, iterator2d, paste, paste, paste, paste, paste, paste, save, save

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

addCaves, addOre, addOres, addPostProcessor, addProcessor, addSchems, apply, cancel, center, commit, contains, contains, countBlocks, countBlocks, createEntity, disableHistory, disableQueue, enableHistory, enableQueue, generate, getBlockDistribution, getBlockDistributionWithData, getEntities, getEntities, getHighestTerrainBlock, getHighestTerrainBlock, getMaxY, getMinY, getNearestSurfaceLayer, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, isQueueEnabled, isWorld, lazyCopy, regenerateChunk, relight, relightBlock, relightSky, removeEntity, replaceBlocks, replaceBlocks, replaceBlocks, setBlocks, setBlocks, setBlocks, spawnResource

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

getBiome, getBiomeType, getBlock, getBrightness, getBrightness, getEmittedLight, getEmittedLight, getFullBlock, getOpacity, getOpacity, getSkyLight, getSkyLight

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

setBiome, setBlockLight, setBlockLight, setHeightMap, setSkyLight, setSkyLight

Method Details

getInstance

public static EmptyClipboard getInstance()

getRegion

@Nonnull
public Region getRegion()

Description copied from interface: Clipboard

Get the bounding region of this extent.

Implementations should return a copy of the region.

Specified by:

getRegion in interface Clipboard

Returns:

the bounding region

getDimensions

@Nonnull
public BlockVector3 getDimensions()

Description copied from interface: Clipboard

Get the dimensions of the copy, which is at minimum (1, 1, 1).

Specified by:

getDimensions in interface Clipboard

Returns:

the dimensions

getOrigin

@Nonnull
public BlockVector3 getOrigin()

Description copied from interface: Clipboard

Get the origin point from which the copy was made from.

Specified by:

getOrigin in interface Clipboard

Returns:

the origin

setOrigin

public void setOrigin(@Nonnull
 BlockVector3 origin)

Description copied from interface: Clipboard

Set the origin point from which the copy was made from.

Specified by:

setOrigin in interface Clipboard

Parameters:

origin - the origin

removeEntity

public void removeEntity(@Nonnull
 Entity entity)

Description copied from interface: Clipboard

Remove entity from clipboard.

Specified by:

removeEntity in interface Clipboard

getMinimumPoint

@Nonnull
public BlockVector3 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 interface Extent

Returns:

the minimum point

getMaximumPoint

@Nonnull
public BlockVector3 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 interface Extent

Returns:

the maximum point

getFullBlock

@Nonnull
public BaseBlock getFullBlock(@Nonnull
 BlockVector3 position)

Description copied from interface: InputExtent

Get an immutable snapshot of the block at the given location.

Specified by:

getFullBlock in interface InputExtent

Parameters:

position - position of the block

Returns:

the block

getBlock

@Nonnull
public BlockState getBlock(@Nonnull
 BlockVector3 position)

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 Patterns and so on.

Specified by:

getBlock in interface InputExtent

Parameters:

position - position of the block

Returns:

the block

getBiome

@Nullable
public BiomeType getBiome(@Nonnull
 BlockVector3 position)

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 interface InputExtent

Parameters:

position - the (x, y, z) location to check the biome at

Returns:

the biome at the location

See Also:

• This must be overridden by new subclasses.

getHeightMap

@Nonnull
public int[] getHeightMap(@Nullable
 HeightMapType type)

Specified by:

getHeightMap in interface InputExtent

setBlock

public boolean setBlock(@Nonnull
 BlockVector3 position,
 BlockStateHolder 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

Parameters:

position - 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

setBlock

public boolean setBlock(int x,
 int y,
 int z,
 BlockStateHolder block)
                 throws WorldEditException

Specified by:

setBlock in interface OutputExtent

Throws:

WorldEditException

setTile

public boolean setTile(int x,
 int y,
 int z,
 @Nonnull
 CompoundTag tile)
                throws WorldEditException

Specified by:

setTile in interface OutputExtent

Throws:

WorldEditException

setBiome

public boolean setBiome(@Nonnull
 BlockVector3 position,
 @Nonnull
 BiomeType biome)

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 interface OutputExtent

Parameters:

position - the (x, y, z) location to set the biome at

biome - the biome to set to

Returns:

true if the biome was successfully set (return value may not be accurate)

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 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.

Specified by:

fullySupports3DBiomes in interface OutputExtent

Returns:

if the extent fully supports 3D biomes

setBiome

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

Specified by:

setBiome in interface OutputExtent