Package com.fastasyncworldedit.core.extent.clipboard

Class ReadOnlyClipboard

java.lang.Object

com.fastasyncworldedit.core.extent.clipboard.SimpleClipboard

com.fastasyncworldedit.core.extent.clipboard.ReadOnlyClipboard

All Implemented Interfaces:

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

Direct Known Subclasses:

WorldCopyClipboard

public abstract class ReadOnlyClipboard
extends SimpleClipboard

Field Summary

Fields

Modifier and Type	Field	Description
final Region	region

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

offset

Constructor Summary

Constructors

Constructor	Description
ReadOnlyClipboard(Region region)

Method Summary

Modifier and Type	Method	Description
Entity	createEntity(Location location, BaseEntity entity)	Create an entity at the given location.
abstract List<? extends Entity>	getEntities()	Get a list of all entities.
Region	getRegion()	Get the bounding region of this extent.
static ReadOnlyClipboard	of(Extent extent, Region region)
static ReadOnlyClipboard	of(Extent extent, Region region, boolean copyEntities, boolean copyBiomes)
static ReadOnlyClipboard	of(Region region)
static ReadOnlyClipboard	of(Region region, boolean copyEntities, boolean copyBiomes)
static ReadOnlyClipboard	of(Supplier<Extent> supplier, Region region)
static ReadOnlyClipboard	of(Supplier<Extent> supplier, Region region, boolean copyEntities, boolean copyBiomes)
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.
<B extends BlockStateHolder<B>> boolean	setBlock(int x, int y, int z, B block)
boolean	setTile(int x, int y, int z, CompoundTag tag)

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

getArea, getDimensions, getHeight, getLength, getMaximumPoint, getMinimumPoint, 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, 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, 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, getBiome, getBiomeType, getBlock, getBlock, getBrightness, getBrightness, getEmittedLight, getEmittedLight, getFullBlock, 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

Field Details

region

public final Region region

Constructor Details

ReadOnlyClipboard

public ReadOnlyClipboard(Region region)

Method Details

of

public static ReadOnlyClipboard of(Region region)

of

public static ReadOnlyClipboard of(Region region,
 boolean copyEntities,
 boolean copyBiomes)

of

public static ReadOnlyClipboard of(Extent extent,
 Region region)

of

public static ReadOnlyClipboard of(Extent extent,
 Region region,
 boolean copyEntities,
 boolean copyBiomes)

of

public static ReadOnlyClipboard of(Supplier<Extent> supplier,
 Region region)

of

public static ReadOnlyClipboard of(Supplier<Extent> supplier,
 Region region,
 boolean copyEntities,
 boolean copyBiomes)

getRegion

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

Overrides:

getRegion in class SimpleClipboard

Returns:

the bounding region

setBiome

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

setBiome

public boolean setBiome(BlockVector3 position,
 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.

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)

getEntities

public abstract List<? extends Entity> 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.

Returns:

a list of entities

setBlock

public <B extends BlockStateHolder<B>> boolean setBlock(int x,
 int y,
 int z,
 B block)

setTile

public boolean setTile(int x,
 int y,
 int z,
 CompoundTag tag)

createEntity

public Entity createEntity(Location location,
 BaseEntity entity)

Description copied from interface: Extent

Create an entity at the given location.

Parameters:

location - the location

entity - the entity

Returns:

a reference to the created entity, or null if the entity could not be created

removeEntity

public void removeEntity(Entity entity)

Description copied from interface: Clipboard

Remove entity from clipboard.