Interface World

All Superinterfaces:

Audience, ForwardingAudience, Keyed, Pointered

public interface World
extends Keyed, ForwardingAudience

Nested Class Summary

Nested classes/interfaces inherited from interface ForwardingAudience

ForwardingAudience.Single

Method Summary

Modifier and Type	Method	Description
Optional<Key>	blockKeyAt(BlockPos pos)
int	blockLight(BlockPos pos)
DayNightCycle	dayNightCycle()
DimensionTypeDefinition	dimensionType()	Returns this world's dimension type.
Collection<? extends Entity>	entities()
Entity	entity(int entityId)
Entity	entity(UUID uuid)
Set<ChunkPos>	forceLoadedChunks()	Returns an immutable snapshot of the force-loaded chunks of this world.
int	getBlockStateId(BlockPos pos)
CompletableFuture<Chunk>	getChunkAsync(int chunkX, int chunkZ)
default CompletableFuture<Chunk>	getChunkAsync(ChunkPos pos)
Optional<Chunk>	getChunkIfLoaded(int chunkX, int chunkZ)
default Chunk	getChunkIfLoaded(ChunkPos pos)
int	height()
boolean	isChunkForceLoaded(int chunkX, int chunkZ)	Whether a chunk is force-loaded.
default boolean	isChunkForceLoaded(ChunkPos pos)	Whether a chunk is force-loaded.
default boolean	isChunkLoaded(int chunkX, int chunkZ)
int	lightLevel(BlockPos pos)
int	minY()
RegionizedScheduler	scheduler()	Returns the scheduler responsible for running tasks against positions in this world.
boolean	setBlockStateId(BlockPos pos, int stateId)
boolean	setChunkForceLoaded(int chunkX, int chunkZ, boolean forced)	Sets the force-loaded state of a chunk.
int	skyLight(BlockPos pos)
CompletableFuture<Boolean>	unloadChunkAsync(int chunkX, int chunkZ)
default CompletableFuture<Boolean>	unloadChunkAsync(ChunkPos pos)

Methods inherited from interface Audience

deleteMessage, openBook, openBook, removeResourcePacks, removeResourcePacks, removeResourcePacks, sendActionBar, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendResourcePacks, sendResourcePacks, showTitle, stopSound

Methods inherited from interface ForwardingAudience

audiences, clearResourcePacks, clearTitle, closeDialog, deleteMessage, filterAudience, forEachAudience, hideBossBar, openBook, playSound, playSound, playSound, pointers, removeResourcePacks, removeResourcePacks, resetTitle, sendActionBar, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendResourcePacks, sendTitlePart, showBossBar, showDialog, stopSound

Methods inherited from interface Keyed

key

Methods inherited from interface Pointered

get, getOrDefault, getOrDefaultFrom

Method Details

minY

int minY()

height

int height()

dimensionType

DimensionTypeDefinition dimensionType()

Returns this world's dimension type.

Returns:

this world's dimension type

Since:

0.1.0

dayNightCycle

DayNightCycle dayNightCycle()

scheduler

RegionizedScheduler scheduler()

Returns the scheduler responsible for running tasks against positions in this world.

Returns:

the scheduler responsible for running tasks against positions in this world

Since:

0.1.0

getChunkAsync

CompletableFuture<Chunk> getChunkAsync(int chunkX,
 int chunkZ)

getChunkAsync

default CompletableFuture<Chunk> getChunkAsync(ChunkPos pos)

getChunkIfLoaded

Optional<Chunk> getChunkIfLoaded(int chunkX,
 int chunkZ)

getChunkIfLoaded

default Chunk getChunkIfLoaded(ChunkPos pos)

isChunkForceLoaded

boolean isChunkForceLoaded(int chunkX,
 int chunkZ)

Whether a chunk is force-loaded.

Parameters:

chunkX - the chunk X coordinate

chunkZ - the chunk Z coordinate

Returns:

true if the chunk is force-loaded

Since:

0.1.0

isChunkForceLoaded

default boolean isChunkForceLoaded(ChunkPos pos)

Whether a chunk is force-loaded.

Parameters:

pos - the chunk position

Returns:

true if the chunk is force-loaded

Since:

0.1.0

See Also:

• isChunkForceLoaded(int, int)

forceLoadedChunks

Set<ChunkPos> forceLoadedChunks()

Returns an immutable snapshot of the force-loaded chunks of this world.

Returns:

an immutable snapshot of the force-loaded chunks of this world

Since:

0.1.0

isChunkLoaded

default boolean isChunkLoaded(int chunkX,
 int chunkZ)

blockKeyAt

Optional<Key> blockKeyAt(BlockPos pos)

getBlockStateId

int getBlockStateId(BlockPos pos)

setBlockStateId

boolean setBlockStateId(BlockPos pos,
 int stateId)

blockLight

int blockLight(BlockPos pos)

skyLight

int skyLight(BlockPos pos)

lightLevel

int lightLevel(BlockPos pos)

entities

Collection<? extends Entity> entities()

entity

Entity entity(UUID uuid)

entity

Entity entity(int entityId)

setChunkForceLoaded

boolean setChunkForceLoaded(int chunkX,
 int chunkZ,
 boolean forced)

Sets the force-loaded state of a chunk.

Parameters:

chunkX - the chunk X coordinate

chunkZ - the chunk Z coordinate

forced - whether to force-load or unforce-load the chunk

Returns:

true forces the chunk to remain loaded, false removes the loaded chunk

Since:

0.1.0

unloadChunkAsync

CompletableFuture<Boolean> unloadChunkAsync(int chunkX,
 int chunkZ)

unloadChunkAsync

default CompletableFuture<Boolean> unloadChunkAsync(ChunkPos pos)