org.spongepowered.api.world

Interface World

All Superinterfaces:

BiomeVolume, BlockVolume, ChatTypeMessageReceiver, ContextSource, EntityUniverse, Extent, Identifiable, InteractableVolume, LocationBasePropertyHolder, LocationCompositeValueStore, MessageReceiver, MutableBiomeVolume, MutableBlockVolume, TileEntityVolume, Viewer, WeatherUniverse

public interface World
extends Extent, WeatherUniverse, Viewer, ContextSource, MessageReceiver, ChatTypeMessageReceiver

A loaded Minecraft world.

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.world.extent.EntityUniverse

EntityUniverse.EntityHit

Method Summary

Modifier and Type	Method and Description
default boolean	doesKeepSpawnLoaded() Gets whether the spawn chunks should remain loaded.
MutableBiomeVolumeWorker<World>	getBiomeWorker() Gets a new biome worker for this biome volume.
MutableBlockVolumeWorker<World>	getBlockWorker() Gets a new block worker for this block volume.
Optional<Chunk>	getChunk(int cx, int cy, int cz) Gets the loaded chunk at the given chunk coordinate position.
default Optional<Chunk>	getChunk(com.flowpowered.math.vector.Vector3i chunkPosition) Gets the loaded chunk at the given chunk coordinate position.
default Optional<Chunk>	getChunkAtBlock(int bx, int by, int bz) Gets the loaded chunk at the given block coordinate position.
default Optional<Chunk>	getChunkAtBlock(com.flowpowered.math.vector.Vector3i blockPosition) Gets the loaded chunk at the given block coordinate position.
default Difficulty	getDifficulty() Gets the current Difficulty.
Dimension	getDimension() Returns the Dimension of this world.
Path	getDirectory() Gets the Path pointing to the root of where the world's data is being stored.
Optional<Entity>	getEntity(UUID uuid) Gets the entity whose UUID matches the provided id, possibly returning no entity if the entity is not loaded or non-existent.
default Optional<String>	getGameRule(String gameRule) Gets a set game rule's current value, if available and set.
default Map<String,String>	getGameRules() Gets the current map of game rules and their values.
Iterable<Chunk>	getLoadedChunks() Returns a Collection of all actively loaded chunks in this world.
default LocatableBlock	getLocatableBlock(int x, int y, int z) Gets a LocatableBlock for the desired x, y, z coordinates.
default LocatableBlock	getLocatableBlock(com.flowpowered.math.vector.Vector3i position) Gets a LocatableBlock for the desired Vector3i position.
default Location<World>	getLocation(double x, double y, double z) Gets a location in this extent at the given position.
default Location<World>	getLocation(int x, int y, int z) Gets a location in this extent at the given position.
default Location<World>	getLocation(com.flowpowered.math.vector.Vector3d position) Gets a location in this extent at the given position.
default Location<World>	getLocation(com.flowpowered.math.vector.Vector3i position) Gets a location in this extent at the given position.
default String	getName() Gets the name of this world.
Collection<Player>	getPlayers() Gets an unmodifiable collection of Players currently in this world.
PortalAgent	getPortalAgent() Gets the portal agent, used for manipulating teleporters.
WorldProperties	getProperties() Gets the properties for this world.
int	getSeaLevel() Gets the sea level of the world.
default SerializationBehavior	getSerializationBehavior() Gets the SerializationBehavior to use.
default Location<World>	getSpawnLocation() Gets the Location of the spawn point.
default UUID	getUniqueId() Gets this World's UUID.
int	getViewDistance() Gets the view distance (in chunks) for this world.
WorldBorder	getWorldBorder() Gets the world border for the world.
WorldGenerator	getWorldGenerator() Gets the WorldGenerator for this world.
WorldStorage	getWorldStorage() Gets the associated WorldStorage persisting this world.
Optional<Chunk>	loadChunk(int cx, int cy, int cz, boolean shouldGenerate) Gets the chunk at the given chunk coordinate position if it exists or if shouldGenerate is true and the chunk is generated.
default Optional<Chunk>	loadChunk(com.flowpowered.math.vector.Vector3i chunkPosition, boolean shouldGenerate) Gets the chunk at the given chunk coordinate position if it exists or if shouldGenerate is true and the chunk is generated.
default CompletableFuture<Optional<Chunk>>	loadChunkAsync(int cx, int cy, int cz, boolean shouldGenerate) Gets the chunk at the given chunk coordinate position if it exists or if shouldGenerate is true and the chunk is generated.
default CompletableFuture<Optional<Chunk>>	loadChunkAsync(com.flowpowered.math.vector.Vector3i chunkPosition, boolean shouldGenerate) Gets the chunk at the given chunk coordinate position if it exists or if shouldGenerate is true and the chunk is generated.
ChunkPreGenerate.Builder	newChunkPreGenerate(com.flowpowered.math.vector.Vector3d center, double diameter) Returns a new builder for creating a task to pre-generate the chunks inside a square border with a given center and diameter.
default Optional<Chunk>	regenerateChunk(int cx, int cy, int cz) Regenerates a chunk at the given chunk coordinates.
Optional<Chunk>	regenerateChunk(int cx, int cy, int cz, ChunkRegenerateFlag flag) Regenerates a chunk at the given chunk coordinates.
default Optional<Chunk>	regenerateChunk(com.flowpowered.math.vector.Vector3i chunkPosition) Regenerates a chunk at the given chunk coordinate position.
default Optional<Chunk>	regenerateChunk(com.flowpowered.math.vector.Vector3i chunkPosition, ChunkRegenerateFlag flag) Regenerates a chunk at the given chunk coordinate position.
void	resetViewDistance() Resets the view distance to the default value for this world.
boolean	save() Instructs the world to save all data.
default void	setKeepSpawnLoaded(boolean keepLoaded) Sets whether the spawn chunks should remain loaded.
default void	setSerializationBehavior(SerializationBehavior behavior) Sets the SerializationBehavior for use.
void	setViewDistance(int viewDistance) Sets the view distance (in chunks) for this world.
void	triggerExplosion(Explosion explosion) Causes an Explosion in a world.
boolean	unloadChunk(Chunk chunk) Unloads the given chunk from the world.

