LocalWorldAdapter (WorldEdit 6.0.0-SNAPSHOT API)

java.lang.Object
- com.sk89q.worldedit.world.AbstractWorld
- - com.sk89q.worldedit.LocalWorld
  - - com.sk89q.worldedit.internal.LocalWorldAdapter

All Implemented Interfaces:

Extent, InputExtent, OutputExtent, World
```
public class LocalWorldAdapter
extends LocalWorld
```
Wraps Worlds into LocalWorld.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static LocalWorldAdapter`	`adapt(World world)`
`void`	`checkLoadedChunk(Vector position)` Load the chunk at the given position if it isn't loaded.
`boolean`	`clearContainerBlockContents(Vector position)` Clear a chest's contents.
`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.
`Mask`	`createLiquidMask()` Create a mask that matches all liquids.
`void`	`dropItem(Vector position, BaseItemStack item)` Drop one stack of the item at the given position.
`void`	`dropItem(Vector position, BaseItemStack item, int count)` Drop an item at the given position.
`boolean`	`equals(Object other)`
`void`	`fixAfterFastMode(Iterable<BlockVector2D> chunks)` Fix the given chunks after fast mode was used.
`void`	`fixLighting(Iterable<BlockVector2D> chunks)` Relight the given chunks if possible.
`boolean`	`generateBigTree(EditSession editSession, Vector position)` Deprecated.
`boolean`	`generateBirchTree(EditSession editSession, Vector position)` Deprecated.
`boolean`	`generateRedwoodTree(EditSession editSession, Vector position)` Deprecated.
`boolean`	`generateTallRedwoodTree(EditSession editSession, Vector position)` Deprecated.
`boolean`	`generateTree(EditSession editSession, Vector position)` Deprecated.
`boolean`	`generateTree(TreeGenerator.TreeType type, EditSession editSession, Vector position)` Generate a tree at the given position.
`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.
`int`	`getBlockData(Vector pt)` Deprecated.
`int`	`getBlockLightLevel(Vector position)` Get the light level at the given block.
`int`	`getBlockType(Vector pt)` Deprecated.
`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.
`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.
`int`	`getMaxY()` Get the maximum Y.
`Vector`	`getMinimumPoint()` Get the minimum point in the extent.
`String`	`getName()` Get the name of the world.
`WorldData`	`getWorldData()` Get the data for blocks and so on for this world.
`int`	`hashCode()`
`boolean`	`isValidBlockType(int id)` Checks whether the given block ID is a valid block ID.
`boolean`	`playEffect(Vector position, int type, int data)` Play the given effect.
`boolean`	`queueBlockBreakEffect(Platform server, Vector position, int blockId, double priority)` Queue a block break effect.
`boolean`	`regenerate(Region region, EditSession editSession)` Regenerate an area.
`boolean`	`setBiome(Vector2D position, BaseBiome biome)` Set the biome.
`boolean`	`setBlock(Vector position, BaseBlock block, boolean notifyAndLight)` Similar to `OutputExtent.setBlock(Vector, BaseBlock)` but a `notifyAndLight` parameter indicates whether adjacent blocks should be notified that changes have been made and lighting operations should be executed.
`void`	`simulateBlockMine(Vector position)` Simulate a block being mined at the given position.
`boolean`	`usesBlockData(int id)` Checks whether the given block ID uses data values for differentiating types of blocks.

Methods inherited from class com.sk89q.worldedit.world.AbstractWorld
setBlock, setBlockData, setBlockType, setTypeIdAndData

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

- Method Detail
  - getName
```
public String getName()
```
    Description copied from interface: World
    
    Get the name of the world.
    
    Returns:
    
    a name for the world
  - getMaxY
```
public int getMaxY()
```
    Description copied from interface: World
    
    Get the maximum Y.
    
    Specified by:
    
    getMaxY in interface World
    
    Overrides:
    
    getMaxY in class AbstractWorld
    
    Returns:
    
    the maximum Y
  - isValidBlockType
```
public boolean isValidBlockType(int id)
```
    Description copied from interface: World
    
    Checks whether the given block ID is a valid block ID.
    
    Specified by:
    
    isValidBlockType in interface World
    
    Overrides:
    
    isValidBlockType in class AbstractWorld
    
    Parameters:
    
    id - the block ID
    
    Returns:
    
    true if the block ID is a valid one
  - usesBlockData
```
public boolean usesBlockData(int id)
```
    Description copied from interface: World
    
    Checks whether the given block ID uses data values for differentiating types of blocks.
    
    Specified by:
    
    usesBlockData in interface World
    
    Overrides:
    
    usesBlockData in class AbstractWorld
    
    Parameters:
    
    id - the block ID
    
    Returns:
    
    true if the block uses data values
  - createLiquidMask
```
public Mask createLiquidMask()
```
    Description copied from interface: World
    
    Create a mask that matches all liquids.
    Implementations should override this so that custom liquids are supported.
    
    Specified by:
    
    createLiquidMask in interface World
    
    Overrides:
    
    createLiquidMask in class AbstractWorld
    
    Returns:
    
    a mask
  - getBlockType
```
@Deprecated
public int getBlockType(Vector pt)
```
    Deprecated.
    
    Specified by:
    
    getBlockType in interface World
    
    Overrides:
    
    getBlockType in class AbstractWorld
  - getBlockData
```
@Deprecated
public int getBlockData(Vector pt)
```
    Deprecated.
    
    Specified by:
    
    getBlockData in interface World
    
    Overrides:
    
    getBlockData in class AbstractWorld
  - setBlock
```
public boolean setBlock(Vector position,
                        BaseBlock block,
                        boolean notifyAndLight)
                 throws WorldEditException
