All Superinterfaces:: net.kyori.adventure.audience.Audience, net.kyori.adventure.audience.ForwardingAudience, Keyed, Metadatable, PluginMessageRecipient, net.kyori.adventure.pointer.Pointered

public interface World extends PluginMessageRecipient, Metadatable, net.kyori.adventure.audience.ForwardingAudience, Keyed

Represents a world, which may contain entities, chunks and blocks

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static interface

World.ChunkLoadCallback

Deprecated.
Use either the Future or the Consumer based methods

static class

World.Environment

Represents various map environment types that a world may be

static class

World.Spigot

Nested classes/interfaces inherited from interface net.kyori.adventure.audience.ForwardingAudience
net.kyori.adventure.audience.ForwardingAudience.Single
Method Summary

Modifier and Type

Method

Description

boolean

addPluginChunkTicket(int x, int z, @NotNull Plugin plugin)

Adds a plugin ticket for the specified chunk, loading the chunk if it is not already loaded.

default @NotNull Iterable<? extends net.kyori.adventure.audience.Audience>

audiences()

boolean

canGenerateStructures()

Gets whether or not structures are being generated.

boolean

createExplosion(double x, double y, double z, float power)

Creates explosion at given coordinates with given power

boolean

createExplosion(double x, double y, double z, float power, boolean setFire)

Creates explosion at given coordinates with given power and optionally setting blocks on fire.

boolean

createExplosion(double x, double y, double z, float power, boolean setFire, boolean breakBlocks)

Creates explosion at given coordinates with given power and optionally setting blocks on fire or breaking blocks.

boolean

createExplosion(double x, double y, double z, float power, boolean setFire, boolean breakBlocks, @Nullable Entity source)

Creates explosion at given coordinates with given power and optionally setting blocks on fire or breaking blocks.

default boolean

createExplosion(@NotNull Entity source, float power)

Creates explosion at given entities location with given power and optionally setting blocks on fire, with the specified entity as the source.

default boolean

createExplosion(@NotNull Entity source, float power, boolean setFire)

Creates explosion at given entities location with given power and optionally setting blocks on fire, with the specified entity as the source.

default boolean

createExplosion(@NotNull Entity source, float power, boolean setFire, boolean breakBlocks)

Creates explosion at given entities location with given power and optionally setting blocks on fire, with the specified entity as the source.

boolean

createExplosion(@NotNull Location loc, float power)

Creates explosion at given coordinates with given power

boolean

createExplosion(@NotNull Location loc, float power, boolean setFire)

Creates explosion at given coordinates with given power and optionally setting blocks on fire.

boolean

createExplosion(@NotNull Location loc, float power, boolean setFire, boolean breakBlocks)

Creates explosion at given coordinates with given power and optionally setting blocks on fire or breaking blocks.

boolean

createExplosion(@NotNull Location loc, float power, boolean setFire, boolean breakBlocks, @Nullable Entity source)

Creates explosion at given coordinates with given power and optionally setting blocks on fire or breaking blocks.

default boolean

createExplosion(@Nullable Entity source, @NotNull Location loc, float power)

Creates explosion at given location with given power, with the specified entity as the source.

default boolean

createExplosion(@Nullable Entity source, @NotNull Location loc, float power, boolean setFire)

Creates explosion at given location with given power and optionally setting blocks on fire, with the specified entity as the source.

boolean

createExplosion(@Nullable Entity source, @NotNull Location loc, float power, boolean setFire, boolean breakBlocks)

Creates explosion at given location with given power and optionally setting blocks on fire, with the specified entity as the source.

boolean

doesBedWork()

Checks if beds work

boolean

doesRespawnAnchorWork()

Checks if respawn anchors work

@NotNull Item

dropItem(@NotNull Location location, @NotNull ItemStack item)

Drops an item at the specified Location

@NotNull Item

dropItem(@NotNull Location location, @NotNull ItemStack item, @Nullable Consumer<Item> function)

Drops an item at the specified Location Note that functions will run before the entity is spawned

@NotNull Item

dropItemNaturally(@NotNull Location location, @NotNull ItemStack item)

Drops an item at the specified Location with a random offset

@NotNull Item

dropItemNaturally(@NotNull Location location, @NotNull ItemStack item, @Nullable Consumer<Item> function)

Drops an item at the specified Location with a random offset Note that functions will run before the entity is spawned

boolean

generateTree(@NotNull Location location, @NotNull TreeType type)

Creates a tree at the given Location

boolean

generateTree(@NotNull Location loc, @NotNull TreeType type, @NotNull BlockChangeDelegate delegate)

Creates a tree at the given Location

boolean

getAllowAnimals()

Gets whether animals can spawn in this world.

boolean

getAllowMonsters()

Gets whether monsters can spawn in this world.

int

getAmbientSpawnLimit()

Gets the limit for number of ambient mobs that can spawn in a chunk in this world

int

getAnimalSpawnLimit()

Gets the limit for number of animals that can spawn in a chunk in this world

@NotNull Biome

getBiome(int x, int z)

Deprecated.
biomes are now 3-dimensional

@NotNull Biome

getBiome(int x, int y, int z)

Gets the biome for the given block coordinates.

@NotNull Block

getBlockAt(int x, int y, int z)

Gets the Block at the given coordinates

@NotNull Block

getBlockAt(@NotNull Location location)

Gets the Block at the given Location

default @NotNull Block

getBlockAtKey(long key)

Gets the Block at the given block key

@NotNull Chunk

getChunkAt(int x, int z)

Gets the Chunk at the given coordinates

default @NotNull Chunk

getChunkAt(long chunkKey)

Gets the chunk at the specified chunk key, which is the X and Z packed into a long.

@NotNull Chunk

getChunkAt(@NotNull Block block)

Gets the Chunk that contains the given Block

@NotNull Chunk

getChunkAt(@NotNull Location location)

Gets the Chunk at the given Location

default CompletableFuture<Chunk>

getChunkAtAsync(int x, int z)

Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time.

default CompletableFuture<Chunk>

getChunkAtAsync(int x, int z, boolean gen)

Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time.

CompletableFuture<Chunk>

getChunkAtAsync(int x, int z, boolean gen, boolean urgent)

default void

getChunkAtAsync(int x, int z, boolean gen, Consumer<Chunk> cb)

Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time.

default void

getChunkAtAsync(int x, int z, @NotNull World.ChunkLoadCallback cb)

Deprecated.
Use either the Future or the Consumer based methods

default void

getChunkAtAsync(int x, int z, Consumer<Chunk> cb)

Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time.

default CompletableFuture<Chunk>

getChunkAtAsync(@NotNull Block block)

Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time.

default CompletableFuture<Chunk>

getChunkAtAsync(@NotNull Block block, boolean gen)

Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time.

default void

getChunkAtAsync(@NotNull Block block, boolean gen, Consumer<Chunk> cb)

Requests Chunk to be loaded that contains the given Block This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time.

default void

getChunkAtAsync(@NotNull Block block, @NotNull World.ChunkLoadCallback cb)

Deprecated.
Use either the Future or the Consumer based methods

default void

getChunkAtAsync(@NotNull Block block, Consumer<Chunk> cb)

Requests Chunk to be loaded that contains the given Block This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time.

default CompletableFuture<Chunk>

getChunkAtAsync(@NotNull Location loc)

Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time.

default CompletableFuture<Chunk>

getChunkAtAsync(@NotNull Location loc, boolean gen)

Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time.

default void

getChunkAtAsync(@NotNull Location loc, boolean gen, Consumer<Chunk> cb)

Requests a Chunk to be loaded at the given Location This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time.

default void

getChunkAtAsync(@NotNull Location loc, @NotNull World.ChunkLoadCallback cb)

Deprecated.
Use either the Future or the Consumer based methods

default void

getChunkAtAsync(@NotNull Location loc, Consumer<Chunk> cb)

Requests a Chunk to be loaded at the given Location This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time.

default CompletableFuture<Chunk>

getChunkAtAsyncUrgently(int x, int z)

Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time.

default CompletableFuture<Chunk>

getChunkAtAsyncUrgently(@NotNull Block block)

Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time.

default CompletableFuture<Chunk>

getChunkAtAsyncUrgently(@NotNull Block block, boolean gen)

Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time.

default CompletableFuture<Chunk>

getChunkAtAsyncUrgently(@NotNull Location loc)

Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time.

default CompletableFuture<Chunk>

getChunkAtAsyncUrgently(@NotNull Location loc, boolean gen)

Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time.

int

getChunkCount()

int

getClearWeatherDuration()

Get the clear weather duration.

double

getCoordinateScale()

Gets the coordinate scaling of this world.

@NotNull Difficulty

getDifficulty()

Gets the Difficulty of the world.

@NotNull ChunkSnapshot

getEmptyChunkSnapshot(int x, int z, boolean includeBiome, boolean includeBiomeTemp)

Get empty chunk snapshot (equivalent to all air blocks), optionally including valid biome data.

@Nullable DragonBattle

getEnderDragonBattle()

Get the DragonBattle associated with this world.

@NotNull List<Entity>

getEntities()

Get a list of all entities in this World

<T extends Entity> @NotNull Collection<T>

getEntitiesByClass(@NotNull Class<T> cls)

Get a collection of all entities in this World matching the given class/interface

<T extends Entity> @NotNull Collection<T>

getEntitiesByClass(@NotNull Class<T>... classes)

Deprecated.

@NotNull Collection<Entity>

getEntitiesByClasses(@NotNull Class<?>... classes)

Get a collection of all entities in this World matching any of the given classes/interfaces

@Nullable Entity

getEntity(@NotNull UUID uuid)

Gets an entity in this world by its UUID

int

getEntityCount()

@NotNull World.Environment

getEnvironment()

Gets the World.Environment type of this world

@NotNull Collection<Chunk>

getForceLoadedChunks()

Returns all force loaded chunks in this world.

long

getFullTime()

Gets the full in-game time on this world

<T> T

getGameRuleDefault(@NotNull GameRule<T> rule)

Get the default value for a given GameRule.

@NotNull String[]

getGameRules()

Get an array containing the names of all the GameRules.

<T> T

getGameRuleValue(@NotNull GameRule<T> rule)

Get the current value for a given GameRule.

@Nullable String

getGameRuleValue(@Nullable String rule)

Deprecated.
use getGameRuleValue(GameRule) instead

long

getGameTime()

Gets the full in-game time on this world since the world generation

@Nullable ChunkGenerator

getGenerator()

Gets the chunk generator for this world

@NotNull Block

getHighestBlockAt(int x, int z)

Gets the highest non-empty (impassable) block at the given coordinates.

@NotNull Block

getHighestBlockAt(int x, int z, @NotNull HeightMap heightMap)

Gets the highest block corresponding to the HeightMap at the given coordinates.

default @NotNull Block

getHighestBlockAt(int x, int z, HeightmapType heightmap)

Deprecated.
Upstream has added support for this, use getHighestBlockAt(int, int, HeightMap)

@NotNull Block

getHighestBlockAt(@NotNull Location location)

Gets the highest non-empty (impassable) block at the given coordinates.

@NotNull Block

getHighestBlockAt(@NotNull Location location, @NotNull HeightMap heightMap)

Gets the highest block corresponding to the HeightMap at the given coordinates.

default @NotNull Block

getHighestBlockAt(@NotNull Location location, HeightmapType heightmap)

Deprecated.
Upstream has added support for this, use getHighestBlockAt(Location, HeightMap)

int

getHighestBlockYAt(int x, int z)

Gets the highest non-empty (impassable) coordinate at the given coordinates.

int

getHighestBlockYAt(int x, int z, @NotNull HeightMap heightMap)

Gets the highest coordinate corresponding to the HeightMap at the given coordinates.

int

getHighestBlockYAt(int x, int z, HeightmapType heightmap)

Deprecated.
Upstream has added support for this, use getHighestBlockYAt(int, int, HeightMap)

int

getHighestBlockYAt(@NotNull Location location)

Gets the highest non-empty (impassable) coordinate at the given Location.

int

getHighestBlockYAt(@NotNull Location location, @NotNull HeightMap heightMap)

Gets the highest coordinate corresponding to the HeightMap at the given Location.

default int

getHighestBlockYAt(@NotNull Location location, HeightmapType heightmap)

Deprecated.
Upstream has added support for this, use getHighestBlockYAt(Location, HeightMap)

double

getHumidity(int x, int z)

Deprecated.
biomes are now 3-dimensional

double

getHumidity(int x, int y, int z)

Gets the humidity for the given block coordinates.

@NotNull Collection<Material>

getInfiniburn()

Gets the collection of materials that burn infinitely in this world.

boolean

getKeepSpawnInMemory()

Gets whether the world's spawn area should be kept loaded into memory or not.

@NotNull NamespacedKey

getKey()

Get the world's key

@NotNull List<LivingEntity>

getLivingEntities()

Get a list of all living entities in this World

@NotNull Chunk[]

getLoadedChunks()

Gets an array of all loaded Chunks

default @NotNull Location

getLocationAtKey(long key)

Gets the Location at the given block key

int

getMaxHeight()

Gets the maximum height of this world.

int

getMinHeight()

Gets the minimum height of this world.

int

getMonsterSpawnLimit()

Gets limit for number of monsters that can spawn in a chunk in this world

MoonPhase

getMoonPhase()

@NotNull String

getName()

Gets the unique name of this world

@NotNull Collection<Entity>

getNearbyEntities(@NotNull Location location, double x, double y, double z)

Returns a list of entities within a bounding box centered around a Location.

@NotNull Collection<Entity>

getNearbyEntities(@NotNull Location location, double x, double y, double z, @Nullable Predicate<Entity> filter)

Returns a list of entities within a bounding box centered around a Location.

@NotNull Collection<Entity>

getNearbyEntities(@NotNull BoundingBox boundingBox)

Returns a list of entities within the given bounding box.

@NotNull Collection<Entity>

getNearbyEntities(@NotNull BoundingBox boundingBox, @Nullable Predicate<Entity> filter)

Returns a list of entities within the given bounding box.

default <T extends Entity> @NotNull Collection<T>

getNearbyEntitiesByType(@Nullable Class<? extends Entity> clazz, @NotNull Location loc, double xRadius, double yRadius, double zRadius, @Nullable Predicate<T> predicate)

Gets all nearby entities of the specified type, within the specified radius (bounding box)

default <T extends Entity> @NotNull Collection<T>

getNearbyEntitiesByType(@Nullable Class<? extends T> clazz, @NotNull Location loc, double radius)

Gets all nearby entities of the specified type, within the specified radius (bounding box)

default <T extends Entity> @NotNull Collection<T>

getNearbyEntitiesByType(@Nullable Class<? extends T> clazz, @NotNull Location loc, double xzRadius, double yRadius)

Gets all nearby entities of the specified type, within the specified radius, with x and x radius matching (bounding box)

default <T extends Entity> @NotNull Collection<T>

getNearbyEntitiesByType(@Nullable Class<? extends T> clazz, @NotNull Location loc, double xRadius, double yRadius, double zRadius)

Gets all nearby entities of the specified type, within the specified radius (bounding box)

default <T extends Entity> @NotNull Collection<T>

getNearbyEntitiesByType(@Nullable Class<? extends T> clazz, @NotNull Location loc, double xzRadius, double yRadius, @Nullable Predicate<T> predicate)

Gets all nearby entities of the specified type, within the specified radius, with x and x radius matching (bounding box)

default <T extends Entity> @NotNull Collection<T>

getNearbyEntitiesByType(@Nullable Class<? extends T> clazz, @NotNull Location loc, double radius, @Nullable Predicate<T> predicate)

Gets all nearby entities of the specified type, within the specified radius (bounding box)

default @NotNull Collection<LivingEntity>

getNearbyLivingEntities(@NotNull Location loc, double radius)

Gets nearby players within the specified radius (bounding box)

default @NotNull Collection<LivingEntity>

getNearbyLivingEntities(@NotNull Location loc, double xzRadius, double yRadius)

Gets nearby players within the specified radius (bounding box)

default @NotNull Collection<LivingEntity>

getNearbyLivingEntities(@NotNull Location loc, double xRadius, double yRadius, double zRadius)

Gets nearby players within the specified radius (bounding box)

default @NotNull Collection<LivingEntity>

getNearbyLivingEntities(@NotNull Location loc, double xRadius, double yRadius, double zRadius, @Nullable Predicate<LivingEntity> predicate)

Gets nearby players within the specified radius (bounding box)

default @NotNull Collection<LivingEntity>

getNearbyLivingEntities(@NotNull Location loc, double xzRadius, double yRadius, @Nullable Predicate<LivingEntity> predicate)

Gets nearby players within the specified radius (bounding box)

default @NotNull Collection<LivingEntity>

getNearbyLivingEntities(@NotNull Location loc, double radius, @Nullable Predicate<LivingEntity> predicate)

Gets nearby players within the specified radius (bounding box)

default @NotNull Collection<Player>

getNearbyPlayers(@NotNull Location loc, double radius)

Gets nearby players within the specified radius (bounding box)

default @NotNull Collection<Player>

getNearbyPlayers(@NotNull Location loc, double xzRadius, double yRadius)

Gets nearby players within the specified radius (bounding box)

default @NotNull Collection<Player>

getNearbyPlayers(@NotNull Location loc, double xRadius, double yRadius, double zRadius)

Gets nearby players within the specified radius (bounding box)

default @NotNull Collection<Player>

getNearbyPlayers(@NotNull Location loc, double xRadius, double yRadius, double zRadius, @Nullable Predicate<Player> predicate)

Gets nearby players within the specified radius (bounding box)

default @NotNull Collection<Player>

getNearbyPlayers(@NotNull Location loc, double xzRadius, double yRadius, @Nullable Predicate<Player> predicate)

Gets nearby players within the specified radius (bounding box)

default @NotNull Collection<Player>

getNearbyPlayers(@NotNull Location loc, double radius, @Nullable Predicate<Player> predicate)

Gets nearby players within the specified radius (bounding box)

int

getNoTickViewDistance()

Returns the no-tick view distance for this world.

int

getPlayerCount()

@NotNull List<Player>

getPlayers()

Get a list of all players in this World

@NotNull Map<Plugin,Collection<Chunk>>

getPluginChunkTickets()

Returns a map of which plugins have tickets for what chunks.

@NotNull Collection<Plugin>

getPluginChunkTickets(int x, int z)

Retrieves a collection specifying which plugins have tickets for the specified chunk.

@NotNull List<BlockPopulator>

getPopulators()

Gets a list of all applied BlockPopulators for this World

boolean

getPVP()

Gets the current PVP setting for this world.

@NotNull List<Raid>

getRaids()

Gets all raids that are going on over this world.

int

getSeaLevel()

Gets the sea level for this world.

long

getSeed()

Gets the Seed for this world.

@NotNull Location

getSpawnLocation()

Gets the default spawn Location of this world

double

getTemperature(int x, int z)

Deprecated.
biomes are now 3-dimensional

double

getTemperature(int x, int y, int z)

Gets the temperature for the given block coordinates.

