Package com.fastasyncworldedit.core.extent.clipboard

Class WorldCopyClipboard

java.lang.Object

com.fastasyncworldedit.core.extent.clipboard.SimpleClipboard

com.fastasyncworldedit.core.extent.clipboard.ReadOnlyClipboard

com.fastasyncworldedit.core.extent.clipboard.WorldCopyClipboard

All Implemented Interfaces:

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

public class WorldCopyClipboard
extends ReadOnlyClipboard

Field Summary

Fields inherited from class com.fastasyncworldedit.core.extent.clipboard.ReadOnlyClipboard

region

Fields inherited from class com.fastasyncworldedit.core.extent.clipboard.SimpleClipboard

offset

Constructor Summary

Constructors

Constructor	Description
WorldCopyClipboard(Supplier<Extent> supplier, Region region)	Deprecated, for removal: This API element is subject to removal in a future version. use of(Extent, Region)
WorldCopyClipboard(Supplier<Extent> supplier, Region region, boolean hasEntities, boolean hasBiomes)	Deprecated, for removal: This API element is subject to removal in a future version. use of(Extent, Region, boolean, boolean)

Method Summary

Modifier and Type	Method	Description
BiomeType	getBiome(BlockVector3 position)	Get the biome at the given location.
BiomeType	getBiomeType(int x, int y, int z)
BlockState	getBlock(int x, int y, int z)
List<? extends Entity>	getEntities()	Deprecated.
Extent	getExtent()
BaseBlock	getFullBlock(int x, int y, int z)
boolean	hasBiomes()	Returns true if the clipboard has biome data.
static WorldCopyClipboard	of(Extent extent, Region region)
static WorldCopyClipboard	of(Extent extent, Region region, boolean hasEntities)
static WorldCopyClipboard	of(Extent extent, Region region, boolean hasEntities, boolean hasBiomes)
void	paste(Extent toExtent, BlockVector3 to, boolean pasteAir, boolean pasteEntities, boolean pasteBiomes)

Methods inherited from class com.fastasyncworldedit.core.extent.clipboard.ReadOnlyClipboard

createEntity, createEntity, getMaximumPoint, getMinimumPoint, getRegion, of, of, of, of, removeEntity, setBiome, setBiome, setBlock, tile

Methods inherited from class com.fastasyncworldedit.core.extent.clipboard.SimpleClipboard

getArea, getDimensions, getHeight, getLength, getOrigin, getVolume, getWidth, setOffset, setOrigin

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, getURI, iterator, iterator, iterator2d, paste, paste, paste, paste, paste, save, save, transform

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

addCaves, addOre, addOres, addPostProcessor, addProcessor, addSchems, apply, cancel, center, commit, contains, contains, countBlocks, countBlocks, disableHistory, disableQueue, enableHistory, enableQueue, generate, getBlockDistribution, getBlockDistributionWithData, 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, getBlock, getBrightness, getBrightness, getEmittedLight, getEmittedLight, getFullBlock, getHeightMap, getOpacity, getOpacity, getSkyLight, getSkyLight

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

fullySupports3DBiomes, setBiome, setBlock, setBlockLight, setBlockLight, setHeightMap, setSkyLight, setSkyLight, setTile

Constructor Details

WorldCopyClipboard

@Deprecated(forRemoval=true,
            since="2.13.0")
public WorldCopyClipboard(Supplier<Extent> supplier,
 Region region)

Deprecated, for removal: This API element is subject to removal in a future version.

use of(Extent, Region)

WorldCopyClipboard

@Deprecated(forRemoval=true,
            since="2.13.0")
public WorldCopyClipboard(Supplier<Extent> supplier,
 Region region,
 boolean hasEntities,
 boolean hasBiomes)

Deprecated, for removal: This API element is subject to removal in a future version.

use of(Extent, Region, boolean, boolean)

Method Details

of

public static WorldCopyClipboard of(Extent extent,
 Region region)

of

public static WorldCopyClipboard of(Extent extent,
 Region region,
 boolean hasEntities)

of

public static WorldCopyClipboard of(Extent extent,
 Region region,
 boolean hasEntities,
 boolean hasBiomes)

getExtent

public Extent getExtent()

getFullBlock

public BaseBlock getFullBlock(int x,
 int y,
 int z)

getBlock

public BlockState getBlock(int x,
 int y,
 int z)

getBiomeType

public BiomeType getBiomeType(int x,
 int y,
 int z)

getBiome

public BiomeType getBiome(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.

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.

getEntities

@Deprecated
public List<? extends Entity> getEntities()

Deprecated.

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

Specified by:

getEntities in class ReadOnlyClipboard

Returns:

a list of entities

hasBiomes

public boolean hasBiomes()

Description copied from interface: Clipboard

Returns true if the clipboard has biome data. This can be checked since InputExtent.getBiome(BlockVector3) strongly suggests returning BiomeTypes.OCEAN instead of null if biomes aren't present.

Returns:

true if the clipboard has biome data set

paste

public void paste(Extent toExtent,
 BlockVector3 to,
 boolean pasteAir,
 boolean pasteEntities,
 boolean pasteBiomes)