org.spongepowered.api.world.biome

Interface BiomeGenerationSettings

public interface BiomeGenerationSettings

A representation of the biome-specific generation settings.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	BiomeGenerationSettings.Builder A builder for BiomeGenerationSettingss.

Method Summary

Modifier and Type	Method and Description
static BiomeGenerationSettings.Builder	builder() Gets a new builder for creating new BiomeGenerationSettings.
BiomeGenerationSettings	copy() Returns a new biome generation settings which is a copy of this set of generation settings at this point in time.
List<GenerationPopulator>	getGenerationPopulators() Gets a mutable list of GenerationPopulators.
List<GenerationPopulator>	getGenerationPopulators(Class<? extends GenerationPopulator> type) Gets an immutable list of GenerationPopulators matching the given class type.
List<GroundCoverLayer>	getGroundCoverLayers() Gets a mutable ordered list of GroundCoverLayers.
float	getMaxHeight() Gets the maximum terrain height of this biome.
float	getMinHeight() Gets the minimum terrain height of this biome.
List<Populator>	getPopulators() Returns a mutable list of Populators specific to this biome.
<T extends Populator> List<T>	getPopulators(Class<T> type) Returns an immutable list of Populators specific to this biome which match the given class type.
void	setMaxHeight(float height) Sets the maximum terrain height of this biome.
void	setMinHeight(float height) Sets the minimum terrain height of this biome.

Method Detail

builder

static BiomeGenerationSettings.Builder builder()

Gets a new builder for creating new BiomeGenerationSettings.

Returns:

The builder

getMinHeight

float getMinHeight()

Gets the minimum terrain height of this biome.

Returns:

The min height

setMinHeight

void setMinHeight(float height)

Sets the minimum terrain height of this biome.

Parameters:

height - The new min height

getMaxHeight

float getMaxHeight()

Gets the maximum terrain height of this biome.

Returns:

The max height

setMaxHeight

void setMaxHeight(float height)

Sets the maximum terrain height of this biome.

Parameters:

height - The new max height

getGroundCoverLayers

List<GroundCoverLayer> getGroundCoverLayers()

Gets a mutable ordered list of GroundCoverLayers. These layers will be applied to the base terrain during the generation phase starting at the topmost stone block in each column.

Returns:

The ground cover layers

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 ground cover layers are applied. These generation populators are typically used to generate large terrain features, like caves and ravines.

Returns:

The generation populators

getGenerationPopulators

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

Gets an immutable list of GenerationPopulators matching the given class type.

Parameters:

type - the generation populator type to return

Returns:

The generation populators

getPopulators

List<Populator> getPopulators()

Returns a mutable list of Populators specific to this biome. Changing this list will affect population of all new chunks.

Returns:

The populators

getPopulators

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

Returns an immutable list of Populators specific to this biome which match the given class type.

Type Parameters:

T - The populator type

Parameters:

type - the populator type to return

Returns:

The populators

copy

BiomeGenerationSettings copy()

Returns a new biome generation settings which is a copy of this set of generation settings at this point in time.

Returns:

The copy of these settings