int

getThunderDuration()

Get the thundering duration.

int

getTickableTileEntityCount()

long

getTicksPerAmbientSpawns()

Gets the world's ticks per ambient mob spawns value

long

getTicksPerAnimalSpawns()

Gets the world's ticks per animal spawns value

long

getTicksPerMonsterSpawns()

Gets the world's ticks per monster spawns value

long

getTicksPerWaterAmbientSpawns()

Gets the default ticks per water ambient mob spawns value.

long

getTicksPerWaterSpawns()

Gets the world's ticks per water mob spawns value

int

getTileEntityCount()

long

getTime()

Gets the relative in-game time of this world.

@NotNull UUID

getUID()

Gets the Unique ID of this world

int

getViewDistance()

Returns the view distance used for this world.

int

getWaterAmbientSpawnLimit()

Gets user-specified limit for number of water ambient mobs that can spawn in a chunk.

int

getWaterAnimalSpawnLimit()

Gets the limit for number of water animals that can spawn in a chunk in this world

int

getWeatherDuration()

Get the remaining time in ticks of the current conditions.

@NotNull WorldBorder

getWorldBorder()

Gets the world border for this world.

@NotNull File

getWorldFolder()

Gets the folder of this world on disk.

@Nullable WorldType

getWorldType()

Deprecated.
world type is only used to select the default word generation settings and is not stored in Vanilla worlds, making it impossible for this method to always return the correct value.

boolean

hasBedrockCeiling()

Checks if the world has a bedrock ceiling

boolean

hasRaids()

Checks if this world supports raids

boolean

hasSkylight()

Checks if the world has skylight access

boolean

hasStorm()

Returns whether the world has an ongoing storm.

boolean

isAutoSave()

Gets whether or not the world will automatically save

boolean

isChunkForceLoaded(int x, int z)

Gets whether the chunk at the specified chunk coordinates is force loaded.

boolean

isChunkGenerated(int x, int z)

Checks if the Chunk at the specified coordinates is generated

default boolean

isChunkGenerated(long chunkKey)

Checks if a Chunk has been generated at the specified chunk key, which is the X and Z packed into a long.

boolean

isChunkInUse(int x, int z)

Deprecated.
This method was added to facilitate chunk garbage collection.

boolean

isChunkLoaded(int x, int z)

Checks if the Chunk at the specified coordinates is loaded

boolean

isChunkLoaded(@NotNull Chunk chunk)

Checks if the specified Chunk is loaded

boolean

isClearWeather()

Returns whether the world has clear weather.

boolean

isDayTime()

Check if it is currently daytime in this world

boolean

isFixedTime()

Checks if this world has a fixed time

boolean

isGameRule(@NotNull String rule)

Checks if string is a valid game rule

boolean

isHardcore()

Gets whether the world is hardcore or not.

boolean

isNatural()

Checks if the world is natural.

boolean

isPiglinSafe()

Checks if piglins will turn into Zombified Piglins in this world

boolean

isThundering()

Returns whether there is thunder.

boolean

isUltrawarm()

Checks if the world: evaporates water dries sponges has lava spread faster and further

boolean

lineOfSightExists(@NotNull Location from, @NotNull Location to)

Tell whether a line of sight exists between the given locations

void

loadChunk(int x, int z)

Loads the Chunk at the specified coordinates.

boolean

loadChunk(int x, int z, boolean generate)

Loads the Chunk at the specified coordinates.

void

loadChunk(@NotNull Chunk chunk)

Loads the specified Chunk.

@Nullable Location

locateNearestBiome(@NotNull Location origin, @NotNull Biome biome, int radius)

Locates the nearest biome based on an origin, biome type, and radius to search.

@Nullable Location

locateNearestBiome(@NotNull Location origin, @NotNull Biome biome, int radius, int step)

Locates the nearest biome based on an origin, biome type, and radius to search and step

@Nullable Raid

locateNearestRaid(@NotNull Location location, int radius)

Finds the nearest raid close to the given location.

@Nullable Location

locateNearestStructure(@NotNull Location origin, @NotNull StructureType structureType, int radius, boolean findUnexplored)

Find the closest nearby structure of a given StructureType.

void

playEffect(@NotNull Location location, @NotNull Effect effect, int data)

Plays an effect to all players within a default radius around a given location.

void

playEffect(@NotNull Location location, @NotNull Effect effect, int data, int radius)

Plays an effect to all players within a given radius around a location.

<T> void

playEffect(@NotNull Location location, @NotNull Effect effect, T data)

Plays an effect to all players within a default radius around a given location.

<T> void

playEffect(@NotNull Location location, @NotNull Effect effect, T data, int radius)

Plays an effect to all players within a given radius around a location.

void

playSound(@NotNull Location location, @NotNull String sound, float volume, float pitch)

Play a Sound at the provided Location in the World.

void

playSound(@NotNull Location location, @NotNull String sound, @NotNull SoundCategory category, float volume, float pitch)

Play a Sound at the provided Location in the World.

void

playSound(@NotNull Location location, @NotNull Sound sound, float volume, float pitch)

Play a Sound at the provided Location in the World

void

playSound(@NotNull Location location, @NotNull Sound sound, @NotNull SoundCategory category, float volume, float pitch)

Play a Sound at the provided Location in the World.

@Nullable RayTraceResult

rayTrace(@NotNull Location start, @NotNull Vector direction, double maxDistance, @NotNull FluidCollisionMode fluidCollisionMode, boolean ignorePassableBlocks, double raySize, @Nullable Predicate<Entity> filter)

Performs a ray trace that checks for both block and entity collisions.

@Nullable RayTraceResult

rayTraceBlocks(@NotNull Location start, @NotNull Vector direction, double maxDistance)

Performs a ray trace that checks for block collisions using the blocks' precise collision shapes.

@Nullable RayTraceResult

rayTraceBlocks(@NotNull Location start, @NotNull Vector direction, double maxDistance, @NotNull FluidCollisionMode fluidCollisionMode)

Performs a ray trace that checks for block collisions using the blocks' precise collision shapes.

@Nullable RayTraceResult

rayTraceBlocks(@NotNull Location start, @NotNull Vector direction, double maxDistance, @NotNull FluidCollisionMode fluidCollisionMode, boolean ignorePassableBlocks)

Performs a ray trace that checks for block collisions using the blocks' precise collision shapes.

@Nullable RayTraceResult

rayTraceEntities(@NotNull Location start, @NotNull Vector direction, double maxDistance)

Performs a ray trace that checks for entity collisions.

@Nullable RayTraceResult

rayTraceEntities(@NotNull Location start, @NotNull Vector direction, double maxDistance, double raySize)

Performs a ray trace that checks for entity collisions.

@Nullable RayTraceResult

rayTraceEntities(@NotNull Location start, @NotNull Vector direction, double maxDistance, double raySize, @Nullable Predicate<Entity> filter)

Performs a ray trace that checks for entity collisions.

@Nullable RayTraceResult

rayTraceEntities(@NotNull Location start, @NotNull Vector direction, double maxDistance, @Nullable Predicate<Entity> filter)

Performs a ray trace that checks for entity collisions.

boolean

refreshChunk(int x, int z)

Deprecated.
This method is not guaranteed to work suitably across all client implementations.

boolean

regenerateChunk(int x, int z)

Deprecated.
regenerating a single chunk is not likely to produce the same chunk as before as terrain decoration may be spread across chunks.

boolean

removePluginChunkTicket(int x, int z, @NotNull Plugin plugin)

Removes the specified plugin's ticket for the specified chunk

void

removePluginChunkTickets(@NotNull Plugin plugin)

Removes all plugin tickets for the specified plugin

void

save()

Saves world to disk

void

setAmbientSpawnLimit(int limit)

Sets the limit for number of ambient mobs that can spawn in a chunk in this world

void

setAnimalSpawnLimit(int limit)

Sets the limit for number of animals that can spawn in a chunk in this world

void

setAutoSave(boolean value)

Sets whether or not the world will automatically save

void

setBiome(int x, int y, int z, @NotNull Biome bio)

Sets the biome for the given block coordinates

void

setBiome(int x, int z, @NotNull Biome bio)

Deprecated.
biomes are now 3-dimensional

void

setChunkForceLoaded(int x, int z, boolean forced)

Sets whether the chunk at the specified chunk coordinates is force loaded.

void

setClearWeatherDuration(int duration)

Set the clear weather duration.

void

setDifficulty(@NotNull Difficulty difficulty)

Sets the Difficulty of the world.

void

setFullTime(long time)

Sets the in-game time on the server

<T> boolean

setGameRule(@NotNull GameRule<T> rule, T newValue)

Set the given GameRule's new value.

boolean

setGameRuleValue(@NotNull String rule, @NotNull String value)

Deprecated.
use setGameRule(GameRule, Object) instead.

void

setHardcore(boolean hardcore)

Sets whether the world is hardcore or not.

void

setKeepSpawnInMemory(boolean keepLoaded)

Sets whether the world's spawn area should be kept loaded into memory or not.

void

setMonsterSpawnLimit(int limit)

Sets the limit for number of monsters that can spawn in a chunk in this world

void

setNoTickViewDistance(int viewDistance)

Sets the no-tick view distance for this world.

void

setPVP(boolean pvp)

Sets the PVP setting for this world.

void

setSpawnFlags(boolean allowMonsters, boolean allowAnimals)

Sets the spawn flags for this.

boolean

setSpawnLocation(int x, int y, int z)

Sets the spawn location of the world

boolean

setSpawnLocation(int x, int y, int z, float angle)

Sets the spawn location of the world

boolean

setSpawnLocation(@NotNull Location location)

Sets the spawn location of the world.

void

setStorm(boolean hasStorm)

Set whether there is a storm.

void

setThunderDuration(int duration)

Set the thundering duration.

void

setThundering(boolean thundering)

Set whether it is thundering.

void

setTicksPerAmbientSpawns(int ticksPerAmbientSpawns)

Sets the world's ticks per ambient mob spawns value

void

setTicksPerAnimalSpawns(int ticksPerAnimalSpawns)

Sets the world's ticks per animal spawns value

void

setTicksPerMonsterSpawns(int ticksPerMonsterSpawns)

Sets the world's ticks per monster spawns value

void

setTicksPerWaterAmbientSpawns(int ticksPerAmbientSpawns)

Sets the world's ticks per water ambient mob spawns value

void

setTicksPerWaterSpawns(int ticksPerWaterSpawns)

Sets the world's ticks per water mob spawns value

void

setTime(long time)

Sets the relative in-game time on the server.

void

setViewDistance(int viewDistance)

Sets the view distance for this world.

void

setWaterAmbientSpawnLimit(int limit)

Sets the limit for number of water ambient mobs that can spawn in a chunk in this world

void

setWaterAnimalSpawnLimit(int limit)

Sets the limit for number of water animals that can spawn in a chunk in this world

void

setWeatherDuration(int duration)

Set the remaining time in ticks of the current conditions.

<T extends Entity> T

spawn(@NotNull Location location, @NotNull Class<T> clazz)

Spawn an entity of a specific class at the given Location

default <T extends Entity> T

spawn(@NotNull Location location, @NotNull Class<T> clazz, @Nullable Consumer<T> function)

Spawn an entity of a specific class at the given Location, with the supplied function run before the entity is added to the world.

<T extends Entity> T

spawn(@NotNull Location location, @NotNull Class<T> clazz, @Nullable Consumer<T> function, CreatureSpawnEvent.SpawnReason reason)

default <T extends Entity> T

spawn(@NotNull Location location, @NotNull Class<T> clazz, CreatureSpawnEvent.SpawnReason reason)

default <T extends Entity> T

spawn(@NotNull Location location, @NotNull Class<T> clazz, CreatureSpawnEvent.SpawnReason reason, @Nullable Consumer<T> function)

@NotNull Arrow

spawnArrow(@NotNull Location location, @NotNull Vector direction, float speed, float spread)

Creates an Arrow entity at the given Location

<T extends AbstractArrow> T

spawnArrow(@NotNull Location location, @NotNull Vector direction, float speed, float spread, @NotNull Class<T> clazz)

Creates an arrow entity of the given class at the given Location

@NotNull Entity

spawnEntity(@NotNull Location loc, @NotNull EntityType type)

Creates a entity at the given Location

default @NotNull Entity

spawnEntity(@NotNull Location loc, @NotNull EntityType type, CreatureSpawnEvent.SpawnReason reason)

default @NotNull Entity

spawnEntity(@NotNull Location loc, @NotNull EntityType type, CreatureSpawnEvent.SpawnReason reason, @Nullable Consumer<Entity> function)

@NotNull FallingBlock

spawnFallingBlock(@NotNull Location location, @NotNull BlockData data)

Spawn a FallingBlock entity at the given Location of the specified Material.

@NotNull FallingBlock

spawnFallingBlock(@NotNull Location location, @NotNull MaterialData data)

Spawn a FallingBlock entity at the given Location of the specified Material.

@NotNull FallingBlock

spawnFallingBlock(@NotNull Location location, @NotNull Material material, byte data)

Deprecated.
Magic value

void

spawnParticle(@NotNull Particle particle, double x, double y, double z, int count)

Spawns the particle (the number of times specified by count) at the target location.

void

spawnParticle(@NotNull Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ)

Spawns the particle (the number of times specified by count) at the target location.

void

spawnParticle(@NotNull Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, double extra)

Spawns the particle (the number of times specified by count) at the target location.

default <T> void

spawnParticle(@NotNull Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, double extra, T data)

Spawns the particle (the number of times specified by count) at the target location.

<T> void

spawnParticle(@NotNull Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, double extra, T data, boolean force)

Spawns the particle (the number of times specified by count) at the target location.

<T> void

spawnParticle(@NotNull Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, T data)

Spawns the particle (the number of times specified by count) at the target location.

<T> void

spawnParticle(@NotNull Particle particle, double x, double y, double z, int count, T data)

Spawns the particle (the number of times specified by count) at the target location.

void

spawnParticle(@NotNull Particle particle, @NotNull Location location, int count)

Spawns the particle (the number of times specified by count) at the target location.

void

spawnParticle(@NotNull Particle particle, @NotNull Location location, int count, double offsetX, double offsetY, double offsetZ)

Spawns the particle (the number of times specified by count) at the target location.

void

spawnParticle(@NotNull Particle particle, @NotNull Location location, int count, double offsetX, double offsetY, double offsetZ, double extra)

Spawns the particle (the number of times specified by count) at the target location.

<T> void

spawnParticle(@NotNull Particle particle, @NotNull Location location, int count, double offsetX, double offsetY, double offsetZ, double extra, T data)

Spawns the particle (the number of times specified by count) at the target location.

<T> void

spawnParticle(@NotNull Particle particle, @NotNull Location location, int count, double offsetX, double offsetY, double offsetZ, double extra, T data, boolean force)

Spawns the particle (the number of times specified by count) at the target location.

<T> void

spawnParticle(@NotNull Particle particle, @NotNull Location location, int count, double offsetX, double offsetY, double offsetZ, T data)

Spawns the particle (the number of times specified by count) at the target location.

<T> void

spawnParticle(@NotNull Particle particle, @NotNull Location location, int count, T data)

Spawns the particle (the number of times specified by count) at the target location.

default <T> void

spawnParticle(@NotNull Particle particle, @Nullable List<Player> receivers, @NotNull Player source, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, double extra, T data)

Spawns the particle (the number of times specified by count) at the target location.

<T> void

spawnParticle(@NotNull Particle particle, @Nullable List<Player> receivers, @Nullable Player source, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, double extra, T data, boolean force)

Spawns the particle (the number of times specified by count) at the target location.

@NotNull World.Spigot

spigot()

@NotNull LightningStrike

strikeLightning(@NotNull Location loc)

Strikes lightning at the given Location

@NotNull LightningStrike

strikeLightningEffect(@NotNull Location loc)

Strikes lightning at the given Location without doing damage

boolean

unloadChunk(int x, int z)

Safely unloads and saves the Chunk at the specified coordinates

boolean

unloadChunk(int x, int z, boolean save)

Safely unloads and optionally saves the Chunk at the specified coordinates.

boolean

unloadChunk(@NotNull Chunk chunk)

Safely unloads and saves the Chunk at the specified coordinates

boolean

unloadChunkRequest(int x, int z)

Safely queues the Chunk at the specified coordinates for unloading.

Methods inherited from interface net.kyori.adventure.audience.Audience
openBook, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeaderAndFooter, stopSound

Methods inherited from interface net.kyori.adventure.audience.ForwardingAudience
clearTitle, get, getOrDefault, getOrDefaultFrom, hideBossBar, openBook, playSound, playSound, playSound, resetTitle, sendActionBar, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeaderAndFooter, showBossBar, showTitle, stopSound

Methods inherited from interface org.bukkit.metadata.Metadatable
getMetadata, hasMetadata, removeMetadata, setMetadata

Methods inherited from interface org.bukkit.plugin.messaging.PluginMessageRecipient
getListeningPluginChannels, sendPluginMessage

Methods inherited from interface net.kyori.adventure.pointer.Pointered
pointers

Method Details
- getEntityCount
  
  int getEntityCount()
  
  Returns:
  
  The amount of Entities in this world
- getTileEntityCount
  
  int getTileEntityCount()
  
  Returns:
  
  The amount of Tile Entities in this world
- getTickableTileEntityCount
  
  int getTickableTileEntityCount()
  
  Returns:
  
  The amount of Tickable Tile Entities in this world
- getChunkCount
  
  int getChunkCount()
  
  Returns:
  
  The amount of Chunks in this world
- getPlayerCount
  
  int getPlayerCount()
  
  Returns:
  
  The amount of Players in this world
- getMoonPhase
  
  @NotNull MoonPhase getMoonPhase()
  
  Returns:
  
  the current moon phase at the current time in the world
- lineOfSightExists
  
  boolean lineOfSightExists(@NotNull @NotNull Location from, @NotNull @NotNull Location to)
  
  Tell whether a line of sight exists between the given locations
  
  Parameters:
  
  from - Location to start at
  
  to - target Location
  
  Returns:
  
  whether a line of sight exists between from and to
- getBlockAt
  
  @NotNull @NotNull Block getBlockAt(int x, int y, int z)
  
  Gets the Block at the given coordinates
  
  Parameters:
  
  x - X-coordinate of the block
  
  y - Y-coordinate of the block
  
  z - Z-coordinate of the block
  
  Returns:
  
  Block at the given coordinates
- getBlockAt
  
  @NotNull @NotNull Block getBlockAt(@NotNull @NotNull Location location)
  
  Gets the Block at the given Location
  
  Parameters:
  
  location - Location of the block
  
  Returns:
  
  Block at the given location
- getBlockAtKey
  
  @NotNull default @NotNull Block getBlockAtKey(long key)
  
  Gets the Block at the given block key
  
  Parameters:
  
  key - The block key. See Block.getBlockKey()
  
  Returns:
  
  Block at the key
  
  See Also:
  
  Block.getBlockKey(int, int, int)