Methods inherited from interface org.spongepowered.api.world.extent.Extent

addScheduledUpdate, addScheduledUpdate, createArchetypeVolume, createSnapshot, createSnapshot, getBlockSelectionBox, getBlockSelectionBox, getCreator, getCreator, getExtentView, getHighestPositionAt, getHighestYAt, getHighestYAt, getIntersectingBlockCollisionBoxes, getIntersectingCollisionBoxes, getIntersectingCollisionBoxes, getNotifier, getNotifier, getPrecipitationLevelAt, getPrecipitationLevelAt, getPrecipitationLevelAt, getScheduledUpdates, getScheduledUpdates, isLoaded, removeScheduledUpdate, removeScheduledUpdate, restoreSnapshot, restoreSnapshot, restoreSnapshot, setBlock, setBlock, setBlockType, setBlockType, setCreator, setCreator, setNotifier, setNotifier

Methods inherited from interface org.spongepowered.api.world.extent.EntityUniverse

createEntity, createEntity, createEntity, createEntity, createEntityNaturally, createEntityNaturally, getEntities, getEntities, getIntersectingEntities, getIntersectingEntities, getIntersectingEntities, getIntersectingEntities, getIntersectingEntities, getIntersectingEntities, getIntersectingEntities, getIntersectingEntities, getNearbyEntities, restoreSnapshot, spawnEntities, spawnEntity

Methods inherited from interface org.spongepowered.api.world.extent.TileEntityVolume

getTileEntities, getTileEntities, getTileEntity, getTileEntity

Methods inherited from interface org.spongepowered.api.world.extent.InteractableVolume

digBlock, digBlock, digBlockWith, digBlockWith, getBlockDigTimeWith, getBlockDigTimeWith, hitBlock, hitBlock, interactBlock, interactBlock, interactBlockWith, interactBlockWith, placeBlock, placeBlock

