Package com.sk89q.worldedit.extent

Class TracingExtent

java.lang.Object

com.sk89q.worldedit.extent.AbstractDelegateExtent

com.sk89q.worldedit.extent.TracingExtent

All Implemented Interfaces:

Extent, InputExtent, OutputExtent

public class TracingExtent
extends AbstractDelegateExtent

An extent that can report back if an operation fails due to the extent(s) below it. Internal use only.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TracingExtent.Action

Field Summary

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

extent

Constructor Summary

Constructors

Constructor	Description
TracingExtent(Extent extent)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
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.
com.google.common.collect.SetMultimap<BlockVector3,TracingExtent.Action>	getFailedActions()
Set<BlockVector3>	getTouchedLocations()
boolean	isActive()
boolean	setBiome(BlockVector3 position, BiomeType biome)	Set the biome.
<T extends BlockStateHolder<T>> boolean	setBlock(BlockVector3 location, T block)	Change the block at the given location to the given block.
String	toString()

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

addPostProcessor, addProcessor, apply, cancel, commit, commitBefore, countBlocks, countBlocks, disableHistory, disableQueue, enableQueue, fullySupports3DBiomes, getBiome, getBiomeType, getBlock, getBlock, getBlockDistribution, getBlockDistributionWithData, getBrightness, getEmittedLight, getEntities, getEntities, getExtent, getFullBlock, getFullBlock, getMaximumPoint, getMaxY, getMinimumPoint, getMinY, getSkyLight, isQueueEnabled, isWorld, relight, relightBlock, relightSky, removeEntity, replaceBlocks, replaceBlocks, replaceBlocks, setBiome, setBlock, setBlockLight, setBlocks, setBlocks, setBlocks, setChangeSet, setSkyLight, tile

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, center, contains, contains, enableHistory, generate, getHighestTerrainBlock, getHighestTerrainBlock, getNearestSurfaceLayer, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, lazyCopy, regenerateChunk, 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, setTile

Constructor Details

TracingExtent

public TracingExtent(Extent extent)

Create a new instance.

Parameters:

extent - the extent

Method Details

isActive

public boolean isActive()

getTouchedLocations

public Set<BlockVector3> getTouchedLocations()

getFailedActions

public com.google.common.collect.SetMultimap<BlockVector3,TracingExtent.Action> getFailedActions()

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

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)

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

Overrides:

createEntity in class AbstractDelegateExtent

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

Overrides:

createEntity in class AbstractDelegateExtent

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

toString

public String toString()

Overrides:

toString in class AbstractDelegateExtent