- getLocationAtKey
  
  @NotNull default @NotNull Location getLocationAtKey(long key)
  
  Gets the Location at the given block key
  
  Parameters:
  
  key - The block key. See Location.toBlockKey()
  
  Returns:
  
  Location at the key
  
  See Also:
  
  Block.getBlockKey(int, int, int)
- getHighestBlockYAt
  
  int getHighestBlockYAt(int x, int z)
  
  Gets the highest non-empty (impassable) coordinate at the given coordinates.
  
  Parameters:
  
  x - X-coordinate of the blocks
  
  z - Z-coordinate of the blocks
  
  Returns:
  
  Y-coordinate of the highest non-empty block
- getHighestBlockYAt
  
  int getHighestBlockYAt(@NotNull @NotNull Location location)
  
  Gets the highest non-empty (impassable) coordinate at the given Location.
  
  Parameters:
  
  location - Location of the blocks
  
  Returns:
  
  Y-coordinate of the highest non-empty block
- getHighestBlockAt
  
  @NotNull @NotNull Block getHighestBlockAt(int x, int z)
  
  Gets the highest non-empty (impassable) block at the given coordinates.
  
  Parameters:
  
  x - X-coordinate of the block
  
  z - Z-coordinate of the block
  
  Returns:
  
  Highest non-empty block
- getHighestBlockAt
  
  @NotNull @NotNull Block getHighestBlockAt(@NotNull @NotNull Location location)
  
  Gets the highest non-empty (impassable) block at the given coordinates.
  
  Parameters:
  
  location - Coordinates to get the highest block
  
  Returns:
  
  Highest non-empty block
- getHighestBlockYAt
  
  @Deprecated int getHighestBlockYAt(int x, int z, @NotNull HeightmapType heightmap) throws UnsupportedOperationException
  
  Deprecated.
  Upstream has added support for this, use getHighestBlockYAt(int, int, HeightMap)
  
  Returns the highest block's y-coordinate at the specified block coordinates that match the specified heightmap's conditions.
  implNote: Implementations are recommended to use an iterative search as a fallback before resorting to throwing an UnsupportedOperationException.
  
  Parameters:
  
  x - The block's x-coordinate.
  
  z - The block's z-coordinate.
  
  heightmap - The specified heightmap to use. See HeightmapType
  
  Returns:
  
  The highest block's y-coordinate at (x, z) that matches the specified heightmap's conditions.
  
  Throws:
  
  UnsupportedOperationException - If the heightmap type is not supported.
  
  See Also:
  
  HeightmapType
- getHighestBlockYAt
  
  @Deprecated default int getHighestBlockYAt(@NotNull @NotNull Location location, @NotNull HeightmapType heightmap) throws UnsupportedOperationException
  
  Deprecated.
  Upstream has added support for this, use getHighestBlockYAt(Location, HeightMap)
  
  Returns the highest block's y-coordinate at the specified block coordinates that match the specified heightmap's conditions. Note that the y-coordinate of the specified location is ignored.
  implNote: Implementations are recommended to use an iterative search as a fallback before resorting to throwing an UnsupportedOperationException.
  
  Parameters:
  
  location - The specified block coordinates.
  
  heightmap - The specified heightmap to use. See HeightmapType
  
  Returns:
  
  The highest block's y-coordinate at location that matches the specified heightmap's conditions.
  
  Throws:
  
  UnsupportedOperationException - If the heightmap type is not supported.
  
  See Also:
  
  HeightmapType
- getHighestBlockAt
  
  @Deprecated @NotNull default @NotNull Block getHighestBlockAt(int x, int z, @NotNull HeightmapType heightmap) throws UnsupportedOperationException
  
  Deprecated.
  Upstream has added support for this, use getHighestBlockAt(int, int, HeightMap)
  
  Returns the highest Block at the specified block coordinates that match the specified heightmap's conditions.
  implNote: Implementations are recommended to use an iterative search as a fallback before resorting to throwing an UnsupportedOperationException.
  
  Parameters:
  
  x - The block's x-coordinate.
  
  z - The block's z-coordinate.
  
  heightmap - The specified heightmap to use. See HeightmapType
  
  Returns:
  
  The highest Block at (x, z) that matches the specified heightmap's conditions.
  
  Throws:
  
  UnsupportedOperationException - If the heightmap type is not supported.
  
  See Also:
  
  HeightmapType
- getHighestBlockAt
  
  @Deprecated @NotNull default @NotNull Block getHighestBlockAt(@NotNull @NotNull Location location, @NotNull HeightmapType heightmap) throws UnsupportedOperationException
  
  Deprecated.
  Upstream has added support for this, use getHighestBlockAt(Location, HeightMap)
  
  Returns the highest Block at the specified block coordinates that match the specified heightmap's conditions. Note that the y-coordinate of the specified location is ignored.
  implNote: Implementations are recommended to use an iterative search as a fallback before resorting to throwing an UnsupportedOperationException.
  
  Parameters:
  
  location - The specified block coordinates.
  
  heightmap - The specified heightmap to use. See HeightmapType
  
  Returns:
  
  The highest Block at location that matches the specified heightmap's conditions.
  
  Throws:
  
  UnsupportedOperationException - If the heightmap type is not supported.
  
  See Also:
  
  HeightmapType
- getHighestBlockYAt
  
  int getHighestBlockYAt(int x, int z, @NotNull @NotNull HeightMap heightMap)
  
  Gets the highest coordinate corresponding to the HeightMap at the given coordinates.
  
  Parameters:
  
  x - X-coordinate of the blocks
  
  z - Z-coordinate of the blocks
  
  heightMap - the heightMap that is used to determine the highest point
  
  Returns:
  
  Y-coordinate of the highest block corresponding to the HeightMap
- getHighestBlockYAt
  
  int getHighestBlockYAt(@NotNull @NotNull Location location, @NotNull @NotNull HeightMap heightMap)
  
  Gets the highest coordinate corresponding to the HeightMap at the given Location.
  
  Parameters:
  
  location - Location of the blocks
  
  heightMap - the heightMap that is used to determine the highest point
  
  Returns:
  
  Y-coordinate of the highest block corresponding to the HeightMap
- getHighestBlockAt
  
  @NotNull @NotNull Block getHighestBlockAt(int x, int z, @NotNull @NotNull HeightMap heightMap)
  
  Gets the highest block corresponding to the HeightMap at the given coordinates.
  
  Parameters:
  
  x - X-coordinate of the block
  
  z - Z-coordinate of the block
  
  heightMap - the heightMap that is used to determine the highest point
  
  Returns:
  
  Highest block corresponding to the HeightMap
- getHighestBlockAt
  
  @NotNull @NotNull Block getHighestBlockAt(@NotNull @NotNull Location location, @NotNull @NotNull HeightMap heightMap)
  
  Gets the highest block corresponding to the HeightMap at the given coordinates.
  
  Parameters:
  
  location - Coordinates to get the highest block
  
  heightMap - the heightMap that is used to determine the highest point
  
  Returns:
  
  Highest block corresponding to the HeightMap
- getChunkAt
  
  @NotNull @NotNull Chunk getChunkAt(int x, int z)
  
  Gets the Chunk at the given coordinates
  
  Parameters:
  
  x - X-coordinate of the chunk
  
  z - Z-coordinate of the chunk
  
  Returns:
  
  Chunk at the given coordinates
- getChunkAt
  
  @NotNull @NotNull Chunk getChunkAt(@NotNull @NotNull Location location)
  
  Gets the Chunk at the given Location
  
  Parameters:
  
  location - Location of the chunk
  
  Returns:
  
  Chunk at the given location
- getChunkAt
  
  @NotNull @NotNull Chunk getChunkAt(@NotNull @NotNull Block block)
  
  Gets the Chunk that contains the given Block
  
  Parameters:
  
  block - Block to get the containing chunk from
  
  Returns:
  
  The chunk that contains the given block
- getChunkAt
  
  @NotNull default @NotNull Chunk getChunkAt(long chunkKey)
  
  Gets the chunk at the specified chunk key, which is the X and Z packed into a long. See Chunk.getChunkKey() for easy access to the key, or you may calculate it as: long chunkKey = (long) chunkX & 0xffffffffL | ((long) chunkZ & 0xffffffffL) >> 32;
  
  Parameters:
  
  chunkKey - The Chunk Key to look up the chunk by
  
  Returns:
  
  The chunk at the specified key
- isChunkGenerated
  
  default boolean isChunkGenerated(long chunkKey)
  
  Checks if a Chunk has been generated at the specified chunk key, which is the X and Z packed into a long.
  
  Parameters:
  
  chunkKey - The Chunk Key to look up the chunk by
  
  Returns:
  
  true if the chunk has been generated, otherwise false
- isChunkLoaded
  
  boolean isChunkLoaded(@NotNull @NotNull Chunk chunk)
  
  Checks if the specified Chunk is loaded
  
  Parameters:
  
  chunk - The chunk to check
  
  Returns:
  
  true if the chunk is loaded, otherwise false
- getLoadedChunks
  
  @NotNull @NotNull Chunk[] getLoadedChunks()
  
  Gets an array of all loaded Chunks
  
  Returns:
  
  Chunk[] containing all loaded chunks
- loadChunk
  
  void loadChunk(@NotNull @NotNull Chunk chunk)
  
  Loads the specified Chunk.
  This method will keep the specified chunk loaded until one of the unload methods is manually called. Callers are advised to instead use getChunkAt which will only temporarily load the requested chunk.
  
  Parameters:
  
  chunk - The chunk to load
- isChunkLoaded
  
  boolean isChunkLoaded(int x, int z)
  
  Checks if the Chunk at the specified coordinates is loaded
  
  Parameters:
  
  x - X-coordinate of the chunk
  
  z - Z-coordinate of the chunk
  
  Returns:
  
  true if the chunk is loaded, otherwise false
- isChunkGenerated
  
  boolean isChunkGenerated(int x, int z)
  
  Checks if the Chunk at the specified coordinates is generated
  
  Parameters:
  
  x - X-coordinate of the chunk
  
  z - Z-coordinate of the chunk
  
  Returns:
  
  true if the chunk is generated, otherwise false
- isChunkInUse
  
  @Deprecated boolean isChunkInUse(int x, int z)
  
  Deprecated.
  This method was added to facilitate chunk garbage collection. As of the current Minecraft version chunks are now strictly managed and will not be loaded for more than 1 tick unless they are in use.
  
  Checks if the Chunk at the specified coordinates is loaded and in use by one or more players
  
  Parameters:
  
  x - X-coordinate of the chunk
  
  z - Z-coordinate of the chunk
  
  Returns:
  
  true if the chunk is loaded and in use by one or more players, otherwise false
- loadChunk
  
  void loadChunk(int x, int z)
  
  Loads the Chunk at the specified coordinates.
  This method will keep the specified chunk loaded until one of the unload methods is manually called. Callers are advised to instead use getChunkAt which will only temporarily load the requested chunk.
  If the chunk does not exist, it will be generated.
  This method is analogous to loadChunk(int, int, boolean) where generate is true.
  
  Parameters:
  
  x - X-coordinate of the chunk
  
  z - Z-coordinate of the chunk
- loadChunk
  
  boolean loadChunk(int x, int z, boolean generate)
  
  Loads the Chunk at the specified coordinates.
  This method will keep the specified chunk loaded until one of the unload methods is manually called. Callers are advised to instead use getChunkAt which will only temporarily load the requested chunk.
  
  Parameters:
  
  x - X-coordinate of the chunk
  
  z - Z-coordinate of the chunk
  
  generate - Whether or not to generate a chunk if it doesn't already exist
  
  Returns:
  
  true if the chunk has loaded successfully, otherwise false
- unloadChunk
  
  boolean unloadChunk(@NotNull @NotNull Chunk chunk)
  
  Safely unloads and saves the Chunk at the specified coordinates
  This method is analogous to unloadChunk(int, int, boolean) where save is true.
  
  Parameters:
  
  chunk - the chunk to unload
  
  Returns:
  
  true if the chunk has unloaded successfully, otherwise false
- unloadChunk
  
  boolean unloadChunk(int x, int z)
  
  Safely unloads and saves the Chunk at the specified coordinates
  This method is analogous to unloadChunk(int, int, boolean) where save is true.
  
  Parameters:
  
  x - X-coordinate of the chunk
  
  z - Z-coordinate of the chunk
  
  Returns:
  
  true if the chunk has unloaded successfully, otherwise false
- unloadChunk
  
  boolean unloadChunk(int x, int z, boolean save)
  
  Safely unloads and optionally saves the Chunk at the specified coordinates.
  
  Parameters:
  
  x - X-coordinate of the chunk
  
  z - Z-coordinate of the chunk
  
  save - Whether or not to save the chunk
  
  Returns:
  
  true if the chunk has unloaded successfully, otherwise false
- unloadChunkRequest
  
  boolean unloadChunkRequest(int x, int z)
  
  Safely queues the Chunk at the specified coordinates for unloading.
  
  Parameters:
  
  x - X-coordinate of the chunk
  
  z - Z-coordinate of the chunk
  
  Returns:
  
  true is the queue attempt was successful, otherwise false
- regenerateChunk
  
  @Deprecated boolean regenerateChunk(int x, int z)
  
  Deprecated.
  regenerating a single chunk is not likely to produce the same chunk as before as terrain decoration may be spread across chunks. Use of this method should be avoided as it is known to produce buggy results.
  
  Regenerates the Chunk at the specified coordinates
  
  Parameters:
  
  x - X-coordinate of the chunk
  
  z - Z-coordinate of the chunk
  
  Returns:
  
  Whether the chunk was actually regenerated
- refreshChunk
  
  @Deprecated boolean refreshChunk(int x, int z)
  
  Deprecated.
  This method is not guaranteed to work suitably across all client implementations.
  
  Resends the Chunk to all clients
  
  Parameters:
  
  x - X-coordinate of the chunk
  
  z - Z-coordinate of the chunk
  
  Returns:
  
  Whether the chunk was actually refreshed
- isChunkForceLoaded
  
  boolean isChunkForceLoaded(int x, int z)
  
  Gets whether the chunk at the specified chunk coordinates is force loaded.
  A force loaded chunk will not be unloaded due to lack of player activity.
  
  Parameters:
  
  x - X-coordinate of the chunk
  
  z - Z-coordinate of the chunk
  
  Returns:
  
  force load status
- setChunkForceLoaded
  
  void setChunkForceLoaded(int x, int z, boolean forced)
  
  Sets whether the chunk at the specified chunk coordinates is force loaded.
  A force loaded chunk will not be unloaded due to lack of player activity.
  
  Parameters:
  
  x - X-coordinate of the chunk
  
  z - Z-coordinate of the chunk
  
  forced - force load status
- getForceLoadedChunks
  
  @NotNull @NotNull Collection<Chunk> getForceLoadedChunks()
  
  Returns all force loaded chunks in this world.
  A force loaded chunk will not be unloaded due to lack of player activity.
  
  Returns:
  
  unmodifiable collection of force loaded chunks
- addPluginChunkTicket
  
  boolean addPluginChunkTicket(int x, int z, @NotNull @NotNull Plugin plugin)
  
  Adds a plugin ticket for the specified chunk, loading the chunk if it is not already loaded.
  A plugin ticket will prevent a chunk from unloading until it is explicitly removed. A plugin instance may only have one ticket per chunk, but each chunk can have multiple plugin tickets.
  
  Parameters:
  
  x - X-coordinate of the chunk
  
  z - Z-coordinate of the chunk
  
  plugin - Plugin which owns the ticket
  
  Returns:
  
  true if a plugin ticket was added, false if the ticket already exists for the plugin
  
  Throws:
  
  IllegalStateException - If the specified plugin is not enabled
  
  See Also:
  
  removePluginChunkTicket(int, int, Plugin)
- removePluginChunkTicket
  
  boolean removePluginChunkTicket(int x, int z, @NotNull @NotNull Plugin plugin)
  
  Removes the specified plugin's ticket for the specified chunk
  A plugin ticket will prevent a chunk from unloading until it is explicitly removed. A plugin instance may only have one ticket per chunk, but each chunk can have multiple plugin tickets.
  
  Parameters:
  
  x - X-coordinate of the chunk
  
  z - Z-coordinate of the chunk
  
  plugin - Plugin which owns the ticket
  
  Returns:
  
  true if the plugin ticket was removed, false if there is no plugin ticket for the chunk
  
  See Also:
  
  addPluginChunkTicket(int, int, Plugin)
- removePluginChunkTickets
  
  void removePluginChunkTickets(@NotNull @NotNull Plugin plugin)
  
  Removes all plugin tickets for the specified plugin
  A plugin ticket will prevent a chunk from unloading until it is explicitly removed. A plugin instance may only have one ticket per chunk, but each chunk can have multiple plugin tickets.
  
  Parameters:
  
  plugin - Specified plugin
  
  See Also:
  
  addPluginChunkTicket(int, int, Plugin), removePluginChunkTicket(int, int, Plugin)
- getPluginChunkTickets
  
  @NotNull @NotNull Collection<Plugin> getPluginChunkTickets(int x, int z)
  
  Retrieves a collection specifying which plugins have tickets for the specified chunk. This collection is not updated when plugin tickets are added or removed to the chunk.
  A plugin ticket will prevent a chunk from unloading until it is explicitly removed. A plugin instance may only have one ticket per chunk, but each chunk can have multiple plugin tickets.
  
  Parameters:
  
  x - X-coordinate of the chunk
  
  z - Z-coordinate of the chunk
  
  Returns:
  
  unmodifiable collection containing which plugins have tickets for the chunk
  
  See Also:
  
  addPluginChunkTicket(int, int, Plugin), removePluginChunkTicket(int, int, Plugin)
- getPluginChunkTickets
  
  @NotNull @NotNull Map<Plugin,Collection<Chunk>> getPluginChunkTickets()
  
  Returns a map of which plugins have tickets for what chunks. The returned map is not updated when plugin tickets are added or removed to chunks. If a plugin has no tickets, it will be absent from the map.
  A plugin ticket will prevent a chunk from unloading until it is explicitly removed. A plugin instance may only have one ticket per chunk, but each chunk can have multiple plugin tickets.
  
  Returns:
  
  unmodifiable map containing which plugins have tickets for what chunks
  
  See Also:
  
  addPluginChunkTicket(int, int, Plugin), removePluginChunkTicket(int, int, Plugin)
- dropItem
  
  @NotNull @NotNull Item dropItem(@NotNull @NotNull Location location, @NotNull @NotNull ItemStack item)
  
  Drops an item at the specified Location
  
  Parameters:
  
  location - Location to drop the item
  
  item - ItemStack to drop
  
  Returns:
  
  ItemDrop entity created as a result of this method
- dropItem
  
  @NotNull @NotNull Item dropItem(@NotNull @NotNull Location location, @NotNull @NotNull ItemStack item, @Nullable @Nullable Consumer<Item> function)
  
  Drops an item at the specified Location Note that functions will run before the entity is spawned
  
  Parameters:
  
  location - Location to drop the item
  
  item - ItemStack to drop
  
  function - the function to be run before the entity is spawned.
  
  Returns:
  
  ItemDrop entity created as a result of this method
