com.sk89q.worldedit.bukkit

Class BukkitWorld

java.lang.Object

com.sk89q.worldedit.world.AbstractWorld

com.sk89q.worldedit.LocalWorld

com.sk89q.worldedit.bukkit.BukkitWorld

All Implemented Interfaces:

Extent, InputExtent, OutputExtent, World

public class BukkitWorld
extends LocalWorld

Constructor Summary

Constructors

Constructor and Description
BukkitWorld(org.bukkit.World world) Construct the object.

Method Summary

Modifier and Type	Method and Description
void	checkLoadedChunk(Vector pt) Load the chunk at the given position if it isn't loaded.
boolean	clearContainerBlockContents(Vector pt) Clear a chest's contents.
Entity	createEntity(Location location, BaseEntity entity) Create an entity at the given location.
void	dropItem(Vector pt, BaseItemStack item) Drop one stack of the item at the given position.
boolean	equals(Object other)
void	fixAfterFastMode(Iterable<BlockVector2D> chunks) Fix the given chunks after fast mode was used.
boolean	generateBigTree(EditSession editSession, Vector pt) Deprecated.
boolean	generateBirchTree(EditSession editSession, Vector pt) Deprecated.
boolean	generateRedwoodTree(EditSession editSession, Vector pt) Deprecated.
boolean	generateTallRedwoodTree(EditSession editSession, Vector pt) Deprecated.
boolean	generateTree(EditSession editSession, Vector pt) Deprecated.
boolean	generateTree(TreeGenerator.TreeType type, EditSession editSession, Vector pt) 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	getBlockLightLevel(Vector pt) Get the light level at the given block.
List<Entity>	getEntities() Get a list of all entities.
List<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).
int	getMaxY() Get the maximum Y.
String	getName() Get the name of the world.
org.bukkit.World	getWorld() Get the world handle.
protected org.bukkit.World	getWorldChecked() Get the world handle.
WorldData	getWorldData() Get the data for blocks and so on for this world.
int	hashCode()
boolean	isValidBlockType(int type) Checks whether the given block ID is a valid block ID.
boolean	playEffect(Vector position, int type, int data) Play the given 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.
boolean	setBlock(Vector pt, Block block, boolean notifyAdjacent) Deprecated. Use setBlock(Vector, BaseBlock, boolean)
void	simulateBlockMine(Vector pt) Simulate a block being mined at the given position.
static org.bukkit.TreeType	toBukkitTreeType(TreeGenerator.TreeType type)

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

commit, createLiquidMask, dropItem, fixLighting, getBlockData, getBlockType, getMaximumPoint, getMinimumPoint, queueBlockBreakEffect, setBlock, setBlockData, setBlockType, setTypeIdAndData, usesBlockData

Methods inherited from class java.lang.Object

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

Constructor Detail

BukkitWorld

public BukkitWorld(org.bukkit.World world)

Construct the object.

Parameters:

world - the world

Method Detail

getEntities

public List<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

getEntities

public List<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

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

getWorld

public org.bukkit.World getWorld()

Get the world handle.

Returns:

the world

getWorldChecked

protected org.bukkit.World getWorldChecked()
                                    throws WorldEditException

Get the world handle.

Returns:

the world

Throws:

WorldEditException

getName

public String getName()

Description copied from interface: World

Get the name of the world.

Returns:

a name for the world

getBlockLightLevel

public int getBlockLightLevel(Vector pt)

Description copied from interface: World

Get the light level at the given block.

Parameters:

pt - the position

Returns:

the light level (0-15)

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

clearContainerBlockContents

public boolean clearContainerBlockContents(Vector pt)

Description copied from interface: World

Clear a chest's contents.

Parameters:

pt - the position

Returns:

true if the container was cleared

generateTree

@Deprecated
public boolean generateTree(EditSession editSession,
                                        Vector pt)

Deprecated.

Specified by:

generateTree in interface World

Overrides:

generateTree in class LocalWorld

generateBigTree

@Deprecated
public boolean generateBigTree(EditSession editSession,
                                           Vector pt)

Deprecated.

Specified by:

generateBigTree in interface World

Overrides:

generateBigTree in class LocalWorld

generateBirchTree

@Deprecated
public boolean generateBirchTree(EditSession editSession,
                                             Vector pt)

Deprecated.

Specified by:

generateBirchTree in interface World

Overrides:

generateBirchTree in class LocalWorld

generateRedwoodTree

@Deprecated
public boolean generateRedwoodTree(EditSession editSession,
                                               Vector pt)

Deprecated.

Specified by:

generateRedwoodTree in interface World

Overrides:

generateRedwoodTree in class LocalWorld

generateTallRedwoodTree

@Deprecated
public boolean generateTallRedwoodTree(EditSession editSession,
                                                   Vector pt)

Deprecated.

Specified by:

generateTallRedwoodTree in interface World

Overrides:

generateTallRedwoodTree in class LocalWorld

toBukkitTreeType

public static org.bukkit.TreeType toBukkitTreeType(TreeGenerator.TreeType type)

generateTree

public boolean generateTree(TreeGenerator.TreeType type,
                            EditSession editSession,
                            Vector pt)

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

pt - the position

Returns:

true if generation was successful

dropItem

public void dropItem(Vector pt,
                     BaseItemStack item)

Description copied from interface: World

Drop one stack of the item at the given position.

Parameters:

pt - the position

item - the item to drop

See Also:

shortcut method to specify the number of stacks

isValidBlockType

public boolean isValidBlockType(int type)

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:

type - the block ID

Returns:

true if the block ID is a valid one

checkLoadedChunk

public void checkLoadedChunk(Vector pt)

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:

pt - the position

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

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

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

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

getWorldData

public WorldData getWorldData()

Description copied from interface: World

Get the data for blocks and so on for this world.

Returns:

the world data

simulateBlockMine

public void simulateBlockMine(Vector pt)

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:

pt - the position

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

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

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

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)

setBlock

@Deprecated
public boolean setBlock(Vector pt,
                                    Block block,
                                    boolean notifyAdjacent)
                             throws WorldEditException

Deprecated. Use setBlock(Vector, BaseBlock, boolean)

Throws:

WorldEditException