Package com.sk89q.worldedit.extent.clipboard

Interface Clipboard

All Superinterfaces:

Extent, InputExtent, OutputExtent

All Known Implementing Classes:

BlockArrayClipboard

public interface Clipboard
extends Extent

Specifies an object that implements something suitable as a "clipboard."

Method Summary

Modifier and Type	Method	Description
BlockVector3	getDimensions()	Get the dimensions of the copy, which is at minimum (1, 1, 1).
BlockVector3	getOrigin()	Get the origin point from which the copy was made from.
Region	getRegion()	Get the bounding region of this extent.
default boolean	hasBiomes()	Returns true if the clipboard has biome data.
void	setOrigin(BlockVector3 origin)	Set the origin point from which the copy was made from.

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

createEntity, getEntities, getEntities, getMaximumPoint, getMinimumPoint

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

getBiome, getBiome, getBlock, getFullBlock

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

commit, fullySupports3DBiomes, setBiome, setBiome, setBlock

Method Details

getRegion

Region getRegion()

Get the bounding region of this extent.

Implementations should return a copy of the region.

Returns:

the bounding region

getDimensions

BlockVector3 getDimensions()

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

Returns:

the dimensions

getOrigin

BlockVector3 getOrigin()

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

Returns:

the origin

setOrigin

void setOrigin(BlockVector3 origin)

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

Parameters:

origin - the origin

hasBiomes

default boolean hasBiomes()

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