org.spongepowered.api.world.gen

Interface WorldGeneratorModifier

All Superinterfaces:

CatalogType

All Known Implementing Classes:

SkylandsWorldGeneratorModifier, VoidWorldGeneratorModifier

@CatalogedBy(value=WorldGeneratorModifiers.class)
public interface WorldGeneratorModifier
extends CatalogType

Custom world generation is done using this interface. Any plugin that wishes to modify the world generator should implement this interface. When the server admin/player has chosen to use this modifier for a world, the method modifyWorldGenerator(WorldProperties, DataContainer, WorldGenerator) will be called.

The modifier can change every aspect of terrain generation using the WorldGenerator provided as a parameter to modifyWorldGenerator. This is no requirement, you can for example replace only the biome generator. Multiple world generator modifiers can be applied on a single world.

Implementations of this interface must be registered using the GameRegistry.

Method Summary

Modifier and Type	Method and Description
void	modifyWorldGenerator(WorldProperties world, DataContainer settings, WorldGenerator worldGenerator) Modifies the given world generator.

Methods inherited from interface org.spongepowered.api.CatalogType

getId, getName

Method Detail

modifyWorldGenerator

void modifyWorldGenerator(WorldProperties world,
                          DataContainer settings,
                          WorldGenerator worldGenerator)

Modifies the given world generator. This method is called by the implementation when the server is set to use this plugin for world generation.

To replace the base chunk generator, replace the main generator populator using WorldGenerator.setBaseGenerationPopulator(GenerationPopulator). To replace the biome generator, use WorldGenerator.setBiomeGenerator(BiomeGenerator). To change terrain population, modify the populator list returned by WorldGenerator.getPopulators() or WorldGenerator.getGenerationPopulators().

Parameters:

world - The properties of the world.

settings - A data container with (usually) user-provided settings, can be used by the plugin to modify the world generator.

worldGenerator - The world generator, should be modified.

See Also:

Additional information on the generation process