org.spongepowered.api.world.gen.populator

Interface Shrub

All Superinterfaces:

Populator

public interface Shrub
extends Populator

Represents a populator which places down various variants of ShrubTypes within the chunk.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static Shrub.Builder	builder() Creates a new Shrub.Builder to build a Shrub populator.
default void	clearSupplierOverride() Clears the supplier override to force the weighted table to be used instead.
VariableAmount	getShrubsPerChunk() Gets the number of shrubs to attempt to spawn per chunk, must be greater than zero.
Optional<Function<Location<Extent>,ShrubType>>	getSupplierOverride() Gets the overriding supplier if it exists.
WeightedTable<ShrubType>	getTypes() Gets a weighted collection of ShrubTypes to place.
default void	setShrubsPerChunk(int count) Sets the number of shrubs to attempt to spawn per chunk, must be greater than zero.
void	setShrubsPerChunk(VariableAmount count) Sets the number of shrubs to attempt to spawn per chunk, must be greater than zero.
void	setSupplierOverride(Function<Location<Extent>,ShrubType> override) Sets the overriding supplier.

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

getType, populate, populate

Method Detail

builder

static Shrub.Builder builder()

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

Returns:

The new builder

getTypes

WeightedTable<ShrubType> getTypes()

Gets a weighted collection of ShrubTypes to place.

Returns:

The shrub types

getShrubsPerChunk

VariableAmount getShrubsPerChunk()

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

Returns:

The amount of shrubs to spawn

setShrubsPerChunk

void setShrubsPerChunk(VariableAmount count)

Sets the number of shrubs to attempt to spawn per chunk, must be greater than zero.

Parameters:

count - The new amount of shrubs to spawn

setShrubsPerChunk

default void setShrubsPerChunk(int count)

Sets the number of shrubs to attempt to spawn per chunk, must be greater than zero.

Parameters:

count - The new amount of shrubs to spawn

getSupplierOverride

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

Returns:

The supplier override

setSupplierOverride

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

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