org.spongepowered.api.world.gen.populator

Interface Flower.Builder

All Superinterfaces:

ResettableBuilder<Flower,Flower.Builder>

Enclosing interface:

Flower

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

A builder for constructing Flower populators.

Method Summary

Modifier and Type	Method and Description
Flower	build() Builds a new instance of a Flower populator with the settings set within the builder.
default Flower.Builder	perChunk(int count) Sets the number of flowers to attempt to spawn per chunk, must be greater than zero.
Flower.Builder	perChunk(VariableAmount count) Sets the number of flowers to attempt to spawn per chunk, must be greater than zero.
Flower.Builder	supplier(Function<Location<Extent>,PlantType> override) Sets the overriding supplier.
Flower.Builder	type(PlantType type, double weight) Adds the plant type to the list of types to spawn with the given weight.
Flower.Builder	types(WeightedTable<PlantType> types) Sets the plant types for this populator to spawn.

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

from, reset

Method Detail

perChunk

Flower.Builder perChunk(VariableAmount count)

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

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

Parameters:

count - The new amount to spawn

Returns:

This builder, for chaining

perChunk

default Flower.Builder perChunk(int count)

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

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

Parameters:

count - The new amount to spawn

Returns:

This builder, for chaining

types

Flower.Builder types(WeightedTable<PlantType> types)

Sets the plant types for this populator to spawn.

Parameters:

types - The plant types to spawn

Returns:

This builder, for chaining

type

Flower.Builder type(PlantType type,
                    double weight)

Adds the plant type to the list of types to spawn with the given weight.

Parameters:

type - The plant type to spawn

weight - The weight of the type

Returns:

This builder, for chaining

supplier

Flower.Builder supplier(Function<Location<Extent>,PlantType> 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

Flower build()
      throws IllegalStateException

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