com.sk89q.worldedit.bukkit

Class BukkitWorld

java.lang.Object

com.sk89q.worldedit.LocalWorld

com.sk89q.worldedit.bukkit.BukkitWorld

All Implemented Interfaces:

World

public class BukkitWorld
extends LocalWorld

Nested Class Summary

Nested classes/interfaces inherited from class com.sk89q.worldedit.LocalWorld

LocalWorld.KillFlags

Field Summary

Fields inherited from class com.sk89q.worldedit.LocalWorld

random

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	checkLoadedChunk(Vector pt) Checks if the chunk pt is in is loaded.
boolean	clearContainerBlockContents(Vector pt) Clear a chest's contents.
boolean	copyFromWorld(Vector pt, BaseBlock block) Attempts to read a BaseBlock's extra data from the world.
boolean	copyToWorld(Vector pt, BaseBlock block) Attempts to accurately copy a BaseBlock's extra data to the world.
void	dropItem(Vector pt, BaseItemStack item) Drop an item.
boolean	equals(Object other) Compare if the other world is equal.
void	fixAfterFastMode(Iterable<BlockVector2D> chunks) Does some post-processing.
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) Generates a tree
BiomeType	getBiome(Vector2D pt) Get biome type
BaseBlock	getBlock(Vector pt) Get a copy of the block at the given location.
int	getBlockData(Vector pt) Get block data.
int	getBlockLightLevel(Vector pt) Get block light level.
int	getBlockType(Vector pt) Get block type.
LocalEntity[]	getEntities(Region region)
int	getMaxY() Get the world's height
String	getName() Get the name of the world
org.bukkit.World	getWorld() Get the world handle.
int	hashCode() Hash code.
boolean	isValidBlockType(int type) Returns whether a block has a valid ID.
int	killEntities(LocalEntity... entities)
int	killMobs(Vector origin, double radius, int flags) Kill mobs in an area.
boolean	playEffect(Vector position, int type, int data) Plays the minecraft effect with the given type and data at the given position.
boolean	regenerate(Region region, EditSession editSession) Regenerate an area.
int	removeEntities(EntityType type, Vector origin, int radius) Remove entities in an area.
void	setBiome(Vector2D pt, BiomeType biome) Set the biome type
boolean	setBlock(Vector pt, Block block, boolean notifyAdjacent) Change the block at the given location to the given block.
void	setBlockData(Vector pt, int data) Set block data.
void	setBlockDataFast(Vector pt, int data) Set block data.
boolean	setBlockType(Vector pt, int type) Set block type.
boolean	setBlockTypeFast(Vector pt, int type) Set block type.
boolean	setTypeIdAndData(Vector pt, int type, int data) set block type & data
boolean	setTypeIdAndDataFast(Vector pt, int type, int data) set block type & data
void	simulateBlockMine(Vector pt) Simulate a block being mined.
static org.bukkit.TreeType	toBukkitTreeType(TreeGenerator.TreeType type)

Methods inherited from class com.sk89q.worldedit.LocalWorld

dropItem, fixLighting, killMobs, killMobs, queueBlockBreakEffect, 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 -

Method Detail

getWorld

public org.bukkit.World getWorld()

Get the world handle.

Returns:

getName

public String getName()

Get the name of the world

Specified by:

getName in class LocalWorld

Returns:

setBlockType

public boolean setBlockType(Vector pt,
                   int type)

Set block type.

Specified by:

setBlockType in class LocalWorld

Parameters:

pt -

type -

Returns:

setBlockTypeFast

public boolean setBlockTypeFast(Vector pt,
                       int type)

Set block type.

Overrides:

setBlockTypeFast in class LocalWorld

Parameters:

pt -

type -

Returns:

setTypeIdAndData

public boolean setTypeIdAndData(Vector pt,
                       int type,
                       int data)

set block type & data

Overrides:

setTypeIdAndData in class LocalWorld

Parameters:

pt -

type -

data -

Returns:

setTypeIdAndDataFast

public boolean setTypeIdAndDataFast(Vector pt,
                           int type,
                           int data)

set block type & data

Overrides:

setTypeIdAndDataFast in class LocalWorld

Parameters:

pt -

type -

data -

Returns:

getBlockType

public int getBlockType(Vector pt)

Get block type.

Specified by:

getBlockType in class LocalWorld

Parameters:

pt -

Returns:

setBlockData

public void setBlockData(Vector pt,
                int data)

Set block data.

Specified by:

setBlockData in class LocalWorld

Parameters:

pt -

data -

setBlockDataFast

public void setBlockDataFast(Vector pt,
                    int data)

Set block data.

Specified by:

setBlockDataFast in class LocalWorld

Parameters:

pt -

data -

getBlockData

public int getBlockData(Vector pt)

Get block data.

Specified by:

getBlockData in class LocalWorld

Parameters:

pt -

Returns:

getBlockLightLevel

public int getBlockLightLevel(Vector pt)

Get block light level.

Specified by:

getBlockLightLevel in class LocalWorld

Parameters:

pt -

Returns:

getBiome

public BiomeType getBiome(Vector2D pt)

Get biome type

Specified by:

getBiome in class LocalWorld

Parameters:

pt -

Returns:

setBiome

public void setBiome(Vector2D pt,
            BiomeType biome)

Description copied from class: LocalWorld

Set the biome type

Specified by:

setBiome in class LocalWorld

Parameters:

pt - The (x, z) location to set the biome at

biome - The biome type to set to

regenerate

public boolean regenerate(Region region,
                 EditSession editSession)

Regenerate an area.

Specified by:

regenerate in class LocalWorld

Parameters:

region -

editSession -

Returns:

copyToWorld

public boolean copyToWorld(Vector pt,
                  BaseBlock block)