- dropItemNaturally
  
  @NotNull @NotNull Item dropItemNaturally(@NotNull @NotNull Location location, @NotNull @NotNull ItemStack item)
  
  Drops an item at the specified Location with a random offset
  
  Parameters:
  
  location - Location to drop the item
  
  item - ItemStack to drop
  
  Returns:
  
  ItemDrop entity created as a result of this method
- dropItemNaturally
  
  @NotNull @NotNull Item dropItemNaturally(@NotNull @NotNull Location location, @NotNull @NotNull ItemStack item, @Nullable @Nullable Consumer<Item> function)
  
  Drops an item at the specified Location with a random offset Note that functions will run before the entity is spawned
  
  Parameters:
  
  location - Location to drop the item
  
  item - ItemStack to drop
  
  function - the function to be run before the entity is spawned.
  
  Returns:
  
  ItemDrop entity created as a result of this method
- spawnArrow
  
  @NotNull @NotNull Arrow spawnArrow(@NotNull @NotNull Location location, @NotNull @NotNull Vector direction, float speed, float spread)
  
  Creates an Arrow entity at the given Location
  
  Parameters:
  
  location - Location to spawn the arrow
  
  direction - Direction to shoot the arrow in
  
  speed - Speed of the arrow. A recommend speed is 0.6
  
  spread - Spread of the arrow. A recommend spread is 12
  
  Returns:
  
  Arrow entity spawned as a result of this method
- spawnArrow
  
  @NotNull <T extends AbstractArrow> T spawnArrow(@NotNull @NotNull Location location, @NotNull @NotNull Vector direction, float speed, float spread, @NotNull @NotNull Class<T> clazz)
  
  Creates an arrow entity of the given class at the given Location
  
  Type Parameters:
  
  T - type of arrow to spawn
  
  Parameters:
  
  location - Location to spawn the arrow
  
  direction - Direction to shoot the arrow in
  
  speed - Speed of the arrow. A recommend speed is 0.6
  
  spread - Spread of the arrow. A recommend spread is 12
  
  clazz - the Entity class for the arrow SpectralArrow,Arrow,TippedArrow
  
  Returns:
  
  Arrow entity spawned as a result of this method
- generateTree
  
  boolean generateTree(@NotNull @NotNull Location location, @NotNull @NotNull TreeType type)
  
  Creates a tree at the given Location
  
  Parameters:
  
  location - Location to spawn the tree
  
  type - Type of the tree to create
  
  Returns:
  
  true if the tree was created successfully, otherwise false
- generateTree
  
  boolean generateTree(@NotNull @NotNull Location loc, @NotNull @NotNull TreeType type, @NotNull @NotNull BlockChangeDelegate delegate)
  
  Creates a tree at the given Location
  
  Parameters:
  
  loc - Location to spawn the tree
  
  type - Type of the tree to create
  
  delegate - A class to call for each block changed as a result of this method
  
  Returns:
  
  true if the tree was created successfully, otherwise false
- spawnEntity
  
  @NotNull @NotNull Entity spawnEntity(@NotNull @NotNull Location loc, @NotNull @NotNull EntityType type)
  
  Creates a entity at the given Location
  
  Parameters:
  
  loc - The location to spawn the entity
  
  type - The entity to spawn
  
  Returns:
  
  Resulting Entity of this method
- strikeLightning
  
  @NotNull @NotNull LightningStrike strikeLightning(@NotNull @NotNull Location loc)
  
  Strikes lightning at the given Location
  
  Parameters:
  
  loc - The location to strike lightning
  
  Returns:
  
  The lightning entity.
- strikeLightningEffect
  
  @NotNull @NotNull LightningStrike strikeLightningEffect(@NotNull @NotNull Location loc)
  
  Strikes lightning at the given Location without doing damage
  
  Parameters:
  
  loc - The location to strike lightning
  
  Returns:
  
  The lightning entity.
- getEntities
  
  @NotNull @NotNull List<Entity> getEntities()
  
  Get a list of all entities in this World
  
  Returns:
  
  A List of all Entities currently residing in this world
- getLivingEntities
  
  @NotNull @NotNull List<LivingEntity> getLivingEntities()
  
  Get a list of all living entities in this World
  
  Returns:
  
  A List of all LivingEntities currently residing in this world
- getEntitiesByClass
  
  @Deprecated @NotNull <T extends Entity> @NotNull Collection<T> getEntitiesByClass(@NotNull @NotNull Class<T>... classes)
  
  Deprecated.
  
  Get a collection of all entities in this World matching the given class/interface
  
  Type Parameters:
  
  T - an entity subclass
  
  Parameters:
  
  classes - The classes representing the types of entity to match
  
  Returns:
  
  A List of all Entities currently residing in this world that match the given class/interface
- getEntitiesByClass
  
  @NotNull <T extends Entity> @NotNull Collection<T> getEntitiesByClass(@NotNull @NotNull Class<T> cls)
  
  Get a collection of all entities in this World matching the given class/interface
  
  Type Parameters:
  
  T - an entity subclass
  
  Parameters:
  
  cls - The class representing the type of entity to match
  
  Returns:
  
  A List of all Entities currently residing in this world that match the given class/interface
- getEntitiesByClasses
  
  @NotNull @NotNull Collection<Entity> getEntitiesByClasses(@NotNull @NotNull Class<?>... classes)
  
  Get a collection of all entities in this World matching any of the given classes/interfaces
  
  Parameters:
  
  classes - The classes representing the types of entity to match
  
  Returns:
  
  A List of all Entities currently residing in this world that match one or more of the given classes/interfaces
- getNearbyLivingEntities
  
  @NotNull default @NotNull Collection<LivingEntity> getNearbyLivingEntities(@NotNull @NotNull Location loc, double radius)
  
  Gets nearby players within the specified radius (bounding box)
  
  Parameters:
  
  loc - Center location
  
  radius - Radius
  
  Returns:
  
  the collection of entities near location. This will always be a non-null collection.
- getNearbyLivingEntities
  
  @NotNull default @NotNull Collection<LivingEntity> getNearbyLivingEntities(@NotNull @NotNull Location loc, double xzRadius, double yRadius)
  
  Gets nearby players within the specified radius (bounding box)
  
  Parameters:
  
  loc - Center location
  
  xzRadius - X/Z Radius
  
  yRadius - Y Radius
  
  Returns:
  
  the collection of entities near location. This will always be a non-null collection.
- getNearbyLivingEntities
  
  @NotNull default @NotNull Collection<LivingEntity> getNearbyLivingEntities(@NotNull @NotNull Location loc, double xRadius, double yRadius, double zRadius)
  
  Gets nearby players within the specified radius (bounding box)
  
  Parameters:
  
  loc - Center location
  
  xRadius - X Radius
  
  yRadius - Y Radius
  
  zRadius - Z radius
  
  Returns:
  
  the collection of entities near location. This will always be a non-null collection.
- getNearbyLivingEntities
  
  @NotNull default @NotNull Collection<LivingEntity> getNearbyLivingEntities(@NotNull @NotNull Location loc, double radius, @Nullable @Nullable Predicate<LivingEntity> predicate)
  
  Gets nearby players within the specified radius (bounding box)
  
  Parameters:
  
  loc - Center location
  
  radius - X Radius
  
  predicate - a predicate used to filter results
  
  Returns:
  
  the collection of living entities near location. This will always be a non-null collection
- getNearbyLivingEntities
  
  @NotNull default @NotNull Collection<LivingEntity> getNearbyLivingEntities(@NotNull @NotNull Location loc, double xzRadius, double yRadius, @Nullable @Nullable Predicate<LivingEntity> predicate)
  
  Gets nearby players within the specified radius (bounding box)
  
  Parameters:
  
  loc - Center location
  
  xzRadius - X/Z Radius
  
  yRadius - Y Radius
  
  predicate - a predicate used to filter results
  
  Returns:
  
  the collection of living entities near location. This will always be a non-null collection
- getNearbyLivingEntities
  
  @NotNull default @NotNull Collection<LivingEntity> getNearbyLivingEntities(@NotNull @NotNull Location loc, double xRadius, double yRadius, double zRadius, @Nullable @Nullable Predicate<LivingEntity> predicate)
  
  Gets nearby players within the specified radius (bounding box)
  
  Parameters:
  
  loc - Center location
  
  xRadius - X Radius
  
  yRadius - Y Radius
  
  zRadius - Z radius
  
  predicate - a predicate used to filter results
  
  Returns:
  
  the collection of living entities near location. This will always be a non-null collection.
- getNearbyPlayers
  
  @NotNull default @NotNull Collection<Player> getNearbyPlayers(@NotNull @NotNull Location loc, double radius)
  
  Gets nearby players within the specified radius (bounding box)
  
  Parameters:
  
  loc - Center location
  
  radius - X/Y/Z Radius
  
  Returns:
  
  the collection of living entities near location. This will always be a non-null collection.
- getNearbyPlayers
  
  @NotNull default @NotNull Collection<Player> getNearbyPlayers(@NotNull @NotNull Location loc, double xzRadius, double yRadius)
  
  Gets nearby players within the specified radius (bounding box)
  
  Parameters:
  
  loc - Center location
  
  xzRadius - X/Z Radius
  
  yRadius - Y Radius
  
  Returns:
  
  the collection of living entities near location. This will always be a non-null collection.
- getNearbyPlayers
  
  @NotNull default @NotNull Collection<Player> getNearbyPlayers(@NotNull @NotNull Location loc, double xRadius, double yRadius, double zRadius)
  
  Gets nearby players within the specified radius (bounding box)
  
  Parameters:
  
  loc - Center location
  
  xRadius - X Radius
  
  yRadius - Y Radius
  
  zRadius - Z Radius
  
  Returns:
  
  the collection of players near location. This will always be a non-null collection.
- getNearbyPlayers
  
  @NotNull default @NotNull Collection<Player> getNearbyPlayers(@NotNull @NotNull Location loc, double radius, @Nullable @Nullable Predicate<Player> predicate)
  
  Gets nearby players within the specified radius (bounding box)
  
  Parameters:
  
  loc - Center location
  
  radius - X/Y/Z Radius
  
  predicate - a predicate used to filter results
  
  Returns:
  
  the collection of players near location. This will always be a non-null collection.
- getNearbyPlayers
  
  @NotNull default @NotNull Collection<Player> getNearbyPlayers(@NotNull @NotNull Location loc, double xzRadius, double yRadius, @Nullable @Nullable Predicate<Player> predicate)
  
  Gets nearby players within the specified radius (bounding box)
  
  Parameters:
  
  loc - Center location
  
  xzRadius - X/Z Radius
  
  yRadius - Y Radius
  
  predicate - a predicate used to filter results
  
  Returns:
  
  the collection of players near location. This will always be a non-null collection.
- getNearbyPlayers
  
  @NotNull default @NotNull Collection<Player> getNearbyPlayers(@NotNull @NotNull Location loc, double xRadius, double yRadius, double zRadius, @Nullable @Nullable Predicate<Player> predicate)
  
  Gets nearby players within the specified radius (bounding box)
  
  Parameters:
  
  loc - Center location
  
  xRadius - X Radius
  
  yRadius - Y Radius
  
  zRadius - Z Radius
  
  predicate - a predicate used to filter results
  
  Returns:
  
  the collection of players near location. This will always be a non-null collection.
- getNearbyEntitiesByType
  
  @NotNull default <T extends Entity> @NotNull Collection<T> getNearbyEntitiesByType(@Nullable @Nullable Class<? extends T> clazz, @NotNull @NotNull Location loc, double radius)
  
  Gets all nearby entities of the specified type, within the specified radius (bounding box)
  
  Type Parameters:
  
  T - the entity type
  
  Parameters:
  
  clazz - Type to filter by
  
  loc - Center location
  
  radius - X/Y/Z radius to search within
  
  Returns:
  
  the collection of entities near location. This will always be a non-null collection.
- getNearbyEntitiesByType
  
  @NotNull default <T extends Entity> @NotNull Collection<T> getNearbyEntitiesByType(@Nullable @Nullable Class<? extends T> clazz, @NotNull @NotNull Location loc, double xzRadius, double yRadius)
  
  Gets all nearby entities of the specified type, within the specified radius, with x and x radius matching (bounding box)
  
  Type Parameters:
  
  T - the entity type
  
  Parameters:
  
  clazz - Type to filter by
  
  loc - Center location
  
  xzRadius - X/Z radius to search within
  
  yRadius - Y radius to search within
  
  Returns:
  
  the collection of entities near location. This will always be a non-null collection.
- getNearbyEntitiesByType
  
  @NotNull default <T extends Entity> @NotNull Collection<T> getNearbyEntitiesByType(@Nullable @Nullable Class<? extends T> clazz, @NotNull @NotNull Location loc, double xRadius, double yRadius, double zRadius)
  
  Gets all nearby entities of the specified type, within the specified radius (bounding box)
  
  Type Parameters:
  
  T - the entity type
  
  Parameters:
  
  clazz - Type to filter by
  
  loc - Center location
  
  xRadius - X Radius
  
  yRadius - Y Radius
  
  zRadius - Z Radius
  
  Returns:
  
  the collection of entities near location. This will always be a non-null collection.
- getNearbyEntitiesByType
  
  @NotNull default <T extends Entity> @NotNull Collection<T> getNearbyEntitiesByType(@Nullable @Nullable Class<? extends T> clazz, @NotNull @NotNull Location loc, double radius, @Nullable @Nullable Predicate<T> predicate)
  
  Gets all nearby entities of the specified type, within the specified radius (bounding box)
  
  Type Parameters:
  
  T - the entity type
  
  Parameters:
  
  clazz - Type to filter by
  
  loc - Center location
  
  radius - X/Y/Z radius to search within
  
  predicate - a predicate used to filter results
  
  Returns:
  
  the collection of entities near location. This will always be a non-null collection.
- getNearbyEntitiesByType
  
  @NotNull default <T extends Entity> @NotNull Collection<T> getNearbyEntitiesByType(@Nullable @Nullable Class<? extends T> clazz, @NotNull @NotNull Location loc, double xzRadius, double yRadius, @Nullable @Nullable Predicate<T> predicate)
  
  Gets all nearby entities of the specified type, within the specified radius, with x and x radius matching (bounding box)
  
  Type Parameters:
  
  T - the entity type
  
  Parameters:
  
  clazz - Type to filter by
  
  loc - Center location
  
  xzRadius - X/Z radius to search within
  
  yRadius - Y radius to search within
  
  predicate - a predicate used to filter results
  
  Returns:
  
  the collection of entities near location. This will always be a non-null collection.
- getNearbyEntitiesByType
  
  @NotNull default <T extends Entity> @NotNull Collection<T> getNearbyEntitiesByType(@Nullable @Nullable Class<? extends Entity> clazz, @NotNull @NotNull Location loc, double xRadius, double yRadius, double zRadius, @Nullable @Nullable Predicate<T> predicate)
  
  Gets all nearby entities of the specified type, within the specified radius (bounding box)
  
  Type Parameters:
  
  T - the entity type
  
  Parameters:
  
  clazz - Type to filter by
  
  loc - Center location
  
  xRadius - X Radius
  
  yRadius - Y Radius
  
  zRadius - Z Radius
  
  predicate - a predicate used to filter results
  
  Returns:
  
  the collection of entities near location. This will always be a non-null collection.
- getChunkAtAsync
  
  @Deprecated default void getChunkAtAsync(int x, int z, @NotNull @NotNull World.ChunkLoadCallback cb)
  
  Deprecated.
  Use either the Future or the Consumer based methods
  
  Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time. You should use this method if you need a chunk but do not need it immediately, and you wish to let the server control the speed of chunk loads, keeping performance in mind. The World.ChunkLoadCallback will always be executed synchronously on the main Server Thread.
  
  Parameters:
  
  x - Chunk X-coordinate of the chunk - (world coordinate / 16)
  
  z - Chunk Z-coordinate of the chunk - (world coordinate / 16)
  
  cb - Callback to receive the chunk when it is loaded. will be executed synchronously
- getChunkAtAsync
  
  @Deprecated default void getChunkAtAsync(@NotNull @NotNull Location loc, @NotNull @NotNull World.ChunkLoadCallback cb)
  
  Deprecated.
  Use either the Future or the Consumer based methods
  
  Requests a Chunk to be loaded at the given Location This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time. You should use this method if you need a chunk but do not need it immediately, and you wish to let the server control the speed of chunk loads, keeping performance in mind. The World.ChunkLoadCallback will always be executed synchronously on the main Server Thread.
  
  Parameters:
  
  loc - Location of the chunk
  
  cb - Callback to receive the chunk when it is loaded. will be executed synchronously
- getChunkAtAsync
  
  @Deprecated default void getChunkAtAsync(@NotNull @NotNull Block block, @NotNull @NotNull World.ChunkLoadCallback cb)
  
  Deprecated.
  Use either the Future or the Consumer based methods
  
  Requests Chunk to be loaded that contains the given Block This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time. You should use this method if you need a chunk but do not need it immediately, and you wish to let the server control the speed of chunk loads, keeping performance in mind. The World.ChunkLoadCallback will always be executed synchronously on the main Server Thread.
  
  Parameters:
  
  block - Block to get the containing chunk from
  
  cb - Callback to receive the chunk when it is loaded. will be executed synchronously
- getChunkAtAsync
  
  default void getChunkAtAsync(int x, int z, @NotNull Consumer<Chunk> cb)
  
  Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time. You should use this method if you need a chunk but do not need it immediately, and you wish to let the server control the speed of chunk loads, keeping performance in mind. The Consumer will always be executed synchronously on the main Server Thread.
  
  Parameters:
  
  x - Chunk X-coordinate of the chunk - (world coordinate / 16)
  
  z - Chunk Z-coordinate of the chunk - (world coordinate / 16)
  
  cb - Callback to receive the chunk when it is loaded. will be executed synchronously
- getChunkAtAsync
  
  default void getChunkAtAsync(int x, int z, boolean gen, @NotNull Consumer<Chunk> cb)
  
  Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time. You should use this method if you need a chunk but do not need it immediately, and you wish to let the server control the speed of chunk loads, keeping performance in mind. The Consumer will always be executed synchronously on the main Server Thread.
  
  Parameters:
  
  x - Chunk X-coordinate of the chunk - (world coordinate / 16)
  
  z - Chunk Z-coordinate of the chunk - (world coordinate / 16)
  
  gen - Should we generate a chunk if it doesn't exists or not
  
  cb - Callback to receive the chunk when it is loaded. will be executed synchronously
- getChunkAtAsync
  
  default void getChunkAtAsync(@NotNull @NotNull Location loc, @NotNull Consumer<Chunk> cb)
  
  Requests a Chunk to be loaded at the given Location This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time. You should use this method if you need a chunk but do not need it immediately, and you wish to let the server control the speed of chunk loads, keeping performance in mind. The Consumer will always be executed synchronously on the main Server Thread.
  
  Parameters:
  
  loc - Location of the chunk
  
  cb - Callback to receive the chunk when it is loaded. will be executed synchronously
