org.spongepowered.api.world.gen.populator

Interface DoublePlant

All Superinterfaces:

Populator

public interface DoublePlant
extends Populator

Represents a populator which spawns in an assortment of two block tall plants. The number of plants attempted to be generated is final = base + [0,variance) .

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static DoublePlant.Builder	builder() Creates a new DoublePlant.Builder to build a DoublePlant populator.
default void	clearSupplierOverride() Clears the supplier override to force the weighted table to be used instead.
VariableAmount	getPlantsPerChunk() Gets the number of plants to create per chunk.
WeightedTable<DoublePlantType>	getPossibleTypes() Gets a mutable weighted collection of possible plants which may be selected to be spawned in by this populator.
Optional<Function<Location<Extent>,DoublePlantType>>	getSupplierOverride() Gets the overriding supplier if it exists.
default void	setPlantsPerChunk(int count) Sets the number of plants to create per chunk, cannot be negative.
void	setPlantsPerChunk(VariableAmount count) Sets the number of plants to create per chunk, cannot be negative.
void	setSupplierOverride(Function<Location<Extent>,DoublePlantType> override) Sets the overriding supplier.

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

getType, populate, populate

Method Detail

builder

static DoublePlant.Builder builder()

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

Returns:

The new builder

getPossibleTypes

WeightedTable<DoublePlantType> getPossibleTypes()

Gets a mutable weighted collection of possible plants which may be selected to be spawned in by this populator.

Returns:

The possible types to be spawned

getPlantsPerChunk

VariableAmount getPlantsPerChunk()

Gets the number of plants to create per chunk.

Returns:

The amount

setPlantsPerChunk

void setPlantsPerChunk(VariableAmount count)

Sets the number of plants to create per chunk, cannot be negative.

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

Parameters:

count - The new amount

setPlantsPerChunk

default void setPlantsPerChunk(int count)

Sets the number of plants to create per chunk, cannot be negative.

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

Parameters:

count - The new amount

getSupplierOverride

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

Returns:

The supplier override

setSupplierOverride

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

Sets the overriding supplier. If the supplier is present then it is used in place of the weighted table while determining what DoublePlantType 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.