```
    Description copied from interface: World
    
    Similar to OutputExtent.setBlock(Vector, BaseBlock) but a notifyAndLight parameter indicates whether adjacent blocks should be notified that changes have been made and lighting operations should be executed.
    If it's not possible to skip lighting, or if it's not possible to avoid notifying adjacent blocks, then attempt to meet the specification as best as possible.
    
    On implementations where the world is not simulated, the notifyAndLight parameter has no effect either way.
    
    Parameters:
    
    position - position of the block
    
    block - block to set
    
    notifyAndLight - true to to notify and light
    
    Returns:
    
    true if the block was successfully set (return value may not be accurate)
    
    Throws:
    
    WorldEditException
  - getBlockLightLevel
```
public int getBlockLightLevel(Vector position)
```
    Description copied from interface: World
    
    Get the light level at the given block.
    
    Parameters:
    
    position - the position
    
    Returns:
    
    the light level (0-15)
  - clearContainerBlockContents
```
public boolean clearContainerBlockContents(Vector position)
```
    Description copied from interface: World
    
    Clear a chest's contents.
    
    Parameters:
    
    position - the position
    
    Returns:
    
    true if the container was cleared
  - 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.
    
    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.
    
    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)
  - dropItem
```
public void dropItem(Vector position,
                     BaseItemStack item,
                     int count)
```
    Description copied from interface: World
    
    Drop an item at the given position.
    
    Specified by:
    
    dropItem in interface World
    
    Overrides:
    
    dropItem in class AbstractWorld
    
    Parameters:
    
    position - the position
    
    item - the item to drop
    
    count - the number of individual stacks to drop (number of item entities)
  - dropItem
```
public void dropItem(Vector position,
                     BaseItemStack item)
```
    Description copied from interface: World
    
    Drop one stack of the item at the given position.
    
    Parameters:
    
    position - the position
    
    item - the item to drop
    
    See Also:
    
    shortcut method to specify the number of stacks
  - simulateBlockMine
```
public void simulateBlockMine(Vector position)
```
    Description copied from interface: World
    
    Simulate a block being mined at the given position.
    
    Specified by:
    
    simulateBlockMine in interface World
    
    Overrides:
    
    simulateBlockMine in class AbstractWorld
    
    Parameters:
    
    position - the position
  - regenerate
```
public boolean regenerate(Region region,
                          EditSession editSession)
```
    Description copied from interface: World
    
    Regenerate an area.
    
    Parameters:
    
    region - the region
    
    editSession - the EditSession
    
    Returns:
    
    true if re-generation was successful
  - generateTree
```
public boolean generateTree(TreeGenerator.TreeType type,
                            EditSession editSession,
                            Vector position)
                     throws MaxChangedBlocksException
```
    Description copied from interface: World
    
    Generate a tree at the given position.
    
    Specified by:
    
    generateTree in interface World
    
    Overrides:
    
    generateTree in class LocalWorld
    
    Parameters:
    
    type - the tree type
    
    editSession - the EditSession
    
    position - the position
    
    Returns:
    
    true if generation was successful
    
    Throws:
    
    MaxChangedBlocksException - thrown if too many blocks were changed
  - generateTree
```
@Deprecated
public boolean generateTree(EditSession editSession,
                                        Vector position)
                                 throws MaxChangedBlocksException
```
    Deprecated.
    
    Specified by:
    
    generateTree in interface World
    
    Overrides:
    
    generateTree in class LocalWorld
    
    Throws:
    
    MaxChangedBlocksException
  - generateBigTree
```
@Deprecated
public boolean generateBigTree(EditSession editSession,
                                           Vector position)
                                    throws MaxChangedBlocksException
```
    Deprecated.
    
    Specified by:
    
    generateBigTree in interface World
    
    Overrides:
    
    generateBigTree in class LocalWorld
    
    Throws:
    
    MaxChangedBlocksException
  - generateBirchTree
```
@Deprecated
public boolean generateBirchTree(EditSession editSession,
                                             Vector position)
                                      throws MaxChangedBlocksException
```
    Deprecated.
    
    Specified by:
    
    generateBirchTree in interface World
    
    Overrides:
    
    generateBirchTree in class LocalWorld
    
    Throws:
    
    MaxChangedBlocksException
  - generateRedwoodTree
```
@Deprecated
public boolean generateRedwoodTree(EditSession editSession,
                                               Vector position)
                                        throws MaxChangedBlocksException