Methods inherited from interface org.spongepowered.api.world.extent.MutableBlockVolume

getBlockView, getBlockView, getRelativeBlockView, setBlock, setBlock, setBlockType, setBlockType

Methods inherited from interface org.spongepowered.api.world.extent.BlockVolume

containsBlock, containsBlock, getBlock, getBlock, getBlockCopy, getBlockCopy, getBlockMax, getBlockMin, getBlockSize, getBlockType, getBlockType, getImmutableBlockCopy, getUnmodifiableBlockView

Methods inherited from interface org.spongepowered.api.world.extent.MutableBiomeVolume

getBiomeView, getBiomeView, getRelativeBiomeView, setBiome, setBiome

Methods inherited from interface org.spongepowered.api.world.extent.BiomeVolume

containsBiome, containsBiome, getBiome, getBiome, getBiomeCopy, getBiomeCopy, getBiomeMax, getBiomeMin, getBiomeSize, getImmutableBiomeCopy, getUnmodifiableBiomeView

Methods inherited from interface org.spongepowered.api.world.extent.LocationCompositeValueStore

copyFrom, copyFrom, copyFrom, copyFrom, copyFrom, copyFrom, copyFrom, copyFrom, get, get, get, get, getKeys, getKeys, getManipulators, getManipulators, getOrCreate, getOrCreate, getOrElse, getOrElse, getOrNull, getOrNull, getValue, getValue, getValues, getValues, offer, offer, offer, offer, offer, offer, offer, offer, offer, offer, offer, remove, remove, remove, remove, setRawData, setRawData, supports, supports, supports, supports, supports, supports, supports, supports, transform, transform, undo, undo, validateRawData, validateRawData

Methods inherited from interface org.spongepowered.api.data.property.LocationBasePropertyHolder

getFacesWithProperty, getFacesWithProperty, getProperties, getProperties, getProperty, getProperty, getProperty, getProperty

Methods inherited from interface org.spongepowered.api.world.weather.WeatherUniverse

getRemainingDuration, getRunningDuration, getWeather, setWeather, setWeather

Methods inherited from interface org.spongepowered.api.effect.Viewer

clearTitle, playRecord, playSound, playSound, playSound, playSound, playSound, playSound, resetBlockChange, resetBlockChange, resetTitle, sendBlockChange, sendBlockChange, sendBookView, sendTitle, spawnParticles, spawnParticles, stopRecord, stopSounds, stopSounds, stopSounds, stopSounds

Methods inherited from interface org.spongepowered.api.service.context.ContextSource

getContext

Methods inherited from interface org.spongepowered.api.text.channel.MessageReceiver

getMessageChannel, sendMessage, sendMessage, sendMessage, sendMessages, sendMessages, setMessageChannel

Methods inherited from interface org.spongepowered.api.text.channel.ChatTypeMessageReceiver

sendMessage, sendMessage, sendMessage, sendMessages, sendMessages

Method Detail

getPlayers

Collection<Player> getPlayers()

Gets an unmodifiable collection of Players currently in this world.

Returns:

The players

getLocation

default Location<World> getLocation(com.flowpowered.math.vector.Vector3i position)

Description copied from interface: Extent

Gets a location in this extent at the given position. Essentially, this is a 3D pointer in the extent.

Specified by:

getLocation in interface Extent

Parameters:

position - The position

Returns:

The location in this extent

getLocation

default Location<World> getLocation(int x,
                                    int y,
                                    int z)

Description copied from interface: Extent

Gets a location in this extent at the given position. Essentially, this is a 3D pointer in the extent.

Specified by:

getLocation in interface Extent

Parameters:

x - The X position

y - The Y position

z - The Z position

Returns:

The location in this extent

getLocation

default Location<World> getLocation(com.flowpowered.math.vector.Vector3d position)

Description copied from interface: Extent

