org.spongepowered.api.world.gen.populator

Interface Ore.Builder

All Superinterfaces:

ResettableBuilder<Ore,Ore.Builder>

Enclosing interface:

Ore

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

A builder for constructing Ore populators.

Method Summary

Modifier and Type	Method and Description
Ore	build() Builds a new instance of a Ore populator with the settings set within the builder.
Ore.Builder	height(VariableAmount height) Sets the height that the ore can generate at.
Ore.Builder	ore(BlockState block) Sets the block to place as ore.
default Ore.Builder	perChunk(int count) Sets the number of ore clumps to attempt to spawn per chunk, must be greater than zero.
Ore.Builder	perChunk(VariableAmount count) Sets the number of ore clumps to attempt to spawn per chunk, must be greater than zero.
Ore.Builder	placementCondition(Predicate<BlockState> condition) Sets a predicate which checks for the placement conditions for this ore.
default Ore.Builder	size(int size) Sets the size of deposit of ore.
Ore.Builder	size(VariableAmount size) Sets the size of deposit of ore.

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

from, reset

Method Detail

ore

Ore.Builder ore(BlockState block)

Sets the block to place as ore.

Parameters:

block - The new ore block

Returns:

This builder, for chaining

size

Ore.Builder size(VariableAmount size)

Sets the size of deposit of ore. This is the number of blocks per clump of ores spawned.

Parameters:

size - The new deposit size

Returns:

This builder, for chaining

size

default Ore.Builder size(int size)

Sets the size of deposit of ore. This is the number of blocks per clump of ores spawned.

Parameters:

size - The new deposit size

Returns:

This builder, for chaining

perChunk

Ore.Builder perChunk(VariableAmount count)

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

Parameters:

count - The new number of clumps to spawn

Returns:

This builder, for chaining

perChunk

default Ore.Builder perChunk(int count)

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

Parameters:

count - The new number of clumps to spawn

Returns:

This builder, for chaining

height

Ore.Builder height(VariableAmount height)

Sets the height that the ore can generate at.

Parameters:

height - The new height

Returns:

This builder, for chaining

placementCondition

Ore.Builder placementCondition(Predicate<BlockState> condition)

Sets a predicate which checks for the placement conditions for this ore.

Parameters:

condition - The new placement conditions check

Returns:

This builder, for chaining

build

Ore build()
   throws IllegalStateException

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