org.spongepowered.api.world.gen.populator

Interface Forest

All Superinterfaces:

Populator

public interface Forest
extends Populator

A populator which will place several trees into a chunk in order to create a forest.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static Forest.Builder	builder() Creates a new Forest.Builder to build a Forest populator.
default void	clearSupplierOverride() Clears the supplier override to force the weighted table to be used instead.
Optional<Function<Location<Extent>,PopulatorObject>>	getSupplierOverride() Gets the overriding supplier if it exists.
VariableAmount	getTreesPerChunk() Gets the number of trees to attempt to spawn per chunk, must be greater than zero.
WeightedTable<PopulatorObject>	getTypes() Gets the a mutable weighted collection of PopulatorObjects to spawn.
void	setSupplierOverride(Function<Location<Extent>,PopulatorObject> override) Sets the overriding supplier.
default void	setTreesPerChunk(int count) Sets the number of trees to attempt to spawn per chunk, must be greater than zero.
void	setTreesPerChunk(VariableAmount count) Sets the number of trees 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 Forest.Builder builder()

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

Returns:

The new builder

getTreesPerChunk

VariableAmount getTreesPerChunk()

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

Returns:

The number to spawn

setTreesPerChunk

void setTreesPerChunk(VariableAmount count)

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

Parameters:

count - The new amount to spawn

setTreesPerChunk

default void setTreesPerChunk(int count)

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

Parameters:

count - The new amount to spawn

getTypes

WeightedTable<PopulatorObject> getTypes()

Gets the a mutable weighted collection of PopulatorObjects to spawn.

Returns:

The type to spawn

getSupplierOverride

Optional<Function<Location<Extent>,PopulatorObject>> getSupplierOverride()

Gets the overriding supplier if it exists. If the supplier is present then it is used in place of the weighted table while determining what PopulatorObject to place.

Returns:

The supplier override

setSupplierOverride

void setSupplierOverride(@Nullable
                         Function<Location<Extent>,PopulatorObject> override)

Sets the overriding supplier. If the supplier is present then it is used in place of the weighted table while determining what PopulatorObject to place.

Parameters:

override - The new supplier override, or null

clearSupplierOverride

default void clearSupplierOverride()

Clears the supplier override to force the weighted table to be used instead.