- getChunkAtAsync
  
  default void getChunkAtAsync(@NotNull @NotNull Location loc, boolean gen, @NotNull Consumer<Chunk> cb)
  
  Requests a Chunk to be loaded at the given Location This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time. You should use this method if you need a chunk but do not need it immediately, and you wish to let the server control the speed of chunk loads, keeping performance in mind. The Consumer will always be executed synchronously on the main Server Thread.
  
  Parameters:
  
  loc - Location of the chunk
  
  gen - Should the chunk generate
  
  cb - Callback to receive the chunk when it is loaded. will be executed synchronously
- getChunkAtAsync
  
  default void getChunkAtAsync(@NotNull @NotNull Block block, @NotNull Consumer<Chunk> cb)
  
  Requests Chunk to be loaded that contains the given Block This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time. You should use this method if you need a chunk but do not need it immediately, and you wish to let the server control the speed of chunk loads, keeping performance in mind. The Consumer will always be executed synchronously on the main Server Thread.
  
  Parameters:
  
  block - Block to get the containing chunk from
  
  cb - Callback to receive the chunk when it is loaded. will be executed synchronously
- getChunkAtAsync
  
  default void getChunkAtAsync(@NotNull @NotNull Block block, boolean gen, @NotNull Consumer<Chunk> cb)
  
  Requests Chunk to be loaded that contains the given Block This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time. You should use this method if you need a chunk but do not need it immediately, and you wish to let the server control the speed of chunk loads, keeping performance in mind. The Consumer will always be executed synchronously on the main Server Thread.
  
  Parameters:
  
  block - Block to get the containing chunk from
  
  gen - Should the chunk generate
  
  cb - Callback to receive the chunk when it is loaded. will be executed synchronously
- getChunkAtAsync
  
  @NotNull default CompletableFuture<Chunk> getChunkAtAsync(@NotNull @NotNull Location loc)
  
  Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time. You should use this method if you need a chunk but do not need it immediately, and you wish to let the server control the speed of chunk loads, keeping performance in mind. The future will always be executed synchronously on the main Server Thread.
  
  Parameters:
  
  loc - Location to load the corresponding chunk from
  
  Returns:
  
  Future that will resolve when the chunk is loaded
- getChunkAtAsync
  
  @NotNull default CompletableFuture<Chunk> getChunkAtAsync(@NotNull @NotNull Location loc, boolean gen)
  
  Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time. You should use this method if you need a chunk but do not need it immediately, and you wish to let the server control the speed of chunk loads, keeping performance in mind. The future will always be executed synchronously on the main Server Thread.
  
  Parameters:
  
  loc - Location to load the corresponding chunk from
  
  gen - Should the chunk generate
  
  Returns:
  
  Future that will resolve when the chunk is loaded
- getChunkAtAsync
  
  @NotNull default CompletableFuture<Chunk> getChunkAtAsync(@NotNull @NotNull Block block)
  
  Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time. You should use this method if you need a chunk but do not need it immediately, and you wish to let the server control the speed of chunk loads, keeping performance in mind. The future will always be executed synchronously on the main Server Thread.
  
  Parameters:
  
  block - Block to load the corresponding chunk from
  
  Returns:
  
  Future that will resolve when the chunk is loaded
- getChunkAtAsync
  
  @NotNull default CompletableFuture<Chunk> getChunkAtAsync(@NotNull @NotNull Block block, boolean gen)
  
  Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time. You should use this method if you need a chunk but do not need it immediately, and you wish to let the server control the speed of chunk loads, keeping performance in mind. The future will always be executed synchronously on the main Server Thread.
  
  Parameters:
  
  block - Block to load the corresponding chunk from
  
  gen - Should the chunk generate
  
  Returns:
  
  Future that will resolve when the chunk is loaded
- getChunkAtAsync
  
  @NotNull default CompletableFuture<Chunk> getChunkAtAsync(int x, int z)
  
  Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time. You should use this method if you need a chunk but do not need it immediately, and you wish to let the server control the speed of chunk loads, keeping performance in mind. The future will always be executed synchronously on the main Server Thread.
  
  Parameters:
  
  x - X Coord
  
  z - Z Coord
  
  Returns:
  
  Future that will resolve when the chunk is loaded
- getChunkAtAsync
  
  @NotNull default CompletableFuture<Chunk> getChunkAtAsync(int x, int z, boolean gen)
  
  Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time. You should use this method if you need a chunk but do not need it immediately, and you wish to let the server control the speed of chunk loads, keeping performance in mind. The future will always be executed synchronously on the main Server Thread.
  
  Parameters:
  
  x - Chunk X-coordinate of the chunk - (world coordinate / 16)
  
  z - Chunk Z-coordinate of the chunk - (world coordinate / 16)
  
  gen - Should we generate a chunk if it doesn't exists or not
  
  Returns:
  
  Future that will resolve when the chunk is loaded
- getChunkAtAsyncUrgently
  
  @NotNull default CompletableFuture<Chunk> getChunkAtAsyncUrgently(@NotNull @NotNull Location loc)
  
  Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time. You should use this method if you need a chunk but do not need it immediately, and you wish to let the server control the speed of chunk loads, keeping performance in mind. The future will always be executed synchronously on the main Server Thread.
  
  Parameters:
  
  loc - Location to load the corresponding chunk from
  
  Returns:
  
  Future that will resolve when the chunk is loaded
- getChunkAtAsyncUrgently
  
  @NotNull default CompletableFuture<Chunk> getChunkAtAsyncUrgently(@NotNull @NotNull Location loc, boolean gen)
  
  Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time. You should use this method if you need a chunk but do not need it immediately, and you wish to let the server control the speed of chunk loads, keeping performance in mind. The future will always be executed synchronously on the main Server Thread.
  
  Parameters:
  
  loc - Location to load the corresponding chunk from
  
  gen - Should the chunk generate
  
  Returns:
  
  Future that will resolve when the chunk is loaded
- getChunkAtAsyncUrgently
  
  @NotNull default CompletableFuture<Chunk> getChunkAtAsyncUrgently(@NotNull @NotNull Block block)
  
  Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time. You should use this method if you need a chunk but do not need it immediately, and you wish to let the server control the speed of chunk loads, keeping performance in mind. The future will always be executed synchronously on the main Server Thread.
  
  Parameters:
  
  block - Block to load the corresponding chunk from
  
  Returns:
  
  Future that will resolve when the chunk is loaded
- getChunkAtAsyncUrgently
  
  @NotNull default CompletableFuture<Chunk> getChunkAtAsyncUrgently(@NotNull @NotNull Block block, boolean gen)
  
  Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time. You should use this method if you need a chunk but do not need it immediately, and you wish to let the server control the speed of chunk loads, keeping performance in mind. The future will always be executed synchronously on the main Server Thread.
  
  Parameters:
  
  block - Block to load the corresponding chunk from
  
  gen - Should the chunk generate
  
  Returns:
  
  Future that will resolve when the chunk is loaded
- getChunkAtAsyncUrgently
  
  @NotNull default CompletableFuture<Chunk> getChunkAtAsyncUrgently(int x, int z)
  
  Requests a Chunk to be loaded at the given coordinates This method makes no guarantee on how fast the chunk will load, and will return the chunk to the callback at a later time. You should use this method if you need a chunk but do not need it immediately, and you wish to let the server control the speed of chunk loads, keeping performance in mind. The future will always be executed synchronously on the main Server Thread.
  
  Parameters:
  
  x - X Coord
  
  z - Z Coord
  
  Returns:
  
  Future that will resolve when the chunk is loaded
- getChunkAtAsync
  
  @NotNull CompletableFuture<Chunk> getChunkAtAsync(int x, int z, boolean gen, boolean urgent)
- getKey
  
  @NotNull @NotNull NamespacedKey getKey()
  
  Get the world's key
  
  Specified by:
  
  getKey in interface Keyed
  
  Returns:
  
  the world's key
- getPlayers
  
  @NotNull @NotNull List<Player> getPlayers()
  
  Get a list of all players in this World
  
  Returns:
  
  A list of all Players currently residing in this world
- audiences
  
  @NotNull default @NotNull Iterable<? extends net.kyori.adventure.audience.Audience> audiences()
  
  Specified by:
  
  audiences in interface net.kyori.adventure.audience.ForwardingAudience
- getNearbyEntities
  
  @NotNull @NotNull Collection<Entity> getNearbyEntities(@NotNull @NotNull Location location, double x, double y, double z)
  
  Returns a list of entities within a bounding box centered around a Location.
  This may not consider entities in currently unloaded chunks. Some implementations may impose artificial restrictions on the size of the search bounding box.
  
  Parameters:
  
  location - The center of the bounding box
  
  x - 1/2 the size of the box along x axis
  
  y - 1/2 the size of the box along y axis
  
  z - 1/2 the size of the box along z axis
  
  Returns:
  
  the collection of entities near location. This will always be a non-null collection.
- getEntity
  
  @Nullable @Nullable Entity getEntity(@NotNull @NotNull UUID uuid)
  
  Gets an entity in this world by its UUID
  
  Parameters:
  
  uuid - the UUID of the entity
  
  Returns:
  
  the entity with the given UUID, or null if it isn't found
- getNearbyEntities
  
  @NotNull @NotNull Collection<Entity> getNearbyEntities(@NotNull @NotNull Location location, double x, double y, double z, @Nullable @Nullable Predicate<Entity> filter)
  
  Returns a list of entities within a bounding box centered around a Location.
  This may not consider entities in currently unloaded chunks. Some implementations may impose artificial restrictions on the size of the search bounding box.
  
  Parameters:
  
  location - The center of the bounding box
  
  x - 1/2 the size of the box along x axis
  
  y - 1/2 the size of the box along y axis
  
  z - 1/2 the size of the box along z axis
  
  filter - only entities that fulfill this predicate are considered, or null to consider all entities
  
  Returns:
  
  the collection of entities near location. This will always be a non-null collection.
- getNearbyEntities
  
  @NotNull @NotNull Collection<Entity> getNearbyEntities(@NotNull @NotNull BoundingBox boundingBox)
  
  Returns a list of entities within the given bounding box.
  This may not consider entities in currently unloaded chunks. Some implementations may impose artificial restrictions on the size of the search bounding box.
  
  Parameters:
  
  boundingBox - the bounding box
  
  Returns:
  
  the collection of entities within the bounding box, will always be a non-null collection
- getNearbyEntities
  
  @NotNull @NotNull Collection<Entity> getNearbyEntities(@NotNull @NotNull BoundingBox boundingBox, @Nullable @Nullable Predicate<Entity> filter)
  
  Returns a list of entities within the given bounding box.
  This may not consider entities in currently unloaded chunks. Some implementations may impose artificial restrictions on the size of the search bounding box.
  
  Parameters:
  
  boundingBox - the bounding box
  
  filter - only entities that fulfill this predicate are considered, or null to consider all entities
  
  Returns:
  
  the collection of entities within the bounding box, will always be a non-null collection
- rayTraceEntities
  
  @Nullable @Nullable RayTraceResult rayTraceEntities(@NotNull @NotNull Location start, @NotNull @NotNull Vector direction, double maxDistance)
  
  Performs a ray trace that checks for entity collisions.
  This may not consider entities in currently unloaded chunks. Some implementations may impose artificial restrictions on the maximum distance.
  
  Parameters:
  
  start - the start position
  
  direction - the ray direction
  
  maxDistance - the maximum distance
  
  Returns:
  
  the closest ray trace hit result, or null if there is no hit
  
  See Also:
  
  rayTraceEntities(Location, Vector, double, double, Predicate)
- rayTraceEntities
  
  @Nullable @Nullable RayTraceResult rayTraceEntities(@NotNull @NotNull Location start, @NotNull @NotNull Vector direction, double maxDistance, double raySize)
  
  Performs a ray trace that checks for entity collisions.
  This may not consider entities in currently unloaded chunks. Some implementations may impose artificial restrictions on the maximum distance.
  
  Parameters:
  
  start - the start position
  
  direction - the ray direction
  
  maxDistance - the maximum distance
  
  raySize - entity bounding boxes will be uniformly expanded (or shrinked) by this value before doing collision checks
  
  Returns:
  
  the closest ray trace hit result, or null if there is no hit
  
  See Also:
  
  rayTraceEntities(Location, Vector, double, double, Predicate)
- rayTraceEntities
  
  @Nullable @Nullable RayTraceResult rayTraceEntities(@NotNull @NotNull Location start, @NotNull @NotNull Vector direction, double maxDistance, @Nullable @Nullable Predicate<Entity> filter)
  
  Performs a ray trace that checks for entity collisions.
  This may not consider entities in currently unloaded chunks. Some implementations may impose artificial restrictions on the maximum distance.
  
  Parameters:
  
  start - the start position
  
  direction - the ray direction
  
  maxDistance - the maximum distance
  
  filter - only entities that fulfill this predicate are considered, or null to consider all entities
  
  Returns:
  
  the closest ray trace hit result, or null if there is no hit
  
  See Also:
  
  rayTraceEntities(Location, Vector, double, double, Predicate)
- rayTraceEntities
  
  @Nullable @Nullable RayTraceResult rayTraceEntities(@NotNull @NotNull Location start, @NotNull @NotNull Vector direction, double maxDistance, double raySize, @Nullable @Nullable Predicate<Entity> filter)
  
  Performs a ray trace that checks for entity collisions.
  This may not consider entities in currently unloaded chunks. Some implementations may impose artificial restrictions on the maximum distance.
  
  Parameters:
  
  start - the start position
  
  direction - the ray direction
  
  maxDistance - the maximum distance
  
  raySize - entity bounding boxes will be uniformly expanded (or shrinked) by this value before doing collision checks
  
  filter - only entities that fulfill this predicate are considered, or null to consider all entities
  
  Returns:
  
  the closest ray trace hit result, or null if there is no hit
- rayTraceBlocks
  
  @Nullable @Nullable RayTraceResult rayTraceBlocks(@NotNull @NotNull Location start, @NotNull @NotNull Vector direction, double maxDistance)
  
  Performs a ray trace that checks for block collisions using the blocks' precise collision shapes.
  This takes collisions with passable blocks into account, but ignores fluids.
  This may cause loading of chunks! Some implementations may impose artificial restrictions on the maximum distance.
  
  Parameters:
  
  start - the start location
  
  direction - the ray direction
  
  maxDistance - the maximum distance
  
  Returns:
  
  the ray trace hit result, or null if there is no hit
  
  See Also:
  
  rayTraceBlocks(Location, Vector, double, FluidCollisionMode, boolean)
- rayTraceBlocks
  
  @Nullable @Nullable RayTraceResult rayTraceBlocks(@NotNull @NotNull Location start, @NotNull @NotNull Vector direction, double maxDistance, @NotNull @NotNull FluidCollisionMode fluidCollisionMode)
  
  Performs a ray trace that checks for block collisions using the blocks' precise collision shapes.
  This takes collisions with passable blocks into account.
  This may cause loading of chunks! Some implementations may impose artificial restrictions on the maximum distance.
  
  Parameters:
  
  start - the start location
  
  direction - the ray direction
  
  maxDistance - the maximum distance
  
  fluidCollisionMode - the fluid collision mode
  
  Returns:
  
  the ray trace hit result, or null if there is no hit
  
  See Also:
  
  rayTraceBlocks(Location, Vector, double, FluidCollisionMode, boolean)
- rayTraceBlocks
  
  @Nullable @Nullable RayTraceResult rayTraceBlocks(@NotNull @NotNull Location start, @NotNull @NotNull Vector direction, double maxDistance, @NotNull @NotNull FluidCollisionMode fluidCollisionMode, boolean ignorePassableBlocks)
  
  Performs a ray trace that checks for block collisions using the blocks' precise collision shapes.
  If collisions with passable blocks are ignored, fluid collisions are ignored as well regardless of the fluid collision mode.
  Portal blocks are only considered passable if the ray starts within them. Apart from that collisions with portal blocks will be considered even if collisions with passable blocks are otherwise ignored.
  This may cause loading of chunks! Some implementations may impose artificial restrictions on the maximum distance.
  
  Parameters:
  
  start - the start location
  
  direction - the ray direction
  
  maxDistance - the maximum distance
  
  fluidCollisionMode - the fluid collision mode
  
  ignorePassableBlocks - whether to ignore passable but collidable blocks (ex. tall grass, signs, fluids, ..)
  
  Returns:
  
  the ray trace hit result, or null if there is no hit
- rayTrace
  
  @Nullable @Nullable RayTraceResult rayTrace(@NotNull @NotNull Location start, @NotNull @NotNull Vector direction, double maxDistance, @NotNull @NotNull FluidCollisionMode fluidCollisionMode, boolean ignorePassableBlocks, double raySize, @Nullable @Nullable Predicate<Entity> filter)
  
  Performs a ray trace that checks for both block and entity collisions.
  Block collisions use the blocks' precise collision shapes. The raySize parameter is only taken into account for entity collision checks.
  If collisions with passable blocks are ignored, fluid collisions are ignored as well regardless of the fluid collision mode.
  Portal blocks are only considered passable if the ray starts within them. Apart from that collisions with portal blocks will be considered even if collisions with passable blocks are otherwise ignored.
  This may cause loading of chunks! Some implementations may impose artificial restrictions on the maximum distance.
  
  Parameters:
  
  start - the start location
  
  direction - the ray direction
  
  maxDistance - the maximum distance
  
  fluidCollisionMode - the fluid collision mode
  
  ignorePassableBlocks - whether to ignore passable but collidable blocks (ex. tall grass, signs, fluids, ..)
  
  raySize - entity bounding boxes will be uniformly expanded (or shrinked) by this value before doing collision checks
  
  filter - only entities that fulfill this predicate are considered, or null to consider all entities
  
  Returns:
  
  the closest ray trace hit result with either a block or an entity, or null if there is no hit
- getName
  
  @NotNull @NotNull String getName()
  
  Gets the unique name of this world
  
  Returns:
  
  Name of this world
- getUID
  
  @NotNull @NotNull UUID getUID()
  
  Gets the Unique ID of this world
  
  Returns:
  
  Unique ID of this world.
- getSpawnLocation
  
  @NotNull @NotNull Location getSpawnLocation()
  
  Gets the default spawn Location of this world
  
  Returns:
  
  The spawn location of this world
- setSpawnLocation
  
  boolean setSpawnLocation(@NotNull @NotNull Location location)
  
  Sets the spawn location of the world.
  The location provided must be equal to this world.
  
  Parameters:
  
  location - The Location to set the spawn for this world at.
  
  Returns:
  
  True if it was successfully set.
- setSpawnLocation
  
  boolean setSpawnLocation(int x, int y, int z, float angle)
  
  Sets the spawn location of the world
  
  Parameters:
  
  x - X coordinate
  
  y - Y coordinate
  
  z - Z coordinate
  
  angle - the angle
  
  Returns:
  
  True if it was successfully set.
