org.spongepowered.api.world.gen.populator

Interface BigMushroom.Builder

All Superinterfaces:

ResettableBuilder<BigMushroom,BigMushroom.Builder>

Enclosing interface:

BigMushroom

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

A builder for constructing BigMushroom populators.

Method Summary

Modifier and Type	Method and Description
BigMushroom	build() Builds a new instance of a BigMushroom populator with the settings set within the builder.
default BigMushroom.Builder	mushroomsPerChunk(int count) Sets the number of mushrooms which will be attempted to be spawned.
BigMushroom.Builder	mushroomsPerChunk(VariableAmount count) Sets the number of mushrooms which will be attempted to be spawned.
BigMushroom.Builder	supplier(Function<Location<Extent>,PopulatorObject> override) Sets the overriding supplier.
BigMushroom.Builder	type(PopulatorObject type, double weight) Adds the weighted PopulatorObject to the list of available types.
BigMushroom.Builder	types(WeightedTable<PopulatorObject> types) Sets the weighted PopulatorObjects to select from during generation.

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

from, reset

Method Detail

types

BigMushroom.Builder types(WeightedTable<PopulatorObject> types)

Sets the weighted PopulatorObjects to select from during generation.

Parameters:

types - The weighted types

Returns:

This builder, for chaining

type

BigMushroom.Builder type(PopulatorObject type,
                         double weight)

Adds the weighted PopulatorObject to the list of available types.

Parameters:

type - The new weighted type

weight - The weight of the new type

Returns:

This builder, for chaining

mushroomsPerChunk

BigMushroom.Builder mushroomsPerChunk(VariableAmount count)

Sets the number of mushrooms which will be attempted to be spawned.

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

Parameters:

count - The new amount to attempt to create

Returns:

This builder, for chaining

mushroomsPerChunk

default BigMushroom.Builder mushroomsPerChunk(int count)

Sets the number of mushrooms which will be attempted to be spawned.

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

Parameters:

count - The new amount to attempt to create

Returns:

This builder, for chaining

supplier

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

BigMushroom build()
           throws IllegalStateException

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