org.spongepowered.api.world.gen.populator

Interface SeaFloor.Builder

All Superinterfaces:

ResettableBuilder<SeaFloor,SeaFloor.Builder>

Enclosing interface:

SeaFloor

public static interface SeaFloor.Builder
extends ResettableBuilder<SeaFloor,SeaFloor.Builder>

A builder for constructing SeaFloor populators.

Method Summary

Modifier and Type	Method and Description
SeaFloor.Builder	block(BlockState block) Sets the BlockState to place down.
SeaFloor	build() Builds a new instance of a SeaFloor populator with the settings set within the builder.
default SeaFloor.Builder	depth(int depth) Sets the depth of the sea floor cover to generate.
SeaFloor.Builder	depth(VariableAmount depth) Sets the depth of the sea floor cover to generate.
default SeaFloor.Builder	perChunk(int count) Sets the number of discs to attempt to spawn per chunk, must be greater than zero.
SeaFloor.Builder	perChunk(VariableAmount count) Sets the number of discs to attempt to spawn per chunk, must be greater than zero.
default SeaFloor.Builder	radius(double radius) Sets the radius of the discs being spawned.
SeaFloor.Builder	radius(VariableAmount radius) Sets the radius of the discs being spawned.
SeaFloor.Builder	replace(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.util.ResettableBuilder

from, reset

Method Detail

block

SeaFloor.Builder block(BlockState block)

Sets the BlockState to place down.

Parameters:

block - The new block to place

Returns:

This builder, for chaining

perChunk

SeaFloor.Builder perChunk(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

Returns:

This builder, for chaining

perChunk

default SeaFloor.Builder perChunk(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

Returns:

This builder, for chaining

radius

SeaFloor.Builder radius(VariableAmount radius)

Sets the radius of the discs being spawned.

Parameters:

radius - The new disc radius

Returns:

This builder, for chaining

radius

default SeaFloor.Builder radius(double radius)

Sets the radius of the discs being spawned.

Parameters:

radius - The new disc radius

Returns:

This builder, for chaining

depth

SeaFloor.Builder depth(VariableAmount depth)

Sets the depth of the sea floor cover to generate.

Parameters:

depth - The new depth

Returns:

This builder, for chaining

depth

default SeaFloor.Builder depth(int depth)

Sets the depth of the sea floor cover to generate.

Parameters:

depth - The new depth

Returns:

This builder, for chaining

replace

SeaFloor.Builder replace(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

Returns:

This builder, for chaining

build

SeaFloor build()
        throws IllegalStateException

Builds a new instance of a SeaFloor populator with the settings set within the builder.

Returns:

A new instance of the populator

Throws:

IllegalStateException - If there are any settings left unset which do not have default values