org.spongepowered.api.world.gen.populator

Interface DoublePlant.Builder

All Superinterfaces:

ResettableBuilder<DoublePlant,DoublePlant.Builder>

Enclosing interface:

DoublePlant

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

A builder for constructing DoublePlant populators.

Method Summary

Modifier and Type	Method and Description
DoublePlant	build() Builds a new instance of a DoublePlant populator with the settings set within the builder.
default DoublePlant.Builder	perChunk(int count) Sets the number of plants to create, cannot be negative.
DoublePlant.Builder	perChunk(VariableAmount count) Sets the number of plants to create, cannot be negative.
DoublePlant.Builder	supplier(Function<Location<Extent>,DoublePlantType> override) Sets the overriding supplier.
DoublePlant.Builder	type(DoublePlantType type, double weight) Adds a plant type to the list that may be spawned in by this populator.
DoublePlant.Builder	types(WeightedTable<DoublePlantType> types) Sets which plant types may be spawned in by this populator.

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

from, reset

Method Detail

types

DoublePlant.Builder types(WeightedTable<DoublePlantType> types)

Sets which plant types may be spawned in by this populator.

Parameters:

types - Possible types

Returns:

This builder, for chaining

type

DoublePlant.Builder type(DoublePlantType type,
                         double weight)

Adds a plant type to the list that may be spawned in by this populator.

Parameters:

type - The new plant type

weight - The weight

Returns:

This builder, for chaining

perChunk

DoublePlant.Builder perChunk(VariableAmount count)

Sets the number of plants to create, cannot be negative.

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

Parameters:

count - The new base amount

Returns:

This builder, for chaining

perChunk

default DoublePlant.Builder perChunk(int count)

Sets the number of plants to create, cannot be negative.

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

Parameters:

count - The new base amount

Returns:

This builder, for chaining

supplier

DoublePlant.Builder supplier(@Nullable
                             Function<Location<Extent>,DoublePlantType> 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

DoublePlant build()
           throws IllegalStateException

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