org.spongepowered.api.world.gen.populator

Interface Reed

All Superinterfaces:

Populator

public interface Reed
extends Populator

Represents a populator which spawns in reeds near valid water sources within the chunk.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static Reed.Builder	builder() Creates a new Reed.Builder to build a Reed populator.
VariableAmount	getReedHeight() Gets the height of the reeds to generate.
VariableAmount	getReedsPerChunk() Gets the number of reeds to attempt to spawn per chunk, must be greater than zero.
void	setReedHeight(VariableAmount height) Sets the height of the reeds to generate.
default void	setReedsPerChunk(int count) Sets the number of reeds to attempt to spawn per chunk, must be greater than zero.
void	setReedsPerChunk(VariableAmount count) Sets the number of reeds to attempt to spawn per chunk, must be greater than zero.

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

getType, populate, populate

Method Detail

builder

static Reed.Builder builder()

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

Returns:

The new builder

getReedsPerChunk

VariableAmount getReedsPerChunk()

Gets the number of reeds to attempt to spawn per chunk, must be greater than zero.

Returns:

The amount to spawn

setReedsPerChunk

void setReedsPerChunk(VariableAmount count)

Sets the number of reeds to attempt to spawn per chunk, must be greater than zero.

Parameters:

count - The new amount to spawn

setReedsPerChunk

default void setReedsPerChunk(int count)

Sets the number of reeds to attempt to spawn per chunk, must be greater than zero.

Parameters:

count - The new amount to spawn

getReedHeight

VariableAmount getReedHeight()

Gets the height of the reeds to generate.

Returns:

The reed height

setReedHeight

void setReedHeight(VariableAmount height)

Sets the height of the reeds to generate.

Parameters:

height - The new reed height