org.spongepowered.api.world.gen.populator

Interface Forest.Builder

All Superinterfaces:

ResettableBuilder<Forest,Forest.Builder>

Enclosing interface:

Forest

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

A builder for constructing Forest populators.

Method Summary

Modifier and Type	Method and Description
Forest	build() Builds a new instance of a Forest populator with the settings set within the builder.
default Forest.Builder	perChunk(int count) Sets the number of trees to attempt to spawn per chunk, must be greater than zero.
Forest.Builder	perChunk(VariableAmount count) Sets the number of trees to attempt to spawn per chunk, must be greater than zero.
Forest.Builder	supplier(Function<Location<Extent>,PopulatorObject> override) Sets the overriding supplier.
Forest.Builder	type(PopulatorObject type, double weight) Sets the BiomeTreeType to the list of weighted types.
Forest.Builder	types(WeightedTable<PopulatorObject> types) Sets the BiomeTreeTypes to spawn.

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

from, reset

Method Detail

perChunk

Forest.Builder perChunk(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

Returns:

This builder, for chaining

perChunk

default Forest.Builder perChunk(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

Returns:

This builder, for chaining

types

Forest.Builder types(WeightedTable<PopulatorObject> types)

Sets the BiomeTreeTypes to spawn.

Parameters:

types - The new types to spawn

Returns:

This builder, for chaining

type

Forest.Builder type(PopulatorObject type,
                    double weight)

Sets the BiomeTreeType to the list of weighted types.

Parameters:

type - The new type to add

weight - The weight of the type

Returns:

This builder, for chaining

supplier

Forest.Builder supplier(@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.

Parameters:

override - The new supplier override, or null

Returns:

This builder, for chaining

build

Forest build()
      throws IllegalStateException

Builds a new instance of a Forest 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