org.spongepowered.api.world.gen.populator

Interface RandomBlock

All Superinterfaces:

Populator

public interface RandomBlock
extends Populator

Represents a populator which creates random distributions of singular blocks, such as fire in the nether and water in the walls of caves.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static RandomBlock.Builder	builder() Creates a new RandomBlock.Builder to build a RandomBlock populator.
VariableAmount	getAttemptsPerChunk() Gets the number of blocks to attempt to spawn per chunk, must be greater than zero.
BlockState	getBlock() Gets the BlockState that this populator will randomly distribute.
VariableAmount	getHeightRange() Gets the height that the block will be randomly placed within.
Predicate<Location<World>>	getPlacementTarget() Gets the Predicate that this populator used to determine of a given Location is valid to attempt to place a block at.
void	getPlacementTarget(Predicate<Location<World>> target) Sets the Predicate that this populator used to determine of a given Location is valid to attempt to place a block at.
default void	setAttemptsPerChunk(int count) Sets the number of blocks to attempt to spawn per chunk, must be greater than zero.
void	setAttemptsPerChunk(VariableAmount count) Sets the number of blocks to attempt to spawn per chunk, must be greater than zero.
void	setBlock(BlockState block) Sets the BlockState that this populator will randomly distribute.
void	setHeightRange(VariableAmount height) Sets the height that the blocks will be randomly placed within.

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

getType, populate, populate

Method Detail

builder

static RandomBlock.Builder builder()

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

Returns:

The new builder

getBlock

BlockState getBlock()

Gets the BlockState that this populator will randomly distribute.

Returns:

The block state

setBlock

void setBlock(BlockState block)

Sets the BlockState that this populator will randomly distribute.

Parameters:

block - The new block state

getAttemptsPerChunk

VariableAmount getAttemptsPerChunk()

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

Returns:

The number to spawn

setAttemptsPerChunk

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

setAttemptsPerChunk

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

getHeightRange

VariableAmount getHeightRange()

Gets the height that the block will be randomly placed within.

Returns:

The height range

setHeightRange

void setHeightRange(VariableAmount height)

Sets the height that the blocks will be randomly placed within.

Parameters:

height - The new height range

getPlacementTarget

Predicate<Location<World>> getPlacementTarget()

Gets the Predicate that this populator used to determine of a given Location is valid to attempt to place a block at.

Returns:

The targeted block predicate

getPlacementTarget

void getPlacementTarget(Predicate<Location<World>> target)

Sets the Predicate that this populator used to determine of a given Location is valid to attempt to place a block at.

Parameters:

target - The new targeted block predicate