org.spongepowered.api.world.gen.populator

Interface Cactus

All Superinterfaces:

Populator

public interface Cactus
extends Populator

Represents a populator which will randomly spawn a number of cacti within the chunk. The cacti will only be spawned at valid locations, that is on top of a sand block with no immediately surrounding blocks.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static Cactus.Builder	builder() Creates a new Cactus.Builder to build a Cactus populator.
VariableAmount	getCactiPerChunk() Gets the number of cacti to spawn per chunk.
VariableAmount	getHeight() Gets the height of the cacti.
default void	setCactiPerChunk(int count) Sets the number of cacti to spawn per chunk, cannot be negative.
void	setCactiPerChunk(VariableAmount count) Sets the number of cacti to spawn per chunk, cannot be negative.
default void	setHeight(int count) Sets the height of the cacti.
void	setHeight(VariableAmount height) Sets the height of the cacti.

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

getType, populate, populate

Method Detail

builder

static Cactus.Builder builder()

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

Returns:

The new builder

getCactiPerChunk

VariableAmount getCactiPerChunk()

Gets the number of cacti to spawn per chunk.

Returns:

The number of cacti to spawn

setCactiPerChunk

void setCactiPerChunk(VariableAmount count)

Sets the number of cacti to spawn per chunk, cannot be negative.

Note: This number is not a definite number and the final count of cacti which are successfully spawned by the populator will almost always be lower.

Parameters:

count - The new number of cacti to spawn

setCactiPerChunk

default void setCactiPerChunk(int count)

Sets the number of cacti to spawn per chunk, cannot be negative.

Note: This number is not a definite number and the final count of cacti which are successfully spawned by the populator will almost always be lower.

Parameters:

count - The new number of cacti to spawn

getHeight

VariableAmount getHeight()

Gets the height of the cacti.

Returns:

The height

setHeight

void setHeight(VariableAmount height)

Sets the height of the cacti.

Parameters:

height - The new height

setHeight

default void setHeight(int count)

Sets the height of the cacti.

Parameters:

count - The new height