com.sk89q.worldedit.world

Interface World

All Superinterfaces:

Extent, InputExtent, OutputExtent

All Known Implementing Classes:

AbstractWorld, BukkitWorld, LocalWorld, LocalWorldAdapter, NullWorld

public interface World
extends Extent

Represents a world (dimension).

Method Summary

Modifier and Type	Method and Description
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.
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. Use #generateTree(TreeType, EditSession, Vector)
boolean	generateBirchTree(EditSession editSession, Vector position) Deprecated. Use #generateTree(TreeType, EditSession, Vector)
boolean	generateRedwoodTree(EditSession editSession, Vector position) Deprecated. Use #generateTree(TreeType, EditSession, Vector)
boolean	generateTallRedwoodTree(EditSession editSession, Vector position) Deprecated. Use #generateTree(TreeType, EditSession, Vector)
boolean	generateTree(EditSession editSession, Vector position) Deprecated. Use #generateTree(TreeType, EditSession, Vector)
boolean	generateTree(TreeGenerator.TreeType type, EditSession editSession, Vector position) Generate a tree at the given position.
int	getBlockData(Vector pt) Deprecated. Use InputExtent.getLazyBlock(Vector)
int	getBlockLightLevel(Vector position) Get the light level at the given block.
int	getBlockType(Vector pt) Deprecated. Use InputExtent.getLazyBlock(Vector)
int	getMaxY() Get the maximum Y.
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	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	setBlockData(Vector position, int data) Deprecated. Use OutputExtent.setBlock(Vector, BaseBlock)
boolean	setBlockType(Vector position, int type) Deprecated. Use OutputExtent.setBlock(Vector, BaseBlock)
boolean	setTypeIdAndData(Vector position, int type, int data) Deprecated. Use OutputExtent.setBlock(Vector, BaseBlock)
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 interface com.sk89q.worldedit.extent.Extent

createEntity, getEntities, getEntities, getMaximumPoint, getMinimumPoint

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

getBiome, getBlock, getLazyBlock

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

commit, setBiome, setBlock

Method Detail

getName

String getName()

Get the name of the world.

Returns:

a name for the world

getMaxY

int getMaxY()

Get the maximum Y.

Returns:

the maximum Y

isValidBlockType

boolean isValidBlockType(int id)

Checks whether the given block ID is a valid block ID.

Parameters:

id - the block ID

Returns:

true if the block ID is a valid one

usesBlockData

boolean usesBlockData(int id)

Checks whether the given block ID uses data values for differentiating types of blocks.

Parameters:

id - the block ID

Returns:

true if the block uses data values

createLiquidMask

Mask createLiquidMask()

Create a mask that matches all liquids.

Implementations should override this so that custom liquids are supported.

Returns:

a mask

getBlockType

@Deprecated
int getBlockType(Vector pt)

Deprecated. Use InputExtent.getLazyBlock(Vector)

getBlockData

@Deprecated
int getBlockData(Vector pt)

Deprecated. Use InputExtent.getLazyBlock(Vector)

setBlock

boolean setBlock(Vector position,
                 BaseBlock block,
                 boolean notifyAndLight)
          throws WorldEditException

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

setBlockType

@Deprecated
boolean setBlockType(Vector position,
                                 int type)

Deprecated. Use OutputExtent.setBlock(Vector, BaseBlock)

setBlockData

@Deprecated
void setBlockData(Vector position,
                              int data)

Deprecated. Use OutputExtent.setBlock(Vector, BaseBlock)

setTypeIdAndData

@Deprecated
boolean setTypeIdAndData(Vector position,
                                     int type,
                                     int data)

Deprecated. Use OutputExtent.setBlock(Vector, BaseBlock)

getBlockLightLevel

int getBlockLightLevel(Vector position)

Get the light level at the given block.

Parameters:

position - the position

Returns:

the light level (0-15)

clearContainerBlockContents

boolean clearContainerBlockContents(Vector position)

Clear a chest's contents.

Parameters:

position - the position

Returns:

true if the container was cleared

dropItem

void dropItem(Vector position,
              BaseItemStack item,
              int count)

Drop an item at the given position.

Parameters:

position - the position

item - the item to drop

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

dropItem

void dropItem(Vector position,
              BaseItemStack item)

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

void simulateBlockMine(Vector position)

Simulate a block being mined at the given position.

Parameters:

position - the position

regenerate

boolean regenerate(Region region,
                   EditSession editSession)

Regenerate an area.

Parameters:

region - the region

editSession - the EditSession

Returns:

true if re-generation was successful

generateTree

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

Generate a tree at the given position.

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
boolean generateTree(EditSession editSession,
                                 Vector position)
                          throws MaxChangedBlocksException

Deprecated. Use #generateTree(TreeType, EditSession, Vector)

Throws:

MaxChangedBlocksException

generateBigTree

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

Deprecated. Use #generateTree(TreeType, EditSession, Vector)

Throws:

MaxChangedBlocksException

generateBirchTree

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

Deprecated. Use #generateTree(TreeType, EditSession, Vector)

Throws:

MaxChangedBlocksException

generateRedwoodTree

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

Deprecated. Use #generateTree(TreeType, EditSession, Vector)

Throws:

MaxChangedBlocksException

generateTallRedwoodTree

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

Deprecated. Use #generateTree(TreeType, EditSession, Vector)

Throws:

MaxChangedBlocksException

checkLoadedChunk

void checkLoadedChunk(Vector position)

Load the chunk at the given position if it isn't loaded.

Parameters:

position - the position

fixAfterFastMode

void fixAfterFastMode(Iterable<BlockVector2D> chunks)

Fix the given chunks after fast mode was used.

Fast mode makes calls to 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.

Parameters:

chunks - a list of chunk coordinates to fix

fixLighting

void fixLighting(Iterable<BlockVector2D> chunks)

Relight the given chunks if possible.

Parameters:

chunks - a list of chunk coordinates to fix

playEffect

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

Play the given effect.

Parameters:

position - the position

type - the effect type

data - the effect data

Returns:

true if the effect was played

queueBlockBreakEffect

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

Queue a block break effect.

Parameters:

server - the server

position - the position

blockId - the block ID

priority - the priority

Returns:

true if the effect was played

getWorldData

WorldData getWorldData()

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

Returns:

the world data

equals

boolean equals(Object other)

Overrides:

equals in class Object

hashCode

int hashCode()

Overrides:

hashCode in class Object