org.spongepowered.api.world.gen.populator

Interface Ore

All Superinterfaces:

Populator

public interface Ore
extends Populator

Represents a populator which seeds the underground areas of the chunks with ores.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static Ore.Builder	builder() Creates a new Ore.Builder to build a Ore populator.
VariableAmount	getDepositSize() Gets the size of deposit of ore.
VariableAmount	getDepositsPerChunk() Gets the number of ore clumps to attempt to spawn per chunk, must be greater than zero.
VariableAmount	getHeight() Gets the height that the ore will generate at.
BlockState	getOreBlock() Gets the block to place as ore.
Predicate<BlockState>	getPlacementCondition() Gets a predicate which checks for the placement conditions for this ore.
default void	setDepositSize(int size) Sets the size of deposit of ore.
void	setDepositSize(VariableAmount size) Sets the size of deposit of ore.
default void	setDepositsPerChunk(int count) Sets the number of ore clumps to attempt to spawn per chunk, must be greater than zero.
void	setDepositsPerChunk(VariableAmount count) Sets the number of ore clumps to attempt to spawn per chunk, must be greater than zero.
void	setHeight(VariableAmount height) Sets the height that the ore will generate at.
void	setOreBlock(BlockState block) Sets the block to place as ore.
void	setPlacementCondition(Predicate<BlockState> condition) Sets a predicate which checks for the placement conditions for this ore.

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

getType, populate, populate

Method Detail

builder

static Ore.Builder builder()

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

Returns:

The new builder

getOreBlock

BlockState getOreBlock()

Gets the block to place as ore.

Returns:

The ore block

setOreBlock

void setOreBlock(BlockState block)

Sets the block to place as ore.

Parameters:

block - The new ore block

getDepositSize

VariableAmount getDepositSize()

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

Returns:

The deposit size

setDepositSize

void setDepositSize(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

setDepositSize

default void setDepositSize(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

getDepositsPerChunk

VariableAmount getDepositsPerChunk()

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

Returns:

The number of clumps to spawn

setDepositsPerChunk

void setDepositsPerChunk(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

setDepositsPerChunk

default void setDepositsPerChunk(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

getHeight

VariableAmount getHeight()

Gets the height that the ore will generate at.

Returns:

The height

setHeight

void setHeight(VariableAmount height)

Sets the height that the ore will generate at.

Parameters:

height - The new height

getPlacementCondition

Predicate<BlockState> getPlacementCondition()

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

Returns:

The placement conditions check

setPlacementCondition

void setPlacementCondition(Predicate<BlockState> condition)

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

Parameters:

condition - The new placement conditions check