org.spongepowered.api.extra.modifier.empty

Class VoidWorldGeneratorModifier

java.lang.Object

org.spongepowered.api.extra.modifier.empty.VoidWorldGeneratorModifier

All Implemented Interfaces:

CatalogType, WorldGeneratorModifier

public class VoidWorldGeneratorModifier
extends Object
implements WorldGeneratorModifier

A modifier that causes a World to generate with empty chunks. Useful for "lobby-like" worlds.

Constructor Summary

Constructors

Constructor and Description
VoidWorldGeneratorModifier()

Method Summary

Modifier and Type	Method and Description
String	getId() Gets the unique identifier of this CatalogType.
String	getName() Gets the human-readable name of this individual CatalogType.
void	modifyWorldGenerator(WorldProperties world, DataContainer settings, WorldGenerator worldGenerator) Modifies the given world generator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VoidWorldGeneratorModifier

public VoidWorldGeneratorModifier()

Method Detail

modifyWorldGenerator

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

Description copied from interface: WorldGeneratorModifier

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().

Specified by:

modifyWorldGenerator in interface WorldGeneratorModifier

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

getId

public String getId()

Description copied from interface: CatalogType

Gets the unique identifier of this CatalogType. The identifier is case insensitive, thus there cannot be another instance with a different character case. The id of this instance must remain the same for the entire duration of its existence. The identifier can be formatted however needed.

A typical id format follows the pattern of `modId:name` or `minecraft:name`. However the prefix may be omitted for default/vanilla minecraft types.

Specified by:

getId in interface CatalogType

Returns:

The unique identifier of this dummy type

getName

public String getName()

Description copied from interface: CatalogType

Gets the human-readable name of this individual CatalogType. This name is not guaranteed to be unique. This value should not be used for serialization.

Specified by:

getName in interface CatalogType

Returns:

The human-readable name of this dummy type