org.spongepowered.api.world.gen.populator

Interface BlockBlob

All Superinterfaces:

Populator

public interface BlockBlob
extends Populator

Represents a populator which places in a number of 'blobs' of a specific block state. The 'blob' is here defined as the union of three ellipsoids whose radii are set randomly between the base radius (inclusive) and the base radius plus the variance (exclusive).

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static BlockBlob.Builder	builder() Creates a new BlockBlob.Builder to build a BlockBlob populator.
BlockState	getBlock() Gets the BlockState that this populator will place down to form the blob.
VariableAmount	getCount() Gets the number of blobs which will be placed per chunk.
VariableAmount	getRadius() Gets the radius of the area for the blob.
void	setBlock(BlockState state) Sets the BlockState that this populator will place down to form the blob.
default void	setCount(int count) Sets the number of blobs to spawn per chunk, must be greater than zero.
void	setCount(VariableAmount count) Sets the number of blobs to spawn per chunk, must be greater than zero.
default void	setRadius(double radius) Sets the radius of the area for the blob, cannot be negative.
void	setRadius(VariableAmount radius) Sets the radius of the area for the blob, cannot be negative.

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

getType, populate, populate

Method Detail

builder

static BlockBlob.Builder builder()

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

Returns:

The new builder

getBlock

BlockState getBlock()

Gets the BlockState that this populator will place down to form the blob.

Returns:

The block state

setBlock

void setBlock(BlockState state)

Sets the BlockState that this populator will place down to form the blob.

Parameters:

state - The new block state

getRadius

VariableAmount getRadius()

Gets the radius of the area for the blob.

Returns:

The radius

setRadius

void setRadius(VariableAmount radius)

Sets the radius of the area for the blob, cannot be negative.

Parameters:

radius - The new radius

setRadius

default void setRadius(double radius)

Sets the radius of the area for the blob, cannot be negative.

Parameters:

radius - The new radius

getCount

VariableAmount getCount()

Gets the number of blobs which will be placed per chunk.

Returns:

The number of blobs

setCount

void setCount(VariableAmount count)

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

Parameters:

count - The new number of blobs

setCount

default void setCount(int count)

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

Parameters:

count - The new number of blobs