com.sk89q.worldedit.foundation

Interface World

All Known Implementing Classes:

BukkitWorld, LocalWorld

public interface World

Represents a world instance that can be modified. The world instance could be loaded in-game or loaded in a stand-alone editor.

This class is meant to replace LocalWorld eventually, once this class has been fleshed out with the required methods and it has been decided that it is time to start breaking some API compatibility.

Method Summary

Methods

Modifier and Type	Method and Description
Block	getBlock(Vector location) Get a copy of the block at the given location.
boolean	setBlock(Vector location, Block block, boolean notifyAdjacent) Change the block at the given location to the given block.

Method Detail

setBlock

boolean setBlock(Vector location,
               Block block,
               boolean notifyAdjacent)

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.

Parameters:

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

Block getBlock(Vector location)

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 setBlock(Vector, Block, boolean) is called.

Parameters:

location - location of the block

Returns:

the block, or null if the block does not exist