```
    Deprecated.
    
    Specified by:
    
    generateRedwoodTree in interface World
    
    Overrides:
    
    generateRedwoodTree in class LocalWorld
    
    Throws:
    
    MaxChangedBlocksException
  - generateTallRedwoodTree
```
@Deprecated
public boolean generateTallRedwoodTree(EditSession editSession,
                                                   Vector position)
                                            throws MaxChangedBlocksException
```
    Deprecated.
    
    Specified by:
    
    generateTallRedwoodTree in interface World
    
    Overrides:
    
    generateTallRedwoodTree in class LocalWorld
    
    Throws:
    
    MaxChangedBlocksException
  - checkLoadedChunk
```
public void checkLoadedChunk(Vector position)
```
    Description copied from interface: World
    
    Load the chunk at the given position if it isn't loaded.
    
    Specified by:
    
    checkLoadedChunk in interface World
    
    Overrides:
    
    checkLoadedChunk in class AbstractWorld
    
    Parameters:
    
    position - the position
  - fixAfterFastMode
```
public void fixAfterFastMode(Iterable<BlockVector2D> chunks)
```
    Description copied from interface: World
    
    Fix the given chunks after fast mode was used.
    Fast mode makes calls to World.setBlock(Vector, BaseBlock, boolean) with false for the notifyAndLight parameter, which may causes lighting errors to accumulate. Use of this method, if it is implemented by the underlying world, corrects those lighting errors and may trigger block change notifications.
    
    Specified by:
    
    fixAfterFastMode in interface World
    
    Overrides:
    
    fixAfterFastMode in class AbstractWorld
    
    Parameters:
    
    chunks - a list of chunk coordinates to fix
  - fixLighting
```
public void fixLighting(Iterable<BlockVector2D> chunks)
```
    Description copied from interface: World
    
    Relight the given chunks if possible.
    
    Specified by:
    
    fixLighting in interface World
    
    Overrides:
    
    fixLighting in class AbstractWorld
    
    Parameters:
    
    chunks - a list of chunk coordinates to fix
  - playEffect
```
public boolean playEffect(Vector position,
                          int type,
                          int data)
```
    Description copied from interface: World
    
    Play the given effect.
    
    Specified by:
    
    playEffect in interface World
    
    Overrides:
    
    playEffect in class AbstractWorld
    
    Parameters:
    
    position - the position
    
    type - the effect type
    
    data - the effect data
    
    Returns:
    
    true if the effect was played
  - queueBlockBreakEffect
```
public boolean queueBlockBreakEffect(Platform server,
                                     Vector position,
                                     int blockId,
                                     double priority)
```
    Description copied from interface: World
    
    Queue a block break effect.
    
    Specified by:
    
    queueBlockBreakEffect in interface World
    
    Overrides:
    
    queueBlockBreakEffect in class AbstractWorld
    
    Parameters:
    
    server - the server
    
    position - the position
    
    blockId - the block ID
    
    priority - the priority
    
    Returns:
    
    true if the effect was played
  - getWorldData
```
public WorldData getWorldData()
```
    Description copied from interface: World
    
    Get the data for blocks and so on for this world.
    
    Returns:
    
    the world data
  - equals
```
public boolean equals(Object other)
```
    Specified by:
    
    equals in interface World
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface World
    
    Overrides:
    
    hashCode in class Object
  - 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
    
    Overrides:
    
    getMinimumPoint in class AbstractWorld
    
    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
    
    Overrides:
    
    getMaximumPoint in class AbstractWorld
    
    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.
    
    Parameters:
    
    region - the region in which entities must be contained
    
    Returns:
    
    a list of entities
  - 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.
    
    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
    
    Overrides:
    
    getLazyBlock in class LocalWorld
    
    Parameters:
    
    position - position of the block
    
    Returns:
    
    the block
  - 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 OutputExtent
    
    Overrides:
    
    commit in class AbstractWorld
    
    Returns:
    
    an operation or null if there is none to execute
  - createEntity
```
@Nullable
public Entity createEntity(Location location,
                                     BaseEntity entity)
```
    Description copied from interface: Extent
    
    Create an entity at the given location.
    
    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.
    
    Returns:
    
    a list of entities
  - adapt
```
public static LocalWorldAdapter adapt(World world)
```

Class LocalWorldAdapter

Method Summary

Methods inherited from class com.sk89q.worldedit.world.AbstractWorld

Methods inherited from class java.lang.Object

Method Detail

getName

getMaxY

isValidBlockType

usesBlockData

createLiquidMask

getBlockType

getBlockData

setBlock

getBlockLightLevel

clearContainerBlockContents

getBiome

setBiome

dropItem

dropItem

simulateBlockMine

regenerate

generateTree

generateTree

generateBigTree

generateBirchTree

generateRedwoodTree

generateTallRedwoodTree

checkLoadedChunk

fixAfterFastMode

fixLighting

playEffect

queueBlockBreakEffect

getWorldData

equals

hashCode

getMinimumPoint

getMaximumPoint

getEntities

getBlock

getLazyBlock

commit

createEntity

getEntities

adapt