Package com.fastasyncworldedit.core.extent

Class BlockTranslateExtent

java.lang.Object

com.sk89q.worldedit.extent.AbstractDelegateExtent

com.fastasyncworldedit.core.extent.BlockTranslateExtent

All Implemented Interfaces:

Extent, InputExtent, OutputExtent

public class BlockTranslateExtent
extends AbstractDelegateExtent

Field Summary

Fields inherited from class com.sk89q.worldedit.extent.AbstractDelegateExtent

extent

Constructor Summary

Constructors

Constructor	Description
BlockTranslateExtent(Extent extent, int dx, int dy, int dz)

Method Summary

Modifier and Type	Method	Description
BiomeType	getBiome(BlockVector3 position)	Get the biome at the given location.
BlockState	getBlock(int x, int y, int z)
BlockState	getBlock(BlockVector3 location)	Get a snapshot of the block at the given location.
BaseBlock	getFullBlock(BlockVector3 pos)	Get an immutable snapshot of the block at the given location.
boolean	setBiome(int x, int y, int z, BiomeType biome)
boolean	setBiome(BlockVector3 position, BiomeType biome)	Set the biome.
<T extends BlockStateHolder<T>> boolean	setBlock(int x, int y, int z, T block)
<T extends BlockStateHolder<T>> boolean	setBlock(BlockVector3 location, T block)	Change the block at the given location to the given block.

Methods inherited from class com.sk89q.worldedit.extent.AbstractDelegateExtent

addPostProcessor, addProcessor, cancel, commit, commitBefore, createEntity, disableHistory, disableQueue, enableQueue, fullySupports3DBiomes, getBiomeType, getBrightness, getEmittedLight, getEntities, getEntities, getExtent, getFullBlock, getMaximumPoint, getMaxY, getMinimumPoint, getMinY, getSkyLight, isQueueEnabled, relight, relightBlock, relightSky, removeEntity, setBlockLight, setChangeSet, setSkyLight, setTile, toString

Methods inherited from class java.lang.Object

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

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

addCaves, addOre, addOres, addSchems, apply, apply, center, contains, contains, countBlocks, countBlocks, enableHistory, generate, getBlockDistribution, getBlockDistributionWithData, getHighestTerrainBlock, getHighestTerrainBlock, getNearestSurfaceLayer, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, isWorld, lazyCopy, regenerateChunk, replaceBlocks, replaceBlocks, replaceBlocks, setBlocks, setBlocks, setBlocks, spawnResource

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

getBiome, getBrightness, getEmittedLight, getHeightMap, getOpacity, getOpacity, getSkyLight

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

setBiome, setBlockLight, setHeightMap, setSkyLight

Constructor Details

BlockTranslateExtent

public BlockTranslateExtent(Extent extent,
 int dx,
 int dy,
 int dz)

Method Details

setBlock

public <T extends BlockStateHolder<T>> boolean setBlock(BlockVector3 location,
 T 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

Overrides:

setBlock in class AbstractDelegateExtent

Parameters:

location - 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 <T extends BlockStateHolder<T>> boolean setBlock(int x,
 int y,
 int z,
 T block)
                                                 throws WorldEditException

Specified by:

setBlock in interface OutputExtent

Overrides:

setBlock in class AbstractDelegateExtent

Throws:

WorldEditException

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.

Specified by:

setBiome in interface OutputExtent

Overrides:

setBiome in class AbstractDelegateExtent

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)

setBiome

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

Specified by:

setBiome in interface OutputExtent

Overrides:

setBiome in class AbstractDelegateExtent

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.

Specified by:

getBiome in interface InputExtent

Overrides:

getBiome in class AbstractDelegateExtent

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.

getBlock

public BlockState getBlock(BlockVector3 location)

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

Overrides:

getBlock in class AbstractDelegateExtent

Parameters:

location - position of the block

Returns:

the block

getBlock

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

Specified by:

getBlock in interface InputExtent

Overrides:

getBlock in class AbstractDelegateExtent

getFullBlock

public BaseBlock getFullBlock(BlockVector3 pos)

Description copied from interface: InputExtent

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

Specified by:

getFullBlock in interface InputExtent

Overrides:

getFullBlock in class AbstractDelegateExtent

Parameters:

pos - position of the block

Returns:

the block