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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Entity	createEntity(Location location, BaseEntity state) Create an entity 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.
boolean	setBlock(Vector location, BaseBlock block) Change the block at the given location to the given block.

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

commit, commitBefore, getBiome, getBlock, getExtent, getLazyBlock, getMaximumPoint, getMinimumPoint, setBiome

Methods inherited from class java.lang.Object

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

Constructor Detail

ChangeSetExtent

public ChangeSetExtent(Extent extent,
                       ChangeSet changeSet)

Create a new instance.

Parameters:

extent - the extent

changeSet - the change set

Method Detail

setBlock

public boolean setBlock(Vector location,
                        BaseBlock 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 BaseBlock to the world, so future changes to the BaseBlock 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

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

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