com.sk89q.worldedit

Class LocalWorld

java.lang.Object

com.sk89q.worldedit.LocalWorld

All Implemented Interfaces:

World

Direct Known Subclasses:

BukkitWorld

public abstract class LocalWorld
extends Object
implements World

Represents a world.

Author:

sk89q

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	LocalWorld.KillFlags Named flags to use as parameters to killMobs(Vector, double, int)

Field Summary

Fields

Modifier and Type	Field and Description
protected Random	random Random generator.

Constructor Summary

Constructors

Constructor and Description
LocalWorld()

Method Summary

Methods

Modifier and Type	Method and Description
void	checkLoadedChunk(Vector pt) Checks if the chunk pt is in is loaded.
abstract boolean	clearContainerBlockContents(Vector pt) Clear a chest's contents.
abstract boolean	copyFromWorld(Vector pt, BaseBlock block) Attempts to read a BaseBlock's extra data from the world.
abstract boolean	copyToWorld(Vector pt, BaseBlock block) Attempts to accurately copy a BaseBlock's extra data to the world.
abstract void	dropItem(Vector pt, BaseItemStack item) Drop an item.
void	dropItem(Vector pt, BaseItemStack item, int times) Drop an item.
abstract boolean	equals(Object other) Compare if the other world is equal.
void	fixAfterFastMode(Iterable<BlockVector2D> chunks) Does some post-processing.
void	fixLighting(Iterable<BlockVector2D> chunks)
boolean	generateBigTree(EditSession editSession, Vector pt) Deprecated. use generateTree(com.sk89q.worldedit.util.TreeGenerator.TreeType, EditSession, Vector) instead
boolean	generateBirchTree(EditSession editSession, Vector pt) Deprecated. use generateTree(com.sk89q.worldedit.util.TreeGenerator.TreeType, EditSession, Vector) instead
boolean	generateRedwoodTree(EditSession editSession, Vector pt) Deprecated. use generateTree(com.sk89q.worldedit.util.TreeGenerator.TreeType, EditSession, Vector) instead
boolean	generateTallRedwoodTree(EditSession editSession, Vector pt) Deprecated. use generateTree(com.sk89q.worldedit.util.TreeGenerator.TreeType, EditSession, Vector) instead
boolean	generateTree(EditSession editSession, Vector pt) Deprecated. use generateTree(com.sk89q.worldedit.util.TreeGenerator.TreeType, EditSession, Vector) instead
boolean	generateTree(TreeGenerator.TreeType type, EditSession editSession, Vector pt) Generates a tree
abstract BiomeType	getBiome(Vector2D pt) Get biome type
BaseBlock	getBlock(Vector pt) Get a copy of the block at the given location.
abstract int	getBlockData(Vector pt) Get block data.
abstract int	getBlockLightLevel(Vector pt) Get block light level.
abstract int	getBlockType(Vector pt) Get block type.
LocalEntity[]	getEntities(Region region)
int	getMaxY() Get the world's height
abstract String	getName() Get the name of the world.
abstract 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.
int	killMobs(Vector origin, int radius) Deprecated.
int	killMobs(Vector origin, int radius, boolean killPets) Deprecated.
boolean	playEffect(Vector position, int type, int data) Plays the minecraft effect with the given type and data at the given position.
boolean	queueBlockBreakEffect(ServerInterface server, Vector position, int blockId, double priority)
abstract boolean	regenerate(Region region, EditSession editSession) Regenerate an area.
abstract int	removeEntities(EntityType type, Vector origin, int radius) Remove entities in an area.
abstract 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.
abstract void	setBlockData(Vector pt, int data) Deprecated.
abstract void	setBlockDataFast(Vector pt, int data) Deprecated.
abstract boolean	setBlockType(Vector pt, int type) Deprecated.
boolean	setBlockTypeFast(Vector pt, int type) Deprecated.
boolean	setTypeIdAndData(Vector pt, int type, int data) Deprecated.
boolean	setTypeIdAndDataFast(Vector pt, int type, int data) Deprecated.
void	simulateBlockMine(Vector pt) Simulate a block being mined.
boolean	usesBlockData(int type) Returns whether a block uses its data value.

Methods inherited from class java.lang.Object

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

Field Detail

random

protected Random random

Random generator.

Constructor Detail

LocalWorld

public LocalWorld()

Method Detail

getName

public abstract String getName()

Get the name of the world.

Returns:

setBlockType

@Deprecated
public abstract boolean setBlockType(Vector pt,
                              int type)

Deprecated.

Set block type.

Parameters:

pt -

type -

Returns:

setBlockTypeFast

@Deprecated
public boolean setBlockTypeFast(Vector pt,
                                  int type)

Deprecated.

Set block type.

Parameters:

pt -

type -

Returns:

getBlockType

public abstract int getBlockType(Vector pt)

Get block type.

Parameters:

pt -

Returns:

setBlockData

@Deprecated
public abstract void setBlockData(Vector pt,
                           int data)

Deprecated.

Set block data.

Parameters:

pt -

data -

setBlockDataFast

@Deprecated
public abstract void setBlockDataFast(Vector pt,
                               int data)

Deprecated.

Set block data.

Parameters:

pt -

data -

getBiome

public abstract BiomeType getBiome(Vector2D pt)

Get biome type

Parameters:

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

Returns:

The biome type at the location

setBiome