Gets a location in this extent at the given position. Essentially, this is a 3D pointer in the extent. This method supports sub-block positions. Block-related methods use flooring to get integer coordinates.

Specified by:

getLocation in interface Extent

Parameters:

position - The position

Returns:

The location in this extent

getLocation

default Location<World> getLocation(double x,
                                    double y,
                                    double z)

Description copied from interface: Extent

Gets a location in this extent at the given position. Essentially, this is a 3D pointer in the extent. This method supports sub-block positions. Block-related methods use flooring to get integer coordinates.

Specified by:

getLocation in interface Extent

Parameters:

x - The X position

y - The Y position

z - The Z position

Returns:

The location in this extent

getLocatableBlock

default LocatableBlock getLocatableBlock(com.flowpowered.math.vector.Vector3i position)

Gets a LocatableBlock for the desired Vector3i position.

Parameters:

position - The position to get the locatable block

Returns:

The locatable block

getLocatableBlock

default LocatableBlock getLocatableBlock(int x,
                                         int y,
                                         int z)

Gets a LocatableBlock for the desired x, y, z coordinates.

Parameters:

x - The x position

y - The y position

z - The z position

Returns:

The locatable block

getChunkAtBlock

default Optional<Chunk> getChunkAtBlock(com.flowpowered.math.vector.Vector3i blockPosition)

Gets the loaded chunk at the given block coordinate position.

Parameters:

blockPosition - The position

Returns:

The chunk, if available

getChunkAtBlock

default Optional<Chunk> getChunkAtBlock(int bx,
                                        int by,
                                        int bz)

Gets the loaded chunk at the given block coordinate position.

Parameters:

bx - The x coordinate

by - The y coordinate

bz - The z coordinate

Returns:

The chunk, if available

getChunk

default Optional<Chunk> getChunk(com.flowpowered.math.vector.Vector3i chunkPosition)

Gets the loaded chunk at the given chunk coordinate position.

Parameters:

chunkPosition - The position

Returns:

The chunk, if available

getChunk

Optional<Chunk> getChunk(int cx,
                         int cy,
                         int cz)

Gets the loaded chunk at the given chunk coordinate position.

In Vanilla, the y coordinate will always be 0.

Parameters:

cx - The x coordinate

cy - The y coordinate

cz - The z coordinate

Returns:

The chunk, if available

loadChunk

default Optional<Chunk> loadChunk(com.flowpowered.math.vector.Vector3i chunkPosition,
                                  boolean shouldGenerate)

Gets the chunk at the given chunk coordinate position if it exists or if shouldGenerate is true and the chunk is generated.

Parameters:

chunkPosition - The position

shouldGenerate - True to generate a new chunk

Returns:

The loaded or generated chunk, if already generated

loadChunk

Optional<Chunk> loadChunk(int cx,
                          int cy,
                          int cz,
                          boolean shouldGenerate)

Gets the chunk at the given chunk coordinate position if it exists or if shouldGenerate is true and the chunk is generated.

In Vanilla, the y coordinate will always be 0.

Parameters:

cx - The x coordinate

cy - The y coordinate

cz - The z coordinate

shouldGenerate - True to generate a new chunk

Returns:

The loaded or generated chunk, if already generated

loadChunkAsync

default CompletableFuture<Optional<Chunk>> loadChunkAsync(com.flowpowered.math.vector.Vector3i chunkPosition,
                                                          boolean shouldGenerate)

Gets the chunk at the given chunk coordinate position if it exists or if shouldGenerate is true and the chunk is generated.

Unlike loadChunk(Vector3i, boolean) this method allows the implementation to load the chunk asynchronously without blocking the main server thread. The Future will be called with the chunk once the operation was completed.

Note: If asynchronous chunk loading is not supported by the implementation, the chunk will be loaded synchronously and the Future will be called immediately.

Parameters:

chunkPosition - The position

shouldGenerate - True to generate a new chunk

Returns:

The future callback for the loaded chunk

loadChunkAsync

default CompletableFuture<Optional<Chunk>> loadChunkAsync(int cx,
                                                          int cy,
                                                          int cz,
                                                          boolean shouldGenerate)