- setSpawnLocation
  
  boolean setSpawnLocation(int x, int y, int z)
  
  Sets the spawn location of the world
  
  Parameters:
  
  x - X coordinate
  
  y - Y coordinate
  
  z - Z coordinate
  
  Returns:
  
  True if it was successfully set.
- getTime
  
  long getTime()
  
  Gets the relative in-game time of this world.
  The relative time is analogous to hours * 1000
  
  Returns:
  
  The current relative time
  
  See Also:
  
  Returns an absolute time of this world
- setTime
  
  void setTime(long time)
  
  Sets the relative in-game time on the server.
  The relative time is analogous to hours * 1000
  Note that setting the relative time below the current relative time will actually move the clock forward a day. If you require to rewind time, please see setFullTime(long)
  
  Parameters:
  
  time - The new relative time to set the in-game time to (in hours*1000)
  
  See Also:
  
  Sets the absolute time of this world
- getFullTime
  
  long getFullTime()
  
  Gets the full in-game time on this world
  
  Returns:
  
  The current absolute time
  
  See Also:
  
  Returns a relative time of this world
- setFullTime
  
  void setFullTime(long time)
  
  Sets the in-game time on the server
  Note that this sets the full time of the world, which may cause adverse effects such as breaking redstone clocks and any scheduled events
  
  Parameters:
  
  time - The new absolute time to set this world to
  
  See Also:
  
  Sets the relative time of this world
- isDayTime
  
  boolean isDayTime()
  
  Check if it is currently daytime in this world
  
  Returns:
  
  True if it is daytime
- getGameTime
  
  long getGameTime()
  
  Gets the full in-game time on this world since the world generation
  
  Returns:
  
  The current absolute time since the world generation
  
  See Also:
  
  Returns a relative time of this world, Returns an absolute time of this world
- hasStorm
  
  boolean hasStorm()
  
  Returns whether the world has an ongoing storm.
  
  Returns:
  
  Whether there is an ongoing storm
- setStorm
  
  void setStorm(boolean hasStorm)
  
  Set whether there is a storm. A duration will be set for the new current conditions. This will implicitly call setClearWeatherDuration(int) with 0 ticks to reset the world's clear weather.
  
  Parameters:
  
  hasStorm - Whether there is rain and snow
- getWeatherDuration
  
  int getWeatherDuration()
  
  Get the remaining time in ticks of the current conditions.
  
  Returns:
  
  Time in ticks
- setWeatherDuration
  
  void setWeatherDuration(int duration)
  
  Set the remaining time in ticks of the current conditions.
  
  Parameters:
  
  duration - Time in ticks
- isThundering
  
  boolean isThundering()
  
  Returns whether there is thunder.
  
  Returns:
  
  Whether there is thunder
- setThundering
  
  void setThundering(boolean thundering)
  
  Set whether it is thundering. This will implicitly call setClearWeatherDuration(int) with 0 ticks to reset the world's clear weather.
  
  Parameters:
  
  thundering - Whether it is thundering
- getThunderDuration
  
  int getThunderDuration()
  
  Get the thundering duration.
  
  Returns:
  
  Duration in ticks
- setThunderDuration
  
  void setThunderDuration(int duration)
  
  Set the thundering duration.
  
  Parameters:
  
  duration - Duration in ticks
- isClearWeather
  
  boolean isClearWeather()
  
  Returns whether the world has clear weather. This will be true such that isThundering() and hasStorm() are both false.
  
  Returns:
  
  true if clear weather
- setClearWeatherDuration
  
  void setClearWeatherDuration(int duration)
  
  Set the clear weather duration. The clear weather ticks determine whether or not the world will be allowed to rain or storm. If clear weather ticks are > 0, the world will not naturally do either until the duration has elapsed. This method is equivalent to calling /weather clear with a set amount of ticks.
  
  Parameters:
  
  duration - duration in ticks
- getClearWeatherDuration
  
  int getClearWeatherDuration()
  
  Get the clear weather duration.
  
  Returns:
  
  duration in ticks
- createExplosion
  
  boolean createExplosion(double x, double y, double z, float power)
  
  Creates explosion at given coordinates with given power
  
  Parameters:
  
  x - X coordinate
  
  y - Y coordinate
  
  z - Z coordinate
  
  power - The power of explosion, where 4F is TNT
  
  Returns:
  
  false if explosion was canceled, otherwise true
- createExplosion
  
  boolean createExplosion(double x, double y, double z, float power, boolean setFire)
  
  Creates explosion at given coordinates with given power and optionally setting blocks on fire.
  
  Parameters:
  
  x - X coordinate
  
  y - Y coordinate
  
  z - Z coordinate
  
  power - The power of explosion, where 4F is TNT
  
  setFire - Whether or not to set blocks on fire
  
  Returns:
  
  false if explosion was canceled, otherwise true
- createExplosion
  
  boolean createExplosion(double x, double y, double z, float power, boolean setFire, boolean breakBlocks)
  
  Creates explosion at given coordinates with given power and optionally setting blocks on fire or breaking blocks.
  
  Parameters:
  
  x - X coordinate
  
  y - Y coordinate
  
  z - Z coordinate
  
  power - The power of explosion, where 4F is TNT
  
  setFire - Whether or not to set blocks on fire
  
  breakBlocks - Whether or not to have blocks be destroyed
  
  Returns:
  
  false if explosion was canceled, otherwise true
- createExplosion
  
  boolean createExplosion(double x, double y, double z, float power, boolean setFire, boolean breakBlocks, @Nullable @Nullable Entity source)
  
  Creates explosion at given coordinates with given power and optionally setting blocks on fire or breaking blocks.
  
  Parameters:
  
  x - X coordinate
  
  y - Y coordinate
  
  z - Z coordinate
  
  power - The power of explosion, where 4F is TNT
  
  setFire - Whether or not to set blocks on fire
  
  breakBlocks - Whether or not to have blocks be destroyed
  
  source - the source entity, used for tracking damage
  
  Returns:
  
  false if explosion was canceled, otherwise true
- createExplosion
  
  boolean createExplosion(@NotNull @NotNull Location loc, float power)
  
  Creates explosion at given coordinates with given power
  
  Parameters:
  
  loc - Location to blow up
  
  power - The power of explosion, where 4F is TNT
  
  Returns:
  
  false if explosion was canceled, otherwise true
- createExplosion
  
  boolean createExplosion(@NotNull @NotNull Location loc, float power, boolean setFire)
  
  Creates explosion at given coordinates with given power and optionally setting blocks on fire.
  
  Parameters:
  
  loc - Location to blow up
  
  power - The power of explosion, where 4F is TNT
  
  setFire - Whether or not to set blocks on fire
  
  Returns:
  
  false if explosion was canceled, otherwise true
- createExplosion
  
  boolean createExplosion(@Nullable @Nullable Entity source, @NotNull @NotNull Location loc, float power, boolean setFire, boolean breakBlocks)
  
  Creates explosion at given location with given power and optionally setting blocks on fire, with the specified entity as the source.
  
  Parameters:
  
  source - The source entity of the explosion
  
  loc - Location to blow up
  
  power - The power of explosion, where 4F is TNT
  
  setFire - Whether or not to set blocks on fire
  
  breakBlocks - Whether or not to have blocks be destroyed
  
  Returns:
  
  false if explosion was canceled, otherwise true
- createExplosion
  
  default boolean createExplosion(@Nullable @Nullable Entity source, @NotNull @NotNull Location loc, float power, boolean setFire)
  
  Creates explosion at given location with given power and optionally setting blocks on fire, with the specified entity as the source. Will destroy other blocks
  
  Parameters:
  
  source - The source entity of the explosion
  
  loc - Location to blow up
  
  power - The power of explosion, where 4F is TNT
  
  setFire - Whether or not to set blocks on fire
  
  Returns:
  
  false if explosion was canceled, otherwise true
- createExplosion
  
  default boolean createExplosion(@Nullable @Nullable Entity source, @NotNull @NotNull Location loc, float power)
  
  Creates explosion at given location with given power, with the specified entity as the source. Will set blocks on fire and destroy blocks.
  
  Parameters:
  
  source - The source entity of the explosion
  
  loc - Location to blow up
  
  power - The power of explosion, where 4F is TNT
  
  Returns:
  
  false if explosion was canceled, otherwise true
- createExplosion
  
  default boolean createExplosion(@NotNull @NotNull Entity source, float power, boolean setFire, boolean breakBlocks)
  
  Creates explosion at given entities location with given power and optionally setting blocks on fire, with the specified entity as the source.
  
  Parameters:
  
  source - The source entity of the explosion
  
  power - The power of explosion, where 4F is TNT
  
  setFire - Whether or not to set blocks on fire
  
  breakBlocks - Whether or not to have blocks be destroyed
  
  Returns:
  
  false if explosion was canceled, otherwise true
- createExplosion
  
  default boolean createExplosion(@NotNull @NotNull Entity source, float power, boolean setFire)
  
  Creates explosion at given entities location with given power and optionally setting blocks on fire, with the specified entity as the source. Will destroy blocks.
  
  Parameters:
  
  source - The source entity of the explosion
  
  power - The power of explosion, where 4F is TNT
  
  setFire - Whether or not to set blocks on fire
  
  Returns:
  
  false if explosion was canceled, otherwise true
- createExplosion
  
  default boolean createExplosion(@NotNull @NotNull Entity source, float power)
  
  Creates explosion at given entities location with given power and optionally setting blocks on fire, with the specified entity as the source.
  
  Parameters:
  
  source - The source entity of the explosion
  
  power - The power of explosion, where 4F is TNT
  
  Returns:
  
  false if explosion was canceled, otherwise true
- createExplosion
  
  boolean createExplosion(@NotNull @NotNull Location loc, float power, boolean setFire, boolean breakBlocks)
  
  Creates explosion at given coordinates with given power and optionally setting blocks on fire or breaking blocks.
  
  Parameters:
  
  loc - Location to blow up
  
  power - The power of explosion, where 4F is TNT
  
  setFire - Whether or not to set blocks on fire
  
  breakBlocks - Whether or not to have blocks be destroyed
  
  Returns:
  
  false if explosion was canceled, otherwise true
- createExplosion
  
  boolean createExplosion(@NotNull @NotNull Location loc, float power, boolean setFire, boolean breakBlocks, @Nullable @Nullable Entity source)
  
  Creates explosion at given coordinates with given power and optionally setting blocks on fire or breaking blocks.
  
  Parameters:
  
  loc - Location to blow up
  
  power - The power of explosion, where 4F is TNT
  
  setFire - Whether or not to set blocks on fire
  
  breakBlocks - Whether or not to have blocks be destroyed
  
  source - the source entity, used for tracking damage
  
  Returns:
  
  false if explosion was canceled, otherwise true
- getEnvironment
  
  @NotNull @NotNull World.Environment getEnvironment()
  
  Gets the World.Environment type of this world
  
  Returns:
  
  This worlds Environment type
- getSeed
  
  long getSeed()
  
  Gets the Seed for this world.
  
  Returns:
  
  This worlds Seed
- getPVP
  
  boolean getPVP()
  
  Gets the current PVP setting for this world.
  
  Returns:
  
  True if PVP is enabled
- setPVP
  
  void setPVP(boolean pvp)
  
  Sets the PVP setting for this world.
  
  Parameters:
  
  pvp - True/False whether PVP should be Enabled.
- getGenerator
  
  @Nullable @Nullable ChunkGenerator getGenerator()
  
  Gets the chunk generator for this world
  
  Returns:
  
  ChunkGenerator associated with this world
- save
  
  void save()
  
  Saves world to disk
- getPopulators
  
  @NotNull @NotNull List<BlockPopulator> getPopulators()
  
  Gets a list of all applied BlockPopulators for this World
  
  Returns:
  
  List containing any or none BlockPopulators
- spawn
  
  @NotNull <T extends Entity> T spawn(@NotNull @NotNull Location location, @NotNull @NotNull Class<T> clazz) throws IllegalArgumentException
  
  Spawn an entity of a specific class at the given Location
  
  Type Parameters:
  
  T - the class of the Entity to spawn
  
  Parameters:
  
  location - the Location to spawn the entity at
  
  clazz - the class of the Entity to spawn
  
  Returns:
  
  an instance of the spawned Entity
  
  Throws:
  
  IllegalArgumentException - if either parameter is null or the Entity requested cannot be spawned
- spawn
  
  @NotNull default <T extends Entity> T spawn(@NotNull @NotNull Location location, @NotNull @NotNull Class<T> clazz, @NotNull CreatureSpawnEvent.SpawnReason reason) throws IllegalArgumentException
  
  Throws:
  
  IllegalArgumentException
- spawn
  
  @NotNull default <T extends Entity> T spawn(@NotNull @NotNull Location location, @NotNull @NotNull Class<T> clazz, @Nullable @Nullable Consumer<T> function) throws IllegalArgumentException
  
  Spawn an entity of a specific class at the given Location, with the supplied function run before the entity is added to the world.
  Note that when the function is run, the entity will not be actually in the world. Any operation involving such as teleporting the entity is undefined until after this function returns.
  
  Type Parameters:
  
  T - the class of the Entity to spawn
  
  Parameters:
  
  location - the Location to spawn the entity at
  
  clazz - the class of the Entity to spawn
  
  function - the function to be run before the entity is spawned.
  
  Returns:
  
  an instance of the spawned Entity
  
  Throws:
  
  IllegalArgumentException - if either parameter is null or the Entity requested cannot be spawned
- spawn
  
  @NotNull default <T extends Entity> T spawn(@NotNull @NotNull Location location, @NotNull @NotNull Class<T> clazz, @NotNull CreatureSpawnEvent.SpawnReason reason, @Nullable @Nullable Consumer<T> function) throws IllegalArgumentException
  
  Throws:
  
  IllegalArgumentException
- spawnEntity
  
  @NotNull default @NotNull Entity spawnEntity(@NotNull @NotNull Location loc, @NotNull @NotNull EntityType type, @NotNull CreatureSpawnEvent.SpawnReason reason)
- spawnEntity
  
  @NotNull default @NotNull Entity spawnEntity(@NotNull @NotNull Location loc, @NotNull @NotNull EntityType type, @NotNull CreatureSpawnEvent.SpawnReason reason, @Nullable @Nullable Consumer<Entity> function)
- spawn
  
  @NotNull <T extends Entity> T spawn(@NotNull @NotNull Location location, @NotNull @NotNull Class<T> clazz, @Nullable @Nullable Consumer<T> function, @NotNull CreatureSpawnEvent.SpawnReason reason) throws IllegalArgumentException
  
  Throws:
  
  IllegalArgumentException
- spawnFallingBlock
  
  @NotNull @NotNull FallingBlock spawnFallingBlock(@NotNull @NotNull Location location, @NotNull @NotNull MaterialData data) throws IllegalArgumentException
  
  Spawn a FallingBlock entity at the given Location of the specified Material. The material dictates what is falling. When the FallingBlock hits the ground, it will place that block.
  The Material must be a block type, check with material.isBlock(). The Material may not be air.
  
  Parameters:
  
  location - The Location to spawn the FallingBlock
  
  data - The block data
  
  Returns:
  
  The spawned FallingBlock instance
  
  Throws:
  
  IllegalArgumentException - if Location or MaterialData are null or Material of the MaterialData is not a block
- spawnFallingBlock
  
  @NotNull @NotNull FallingBlock spawnFallingBlock(@NotNull @NotNull Location location, @NotNull @NotNull BlockData data) throws IllegalArgumentException
  
  Spawn a FallingBlock entity at the given Location of the specified Material. The material dictates what is falling. When the FallingBlock hits the ground, it will place that block.
  The Material must be a block type, check with material.isBlock(). The Material may not be air.
  
  Parameters:
  
  location - The Location to spawn the FallingBlock
  
  data - The block data
  
  Returns:
  
  The spawned FallingBlock instance
  
  Throws:
  
  IllegalArgumentException - if Location or BlockData are null
- spawnFallingBlock
  
  @Deprecated @NotNull @NotNull FallingBlock spawnFallingBlock(@NotNull @NotNull Location location, @NotNull @NotNull Material material, byte data) throws IllegalArgumentException
  
  Deprecated.
  Magic value
  
  Spawn a FallingBlock entity at the given Location of the specified Material. The material dictates what is falling. When the FallingBlock hits the ground, it will place that block.
  The Material must be a block type, check with material.isBlock(). The Material may not be air.
  
  Parameters:
  
  location - The Location to spawn the FallingBlock
  
  material - The block Material type
  
  data - The block data
  
  Returns:
  
  The spawned FallingBlock instance
  
  Throws:
  
  IllegalArgumentException - if Location or Material are null or Material is not a block
- playEffect
  
  void playEffect(@NotNull @NotNull Location location, @NotNull @NotNull Effect effect, int data)
  
  Plays an effect to all players within a default radius around a given location.
  
  Parameters:
  
  location - the Location around which players must be to hear the sound
  
  effect - the Effect
  
  data - a data bit needed for some effects
- playEffect
  
  void playEffect(@NotNull @NotNull Location location, @NotNull @NotNull Effect effect, int data, int radius)
  
  Plays an effect to all players within a given radius around a location.
  
  Parameters:
  
  location - the Location around which players must be to hear the effect
  
  effect - the Effect
  
  data - a data bit needed for some effects
  
  radius - the radius around the location
- playEffect
  
  <T> void playEffect(@NotNull @NotNull Location location, @NotNull @NotNull Effect effect, @Nullable T data)
  
  Plays an effect to all players within a default radius around a given location.
  
  Type Parameters:
  
  T - data dependant on the type of effect
  
  Parameters:
  
  location - the Location around which players must be to hear the sound
  
  effect - the Effect
  
  data - a data bit needed for some effects
- playEffect
  
  <T> void playEffect(@NotNull @NotNull Location location, @NotNull @NotNull Effect effect, @Nullable T data, int radius)
  
  Plays an effect to all players within a given radius around a location.
  
  Type Parameters:
  
  T - data dependant on the type of effect
  
  Parameters:
  
  location - the Location around which players must be to hear the effect
  
  effect - the Effect
  
  data - a data bit needed for some effects
  
  radius - the radius around the location
- getEmptyChunkSnapshot
  
  @NotNull @NotNull ChunkSnapshot getEmptyChunkSnapshot(int x, int z, boolean includeBiome, boolean includeBiomeTemp)
  
  Get empty chunk snapshot (equivalent to all air blocks), optionally including valid biome data. Used for representing an ungenerated chunk, or for fetching only biome data without loading a chunk.
  
  Parameters:
  
  x - - chunk x coordinate
  
  z - - chunk z coordinate
  
  includeBiome - - if true, snapshot includes per-coordinate biome type
  
  includeBiomeTemp - - if true, snapshot includes per-coordinate raw biome temperature
  
  Returns:
  
  The empty snapshot.
