org.spongepowered.api.world.gen.populator

Interface Mushroom.Builder

All Superinterfaces:

ResettableBuilder<Mushroom,Mushroom.Builder>

Enclosing interface:

Mushroom

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

A builder for constructing Mushroom populators.

Method Summary

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

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

from, reset

Method Detail

types

Mushroom.Builder types(ChanceTable<MushroomType> types)

Sets the weighted MushroomTypes to select from during generation.

Parameters:

types - The weighted types

Returns:

This builder, for chaining

type

Mushroom.Builder type(MushroomType type,
                      double weight)

Adds the weighted MushroomType 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

Mushroom.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 Mushroom.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

Mushroom.Builder supplier(@Nullable
                          Function<Location<Extent>,MushroomType> override)

Sets the overriding supplier. If the supplier is present then it is used in place of the chance table.

Parameters:

override - The new supplier override, or null

Returns:

This builder, for chaining

build

Mushroom build()
        throws IllegalStateException

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