AbstractDelegateExtent (WorldEdit 6.0.0-SNAPSHOT API)

java.lang.Object
- com.sk89q.worldedit.extent.AbstractDelegateExtent

All Implemented Interfaces:

Extent, InputExtent, OutputExtent

Direct Known Subclasses:

AbstractLoggingExtent, BlockBagExtent, BlockChangeLimiter, BlockQuirkExtent, BlockTransformExtent, ChangeSetExtent, ChunkLoadingExtent, DataValidatorExtent, FastModeExtent, ForgetfulExtentBuffer, LastAccessExtentCache, MaskingExtent, MultiStageReorder, SurvivalModeExtent
```
public abstract class AbstractDelegateExtent
extends Object
implements Extent
```
A base class for Extents that merely passes extents onto another.

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractDelegateExtent(Extent extent)
Create a new instance.

Constructors
Modifier	Constructor and Description
`protected`	`AbstractDelegateExtent(Extent extent)` Create a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Operation`	`commit()` Return an `Operation` that should be called to tie up loose ends (such as to commit changes in a buffer).
`protected Operation`	`commitBefore()`
`Entity`	`createEntity(Location location, BaseEntity entity)` Create an entity at the given location.
`BaseBiome`	`getBiome(Vector2D position)` Get the biome at the given location.
`BaseBlock`	`getBlock(Vector 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.
`Extent`	`getExtent()` Get the extent.
`BaseBlock`	`getLazyBlock(Vector position)` Get a lazy, immutable snapshot of the block at the given location that only immediately contains information about the block's type (and metadata).
`Vector`	`getMaximumPoint()` Get the maximum point in the extent.
`Vector`	`getMinimumPoint()` Get the minimum point in the extent.
`boolean`	`setBiome(Vector2D position, BaseBiome biome)` Set the biome.
`boolean`	`setBlock(Vector location, BaseBlock block)` Change the block at the given location to the given block.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractDelegateExtent
```
protected AbstractDelegateExtent(Extent extent)
```
    Create a new instance.
    
    Parameters:
    
    extent - the extent
- Method Detail
  - getExtent
```
public Extent getExtent()
```
    Get the extent.
    
    Returns:
    
    the extent
  - getBlock
```
public BaseBlock getBlock(Vector 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 mutable 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.
    
    Calls to this method can actually be quite expensive, so cache results whenever it is possible, while being aware of the mutability aspect. The cost, however, depends on the implementation and particular extent. If only basic information about the block is required, then use of InputExtent.getLazyBlock(Vector) is recommended.
    
    Specified by:
    
    getBlock in interface InputExtent
    
    Parameters:
    
    position - position of the block
    
    Returns:
    
    the block
  - getLazyBlock
```
public BaseBlock getLazyBlock(Vector position)
```
    Description copied from interface: InputExtent
    
    Get a lazy, immutable snapshot of the block at the given location that only immediately contains information about the block's type (and metadata).
    Further information (such as NBT data) will be available by the time of access. Therefore, it is not recommended that this method is used if the world is being simulated at the time of call. If the block needs to be stored for future use, then this method should definitely not be used. Moreover, the block that is returned is immutable (or should be), and therefore modifications should not be attempted on it. If a modifiable copy is required, then the block should be cloned.
    
    This method exists because it is sometimes important to inspect the block at a given location, but InputExtent.getBlock(Vector) may be too expensive in the underlying implementation. It is also not possible to implement caching if the returned object is mutable, so this methods allows caching implementations to be used.
    
    Specified by:
    
    getLazyBlock in interface InputExtent
    
    Parameters:
    
    position - position of the block
    
    Returns:
    
    the block
  - 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
    
    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 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
  - 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
  - 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
  - getBiome
```
public BaseBiome getBiome(Vector2D 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.
    
    Specified by:
    
    getBiome in interface InputExtent
    
    Parameters:
    
    position - the (x, z) location to check the biome at
    
    Returns:
    
    the biome at the location
  - setBiome
```
public boolean setBiome(Vector2D position,
                        BaseBiome biome)
```
    Description copied from interface: OutputExtent
    
    Set the biome.
    
    Specified by:
    
    setBiome in interface OutputExtent
    
    Parameters:
    
    position - the (x, 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)
  - getMinimumPoint
```
public Vector 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 Vector 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
  - commitBefore
```
protected Operation commitBefore()
```
  - commit
```
@Nullable
public final 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 OutputExtent
    
    Returns:
    
    an operation or null if there is none to execute

Class AbstractDelegateExtent

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractDelegateExtent

Method Detail

getExtent

getBlock

getLazyBlock

setBlock

createEntity

getEntities

getEntities

getBiome

setBiome

getMinimumPoint

getMaximumPoint

commitBefore

commit