- setSpawnFlags
  
  void setSpawnFlags(boolean allowMonsters, boolean allowAnimals)
  
  Sets the spawn flags for this.
  
  Parameters:
  
  allowMonsters - - if true, monsters are allowed to spawn in this world.
  
  allowAnimals - - if true, animals are allowed to spawn in this world.
- getAllowAnimals
  
  boolean getAllowAnimals()
  
  Gets whether animals can spawn in this world.
  
  Returns:
  
  whether animals can spawn in this world.
- getAllowMonsters
  
  boolean getAllowMonsters()
  
  Gets whether monsters can spawn in this world.
  
  Returns:
  
  whether monsters can spawn in this world.
- getBiome
  
  @NotNull @Deprecated @NotNull Biome getBiome(int x, int z)
  
  Deprecated.
  biomes are now 3-dimensional
  
  Gets the biome for the given block coordinates.
  
  Parameters:
  
  x - X coordinate of the block
  
  z - Z coordinate of the block
  
  Returns:
  
  Biome of the requested block
- getBiome
  
  @NotNull @NotNull Biome getBiome(int x, int y, int z)
  
  Gets the biome for the given block coordinates.
  
  Parameters:
  
  x - X coordinate of the block
  
  y - Y coordinate of the block
  
  z - Z coordinate of the block
  
  Returns:
  
  Biome of the requested block
- setBiome
  
  @Deprecated void setBiome(int x, int z, @NotNull @NotNull Biome bio)
  
  Deprecated.
  biomes are now 3-dimensional
  
  Sets the biome for the given block coordinates
  
  Parameters:
  
  x - X coordinate of the block
  
  z - Z coordinate of the block
  
  bio - new Biome type for this block
- setBiome
  
  void setBiome(int x, int y, int z, @NotNull @NotNull Biome bio)
  
  Sets the biome for the given block coordinates
  
  Parameters:
  
  x - X coordinate of the block
  
  y - Y coordinate of the block
  
  z - Z coordinate of the block
  
  bio - new Biome type for this block
- getTemperature
  
  @Deprecated double getTemperature(int x, int z)
  
  Deprecated.
  biomes are now 3-dimensional
  
  Gets the temperature for the given block coordinates.
  It is safe to run this method when the block does not exist, it will not create the block.
  This method will return the raw temperature without adjusting for block height effects.
  
  Parameters:
  
  x - X coordinate of the block
  
  z - Z coordinate of the block
  
  Returns:
  
  Temperature of the requested block
- getTemperature
  
  double getTemperature(int x, int y, int z)
  
  Gets the temperature for the given block coordinates.
  It is safe to run this method when the block does not exist, it will not create the block.
  This method will return the raw temperature without adjusting for block height effects.
  
  Parameters:
  
  x - X coordinate of the block
  
  y - Y coordinate of the block
  
  z - Z coordinate of the block
  
  Returns:
  
  Temperature of the requested block
- getHumidity
  
  @Deprecated double getHumidity(int x, int z)
  
  Deprecated.
  biomes are now 3-dimensional
  
  Gets the humidity for the given block coordinates.
  It is safe to run this method when the block does not exist, it will not create the block.
  
  Parameters:
  
  x - X coordinate of the block
  
  z - Z coordinate of the block
  
  Returns:
  
  Humidity of the requested block
- getHumidity
  
  double getHumidity(int x, int y, int z)
  
  Gets the humidity for the given block coordinates.
  It is safe to run this method when the block does not exist, it will not create the block.
  
  Parameters:
  
  x - X coordinate of the block
  
  y - Y coordinate of the block
  
  z - Z coordinate of the block
  
  Returns:
  
  Humidity of the requested block
- getMinHeight
  
  int getMinHeight()
  
  Gets the minimum height of this world.
  If the min height is 0, there are only blocks from y=0.
  
  Returns:
  
  Minimum height of the world
- getMaxHeight
  
  int getMaxHeight()
  
  Gets the maximum height of this world.
  If the max height is 100, there are only blocks from y=0 to y=99.
  
  Returns:
  
  Maximum height of the world
- getSeaLevel
  
  int getSeaLevel()
  
  Gets the sea level for this world.
  This is often half of getMaxHeight()
  
  Returns:
  
  Sea level
- getKeepSpawnInMemory
  
  boolean getKeepSpawnInMemory()
  
  Gets whether the world's spawn area should be kept loaded into memory or not.
  
  Returns:
  
  true if the world's spawn area will be kept loaded into memory.
- setKeepSpawnInMemory
  
  void setKeepSpawnInMemory(boolean keepLoaded)
  
  Sets whether the world's spawn area should be kept loaded into memory or not.
  
  Parameters:
  
  keepLoaded - if true then the world's spawn area will be kept loaded into memory.
- isAutoSave
  
  boolean isAutoSave()
  
  Gets whether or not the world will automatically save
  
  Returns:
  
  true if the world will automatically save, otherwise false
- setAutoSave
  
  void setAutoSave(boolean value)
  
  Sets whether or not the world will automatically save
  
  Parameters:
  
  value - true if the world should automatically save, otherwise false
- setDifficulty
  
  void setDifficulty(@NotNull @NotNull Difficulty difficulty)
  
  Sets the Difficulty of the world.
  
  Parameters:
  
  difficulty - the new difficulty you want to set the world to
- getDifficulty
  
  @NotNull @NotNull Difficulty getDifficulty()
  
  Gets the Difficulty of the world.
  
  Returns:
  
  The difficulty of the world.
- getWorldFolder
  
  @NotNull @NotNull File getWorldFolder()
  
  Gets the folder of this world on disk.
  
  Returns:
  
  The folder of this world.
- getWorldType
  
  @Nullable @Deprecated @Nullable WorldType getWorldType()
  
  Deprecated.
  world type is only used to select the default word generation settings and is not stored in Vanilla worlds, making it impossible for this method to always return the correct value.
  
  Gets the type of this world.
  
  Returns:
  
  Type of this world.
- canGenerateStructures
  
  boolean canGenerateStructures()
  
  Gets whether or not structures are being generated.
  
  Returns:
  
  True if structures are being generated.
- isHardcore
  
  boolean isHardcore()
  
  Gets whether the world is hardcore or not. In a hardcore world the difficulty is locked to hard.
  
  Returns:
  
  hardcore status
- setHardcore
  
  void setHardcore(boolean hardcore)
  
  Sets whether the world is hardcore or not. In a hardcore world the difficulty is locked to hard.
  
  Parameters:
  
  hardcore - Whether the world is hardcore
- getTicksPerAnimalSpawns
  
  long getTicksPerAnimalSpawns()
  Gets the world's ticks per animal spawns value
  This value determines how many ticks there are between attempts to spawn animals.
  Example Usage:
  
  A value of 1 will mean the server will attempt to spawn animals in this world every tick.
  A value of 400 will mean the server will attempt to spawn animals in this world every 400th tick.
  A value below 0 will be reset back to Minecraft's default.
  
  Note: If set to 0, animal spawning will be disabled for this world. We recommend using setSpawnFlags(boolean, boolean) to control this instead.
  Minecraft default: 400.
  Returns:
  
  The world's ticks per animal spawns value
- setTicksPerAnimalSpawns
  
  void setTicksPerAnimalSpawns(int ticksPerAnimalSpawns)
  Sets the world's ticks per animal spawns value
  This value determines how many ticks there are between attempts to spawn animals.
  Example Usage:
  
  A value of 1 will mean the server will attempt to spawn animals in this world every tick.
  A value of 400 will mean the server will attempt to spawn animals in this world every 400th tick.
  A value below 0 will be reset back to Minecraft's default.
  
  Note: If set to 0, animal spawning will be disabled for this world. We recommend using setSpawnFlags(boolean, boolean) to control this instead.
  Minecraft default: 400.
  Parameters:
  
  ticksPerAnimalSpawns - the ticks per animal spawns value you want to set the world to
- getTicksPerMonsterSpawns
  
  long getTicksPerMonsterSpawns()
  Gets the world's ticks per monster spawns value
  This value determines how many ticks there are between attempts to spawn monsters.
  Example Usage:
  
  A value of 1 will mean the server will attempt to spawn monsters in this world every tick.
  A value of 400 will mean the server will attempt to spawn monsters in this world every 400th tick.
  A value below 0 will be reset back to Minecraft's default.
  
  Note: If set to 0, monsters spawning will be disabled for this world. We recommend using setSpawnFlags(boolean, boolean) to control this instead.
  Minecraft default: 1.
  Returns:
  
  The world's ticks per monster spawns value
- setTicksPerMonsterSpawns
  
  void setTicksPerMonsterSpawns(int ticksPerMonsterSpawns)
  Sets the world's ticks per monster spawns value
  This value determines how many ticks there are between attempts to spawn monsters.
  Example Usage:
  
  A value of 1 will mean the server will attempt to spawn monsters in this world on every tick.
  A value of 400 will mean the server will attempt to spawn monsters in this world every 400th tick.
  A value below 0 will be reset back to Minecraft's default.
  
  Note: If set to 0, monsters spawning will be disabled for this world. We recommend using setSpawnFlags(boolean, boolean) to control this instead.
  Minecraft default: 1.
  Parameters:
  
  ticksPerMonsterSpawns - the ticks per monster spawns value you want to set the world to
- getTicksPerWaterSpawns
  
  long getTicksPerWaterSpawns()
  Gets the world's ticks per water mob spawns value
  This value determines how many ticks there are between attempts to spawn water mobs.
  Example Usage:
  
  A value of 1 will mean the server will attempt to spawn water mobs in this world every tick.
  A value of 400 will mean the server will attempt to spawn water mobs in this world every 400th tick.
  A value below 0 will be reset back to Minecraft's default.
  
  Note: If set to 0, water mobs spawning will be disabled for this world.
  Minecraft default: 1.
  Returns:
  
  The world's ticks per water mob spawns value
- setTicksPerWaterSpawns
  
  void setTicksPerWaterSpawns(int ticksPerWaterSpawns)
  Sets the world's ticks per water mob spawns value
  This value determines how many ticks there are between attempts to spawn water mobs.
  Example Usage:
  
  A value of 1 will mean the server will attempt to spawn water mobs in this world on every tick.
  A value of 400 will mean the server will attempt to spawn water mobs in this world every 400th tick.
  A value below 0 will be reset back to Minecraft's default.
  
  Note: If set to 0, water mobs spawning will be disabled for this world.
  Minecraft default: 1.
  Parameters:
  
  ticksPerWaterSpawns - the ticks per water mob spawns value you want to set the world to
- getTicksPerWaterAmbientSpawns
  
  long getTicksPerWaterAmbientSpawns()
  Gets the default ticks per water ambient mob spawns value.
  Example Usage:
  
  A value of 1 will mean the server will attempt to spawn water ambient mobs every tick.
  A value of 400 will mean the server will attempt to spawn water ambient mobs every 400th tick.
  A value below 0 will be reset back to Minecraft's default.
  
  Note: If set to 0, ambient mobs spawning will be disabled.
  Minecraft default: 1.
  Returns:
  
  the default ticks per water ambient mobs spawn value
- setTicksPerWaterAmbientSpawns
  
  void setTicksPerWaterAmbientSpawns(int ticksPerAmbientSpawns)
  Sets the world's ticks per water ambient mob spawns value
  This value determines how many ticks there are between attempts to spawn water ambient mobs.
  Example Usage:
  
  A value of 1 will mean the server will attempt to spawn water ambient mobs in this world on every tick.
  A value of 400 will mean the server will attempt to spawn weater ambient mobs in this world every 400th tick.
  A value below 0 will be reset back to Minecraft's default.
  
  Note: If set to 0, water ambient mobs spawning will be disabled for this world.
  Minecraft default: 1.
  Parameters:
  
  ticksPerAmbientSpawns - the ticks per water ambient mob spawns value you want to set the world to
- getTicksPerAmbientSpawns
  
  long getTicksPerAmbientSpawns()
  Gets the world's ticks per ambient mob spawns value
  This value determines how many ticks there are between attempts to spawn ambient mobs.
  Example Usage:
  
  A value of 1 will mean the server will attempt to spawn ambient mobs in this world every tick.
  A value of 400 will mean the server will attempt to spawn ambient mobs in this world every 400th tick.
  A value below 0 will be reset back to Minecraft's default.
  
  Note: If set to 0, ambient mobs spawning will be disabled for this world.
  Minecraft default: 1.
  Returns:
  
  The world's ticks per ambient mob spawns value
- setTicksPerAmbientSpawns
  
  void setTicksPerAmbientSpawns(int ticksPerAmbientSpawns)
  Sets the world's ticks per ambient mob spawns value
  This value determines how many ticks there are between attempts to spawn ambient mobs.
  Example Usage:
  
  A value of 1 will mean the server will attempt to spawn ambient mobs in this world on every tick.
  A value of 400 will mean the server will attempt to spawn ambient mobs in this world every 400th tick.
  A value below 0 will be reset back to Minecraft's default.
  
  Note: If set to 0, ambient mobs spawning will be disabled for this world.
  Minecraft default: 1.
  Parameters:
  
  ticksPerAmbientSpawns - the ticks per ambient mob spawns value you want to set the world to
- getMonsterSpawnLimit
  
  int getMonsterSpawnLimit()
  
  Gets limit for number of monsters that can spawn in a chunk in this world
  
  Returns:
  
  The monster spawn limit
- setMonsterSpawnLimit
  
  void setMonsterSpawnLimit(int limit)
  
  Sets the limit for number of monsters that can spawn in a chunk in this world
  Note: If set to a negative number the world will use the server-wide spawn limit instead.
  
  Parameters:
  
  limit - the new mob limit
- getAnimalSpawnLimit
  
  int getAnimalSpawnLimit()
  
  Gets the limit for number of animals that can spawn in a chunk in this world
  
  Returns:
  
  The animal spawn limit
- setAnimalSpawnLimit
  
  void setAnimalSpawnLimit(int limit)
  
  Sets the limit for number of animals that can spawn in a chunk in this world
  Note: If set to a negative number the world will use the server-wide spawn limit instead.
  
  Parameters:
  
  limit - the new mob limit
- getWaterAnimalSpawnLimit
  
  int getWaterAnimalSpawnLimit()
  
  Gets the limit for number of water animals that can spawn in a chunk in this world
  
  Returns:
  
  The water animal spawn limit
- setWaterAnimalSpawnLimit
  
  void setWaterAnimalSpawnLimit(int limit)
  
  Sets the limit for number of water animals that can spawn in a chunk in this world
  Note: If set to a negative number the world will use the server-wide spawn limit instead.
  
  Parameters:
  
  limit - the new mob limit
- getWaterAmbientSpawnLimit
  
  int getWaterAmbientSpawnLimit()
  
  Gets user-specified limit for number of water ambient mobs that can spawn in a chunk.
  
  Returns:
  
  the water ambient spawn limit
- setWaterAmbientSpawnLimit
  
  void setWaterAmbientSpawnLimit(int limit)
  
  Sets the limit for number of water ambient mobs that can spawn in a chunk in this world
  Note: If set to a negative number the world will use the server-wide spawn limit instead.
  
  Parameters:
  
  limit - the new mob limit
- getAmbientSpawnLimit
  
  int getAmbientSpawnLimit()
  
  Gets the limit for number of ambient mobs that can spawn in a chunk in this world
  
  Returns:
  
  The ambient spawn limit
- setAmbientSpawnLimit
  
  void setAmbientSpawnLimit(int limit)
  
  Sets the limit for number of ambient mobs that can spawn in a chunk in this world
  Note: If set to a negative number the world will use the server-wide spawn limit instead.
  
  Parameters:
  
  limit - the new mob limit
- playSound
  
  void playSound(@NotNull @NotNull Location location, @NotNull @NotNull Sound sound, float volume, float pitch)
  
  Play a Sound at the provided Location in the World
  This function will fail silently if Location or Sound are null.
  
  Parameters:
  
  location - The location to play the sound
  
  sound - The sound to play
  
  volume - The volume of the sound
  
  pitch - The pitch of the sound
- playSound
  
  void playSound(@NotNull @NotNull Location location, @NotNull @NotNull String sound, float volume, float pitch)
  
  Play a Sound at the provided Location in the World.
  This function will fail silently if Location or Sound are null. No sound will be heard by the players if their clients do not have the respective sound for the value passed.
  
  Parameters:
  
  location - the location to play the sound
  
  sound - the internal sound name to play
  
  volume - the volume of the sound
  
  pitch - the pitch of the sound
- playSound
  
  void playSound(@NotNull @NotNull Location location, @NotNull @NotNull Sound sound, @NotNull @NotNull SoundCategory category, float volume, float pitch)
  
  Play a Sound at the provided Location in the World.
  This function will fail silently if Location or Sound are null.
  
  Parameters:
  
  location - The location to play the sound
  
  sound - The sound to play
  
  category - the category of the sound
  
  volume - The volume of the sound
  
  pitch - The pitch of the sound
- playSound
  
  void playSound(@NotNull @NotNull Location location, @NotNull @NotNull String sound, @NotNull @NotNull SoundCategory category, float volume, float pitch)
  
  Play a Sound at the provided Location in the World.
  This function will fail silently if Location or Sound are null. No sound will be heard by the players if their clients do not have the respective sound for the value passed.
  
  Parameters:
  
  location - the location to play the sound
  
  sound - the internal sound name to play
  
  category - the category of the sound
  
  volume - the volume of the sound
  
  pitch - the pitch of the sound
- getGameRules
  
  @NotNull @NotNull String[] getGameRules()
  
  Get an array containing the names of all the GameRules.
  
  Returns:
  
  An array of GameRule names.
- getGameRuleValue
  
  @Deprecated @Contract("null -> null; !null -> !null") @Nullable @Nullable String getGameRuleValue(@Nullable @Nullable String rule)
  
  Deprecated.
  use getGameRuleValue(GameRule) instead
  
  Gets the current state of the specified rule
  Will return null if rule passed is null
  
  Parameters:
  
  rule - Rule to look up value of
  
  Returns:
  
  String value of rule
- setGameRuleValue
  
  @Deprecated boolean setGameRuleValue(@NotNull @NotNull String rule, @NotNull @NotNull String value)
  
  Deprecated.
  use setGameRule(GameRule, Object) instead.
  
  Set the specified gamerule to specified value.
  The rule may attempt to validate the value passed, will return true if value was set.
  If rule is null, the function will return false.
  
  Parameters:
  
  rule - Rule to set
  
  value - Value to set rule to
  
  Returns:
  
  True if rule was set
- isGameRule
  
  boolean isGameRule(@NotNull @NotNull String rule)
  
  Checks if string is a valid game rule
  
  Parameters:
  
  rule - Rule to check
  
  Returns:
  
  True if rule exists
- getGameRuleValue
  
  @Nullable <T> T getGameRuleValue(@NotNull @NotNull GameRule<T> rule)
  
  Get the current value for a given GameRule.
  
  Type Parameters:
  
  T - the GameRule's type
  
  Parameters:
  
  rule - the GameRule to check
  
  Returns:
  
  the current value
