com.sk89q.worldedit.world

Class NullWorld

java.lang.Object

com.sk89q.worldedit.world.AbstractWorld

com.sk89q.worldedit.world.NullWorld

All Implemented Interfaces:

Extent, InputExtent, OutputExtent, World

public class NullWorld
extends AbstractWorld

A null implementation of World that drops all changes and returns dummy data.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NullWorld()

Method Summary

Modifier and Type	Method and Description
boolean	clearContainerBlockContents(Vector position) Clear a chest's contents.
Entity	createEntity(Location location, BaseEntity entity) Create an entity at the given location.
void	dropItem(Vector position, BaseItemStack item) Drop one stack of the item at the given position.
boolean	generateTree(TreeGenerator.TreeType type, EditSession editSession, Vector position) Generate a tree at the given position.
BaseBiome	getBiome(Vector2D position) Get the biome at the given location.
BaseBlock	getBlock(Vector position) Get a snapshot of the block at the given location.
int	getBlockLightLevel(Vector position) Get the light level at the given block.
List<Entity>	getEntities() Get a list of all entities.
List<Entity>	getEntities(Region region) Get a list of all entities within the given region.
static NullWorld	getInstance() Return an instance of this null world.
BaseBlock	getLazyBlock(Vector position) Get a lazy, immutable snapshot of the block at the given location that only immediately contains information about the block's type (and metadata).
String	getName() Get the name of the world.
WorldData	getWorldData() Get the data for blocks and so on for this world.
boolean	regenerate(Region region, EditSession editSession) Regenerate an area.
boolean	setBiome(Vector2D position, BaseBiome biome) Set the biome.
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.

Methods inherited from class com.sk89q.worldedit.world.AbstractWorld

checkLoadedChunk, commit, createLiquidMask, dropItem, fixAfterFastMode, fixLighting, generateBigTree, generateBirchTree, generateRedwoodTree, generateTallRedwoodTree, generateTree, getBlockData, getBlockType, getMaximumPoint, getMaxY, getMinimumPoint, isValidBlockType, playEffect, queueBlockBreakEffect, setBlock, setBlockData, setBlockType, setTypeIdAndData, simulateBlockMine, usesBlockData

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

equals, hashCode

Constructor Detail

NullWorld

protected NullWorld()

Method Detail

getName

public String getName()

Description copied from interface: World

Get the name of the world.

Returns:

a name for the world

setBlock

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

Description copied from interface: World

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

getBlockLightLevel

public int getBlockLightLevel(Vector position)

Description copied from interface: World

Get the light level at the given block.

Parameters:

position - the position

Returns:

the light level (0-15)

clearContainerBlockContents

public boolean clearContainerBlockContents(Vector position)

Description copied from interface: World

Clear a chest's contents.

Parameters:

position - the position

Returns:

true if the container was cleared

getBiome

public BaseBiome getBiome(Vector2D position)

Description copied from interface: InputExtent

Get the biome at the given location.

If there is no biome available, then the ocean biome should be returned.

Parameters:

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

Returns:

the biome at the location

setBiome

public boolean setBiome(Vector2D position,
                        BaseBiome biome)

Description copied from interface: OutputExtent

Set the biome.

Parameters:

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

biome - the biome to set to

Returns:

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

dropItem

public void dropItem(Vector position,
                     BaseItemStack item)

Description copied from interface: World

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

regenerate

public boolean regenerate(Region region,
                          EditSession editSession)

Description copied from interface: World

Regenerate an area.

Parameters:

region - the region

editSession - the EditSession

Returns:

true if re-generation was successful

generateTree

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

Description copied from interface: World

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

getWorldData

public WorldData getWorldData()

Description copied from interface: World

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

Returns:

the world data

getBlock

public BaseBlock getBlock(Vector position)

Description copied from interface: InputExtent

Get a snapshot of the block at the given location.

If the given position is out of the bounds of the extent, then the behavior is undefined (an air block could be returned). However, null should not be returned.

The returned block is mutable and is a snapshot of the block at the time of call. It has no position attached to it, so it could be reused in Patterns and so on.

Calls to this method can actually be quite expensive, so cache results whenever it is possible, while being aware of the mutability aspect. The cost, however, depends on the implementation and particular extent. If only basic information about the block is required, then use of InputExtent.getLazyBlock(Vector) is recommended.

Parameters:

position - position of the block

Returns:

the block

getLazyBlock

public BaseBlock getLazyBlock(Vector position)

Description copied from interface: InputExtent

Get a lazy, immutable snapshot of the block at the given location that only immediately contains information about the block's type (and metadata).

Further information (such as NBT data) will be available by the time of access. Therefore, it is not recommended that this method is used if the world is being simulated at the time of call. If the block needs to be stored for future use, then this method should definitely not be used. Moreover, the block that is returned is immutable (or should be), and therefore modifications should not be attempted on it. If a modifiable copy is required, then the block should be cloned.

This method exists because it is sometimes important to inspect the block at a given location, but InputExtent.getBlock(Vector) may be too expensive in the underlying implementation. It is also not possible to implement caching if the returned object is mutable, so this methods allows caching implementations to be used.

Parameters:

position - position of the block

Returns:

the block

getEntities

public List<Entity> getEntities(Region region)

Description copied from interface: Extent

Get a list of all entities within the given region.

If the extent is not wholly loaded (i.e. a world being simulated in the game will not have every chunk loaded), then this list may not be incomplete.

Parameters:

region - the region in which entities must be contained

Returns:

a list of entities

getEntities

public List<Entity> getEntities()

Description copied from interface: Extent

Get a list of all entities.

If the extent is not wholly loaded (i.e. a world being simulated in the game will not have every chunk loaded), then this list may not be incomplete.

Returns:

a list of entities

createEntity

@Nullable
public Entity createEntity(Location location,
                                     BaseEntity entity)

Description copied from interface: Extent

Create an entity at the given location.

Parameters:

location - the location

entity - the entity

Returns:

a reference to the created entity, or null if the entity could not be created

getInstance

public static NullWorld getInstance()

Return an instance of this null world.

Returns:

a null world