Package com.sk89q.worldedit.session.request

Class RequestExtent

java.lang.Object

com.sk89q.worldedit.session.request.RequestExtent

All Implemented Interfaces:

Extent, InputExtent, OutputExtent

public class RequestExtent
extends Object
implements Extent

Constructor Summary

Constructors

Constructor	Description
RequestExtent()

Method Summary

Modifier and Type	Method	Description
Operation	commit()	Return an Operation that should be called to tie up loose ends (such as to commit changes in a buffer).
Entity	createEntity(Location location, BaseEntity entity)	Create an entity at the given location.
Entity	createEntity(Location location, BaseEntity entity, UUID uuid)	Create an entity at the given location, forcing a UUID onto the entity Only use if you are aware of the consequences of forcing a UUID to an entity.
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.
List<? extends Entity>	getEntities()	Get a list of all entities.
List<? extends Entity>	getEntities(Region region)	Get a list of all entities within the given region.
protected Extent	getExtent()
BaseBlock	getFullBlock(BlockVector3 position)	Get an immutable snapshot of the block at the given location.
BlockVector3	getMaximumPoint()	Get the maximum point in the extent.
BlockVector3	getMinimumPoint()	Get the minimum point in the extent.
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 position, T block)	Change the block at the given location to the given block.
boolean	tile(int x, int y, int z, FaweCompoundTag tile)	Sets a tile/block entity at the given location.

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

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

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

setBiome, setBlockLight, setBlockLight, setHeightMap, setSkyLight, setSkyLight, setTile

Constructor Details

RequestExtent

public RequestExtent()

Method Details

getExtent

protected Extent getExtent()

getMinimumPoint

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

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

getEntities

public List<? extends Entity> getEntities(Region region)

Description copied from interface: Extent

Get a list of all entities within the given region.

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

Parameters:

region - the region in which entities must be contained

Returns:

a list of entities

getEntities

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

Specified by:

getEntities in interface Extent

Returns:

a list of entities

createEntity

@Nullable
public Entity createEntity(Location location,
 BaseEntity entity)

Description copied from interface: Extent

Create an entity at the given location.

Specified by:

createEntity in interface Extent

Parameters:

location - the location

entity - the entity

Returns:

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

createEntity

@Nullable
public Entity createEntity(Location location,
 BaseEntity entity,
 UUID uuid)

Description copied from interface: Extent

Create an entity at the given location, forcing a UUID onto the entity Only use if you are aware of the consequences of forcing a UUID to an entity.

Specified by:

createEntity in interface Extent

Parameters:

location - the location

entity - the entity

uuid - UUID to force the entity to have

Returns:

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

getBlock

public BlockState getBlock(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

getFullBlock

public BaseBlock getFullBlock(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

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

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.

setBlock

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

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

Specified by:

setBlock in interface OutputExtent

Throws:

WorldEditException

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

tile

public boolean tile(int x,
 int y,
 int z,
 FaweCompoundTag tile)
             throws WorldEditException

Description copied from interface: OutputExtent

Sets a tile/block entity at the given location.

Specified by:

tile in interface OutputExtent

Parameters:

x - the x position

y - the y position

z - the z position

tile - the tile/block entity to set

Returns:

true if the tile/block entity was placed

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

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

commit

@Nullable
public Operation commit()

Description copied from interface: OutputExtent

Return an Operation that should be called to tie up loose ends (such as to commit changes in a buffer).

Specified by:

commit in interface Extent

Specified by:

commit in interface OutputExtent

Returns:

an operation or null if there is none to execute