org.spongepowered.api.world.gen.populator

Interface Mushroom

All Superinterfaces:

Populator

public interface Mushroom
extends Populator

Represents a populator which places a number of mushrooms. The type of mushroom to place can be set or can be randomized.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Mushroom.Builder A builder for constructing Mushroom populators.

Method Summary

Modifier and Type	Method and Description
static Mushroom.Builder	builder() Creates a new Mushroom.Builder to build a Mushroom populator.
default void	clearSupplierOverride() Clears the supplier override to force the chance table to be used instead.
VariableAmount	getMushroomsPerChunk() Gets a representation of the amount of mushrooms which will be attempted to be spawned per chunk.
Optional<Function<Location<Extent>,MushroomType>>	getSupplierOverride() Gets the overriding supplier if it exists.
ChanceTable<MushroomType>	getTypes() Gets a mutable ChanceTable of possible mushroom types to spawn.
default void	setMushroomsPerChunk(int count) Sets the amount of mushrooms which will be attempted to be spawned per chunk.
void	setMushroomsPerChunk(VariableAmount count) Sets the representation of the amount of mushrooms which will be attempted to be spawned per chunk.
void	setSupplierOverride(Function<Location<Extent>,MushroomType> override) Sets the overriding supplier.

Methods inherited from interface org.spongepowered.api.world.gen.Populator

getType, populate, populate

Method Detail

builder

static Mushroom.Builder builder()

Creates a new Mushroom.Builder to build a Mushroom populator.

Returns:

The new builder

getTypes

ChanceTable<MushroomType> getTypes()

Gets a mutable ChanceTable of possible mushroom types to spawn. If the list is empty then a MushroomType will be selected at random from all available MushroomTypes.

Returns:

The weighted list

getMushroomsPerChunk

VariableAmount getMushroomsPerChunk()

Gets a representation of the amount of mushrooms which will be attempted to be spawned per chunk.

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.

Returns:

The number of mushrooms attempted to be spawned per chunk

setMushroomsPerChunk

void setMushroomsPerChunk(VariableAmount count)

Sets the representation of the amount of mushrooms which will be attempted to be spawned per chunk.

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

setMushroomsPerChunk

default void setMushroomsPerChunk(int count)

Sets the amount of mushrooms which will be attempted to be spawned per chunk.

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

getSupplierOverride

Optional<Function<Location<Extent>,MushroomType>> getSupplierOverride()

Gets the overriding supplier if it exists. If the supplier is present then it is used in place of the weighted table while determining what MushroomType to place.

Returns:

The supplier override

setSupplierOverride

void setSupplierOverride(@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 while determining what MushroomType to place.

Parameters:

override - The new supplier override, or null

clearSupplierOverride

default void clearSupplierOverride()

Clears the supplier override to force the chance table to be used instead.