Gets the chunk at the given chunk coordinate position if it exists or if shouldGenerate is true and the chunk is generated.

Unlike loadChunk(Vector3i, boolean) this method allows the implementation to load the chunk asynchronously without blocking the main server thread. The Future will be called with the chunk once the operation was completed.

Note: If asynchronous chunk loading is not supported by the implementation, the chunk will be loaded synchronously and the Future will be called immediately.

Parameters:

cx - The x coordinate

cy - The y coordinate

cz - The z coordinate

shouldGenerate - True to generate a new chunk

Returns:

The future callback for the loaded chunk

regenerateChunk

default Optional<Chunk> regenerateChunk(com.flowpowered.math.vector.Vector3i chunkPosition)

Regenerates a chunk at the given chunk coordinate position.

Parameters:

chunkPosition - The chunk position to regenerate

Returns:

The regenerated chunk, if available

regenerateChunk

default Optional<Chunk> regenerateChunk(int cx,
                                        int cy,
                                        int cz)

Regenerates a chunk at the given chunk coordinates.

Parameters:

cx - The chunk x coordinate

cy - The chunk y coordinate

cz - The chunk z coordinate

Returns:

The regenerated chunk, if available

regenerateChunk

default Optional<Chunk> regenerateChunk(com.flowpowered.math.vector.Vector3i chunkPosition,
                                        ChunkRegenerateFlag flag)

Regenerates a chunk at the given chunk coordinate position.

Parameters:

chunkPosition - The chunk position to regenerate

flag - The chunk regenerate flag to use

Returns:

The regenerated chunk, if available

regenerateChunk

Optional<Chunk> regenerateChunk(int cx,
                                int cy,
                                int cz,
                                ChunkRegenerateFlag flag)

Regenerates a chunk at the given chunk coordinates.

Parameters:

cx - The chunk x coordinate

cy - The chunk y coordinate

cz - The chunk z coordinate

flag - The chunk regenerate flag to use

Returns:

The regenerated chunk, if available

unloadChunk

boolean unloadChunk(Chunk chunk)

Unloads the given chunk from the world. Returns a boolean flag for whether the operation was successful.

Parameters:

chunk - The chunk to unload

Returns:

Whether the operation was successful

getLoadedChunks

Iterable<Chunk> getLoadedChunks()

Returns a Collection of all actively loaded chunks in this world.

The ordering of the returned chunks is undefined.

Returns:

The loaded chunks

getEntity

Optional<Entity> getEntity(UUID uuid)

Gets the entity whose UUID matches the provided id, possibly returning no entity if the entity is not loaded or non-existent.

For world implementations, only some parts of the world is usually loaded, so this method may return no entity if the entity is not loaded.

Specified by:

getEntity in interface EntityUniverse

Parameters:

uuid - The unique id

Returns:

An entity, if available

getWorldBorder

WorldBorder getWorldBorder()

Gets the world border for the world.

Returns:

The world border

newChunkPreGenerate

ChunkPreGenerate.Builder newChunkPreGenerate(com.flowpowered.math.vector.Vector3d center,
                                             double diameter)

Returns a new builder for creating a task to pre-generate the chunks inside a square border with a given center and diameter.

Parameters:

center - The center of the border

diameter - The diameter of the border

Returns:

The builder for the chunk pre-generate task

See Also:

ChunkPreGenerate

getDimension

Dimension getDimension()

Returns the Dimension of this world.

Returns:

The Dimension

getWorldGenerator

WorldGenerator getWorldGenerator()

Gets the WorldGenerator for this world.

Any changes made to the world generator will only affect newly generated chunks.

Returns:

The world generator

getProperties

WorldProperties getProperties()

Gets the properties for this world.

Returns:

The properties

getDirectory

Path getDirectory()

Gets the Path pointing to the root of where the world's data is being stored.

Returns:

The path

getUniqueId

default UUID getUniqueId()

Gets this World's UUID.

Specified by:

getUniqueId in interface Identifiable

Returns:

The uuid for this world

See Also:

WorldProperties.getUniqueId()

getName

default String getName()

Gets the name of this world.

Returns:

The name for this world

See Also:

WorldProperties.getWorldName()

getDifficulty

default Difficulty getDifficulty()

Gets the current Difficulty.

Returns:

The difficulty for this world

See Also:

WorldProperties.getDifficulty()

getGameRule

default Optional<String> getGameRule(String gameRule)

Gets a set game rule's current value, if available and set.

Parameters:

gameRule - The game rule

Returns:

the game rule, if available

See Also:

WorldProperties.getGameRule(String)

getGameRules

default Map<String,String> getGameRules()

Gets the current map of game rules and their values. Most game rules can be found in DefaultGameRules.

Returns:

The map of game rules and their values

See Also:

WorldProperties.getGameRules()

doesKeepSpawnLoaded

default boolean doesKeepSpawnLoaded()

Gets whether the spawn chunks should remain loaded.

Returns:

True if the spawn of this world should remain loaded

See Also:

WorldProperties.doesKeepSpawnLoaded()

setKeepSpawnLoaded

default void setKeepSpawnLoaded(boolean keepLoaded)

Sets whether the spawn chunks should remain loaded.

Parameters:

keepLoaded - Whether to keep spawn loaded

See Also:

WorldProperties.setKeepSpawnLoaded(boolean)

getSpawnLocation

default Location<World> getSpawnLocation()

Gets the Location of the spawn point.

Returns:

The location

getSerializationBehavior

default SerializationBehavior getSerializationBehavior()

Gets the SerializationBehavior to use.

Returns:

The serialization behavior of this world

See Also:

WorldProperties.getSerializationBehavior()

setSerializationBehavior

default void setSerializationBehavior(SerializationBehavior behavior)

Sets the SerializationBehavior for use.

Parameters:

behavior - The serialization behavior to set

See Also:

WorldProperties.setSerializationBehavior(SerializationBehavior)

getWorldStorage

WorldStorage getWorldStorage()

Gets the associated WorldStorage persisting this world.

Returns:

The associated world storage

triggerExplosion

void triggerExplosion(Explosion explosion)

Causes an Explosion in a world.

Parameters:

explosion - The explosion to cause

getPortalAgent

PortalAgent getPortalAgent()

Gets the portal agent, used for manipulating teleporters.

Returns:

The portal agent

getSeaLevel

int getSeaLevel()

Gets the sea level of the world.

Returns:

The sea level

getBiomeWorker

MutableBiomeVolumeWorker<World> getBiomeWorker()

Description copied from interface: BiomeVolume

Gets a new biome worker for this biome volume.

Specified by:

getBiomeWorker in interface BiomeVolume

Specified by:

getBiomeWorker in interface Extent

Specified by:

getBiomeWorker in interface MutableBiomeVolume

Returns:

The biome worker

getBlockWorker

MutableBlockVolumeWorker<World> getBlockWorker()

Description copied from interface: BlockVolume

Gets a new block worker for this block volume.

Specified by:

getBlockWorker in interface BlockVolume

Specified by:

getBlockWorker in interface Extent

Specified by:

getBlockWorker in interface InteractableVolume

Specified by:

getBlockWorker in interface MutableBlockVolume

Specified by:

getBlockWorker in interface TileEntityVolume

Returns:

The block worker

save

boolean save()
      throws IOException

Instructs the world to save all data.

Returns:

True if save was successfull, or false if SerializationBehavior is SerializationBehaviors.NONE

Throws:

IOException - If the save failed

getViewDistance

int getViewDistance()

Gets the view distance (in chunks) for this world.

Returns:

The view distance

setViewDistance

void setViewDistance(int viewDistance)

Sets the view distance (in chunks) for this world.

The view distance must be greater than or equal to 3, and less than or equal to 32.

Parameters:

viewDistance - The view distance

resetViewDistance

void resetViewDistance()

Resets the view distance to the default value for this world.