org.spongepowered.api.world.gen.populator

Interface RandomBlock.Builder

All Superinterfaces:

ResettableBuilder<RandomBlock,RandomBlock.Builder>

Enclosing interface:

RandomBlock

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

A builder for constructing RandomBlock populators.

Method Summary

Modifier and Type	Method and Description
RandomBlock.Builder	block(BlockState block) Sets the BlockState that this populator will randomly distribute.
RandomBlock	build() Builds a new instance of a RandomBlock populator with the settings set within the builder.
RandomBlock.Builder	height(VariableAmount height) Sets the height range of the random block placement.
default RandomBlock.Builder	perChunk(int count) Sets the number of blocks to attempt to spawn per chunk, must be greater than zero.
RandomBlock.Builder	perChunk(VariableAmount count) Sets the number of blocks to attempt to spawn per chunk, must be greater than zero.
RandomBlock.Builder	placementTarget(Predicate<Location<World>> target) Sets the Predicate that this populator used to determine of a given BlockType is valid to attempt to place a block of fire on top of.

Methods inherited from interface org.spongepowered.api.util.ResettableBuilder

from, reset

Method Detail

block

RandomBlock.Builder block(BlockState block)

Sets the BlockState that this populator will randomly distribute.

Parameters:

block - The new block state

Returns:

This builder, for chaining

perChunk

RandomBlock.Builder perChunk(VariableAmount count)

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

Parameters:

count - The new number to spawn

Returns:

This builder, for chaining

perChunk

default RandomBlock.Builder perChunk(int count)

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

Parameters:

count - The new number to spawn

Returns:

This builder, for chaining

placementTarget

RandomBlock.Builder placementTarget(Predicate<Location<World>> target)

Sets the Predicate that this populator used to determine of a given BlockType is valid to attempt to place a block of fire on top of.

Parameters:

target - The new targeted block predicate

Returns:

This builder, for chaining

height

RandomBlock.Builder height(VariableAmount height)

Sets the height range of the random block placement.

Parameters:

height - The new height range

Returns:

This builder, for chaining

build

RandomBlock build()
           throws IllegalStateException

Builds a new instance of a RandomBlock 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