Class ChunkGenerator
generateNoise(WorldInfo, Random, int, int, ChunkData)
generateSurface(WorldInfo, Random, int, int, ChunkData)
generateBedrock(WorldInfo, Random, int, int, ChunkData)
generateCaves(WorldInfo, Random, int, int, ChunkData)
getBaseHeight(WorldInfo, Random, int, int, HeightMap)
must be completely thread safe and able to handle multiple concurrent
callers.
Some aspects of world generation can be delegated to the Vanilla generator.
The following methods can be overridden to enable this:
shouldGenerateNoise()
orshouldGenerateNoise(WorldInfo, Random, int, int)
shouldGenerateSurface()
orshouldGenerateSurface(WorldInfo, Random, int, int)
shouldGenerateCaves()
orshouldGenerateCaves(WorldInfo, Random, int, int)
shouldGenerateDecorations()
orshouldGenerateDecorations(WorldInfo, Random, int, int)
shouldGenerateMobs()
orshouldGenerateMobs(WorldInfo, Random, int, int)
shouldGenerateStructures()
orshouldGenerateStructures(WorldInfo, Random, int, int)
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Deprecated.static interface
Data for a Chunk. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Tests if the specified location is valid for a natural spawn positionprotected final @NotNull ChunkGenerator.ChunkData
createChunkData
(@NotNull World world) Deprecated.ChunkGenerator.ChunkData
are now directly providedvoid
generateBedrock
(@NotNull WorldInfo worldInfo, @NotNull Random random, int chunkX, int chunkZ, @NotNull ChunkGenerator.ChunkData chunkData) Shapes the Chunk bedrock layer for the given coordinates.void
generateCaves
(@NotNull WorldInfo worldInfo, @NotNull Random random, int chunkX, int chunkZ, @NotNull ChunkGenerator.ChunkData chunkData) Shapes the Chunk caves for the given coordinates.generateChunkData
(@NotNull World world, @NotNull Random random, int x, int z, @NotNull ChunkGenerator.BiomeGrid biome) Deprecated.The generation is now split up and the new methods should be used, seeChunkGenerator
void
generateNoise
(@NotNull WorldInfo worldInfo, @NotNull Random random, int chunkX, int chunkZ, @NotNull ChunkGenerator.ChunkData chunkData) Shapes the Chunk noise for the given coordinates.void
generateSurface
(@NotNull WorldInfo worldInfo, @NotNull Random random, int chunkX, int chunkZ, @NotNull ChunkGenerator.ChunkData chunkData) Shapes the Chunk surface for the given coordinates.int
getBaseHeight
(@NotNull WorldInfo worldInfo, @NotNull Random random, int x, int z, @NotNull HeightMap heightMap) This method is similar toWorld.getHighestBlockAt(int, int, HeightMap)
.getDefaultBiomeProvider
(@NotNull WorldInfo worldInfo) Gets called when noBiomeProvider
is set inWorldCreator
or via the server configuration files.getDefaultPopulators
(@NotNull World world) Gets a list of defaultBlockPopulator
s to apply to a given worldgetFixedSpawnLocation
(@NotNull World world, @NotNull Random random) Gets a fixed spawn location to use for a given world.boolean
Deprecated.the chunk generation code should be thread safeboolean
Deprecated.has no effect, bedrock generation is part of the surface step, seeshouldGenerateSurface()
boolean
Gets if the server should generate Vanilla caves.boolean
shouldGenerateCaves
(@NotNull WorldInfo worldInfo, @NotNull Random random, int chunkX, int chunkZ) Gets if the server should generate Vanilla caves.boolean
Gets if the server should generate Vanilla decorations after this ChunkGenerator.boolean
shouldGenerateDecorations
(@NotNull WorldInfo worldInfo, @NotNull Random random, int chunkX, int chunkZ) Gets if the server should generate Vanilla decorations after this ChunkGenerator.boolean
Gets if the server should generate Vanilla mobs after this ChunkGenerator.boolean
shouldGenerateMobs
(@NotNull WorldInfo worldInfo, @NotNull Random random, int chunkX, int chunkZ) Gets if the server should generate Vanilla mobs after this ChunkGenerator.boolean
Gets if the server should generate Vanilla noise.boolean
shouldGenerateNoise
(@NotNull WorldInfo worldInfo, @NotNull Random random, int chunkX, int chunkZ) Gets if the server should generate Vanilla noise.boolean
Gets if the server should generate Vanilla structures after this ChunkGenerator.boolean
shouldGenerateStructures
(@NotNull WorldInfo worldInfo, @NotNull Random random, int chunkX, int chunkZ) Gets if the server should generate Vanilla structures after this ChunkGenerator.boolean
Gets if the server should generate Vanilla surface.boolean
shouldGenerateSurface
(@NotNull WorldInfo worldInfo, @NotNull Random random, int chunkX, int chunkZ) Gets if the server should generate Vanilla surface.
-
Constructor Details
-
ChunkGenerator
public ChunkGenerator()
-
-
Method Details
-
generateNoise
public void generateNoise(@NotNull @NotNull WorldInfo worldInfo, @NotNull @NotNull Random random, int chunkX, int chunkZ, @NotNull @NotNull ChunkGenerator.ChunkData chunkData) Shapes the Chunk noise for the given coordinates.Notes:
This method should never attempt to get the Chunk at the passed coordinates, as doing so may cause an infinite loop.
This method should never modify the
ChunkGenerator.ChunkData
at a later point of time.The Y-coordinate range should never be hardcoded, to get the Y-coordinate range use the methods
ChunkGenerator.ChunkData.getMinHeight()
andChunkGenerator.ChunkData.getMaxHeight()
.If
shouldGenerateNoise()
is set to true, the givenChunkGenerator.ChunkData
contains already the Vanilla noise generation.- Parameters:
worldInfo
- The world info of the world this chunk will be used forrandom
- The random generator to usechunkX
- The X-coordinate of the chunkchunkZ
- The Z-coordinate of the chunkchunkData
- To modify
-
generateSurface
public void generateSurface(@NotNull @NotNull WorldInfo worldInfo, @NotNull @NotNull Random random, int chunkX, int chunkZ, @NotNull @NotNull ChunkGenerator.ChunkData chunkData) Shapes the Chunk surface for the given coordinates.Notes:
This method should never attempt to get the Chunk at the passed coordinates, as doing so may cause an infinite loop.
This method should never modify the
ChunkGenerator.ChunkData
at a later point of time.The Y-coordinate range should never be hardcoded, to get the Y-coordinate range use the methods
ChunkGenerator.ChunkData.getMinHeight()
andChunkGenerator.ChunkData.getMaxHeight()
.If
shouldGenerateSurface()
is set to true, the givenChunkGenerator.ChunkData
contains already the Vanilla surface generation.- Parameters:
worldInfo
- The world info of the world this chunk will be used forrandom
- The random generator to usechunkX
- The X-coordinate of the chunkchunkZ
- The Z-coordinate of the chunkchunkData
- To modify
-
generateBedrock
public void generateBedrock(@NotNull @NotNull WorldInfo worldInfo, @NotNull @NotNull Random random, int chunkX, int chunkZ, @NotNull @NotNull ChunkGenerator.ChunkData chunkData) Shapes the Chunk bedrock layer for the given coordinates.Notes:
This method should never attempt to get the Chunk at the passed coordinates, as doing so may cause an infinite loop.
This method should never modify the
ChunkGenerator.ChunkData
at a later point of time.The Y-coordinate range should never be hardcoded, to get the Y-coordinate range use the methods
ChunkGenerator.ChunkData.getMinHeight()
andChunkGenerator.ChunkData.getMaxHeight()
.- Parameters:
worldInfo
- The world info of the world this chunk will be used forrandom
- The random generator to usechunkX
- The X-coordinate of the chunkchunkZ
- The Z-coordinate of the chunkchunkData
- To modify
-
generateCaves
public void generateCaves(@NotNull @NotNull WorldInfo worldInfo, @NotNull @NotNull Random random, int chunkX, int chunkZ, @NotNull @NotNull ChunkGenerator.ChunkData chunkData) Shapes the Chunk caves for the given coordinates.Notes:
This method should never attempt to get the Chunk at the passed coordinates, as doing so may cause an infinite loop.
This method should never modify the
ChunkGenerator.ChunkData
at a later point of time.The Y-coordinate range should never be hardcoded, to get the Y-coordinate range use the methods
ChunkGenerator.ChunkData.getMinHeight()
andChunkGenerator.ChunkData.getMaxHeight()
.If
shouldGenerateCaves()
is set to true, the givenChunkGenerator.ChunkData
contains already the Vanilla cave generation.- Parameters:
worldInfo
- The world info of the world this chunk will be used forrandom
- The random generator to usechunkX
- The X-coordinate of the chunkchunkZ
- The Z-coordinate of the chunkchunkData
- To modify
-
getDefaultBiomeProvider
@Nullable public @Nullable BiomeProvider getDefaultBiomeProvider(@NotNull @NotNull WorldInfo worldInfo) Gets called when noBiomeProvider
is set inWorldCreator
or via the server configuration files. It is therefore possible that one plugin can provide the Biomes and another one the generation.Notes:
If
null
is returned, than Vanilla biomes are used.This method only gets called once when the world is loaded. Returning another
BiomeProvider
later one is not respected.- Parameters:
worldInfo
- The world info of the world the biome provider will be used for- Returns:
- BiomeProvider to use to fill the biomes of a chunk
-
getBaseHeight
public int getBaseHeight(@NotNull @NotNull WorldInfo worldInfo, @NotNull @NotNull Random random, int x, int z, @NotNull @NotNull HeightMap heightMap) This method is similar toWorld.getHighestBlockAt(int, int, HeightMap)
. With the difference being, that the highest y coordinate should be the block before any surface, bedrock, caves or decoration is applied. Or in other words the highest block when only the noise is present at the chunk.Notes:
When this method is not overridden, the Vanilla base height is used.
This method should never attempt to get the Chunk at the passed coordinates, or use the method
World.getHighestBlockAt(int, int, HeightMap)
, as doing so may cause an infinite loop.- Parameters:
worldInfo
- The world info of the world this chunk will be used forrandom
- The random generator to usex
- The X-coordinate from world originz
- The Z-coordinate from world originheightMap
- From the highest block should be get- Returns:
- The y coordinate of the highest block at the given location
-
generateChunkData
@NotNull @Deprecated public @NotNull ChunkGenerator.ChunkData generateChunkData(@NotNull @NotNull World world, @NotNull @NotNull Random random, int x, int z, @NotNull @NotNull ChunkGenerator.BiomeGrid biome) Deprecated.The generation is now split up and the new methods should be used, seeChunkGenerator
Shapes the chunk for the given coordinates. This method must return a ChunkData.Notes:
This method should never attempt to get the Chunk at the passed coordinates, as doing so may cause an infinite loop
This method should never modify a ChunkData after it has been returned.
This method must return a ChunkData returned by
createChunkData(org.bukkit.World)
- Parameters:
world
- The world this chunk will be used forrandom
- The random generator to usex
- The X-coordinate of the chunkz
- The Z-coordinate of the chunkbiome
- Proposed biome values for chunk - can be updated by generator- Returns:
- ChunkData containing the types for each block created by this generator
-
createChunkData
@NotNull @Deprecated protected final @NotNull ChunkGenerator.ChunkData createChunkData(@NotNull @NotNull World world) Deprecated.ChunkGenerator.ChunkData
are now directly providedCreate a ChunkData for a world.- Parameters:
world
- the world the ChunkData is for- Returns:
- a new ChunkData for world
-
canSpawn
Tests if the specified location is valid for a natural spawn position- Parameters:
world
- The world we're testing onx
- X-coordinate of the block to testz
- Z-coordinate of the block to test- Returns:
- true if the location is valid, otherwise false
-
getDefaultPopulators
Gets a list of defaultBlockPopulator
s to apply to a given world- Parameters:
world
- World to apply to- Returns:
- List containing any amount of BlockPopulators
-
getFixedSpawnLocation
@Nullable public @Nullable Location getFixedSpawnLocation(@NotNull @NotNull World world, @NotNull @NotNull Random random) Gets a fixed spawn location to use for a given world.A null value is returned if a world should not use a fixed spawn point, and will instead attempt to find one randomly.
- Parameters:
world
- The world to locate a spawn point forrandom
- Random generator to use in the calculation- Returns:
- Location containing a new spawn point, otherwise null
-
isParallelCapable
Deprecated.the chunk generation code should be thread safeGets if this ChunkGenerator is parallel capable. SeeChunkGenerator
for more information.- Returns:
- parallel capable status
-
shouldGenerateNoise
public boolean shouldGenerateNoise()Gets if the server should generate Vanilla noise.The Vanilla noise is generated before
generateNoise(WorldInfo, Random, int, int, ChunkData)
is called.This is method is not called (and has therefore no effect), if
shouldGenerateNoise(WorldInfo, Random, int, int)
is overridden.- Returns:
- true if the server should generate Vanilla noise
- See Also:
-
shouldGenerateNoise
public boolean shouldGenerateNoise(@NotNull @NotNull WorldInfo worldInfo, @NotNull @NotNull Random random, int chunkX, int chunkZ) Gets if the server should generate Vanilla noise.The Vanilla noise is generated before
generateNoise(WorldInfo, Random, int, int, ChunkData)
is called.Only this method is called if both this and
shouldGenerateNoise()
are overridden.- Parameters:
worldInfo
- The world info of the world this chunk will be used forrandom
- The random generator to usechunkX
- The X-coordinate of the chunkchunkZ
- The Z-coordinate of the chunk- Returns:
- true if the server should generate Vanilla noise
- See Also:
-
shouldGenerateSurface
public boolean shouldGenerateSurface()Gets if the server should generate Vanilla surface.The Vanilla surface is generated before
generateSurface(WorldInfo, Random, int, int, ChunkData)
is called.This is method is not called (and has therefore no effect), if
shouldGenerateSurface(WorldInfo, Random, int, int)
is overridden.- Returns:
- true if the server should generate Vanilla surface
- See Also:
-
shouldGenerateSurface
public boolean shouldGenerateSurface(@NotNull @NotNull WorldInfo worldInfo, @NotNull @NotNull Random random, int chunkX, int chunkZ) Gets if the server should generate Vanilla surface.The Vanilla surface is generated before
generateSurface(WorldInfo, Random, int, int, ChunkData)
is called.Only this method is called if both this and
shouldGenerateSurface()
are overridden.- Parameters:
worldInfo
- The world info of the world this chunk will be used forrandom
- The random generator to usechunkX
- The X-coordinate of the chunkchunkZ
- The Z-coordinate of the chunk- Returns:
- true if the server should generate Vanilla surface
- See Also:
-
shouldGenerateBedrock
Deprecated.has no effect, bedrock generation is part of the surface step, seeshouldGenerateSurface()
Gets if the server should generate Vanilla bedrock.The Vanilla bedrock is generated before
generateBedrock(WorldInfo, Random, int, int, ChunkData)
is called.- Returns:
- true if the server should generate Vanilla bedrock
-
shouldGenerateCaves
public boolean shouldGenerateCaves()Gets if the server should generate Vanilla caves.The Vanilla caves are generated before
generateCaves(WorldInfo, Random, int, int, ChunkData)
is called.This is method is not called (and has therefore no effect), if
shouldGenerateCaves(WorldInfo, Random, int, int)
is overridden.- Returns:
- true if the server should generate Vanilla caves
- See Also:
-
shouldGenerateCaves
public boolean shouldGenerateCaves(@NotNull @NotNull WorldInfo worldInfo, @NotNull @NotNull Random random, int chunkX, int chunkZ) Gets if the server should generate Vanilla caves.The Vanilla caves are generated before
generateCaves(WorldInfo, Random, int, int, ChunkData)
is called.Only this method is called if both this and
shouldGenerateCaves()
are overridden.- Parameters:
worldInfo
- The world info of the world this chunk will be used forrandom
- The random generator to usechunkX
- The X-coordinate of the chunkchunkZ
- The Z-coordinate of the chunk- Returns:
- true if the server should generate Vanilla caves
- See Also:
-
shouldGenerateDecorations
public boolean shouldGenerateDecorations()Gets if the server should generate Vanilla decorations after this ChunkGenerator.The Vanilla decoration are generated before any
BlockPopulator
are called.This is method is not called (and has therefore no effect), if
shouldGenerateDecorations(WorldInfo, Random, int, int)
is overridden.- Returns:
- true if the server should generate Vanilla decorations
- See Also:
-
shouldGenerateDecorations
public boolean shouldGenerateDecorations(@NotNull @NotNull WorldInfo worldInfo, @NotNull @NotNull Random random, int chunkX, int chunkZ) Gets if the server should generate Vanilla decorations after this ChunkGenerator.The Vanilla decoration are generated before any
BlockPopulator
are called.Only this method is called if both this and
shouldGenerateDecorations()
are overridden.- Parameters:
worldInfo
- The world info of the world this chunk will be used forrandom
- The random generator to usechunkX
- The X-coordinate of the chunkchunkZ
- The Z-coordinate of the chunk- Returns:
- true if the server should generate Vanilla decorations
- See Also:
-
shouldGenerateMobs
public boolean shouldGenerateMobs()Gets if the server should generate Vanilla mobs after this ChunkGenerator.This is method is not called (and has therefore no effect), if
shouldGenerateMobs(WorldInfo, Random, int, int)
is overridden.- Returns:
- true if the server should generate Vanilla mobs
- See Also:
-
shouldGenerateMobs
public boolean shouldGenerateMobs(@NotNull @NotNull WorldInfo worldInfo, @NotNull @NotNull Random random, int chunkX, int chunkZ) Gets if the server should generate Vanilla mobs after this ChunkGenerator.Only this method is called if both this and
shouldGenerateMobs()
are overridden.- Parameters:
worldInfo
- The world info of the world this chunk will be used forrandom
- The random generator to usechunkX
- The X-coordinate of the chunkchunkZ
- The Z-coordinate of the chunk- Returns:
- true if the server should generate Vanilla mobs
- See Also:
-
shouldGenerateStructures
public boolean shouldGenerateStructures()Gets if the server should generate Vanilla structures after this ChunkGenerator.This is method is not called (and has therefore no effect), if
shouldGenerateStructures(WorldInfo, Random, int, int)
is overridden.- Returns:
- true if the server should generate Vanilla structures
- See Also:
-
shouldGenerateStructures
public boolean shouldGenerateStructures(@NotNull @NotNull WorldInfo worldInfo, @NotNull @NotNull Random random, int chunkX, int chunkZ) Gets if the server should generate Vanilla structures after this ChunkGenerator.Only this method is called if both this and
shouldGenerateStructures()
are overridden.- Parameters:
worldInfo
- The world info of the world this chunk will be used forrandom
- The random generator to usechunkX
- The X-coordinate of the chunkchunkZ
- The Z-coordinate of the chunk- Returns:
- true if the server should generate Vanilla structures
- See Also:
-
BiomeProvider