org.spongepowered.api.world.gen.populator

Interface Shrub.Builder

All Superinterfaces:

ResettableBuilder<Shrub,Shrub.Builder>

Enclosing interface:

Shrub

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

A builder for constructing Shrub populators.

Method Summary

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

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

from, reset

Method Detail

perChunk

Shrub.Builder perChunk(VariableAmount count)

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

Parameters:

count - The new amount of shrubs to spawn

Returns:

This builder, for chaining

perChunk

default Shrub.Builder perChunk(int count)

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

Parameters:

count - The new amount of shrubs to spawn

Returns:

This builder, for chaining

types

Shrub.Builder types(WeightedTable<ShrubType> types)

Sets the weighted ShrubTypes to place.

Parameters:

types - The new shrub types

Returns:

This builder, for chaining

type

Shrub.Builder type(ShrubType type,
                   int weight)

Adds the weighted ShrubTypes to the list of types.

Parameters:

type - The new shrub type

weight - The weight of the type

Returns:

This builder, for chaining

supplier

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

Shrub build()
     throws IllegalStateException

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