org.spongepowered.api.world.gen

Interface WorldGenerator

public interface WorldGenerator

Represents the world generator of a world. This interface contains all settings for the world generator, like which populators are in use, but also the world seed.

The generation process for chunks is divided into two phases, generation and population. The generation phase is in charge of creating the base terrain shape and generating large terrain features. All operations during the generation phase act upon a MutableBlockVolume rather than a live chunk object.

Conversely the population phase operates against a live chunk object and has the guarantee that all immediately surrounding chunks have at least passed the generation phase. The population phase is typically used for the placement of small features and objects placed may cross chunk boundaries.

The generation phase:
1. Create a BlockBuffer representing the chunk's volume
2. Call the base GenerationPopulator from the WorldGenerator to create the base terrain shape.
3. Call each of the GenerationPopulators registered to the BiomeType (or from an override if found).
4. Call each of the GenerationPopulators registered to the WorldGenerator.
5. Build the final Chunk object from the contents of the BlockBuffer.

The population phase:
1. Validate surrounding chunks.
2. Using the biome at an arbitrary point within the chunk ({16, 0, 16} in the vanilla game), pass the chunk to each of the Populators registered to the chosen biome (or from an override if found).
3. Pass the chunk to each of the Populators registered to the WorldGenerator.

Method Summary

Modifier and Type	Method and Description
GenerationPopulator	getBaseGenerationPopulator() Gets the main GenerationPopulator.
BiomeGenerator	getBiomeGenerator() Gets the BiomeGenerator for this world generator.
BiomeGenerationSettings	getBiomeSettings(BiomeType type) Gets this world generator settings for the given BiomeType..
List<GenerationPopulator>	getGenerationPopulators() Gets a mutable list of GenerationPopulators.
List<GenerationPopulator>	getGenerationPopulators(Class<? extends GenerationPopulator> type) Gets an immutable list of GenerationPopulators which match the given class type.
List<Populator>	getPopulators() Gets a mutable list of Populators which are applied globally (in the whole world).
List<Populator>	getPopulators(Class<? extends Populator> type) Gets an immutable list of Populators which match the given class type.
void	setBaseGenerationPopulator(GenerationPopulator generator) Sets the GenerationPopulator.
void	setBiomeGenerator(BiomeGenerator biomeGenerator) Sets the BiomeGenerator for this world generator.

Method Detail

getBaseGenerationPopulator

GenerationPopulator getBaseGenerationPopulator()

Gets the main GenerationPopulator. This generator populator is responsible for generating the base terrain of the chunk.

Returns:

The GenerationPopulator.

See Also:

setBaseGenerationPopulator(GenerationPopulator)

setBaseGenerationPopulator

void setBaseGenerationPopulator(GenerationPopulator generator)

Sets the GenerationPopulator. This generator populator is responsible for generating the base terrain of the chunk.

Parameters:

generator - The generator.

getGenerationPopulators

List<GenerationPopulator> getGenerationPopulators()

Gets a mutable list of GenerationPopulators. These populators work strictly on a single chunk. They will be executed directly after the biome ground cover layers and the biome generator populators have been called. These generator populators are typically used to generate large terrain features, like caves and ravines.

This list does not include the base generator.

Returns:

The generator populators

getGenerationPopulators

List<GenerationPopulator> getGenerationPopulators(Class<? extends GenerationPopulator> type)

Gets an immutable list of GenerationPopulators which match the given class type.

Parameters:

type - The type to match

Returns:

The generation populator which match the type

getPopulators

List<Populator> getPopulators()

Gets a mutable list of Populators which are applied globally (in the whole world).

Returns:

The populators

See Also:

BiomeGenerationSettings.getPopulators()

getPopulators

List<Populator> getPopulators(Class<? extends Populator> type)

Gets an immutable list of Populators which match the given class type.

Parameters:

type - The type to match

Returns:

The populators which match the type

getBiomeGenerator

BiomeGenerator getBiomeGenerator()

Gets the BiomeGenerator for this world generator.

Returns:

The biome generator

setBiomeGenerator

void setBiomeGenerator(BiomeGenerator biomeGenerator)

Sets the BiomeGenerator for this world generator.

Parameters:

biomeGenerator - The new biome generator

getBiomeSettings

BiomeGenerationSettings getBiomeSettings(BiomeType type)

Gets this world generator settings for the given BiomeType..

Parameters:

type - The biome type

Returns:

The generation settings