org.spongepowered.api.world.gen.populator

Interface SeaFloor

All Superinterfaces:

Populator

public interface SeaFloor
extends Populator

Represents a populator which places down a disc of material onto the bottom on an ocean or river.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static SeaFloor.Builder	builder() Creates a new SeaFloor.Builder to build a SeaFloor populator.
BlockState	getBlock() Gets the BlockState to place down.
VariableAmount	getDepth() Gets the depth of the sea floor cover to generate.
VariableAmount	getDiscsPerChunk() Gets the number of discs to attempt to spawn per chunk, must be greater than zero.
VariableAmount	getRadius() Gets the radius of the discs being spawned.
Predicate<BlockState>	getValidBlocksToReplace() Gets the predicate which is applied to determine what BlockStates this populator may replace.
void	setBlock(BlockState block) Sets the BlockState to place down.
default void	setDepth(int depth) Sets the depth of the sea floor cover to generate.
void	setDepth(VariableAmount depth) Sets the depth of the sea floor cover to generate.
default void	setDiscsPerChunk(int count) Sets the number of discs to attempt to spawn per chunk, must be greater than zero.
void	setDiscsPerChunk(VariableAmount count) Sets the number of discs to attempt to spawn per chunk, must be greater than zero.
default void	setRadius(double radius) Sets the radius of the discs being spawned.
void	setRadius(VariableAmount radius) Sets the radius of the discs being spawned.
void	setValidBlocksToReplace(Predicate<BlockState> check) Sets the predicate which will be applied to all BlockStates that this populator attempts to replace in order to determine if they are valid.

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

getType, populate, populate

Method Detail

builder

static SeaFloor.Builder builder()

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

Returns:

The new builder

getBlock

BlockState getBlock()

Gets the BlockState to place down.

Returns:

The block to place

setBlock

void setBlock(BlockState block)

Sets the BlockState to place down.

Parameters:

block - The new block to place

getDiscsPerChunk

VariableAmount getDiscsPerChunk()

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

Returns:

The amount to spawn

setDiscsPerChunk

void setDiscsPerChunk(VariableAmount count)

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

Parameters:

count - The new amount to spawn

setDiscsPerChunk

default void setDiscsPerChunk(int count)

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

Parameters:

count - The new amount to spawn

getRadius

VariableAmount getRadius()

Gets the radius of the discs being spawned.

Returns:

The disc radius

setRadius

void setRadius(VariableAmount radius)

Sets the radius of the discs being spawned.

Parameters:

radius - The new disc radius

setRadius

default void setRadius(double radius)

Sets the radius of the discs being spawned.

Parameters:

radius - The new disc radius

getDepth

VariableAmount getDepth()

Gets the depth of the sea floor cover to generate.

Returns:

The depth

setDepth

void setDepth(VariableAmount depth)

Sets the depth of the sea floor cover to generate.

Parameters:

depth - The new depth

setDepth

default void setDepth(int depth)

Sets the depth of the sea floor cover to generate.

Parameters:

depth - The new depth

getValidBlocksToReplace

Predicate<BlockState> getValidBlocksToReplace()

Gets the predicate which is applied to determine what BlockStates this populator may replace.

Returns:

The replacement check

setValidBlocksToReplace

void setValidBlocksToReplace(Predicate<BlockState> check)

Sets the predicate which will be applied to all BlockStates that this populator attempts to replace in order to determine if they are valid.

Parameters:

check - The new replacement check