Package com.sk89q.worldedit.extent

Class ChangeSetExtent

java.lang.Object

com.sk89q.worldedit.extent.AbstractDelegateExtent

com.sk89q.worldedit.extent.ChangeSetExtent

All Implemented Interfaces:

Extent, InputExtent, OutputExtent

public class ChangeSetExtent
extends AbstractDelegateExtent

Stores changes to a ChangeSet.

Field Summary

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

extent

Constructor Summary

Constructors

Constructor	Description
ChangeSetExtent(Extent extent, ChangeSet changeSet)	Create a new instance.
ChangeSetExtent(Extent extent, ChangeSet changeSet, boolean enabled)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
Entity	createEntity(Location location, BaseEntity state)	Create an entity at the given location.
Entity	createEntity(Location location, BaseEntity state, 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.
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.
boolean	isEnabled()	If this extent is enabled and should perform change tracking.
boolean	setBiome(BlockVector3 position, BiomeType biome)	Set the biome.
<B extends BlockStateHolder<B>> boolean	setBlock(BlockVector3 location, B block)	Change the block at the given location to the given block.
void	setEnabled(boolean enabled)	Sets whether this extent is enabled and should perform change tracking.

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, 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, 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, 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

ChangeSetExtent

public ChangeSetExtent(Extent extent,
 ChangeSet changeSet)

Create a new instance.

Parameters:

extent - the extent

changeSet - the change set

ChangeSetExtent

public ChangeSetExtent(Extent extent,
 ChangeSet changeSet,
 boolean enabled)

Create a new instance.

Parameters:

extent - the extent

changeSet - the change set

enabled - if the extent is enabled

Method Details

isEnabled

public boolean isEnabled()

If this extent is enabled and should perform change tracking.

Returns:

if enabled

setEnabled

public void setEnabled(boolean enabled)

Sets whether this extent is enabled and should perform change tracking.

Parameters:

enabled - whether to enable

setBlock

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

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

state - 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 state,
 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

state - 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

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

Overrides:

getEntities in class AbstractDelegateExtent

Returns:

a list of entities

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

Overrides:

getEntities in class AbstractDelegateExtent

Parameters:

region - the region in which entities must be contained

Returns:

a list of entities