org.spongepowered.api.world.gen.populator

Interface IceSpike

All Superinterfaces:

Populator

public interface IceSpike
extends Populator

Represents a populator which generates large spikes of Ice.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IceSpike.Builder A builder for constructing IceSpike populators.

Method Summary

Modifier and Type	Method and Description
static IceSpike.Builder	builder() Creates a new IceSpike.Builder to build a IceSpike populator.
VariableAmount	getExtremeSpikeIncrease() Gets the height increase of the extreme spikes.
double	getExtremeSpikeProbability() Gets the probability of the spike much larger than normal.
VariableAmount	getHeight() Gets the base height of the spike.
VariableAmount	getSpikesPerChunk() Gets the number of spikes to generate per chunk.
default void	setExtremeSpikeIncrease(int increase) Sets the height increase of the extreme spikes.
void	setExtremeSpikeIncrease(VariableAmount increase) Sets the height increase of the extreme spikes.
void	setExtremeSpikeProbability(double p) Gets the probability of the spike much larger than normal.
default void	setHeight(int height) Sets the base height of the spike.
void	setHeight(VariableAmount height) Sets the base height of the spike.
default void	setSpikesPerChunk(int count) Sets the number of spikes to attempt to generate per chunk.
void	setSpikesPerChunk(VariableAmount count) Sets the number of spikes to attempt to generate per chunk.

Methods inherited from interface org.spongepowered.api.world.gen.Populator

getType, populate, populate

Method Detail

builder

static IceSpike.Builder builder()

Creates a new IceSpike.Builder to build a IceSpike populator.

Returns:

The new builder

getSpikesPerChunk

VariableAmount getSpikesPerChunk()

Gets the number of spikes to generate per chunk.

Returns:

The number of spikes

setSpikesPerChunk

void setSpikesPerChunk(VariableAmount count)

Sets the number of spikes to attempt to generate per chunk.

Parameters:

count - The new number of spikes

setSpikesPerChunk

default void setSpikesPerChunk(int count)

Sets the number of spikes to attempt to generate per chunk.

Parameters:

count - The new number of spikes

getHeight

VariableAmount getHeight()

Gets the base height of the spike.

Returns:

The base height

setHeight

void setHeight(VariableAmount height)

Sets the base height of the spike.

Parameters:

height - The new base height

setHeight

default void setHeight(int height)

Sets the base height of the spike.

Parameters:

height - The new base height

getExtremeSpikeProbability

double getExtremeSpikeProbability()

Gets the probability of the spike much larger than normal.

Returns:

The spawn probability

setExtremeSpikeProbability

void setExtremeSpikeProbability(double p)

Gets the probability of the spike much larger than normal.

Parameters:

p - The new spawn probability

getExtremeSpikeIncrease

VariableAmount getExtremeSpikeIncrease()

Gets the height increase of the extreme spikes.

Returns:

The height increase

setExtremeSpikeIncrease

void setExtremeSpikeIncrease(VariableAmount increase)

Sets the height increase of the extreme spikes.

Parameters:

increase - The new height increase

setExtremeSpikeIncrease

default void setExtremeSpikeIncrease(int increase)

Sets the height increase of the extreme spikes.

Parameters:

increase - The new height increase