org.spongepowered.api.world.gen.populator

Interface Flower

All Superinterfaces:

Populator

public interface Flower
extends Populator

Represents a populator which scatters flowers randomly around a chunk.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static Flower.Builder	builder() Creates a new Flower.Builder to build a Flower populator.
default void	clearSupplierOverride() Clears the supplier override to force the weighted table to be used instead.
VariableAmount	getFlowersPerChunk() Gets the number of flowers to attempt to spawn per chunk, must be greater than zero.
WeightedTable<PlantType>	getFlowerTypes() Gets a mutable weighted collection of plant type for this populator to spawn.
Optional<Function<Location<Extent>,PlantType>>	getSupplierOverride() Gets the overriding supplier if it exists.
default void	setFlowersPerChunk(int count) Sets the number of flowers to attempt to spawn per chunk, must be greater than zero.
void	setFlowersPerChunk(VariableAmount count) Sets the number of flowers to attempt to spawn per chunk, must be greater than zero.
void	setSupplierOverride(Function<Location<Extent>,PlantType> override) Sets the overriding supplier.

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

getType, populate, populate

Method Detail

builder

static Flower.Builder builder()

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

Returns:

The new builder

getFlowersPerChunk

VariableAmount getFlowersPerChunk()

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

Returns:

The number to spawn

setFlowersPerChunk

void setFlowersPerChunk(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

setFlowersPerChunk

default void setFlowersPerChunk(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

getFlowerTypes

WeightedTable<PlantType> getFlowerTypes()

Gets a mutable weighted collection of plant type for this populator to spawn.

Returns:

The plant types

getSupplierOverride

Optional<Function<Location<Extent>,PlantType>> 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 PlantType to place.

Returns:

The supplier override

setSupplierOverride

void setSupplierOverride(@Nullable
                         Function<Location<Extent>,PlantType> override)

Sets the overriding supplier. If the supplier is present then it is used in place of the weighted table while determining what PlantType to place.

Parameters:

override - The new supplier override, or null

clearSupplierOverride

default void clearSupplierOverride()

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