public abstract void setBiome(Vector2D pt,
            BiomeType biome)

Set the biome type

Parameters:

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

biome - The biome type to set to

setTypeIdAndData

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

Deprecated.

set block type & data

Parameters:

pt -

type -

data -

Returns:

setTypeIdAndDataFast

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

Deprecated.

set block type & data

Parameters:

pt -

type -

data -

Returns:

getBlockData

public abstract int getBlockData(Vector pt)

Get block data.

Parameters:

pt -

Returns:

getBlockLightLevel

public abstract int getBlockLightLevel(Vector pt)

Get block light level.

Parameters:

pt -

Returns:

regenerate

public abstract boolean regenerate(Region region,
                 EditSession editSession)

Regenerate an area.

Parameters:

region -

editSession -

Returns:

copyToWorld

public abstract boolean copyToWorld(Vector pt,
                  BaseBlock block)

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

Parameters:

pt -

block -

Returns:

copyFromWorld

public abstract boolean copyFromWorld(Vector pt,
                    BaseBlock block)

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

Parameters:

pt -

block -

Returns:

clearContainerBlockContents

public abstract boolean clearContainerBlockContents(Vector pt)

Clear a chest's contents.

Parameters:

pt -

Returns:

generateTree

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

Deprecated. use generateTree(com.sk89q.worldedit.util.TreeGenerator.TreeType, EditSession, Vector) instead

Generate a tree at a location.

Parameters:

editSession -

pt -

Returns:

Throws:

MaxChangedBlocksException

generateBigTree

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

Deprecated. use generateTree(com.sk89q.worldedit.util.TreeGenerator.TreeType, EditSession, Vector) instead

Generate a big tree at a location.

Parameters:

editSession -

pt -

Returns:

Throws:

MaxChangedBlocksException

generateBirchTree

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

Deprecated. use generateTree(com.sk89q.worldedit.util.TreeGenerator.TreeType, EditSession, Vector) instead

Generate a birch tree at a location.

Parameters:

editSession -

pt -

Returns:

Throws:

MaxChangedBlocksException

generateRedwoodTree

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

Deprecated. use generateTree(com.sk89q.worldedit.util.TreeGenerator.TreeType, EditSession, Vector) instead

Generate a redwood tree at a location.

Parameters:

editSession -

pt -

Returns:

Throws:

MaxChangedBlocksException

generateTallRedwoodTree

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

Deprecated. use generateTree(com.sk89q.worldedit.util.TreeGenerator.TreeType, EditSession, Vector) instead

Generate a tall redwood tree at a location.

Parameters:

editSession -

pt -

Returns:

Throws:

MaxChangedBlocksException

generateTree

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

Generates a tree

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

Throws:

MaxChangedBlocksException - if too many blocks were changed by the EditSession

dropItem

public void dropItem(Vector pt,
            BaseItemStack item,
            int times)

Drop an item.

Parameters:

pt -

item -

times -

dropItem

public abstract void dropItem(Vector pt,
            BaseItemStack item)

Drop an item.

Parameters:

pt -

item -

simulateBlockMine

public void simulateBlockMine(Vector pt)

Simulate a block being mined.

Parameters:

pt -

killMobs

@Deprecated
public int killMobs(Vector origin,
                      int radius)

Deprecated.

Kill mobs in an area, excluding pet wolves.

Parameters:

origin - The center of the area to kill mobs in

radius - -1 for the whole world

Returns:

number of mobs killed

killMobs

@Deprecated
public int killMobs(Vector origin,
                      int radius,
                      boolean killPets)

Deprecated.

Kill mobs in an area.

Parameters:

origin - The center of the area to kill mobs in

radius - -1 for all mobs

killPets - whether to kill pets

Returns:

number of mobs killed

killMobs

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

Kill mobs in an area.

Parameters:

origin - The center of the area to kill mobs in

radius - -1 for all mobs

flags - various flags that determine what to kill

Returns:

number of mobs killed

removeEntities

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

Remove entities in an area.

Parameters:

type -

origin -

radius -

Returns:

isValidBlockType

public boolean isValidBlockType(int type)

Returns whether a block has a valid ID.

Parameters:

type -

Returns:

usesBlockData

public boolean usesBlockData(int type)

Returns whether a block uses its data value.

Parameters:

type - block ID type

Returns:

true if the block uses data value

checkLoadedChunk

public void checkLoadedChunk(Vector pt)

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

Parameters:

pt - Position to check

equals

public abstract boolean equals(Object other)

Compare if the other world is equal.

Overrides:

equals in class Object

Parameters:

other -

Returns:

hashCode

public abstract int hashCode()

Hash code.

Overrides:

hashCode in class Object

Returns:

getMaxY

public int getMaxY()

Get the world's height

Returns:

fixAfterFastMode

public void fixAfterFastMode(Iterable<BlockVector2D> chunks)

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

Parameters:

chunks - the chunks to fix

fixLighting

public void fixLighting(Iterable<BlockVector2D> chunks)

playEffect

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

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

Parameters:

position -

type -

data -

queueBlockBreakEffect

public boolean queueBlockBreakEffect(ServerInterface server,
                            Vector position,
                            int blockId,
                            double priority)

getEntities

public LocalEntity[] getEntities(Region region)

killEntities

public int killEntities(LocalEntity... entities)

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

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)

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

Parameters:

pt - location of the block

Returns:

the block, or null if the block does not exist