com.sk89q.worldedit.world

Class AbstractWorld

java.lang.Object

com.sk89q.worldedit.world.AbstractWorld

All Implemented Interfaces:

Extent, InputExtent, OutputExtent, World

Direct Known Subclasses:

LocalWorld, NullWorld

public abstract class AbstractWorld
extends Object
implements World

An abstract implementation of World.

Constructor Summary

Constructors

Constructor and Description
AbstractWorld()

Method Summary

Modifier and Type	Method and Description
void	checkLoadedChunk(Vector pt) Load the chunk at the given position if it isn't loaded.
Operation	commit() Return an Operation that should be called to tie up loose ends (such as to commit changes in a buffer).
Mask	createLiquidMask() Create a mask that matches all liquids.
void	dropItem(Vector pt, BaseItemStack item, int times) Drop an item at the given position.
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 pt)
boolean	generateBirchTree(EditSession editSession, Vector pt)
boolean	generateRedwoodTree(EditSession editSession, Vector pt)
boolean	generateTallRedwoodTree(EditSession editSession, Vector pt)
boolean	generateTree(EditSession editSession, Vector pt)
int	getBlockData(Vector pt)
int	getBlockType(Vector pt)
Vector	getMaximumPoint() Get the maximum point in the extent.
int	getMaxY() Get the maximum Y.
Vector	getMinimumPoint() Get the minimum point in the extent.
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	queueBlockBreakEffect(Platform server, Vector position, int blockId, double priority) Queue a block break effect.
boolean	setBlock(Vector pt, BaseBlock block) Change the block at the given location to the given block.
void	setBlockData(Vector position, int data)
boolean	setBlockType(Vector position, int type)
boolean	setTypeIdAndData(Vector position, int type, int data)
void	simulateBlockMine(Vector pt) Simulate a block being mined at the given position.
boolean	usesBlockData(int type) Checks whether the given block ID uses data values for differentiating types of blocks.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sk89q.worldedit.world.World

clearContainerBlockContents, dropItem, equals, generateTree, getBlockLightLevel, getName, getWorldData, hashCode, regenerate, setBlock

Methods inherited from interface com.sk89q.worldedit.extent.Extent

createEntity, getEntities, getEntities

Methods inherited from interface com.sk89q.worldedit.extent.InputExtent

getBiome, getBlock, getLazyBlock

Methods inherited from interface com.sk89q.worldedit.extent.OutputExtent

setBiome

Constructor Detail

AbstractWorld

public AbstractWorld()

Method Detail

setBlockType

public final boolean setBlockType(Vector position,
                                  int type)

Specified by:

setBlockType in interface World

setBlockData

public final void setBlockData(Vector position,
                               int data)

Specified by:

setBlockData in interface World

setTypeIdAndData

public final boolean setTypeIdAndData(Vector position,
                                      int type,
                                      int data)

Specified by:

setTypeIdAndData in interface World

setBlock

public final boolean setBlock(Vector pt,
                              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:

pt - 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

getMaxY

public int getMaxY()

Description copied from interface: World

Get the maximum Y.

Specified by:

getMaxY in interface World

Returns:

the maximum Y

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

Parameters:

type - the block ID

Returns:

true if the block ID is a valid one

usesBlockData

public boolean usesBlockData(int type)

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

Parameters:

type - 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

Returns:

a mask

getBlockType

public int getBlockType(Vector pt)

Specified by:

getBlockType in interface World

getBlockData

public int getBlockData(Vector pt)

Specified by:

getBlockData in interface World

dropItem

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

Description copied from interface: World

Drop an item at the given position.

Specified by:

dropItem in interface World

Parameters:

pt - the position

item - the item to drop

times - the number of individual stacks to drop (number of item entities)

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

Parameters:

pt - the position

generateTree

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

Specified by:

generateTree in interface World

Throws:

MaxChangedBlocksException

generateBigTree

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

Specified by:

generateBigTree in interface World

Throws:

MaxChangedBlocksException

generateBirchTree

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

Specified by:

generateBirchTree in interface World

Throws:

MaxChangedBlocksException

generateRedwoodTree

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

Specified by:

generateRedwoodTree in interface World

Throws:

MaxChangedBlocksException

generateTallRedwoodTree

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

Specified by:

generateTallRedwoodTree in interface World

Throws:

MaxChangedBlocksException

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

Parameters:

pt - 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

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

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

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

Parameters:

server - the server

position - the position

blockId - the block ID

priority - the priority

Returns:

true if the effect was played

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

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

Returns:

an operation or null if there is none to execute