Attempts to accurately copy a BaseBlock's extra data to the world.

Specified by:

copyToWorld in class LocalWorld

Parameters:

pt -

block -

Returns:

copyFromWorld

public boolean copyFromWorld(Vector pt,
                    BaseBlock block)

Attempts to read a BaseBlock's extra data from the world.

Specified by:

copyFromWorld in class LocalWorld

Parameters:

pt -

block -

Returns:

clearContainerBlockContents

public boolean clearContainerBlockContents(Vector pt)

Clear a chest's contents.

Specified by:

clearContainerBlockContents in class LocalWorld

Parameters:

pt -

Returns:

generateTree

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

Deprecated.

Generate a tree at a location.

Overrides:

generateTree in class LocalWorld

Parameters:

pt -

Returns:

generateBigTree

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

Deprecated.

Generate a big tree at a location.

Overrides:

generateBigTree in class LocalWorld

Parameters:

pt -

Returns:

generateBirchTree

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

Deprecated.

Generate a birch tree at a location.

Overrides:

generateBirchTree in class LocalWorld

Parameters:

pt -

Returns:

generateRedwoodTree

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

Deprecated.

Generate a redwood tree at a location.

Overrides:

generateRedwoodTree in class LocalWorld

Parameters:

pt -

Returns:

generateTallRedwoodTree

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

Deprecated.

Generate a redwood tree at a location.

Overrides:

generateTallRedwoodTree in class LocalWorld

Parameters:

pt -

Returns:

toBukkitTreeType

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

generateTree

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

Description copied from class: LocalWorld

Generates a tree

Overrides:

generateTree in class LocalWorld

Parameters:

type - The type of tree to generate

editSession - The EditSession to pass block changes through

pt - The point where the base of the tree should be located

Returns:

Whether the tree generation was successful

dropItem

public void dropItem(Vector pt,
            BaseItemStack item)

Drop an item.

Specified by:

dropItem in class LocalWorld

Parameters:

pt -

item -

killMobs

public int killMobs(Vector origin,
           double radius,
           int flags)

Kill mobs in an area.

Overrides:

killMobs in class LocalWorld

Parameters:

origin - The center of the area to kill mobs in.

radius - Maximum distance to kill mobs at; radius < 0 means kill all mobs

flags - various flags that determine what to kill

Returns:

number of mobs killed

removeEntities

public int removeEntities(EntityType type,
                 Vector origin,
                 int radius)

Remove entities in an area.

Specified by:

removeEntities in class LocalWorld

Parameters:

origin -

radius -

Returns:

isValidBlockType

public boolean isValidBlockType(int type)

Returns whether a block has a valid ID.

Overrides:

isValidBlockType in class LocalWorld

Parameters:

type -

Returns:

checkLoadedChunk

public void checkLoadedChunk(Vector pt)

Description copied from class: LocalWorld

Checks if the chunk pt is in is loaded. if not, loads the chunk

Overrides:

checkLoadedChunk in class LocalWorld

Parameters:

pt - Position to check

equals

public boolean equals(Object other)

Description copied from class: LocalWorld

Compare if the other world is equal.

Specified by:

equals in class LocalWorld

hashCode

public int hashCode()

Description copied from class: LocalWorld

Hash code.

Specified by:

hashCode in class LocalWorld

getMaxY

public int getMaxY()

Description copied from class: LocalWorld

Get the world's height

Overrides:

getMaxY in class LocalWorld

Returns:

fixAfterFastMode

public void fixAfterFastMode(Iterable<BlockVector2D> chunks)

Description copied from class: LocalWorld

Does some post-processing. Should be called after using fast mode

Overrides:

fixAfterFastMode in class LocalWorld

Parameters:

chunks - the chunks to fix

playEffect

public boolean playEffect(Vector position,
                 int type,
                 int data)

Description copied from class: LocalWorld

Plays the minecraft effect with the given type and data at the given position.

Overrides:

playEffect in class LocalWorld

simulateBlockMine

public void simulateBlockMine(Vector pt)

Description copied from class: LocalWorld

Simulate a block being mined.

Overrides:

simulateBlockMine in class LocalWorld

getEntities

public LocalEntity[] getEntities(Region region)

Overrides:

getEntities in class LocalWorld

killEntities

public int killEntities(LocalEntity... entities)

Overrides:

killEntities in class LocalWorld

getBlock

public BaseBlock getBlock(Vector pt)

Description copied from interface: World

Get a copy of the block at the given location. May return null if the location given is out of bounds. The returned block must not be tied to any real block in the world, so changes to the returned Block have no effect until World.setBlock(Vector, Block, boolean) is called.

Specified by:

getBlock in interface World

Overrides:

getBlock in class LocalWorld

Parameters:

pt - location of the block

Returns:

the block, or null if the block does not exist

setBlock

public boolean setBlock(Vector pt,
               Block block,
               boolean notifyAdjacent)

Description copied from interface: World

Change the block at the given location to the given block. The operation may not tie the given Block to the world, so future changes to the Block do not affect the world until this method is called again.

Implementations may or may not consider the value of the notifyAdjacent parameter, and implementations may to choose to either apply physics anyway or to not apply any physics (particularly in a stand-alone implementation).

The return value of this method indicates whether the change "went through," as in the block was changed in the world in any way. If the new block is no different than the block already at the position in the world, 'false' would be returned. If the position is invalid (out of bounds, for example), then nothing should occur and 'false' should be returned. If possible, the return value should be accurate as possible, but implementations may choose to not provide an accurate value if it is not possible to know.

Specified by:

setBlock in interface World

Overrides:

setBlock in class LocalWorld

Parameters:

pt - location of the block

block - block to set

notifyAdjacent - true to to notify adjacent (perform physics)

Returns:

true if the block was successfully set (return value may not be accurate)