org.spongepowered.api.world.gen.populator

Interface IceSpike.Builder

All Superinterfaces:

ResettableBuilder<IceSpike,IceSpike.Builder>

Enclosing interface:

IceSpike

public static interface IceSpike.Builder
extends ResettableBuilder<IceSpike,IceSpike.Builder>

A builder for constructing IceSpike populators.

Method Summary

Modifier and Type	Method and Description
IceSpike	build() Builds a new instance of a IceSpike populator with the settings set within the builder.
default IceSpike.Builder	extremeSpikeIncrease(int increase) Sets the base height increase of the extreme spikes.
IceSpike.Builder	extremeSpikeIncrease(VariableAmount increase) Sets the base height increase of the extreme spikes.
IceSpike.Builder	extremeSpikeProbability(double p) Gets the probability of the spike much larger than normal.
default IceSpike.Builder	height(int height) Sets the base height of the spike.
IceSpike.Builder	height(VariableAmount height) Sets the base height of the spike.
default IceSpike.Builder	spikesPerChunk(int count) Sets the number of spikes to generate per chunk.
IceSpike.Builder	spikesPerChunk(VariableAmount count) Sets the number of spikes to generate per chunk.

Methods inherited from interface org.spongepowered.api.util.ResettableBuilder

from, reset

Method Detail

spikesPerChunk

IceSpike.Builder spikesPerChunk(VariableAmount count)

Sets the number of spikes to generate per chunk.

Parameters:

count - The new number of spikes

Returns:

This builder, for chaining

spikesPerChunk

default IceSpike.Builder spikesPerChunk(int count)

Sets the number of spikes to generate per chunk.

Parameters:

count - The new number of spikes

Returns:

This builder, for chaining

height

IceSpike.Builder height(VariableAmount height)

Sets the base height of the spike.

Parameters:

height - The new base height

Returns:

This builder, for chaining

height

default IceSpike.Builder height(int height)

Sets the base height of the spike.

Parameters:

height - The new base height

Returns:

This builder, for chaining

extremeSpikeProbability

IceSpike.Builder extremeSpikeProbability(double p)

Gets the probability of the spike much larger than normal.

Parameters:

p - The new spawn probability

Returns:

This builder, for chaining

extremeSpikeIncrease

IceSpike.Builder extremeSpikeIncrease(VariableAmount increase)

Sets the base height increase of the extreme spikes.

Parameters:

increase - The new base height increase

Returns:

This builder, for chaining

extremeSpikeIncrease

default IceSpike.Builder extremeSpikeIncrease(int increase)

Sets the base height increase of the extreme spikes.

Parameters:

increase - The new base height increase

Returns:

This builder, for chaining

build

IceSpike build()
        throws IllegalStateException

Builds a new instance of a IceSpike populator with the settings set within the builder.

Returns:

A new instance of the populator

Throws:

IllegalStateException - If there are any settings left unset which do not have default values