- getGameRuleDefault
  
  @Nullable <T> T getGameRuleDefault(@NotNull @NotNull GameRule<T> rule)
  
  Get the default value for a given GameRule. This value is not guaranteed to match the current value.
  
  Type Parameters:
  
  T - the type of GameRule
  
  Parameters:
  
  rule - the rule to return a default value for
  
  Returns:
  
  the default value
- setGameRule
  
  <T> boolean setGameRule(@NotNull @NotNull GameRule<T> rule, @NotNull T newValue)
  
  Set the given GameRule's new value.
  
  Type Parameters:
  
  T - the value type of the GameRule
  
  Parameters:
  
  rule - the GameRule to update
  
  newValue - the new value
  
  Returns:
  
  true if the value was successfully set
- getWorldBorder
  
  @NotNull @NotNull WorldBorder getWorldBorder()
  
  Gets the world border for this world.
  
  Returns:
  
  The world border for this world.
- spawnParticle
  
  void spawnParticle(@NotNull @NotNull Particle particle, @NotNull @NotNull Location location, int count)
  
  Spawns the particle (the number of times specified by count) at the target location.
  
  Parameters:
  
  particle - the particle to spawn
  
  location - the location to spawn at
  
  count - the number of particles
- spawnParticle
  
  void spawnParticle(@NotNull @NotNull Particle particle, double x, double y, double z, int count)
  
  Spawns the particle (the number of times specified by count) at the target location.
  
  Parameters:
  
  particle - the particle to spawn
  
  x - the position on the x axis to spawn at
  
  y - the position on the y axis to spawn at
  
  z - the position on the z axis to spawn at
  
  count - the number of particles
- spawnParticle
  
  <T> void spawnParticle(@NotNull @NotNull Particle particle, @NotNull @NotNull Location location, int count, @Nullable T data)
  
  Spawns the particle (the number of times specified by count) at the target location.
  
  Type Parameters:
  
  T - type of particle data (see Particle.getDataType()
  
  Parameters:
  
  particle - the particle to spawn
  
  location - the location to spawn at
  
  count - the number of particles
  
  data - the data to use for the particle or null, the type of this depends on Particle.getDataType()
- spawnParticle
  
  <T> void spawnParticle(@NotNull @NotNull Particle particle, double x, double y, double z, int count, @Nullable T data)
  
  Spawns the particle (the number of times specified by count) at the target location.
  
  Type Parameters:
  
  T - type of particle data (see Particle.getDataType()
  
  Parameters:
  
  particle - the particle to spawn
  
  x - the position on the x axis to spawn at
  
  y - the position on the y axis to spawn at
  
  z - the position on the z axis to spawn at
  
  count - the number of particles
  
  data - the data to use for the particle or null, the type of this depends on Particle.getDataType()
- spawnParticle
  
  void spawnParticle(@NotNull @NotNull Particle particle, @NotNull @NotNull Location location, int count, double offsetX, double offsetY, double offsetZ)
  
  Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
  
  Parameters:
  
  particle - the particle to spawn
  
  location - the location to spawn at
  
  count - the number of particles
  
  offsetX - the maximum random offset on the X axis
  
  offsetY - the maximum random offset on the Y axis
  
  offsetZ - the maximum random offset on the Z axis
- spawnParticle
  
  void spawnParticle(@NotNull @NotNull Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ)
  
  Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
  
  Parameters:
  
  particle - the particle to spawn
  
  x - the position on the x axis to spawn at
  
  y - the position on the y axis to spawn at
  
  z - the position on the z axis to spawn at
  
  count - the number of particles
  
  offsetX - the maximum random offset on the X axis
  
  offsetY - the maximum random offset on the Y axis
  
  offsetZ - the maximum random offset on the Z axis
- spawnParticle
  
  <T> void spawnParticle(@NotNull @NotNull Particle particle, @NotNull @NotNull Location location, int count, double offsetX, double offsetY, double offsetZ, @Nullable T data)
  
  Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
  
  Type Parameters:
  
  T - type of particle data (see Particle.getDataType()
  
  Parameters:
  
  particle - the particle to spawn
  
  location - the location to spawn at
  
  count - the number of particles
  
  offsetX - the maximum random offset on the X axis
  
  offsetY - the maximum random offset on the Y axis
  
  offsetZ - the maximum random offset on the Z axis
  
  data - the data to use for the particle or null, the type of this depends on Particle.getDataType()
- spawnParticle
  
  <T> void spawnParticle(@NotNull @NotNull Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, @Nullable T data)
  
  Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
  
  Type Parameters:
  
  T - type of particle data (see Particle.getDataType()
  
  Parameters:
  
  particle - the particle to spawn
  
  x - the position on the x axis to spawn at
  
  y - the position on the y axis to spawn at
  
  z - the position on the z axis to spawn at
  
  count - the number of particles
  
  offsetX - the maximum random offset on the X axis
  
  offsetY - the maximum random offset on the Y axis
  
  offsetZ - the maximum random offset on the Z axis
  
  data - the data to use for the particle or null, the type of this depends on Particle.getDataType()
- spawnParticle
  
  void spawnParticle(@NotNull @NotNull Particle particle, @NotNull @NotNull Location location, int count, double offsetX, double offsetY, double offsetZ, double extra)
  
  Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
  
  Parameters:
  
  particle - the particle to spawn
  
  location - the location to spawn at
  
  count - the number of particles
  
  offsetX - the maximum random offset on the X axis
  
  offsetY - the maximum random offset on the Y axis
  
  offsetZ - the maximum random offset on the Z axis
  
  extra - the extra data for this particle, depends on the particle used (normally speed)
- spawnParticle
  
  void spawnParticle(@NotNull @NotNull Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, double extra)
  
  Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
  
  Parameters:
  
  particle - the particle to spawn
  
  x - the position on the x axis to spawn at
  
  y - the position on the y axis to spawn at
  
  z - the position on the z axis to spawn at
  
  count - the number of particles
  
  offsetX - the maximum random offset on the X axis
  
  offsetY - the maximum random offset on the Y axis
  
  offsetZ - the maximum random offset on the Z axis
  
  extra - the extra data for this particle, depends on the particle used (normally speed)
- spawnParticle
  
  <T> void spawnParticle(@NotNull @NotNull Particle particle, @NotNull @NotNull Location location, int count, double offsetX, double offsetY, double offsetZ, double extra, @Nullable T data)
  
  Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
  
  Type Parameters:
  
  T - type of particle data (see Particle.getDataType()
  
  Parameters:
  
  particle - the particle to spawn
  
  location - the location to spawn at
  
  count - the number of particles
  
  offsetX - the maximum random offset on the X axis
  
  offsetY - the maximum random offset on the Y axis
  
  offsetZ - the maximum random offset on the Z axis
  
  extra - the extra data for this particle, depends on the particle used (normally speed)
  
  data - the data to use for the particle or null, the type of this depends on Particle.getDataType()
- spawnParticle
  
  default <T> void spawnParticle(@NotNull @NotNull Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, double extra, @Nullable T data)
  
  Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
  
  Type Parameters:
  
  T - type of particle data (see Particle.getDataType()
  
  Parameters:
  
  particle - the particle to spawn
  
  x - the position on the x axis to spawn at
  
  y - the position on the y axis to spawn at
  
  z - the position on the z axis to spawn at
  
  count - the number of particles
  
  offsetX - the maximum random offset on the X axis
  
  offsetY - the maximum random offset on the Y axis
  
  offsetZ - the maximum random offset on the Z axis
  
  extra - the extra data for this particle, depends on the particle used (normally speed)
  
  data - the data to use for the particle or null, the type of this depends on Particle.getDataType()
- spawnParticle
  
  default <T> void spawnParticle(@NotNull @NotNull Particle particle, @Nullable @Nullable List<Player> receivers, @NotNull @NotNull Player source, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, double extra, @Nullable T data)
  
  Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
  
  Type Parameters:
  
  T - Type
  
  Parameters:
  
  particle - the particle to spawn
  
  receivers - List of players to receive the particles, or null for all in world
  
  source - Source of the particles to be used in visibility checks, or null if no player source
  
  x - the position on the x axis to spawn at
  
  y - the position on the y axis to spawn at
  
  z - the position on the z axis to spawn at
  
  count - the number of particles
  
  offsetX - the maximum random offset on the X axis
  
  offsetY - the maximum random offset on the Y axis
  
  offsetZ - the maximum random offset on the Z axis
  
  extra - the extra data for this particle, depends on the particle used (normally speed)
  
  data - the data to use for the particle or null, the type of this depends on Particle.getDataType()
- spawnParticle
  
  <T> void spawnParticle(@NotNull @NotNull Particle particle, @Nullable @Nullable List<Player> receivers, @Nullable @Nullable Player source, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, double extra, @Nullable T data, boolean force)
  
  Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
  
  Type Parameters:
  
  T - Type
  
  Parameters:
  
  particle - the particle to spawn
  
  receivers - List of players to receive the particles, or null for all in world
  
  source - Source of the particles to be used in visibility checks, or null if no player source
  
  x - the position on the x axis to spawn at
  
  y - the position on the y axis to spawn at
  
  z - the position on the z axis to spawn at
  
  count - the number of particles
  
  offsetX - the maximum random offset on the X axis
  
  offsetY - the maximum random offset on the Y axis
  
  offsetZ - the maximum random offset on the Z axis
  
  extra - the extra data for this particle, depends on the particle used (normally speed)
  
  data - the data to use for the particle or null, the type of this depends on Particle.getDataType()
  
  force - allows the particle to be seen further away from the player and shows to players using any vanilla client particle settings
- spawnParticle
  
  <T> void spawnParticle(@NotNull @NotNull Particle particle, @NotNull @NotNull Location location, int count, double offsetX, double offsetY, double offsetZ, double extra, @Nullable T data, boolean force)
  
  Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
  
  Type Parameters:
  
  T - type of particle data (see Particle.getDataType()
  
  Parameters:
  
  particle - the particle to spawn
  
  location - the location to spawn at
  
  count - the number of particles
  
  offsetX - the maximum random offset on the X axis
  
  offsetY - the maximum random offset on the Y axis
  
  offsetZ - the maximum random offset on the Z axis
  
  extra - the extra data for this particle, depends on the particle used (normally speed)
  
  data - the data to use for the particle or null, the type of this depends on Particle.getDataType()
  
  force - whether to send the particle to players within an extended range and encourage their client to render it regardless of settings
- spawnParticle
  
  <T> void spawnParticle(@NotNull @NotNull Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, double extra, @Nullable T data, boolean force)
  
  Spawns the particle (the number of times specified by count) at the target location. The position of each particle will be randomized positively and negatively by the offset parameters on each axis.
  
  Type Parameters:
  
  T - type of particle data (see Particle.getDataType()
  
  Parameters:
  
  particle - the particle to spawn
  
  x - the position on the x axis to spawn at
  
  y - the position on the y axis to spawn at
  
  z - the position on the z axis to spawn at
  
  count - the number of particles
  
  offsetX - the maximum random offset on the X axis
  
  offsetY - the maximum random offset on the Y axis
  
  offsetZ - the maximum random offset on the Z axis
  
  extra - the extra data for this particle, depends on the particle used (normally speed)
  
  data - the data to use for the particle or null, the type of this depends on Particle.getDataType()
  
  force - whether to send the particle to players within an extended range and encourage their client to render it regardless of settings
- locateNearestStructure
  
  @Nullable @Nullable Location locateNearestStructure(@NotNull @NotNull Location origin, @NotNull @NotNull StructureType structureType, int radius, boolean findUnexplored)
  
  Find the closest nearby structure of a given StructureType. Finding unexplored structures can, and will, block if the world is looking in chunks that gave not generated yet. This can lead to the world temporarily freezing while locating an unexplored structure.
  The radius is not a rigid square radius. Each structure may alter how many chunks to check for each iteration. Do not assume that only a radius x radius chunk area will be checked. For example, StructureType.WOODLAND_MANSION can potentially check up to 20,000 blocks away (or more) regardless of the radius used.
  This will not load or generate chunks. This can also lead to instances where the server can hang if you are only looking for unexplored structures. This is because it will keep looking further and further out in order to find the structure.
  
  Parameters:
  
  origin - where to start looking for a structure
  
  structureType - the type of structure to find
  
  radius - the radius, in chunks, around which to search
  
  findUnexplored - true to only find unexplored structures
  
  Returns:
  
  the closest Location, or null if no structure of the specified type exists.
- locateNearestBiome
  
  @Nullable @Nullable Location locateNearestBiome(@NotNull @NotNull Location origin, @NotNull @NotNull Biome biome, int radius)
  
  Locates the nearest biome based on an origin, biome type, and radius to search. Step defaults to 8.
  
  Parameters:
  
  origin - Origin location
  
  biome - Biome to find
  
  radius - radius to search
  
  Returns:
  
  Location of biome or null if not found in specified radius
- locateNearestBiome
  
  @Nullable @Nullable Location locateNearestBiome(@NotNull @NotNull Location origin, @NotNull @NotNull Biome biome, int radius, int step)
  
  Locates the nearest biome based on an origin, biome type, and radius to search and step
  
  Parameters:
  
  origin - Origin location
  
  biome - Biome to find
  
  radius - radius to search
  
  step - Search step 1 would mean checking every block, 8 would be every 8th block
  
  Returns:
  
  Location of biome or null if not found in specified radius
- isUltrawarm
  
  boolean isUltrawarm()
  Checks if the world:
  
  evaporates water
  
  dries sponges
  
  has lava spread faster and further
  Returns:
  
  true if ultrawarm, false if not
- isNatural
  
  boolean isNatural()
  
  Checks if the world is natural.
  If false, compasses will spin randomly in the world. If true, nether portals will spawn zombified piglins.
  
  Returns:
  
  true or false
- getCoordinateScale
  
  double getCoordinateScale()
  
  Gets the coordinate scaling of this world.
  
  Returns:
  
  the coordinate scale
- hasSkylight
  
  boolean hasSkylight()
  
  Checks if the world has skylight access
  
  Returns:
  
  whether there is skylight
- hasBedrockCeiling
  
  boolean hasBedrockCeiling()
  
  Checks if the world has a bedrock ceiling
  
  Returns:
  
  whether the world has a bedrock ceiling
- isPiglinSafe
  
  boolean isPiglinSafe()
  
  Checks if piglins will turn into Zombified Piglins in this world
  
  Returns:
  
  whether Piglins will not transform
- doesBedWork
  
  boolean doesBedWork()
  
  Checks if beds work
  
  Returns:
  
  whether beds work
- doesRespawnAnchorWork
  
  boolean doesRespawnAnchorWork()
  
  Checks if respawn anchors work
  
  Returns:
  
  whether respawn anchors work
- hasRaids
  
  boolean hasRaids()
  
  Checks if this world supports raids
  
  Returns:
  
  whether this world supports raids
- isFixedTime
  
  boolean isFixedTime()
  
  Checks if this world has a fixed time
  
  Returns:
  
  whether this world has fixed time
- getInfiniburn
  
  @NotNull @NotNull Collection<Material> getInfiniburn()
  
  Gets the collection of materials that burn infinitely in this world.
  
  Returns:
  
  the materials that will forever stay lit by fire
- getViewDistance
  
  int getViewDistance()
  
  Returns the view distance used for this world.
  
  Returns:
  
  the view distance used for this world
- setViewDistance
  
  void setViewDistance(int viewDistance)
  
  Sets the view distance for this world.
  
  Parameters:
  
  viewDistance - view distance in [2, 32]
- getNoTickViewDistance
  
  int getNoTickViewDistance()
  
  Returns the no-tick view distance for this world.
  No-tick view distance is the view distance where chunks will load, however the chunks and their entities will not be set to tick.
  
  Returns:
  
  The no-tick view distance for this world.
- setNoTickViewDistance
  
  void setNoTickViewDistance(int viewDistance)
  
  Sets the no-tick view distance for this world.
  No-tick view distance is the view distance where chunks will load, however the chunks and their entities will not be set to tick.
  
  Parameters:
  
  viewDistance - view distance in [2, 32]
- spigot
  
  @NotNull @NotNull World.Spigot spigot()
- locateNearestRaid
  
  @Nullable @Nullable Raid locateNearestRaid(@NotNull @NotNull Location location, int radius)
  
  Finds the nearest raid close to the given location.
  
  Parameters:
  
  location - the origin location
  
  radius - the radius
  
  Returns:
  
  the closest Raid, or null if no raids were found
- getRaids
  
  @NotNull @NotNull List<Raid> getRaids()
  
  Gets all raids that are going on over this world.
  
  Returns:
  
  the list of all active raids
- getEnderDragonBattle
  
  @Nullable @Nullable DragonBattle getEnderDragonBattle()
  
  Get the DragonBattle associated with this world. If this world's environment is not World.Environment.THE_END, null will be returned.
  If an end world, a dragon battle instance will be returned regardless of whether or not a dragon is present in the world or a fight sequence has been activated. The dragon battle instance acts as a state holder.
  
  Returns:
  
  the dragon battle instance

Interface World

Nested Class Summary

Nested classes/interfaces inherited from interface net.kyori.adventure.audience.ForwardingAudience

Method Summary

Methods inherited from interface net.kyori.adventure.audience.Audience

Methods inherited from interface net.kyori.adventure.audience.ForwardingAudience

Methods inherited from interface org.bukkit.metadata.Metadatable

Methods inherited from interface org.bukkit.plugin.messaging.PluginMessageRecipient

Methods inherited from interface net.kyori.adventure.pointer.Pointered

Method Details

getEntityCount

getTileEntityCount

getTickableTileEntityCount

getChunkCount

getPlayerCount

getMoonPhase

lineOfSightExists

getBlockAt

getBlockAt

getBlockAtKey

getLocationAtKey

getHighestBlockYAt

getHighestBlockYAt

getHighestBlockAt

getHighestBlockAt

getHighestBlockYAt

getHighestBlockYAt

getHighestBlockAt

getHighestBlockAt

getHighestBlockYAt

getHighestBlockYAt

getHighestBlockAt

getHighestBlockAt

getChunkAt

getChunkAt

getChunkAt

getChunkAt

isChunkGenerated

isChunkLoaded

getLoadedChunks

loadChunk

isChunkLoaded

isChunkGenerated

isChunkInUse

loadChunk

loadChunk

unloadChunk

unloadChunk

unloadChunk

unloadChunkRequest

regenerateChunk

refreshChunk

isChunkForceLoaded

setChunkForceLoaded

getForceLoadedChunks

addPluginChunkTicket

removePluginChunkTicket

removePluginChunkTickets

getPluginChunkTickets

getPluginChunkTickets

dropItem

dropItem

dropItemNaturally

dropItemNaturally

spawnArrow

spawnArrow

generateTree

generateTree

spawnEntity

strikeLightning

strikeLightningEffect

getEntities

getLivingEntities

getEntitiesByClass

getEntitiesByClass

getEntitiesByClasses

getNearbyLivingEntities

getNearbyLivingEntities

getNearbyLivingEntities

getNearbyLivingEntities