org.spongepowered.api.world.gen.populator

Interface RandomObject

All Superinterfaces:

Populator

public interface RandomObject
extends Populator

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static RandomObject.Builder	builder() Creates a new RandomObject.Builder to build a RandomObject populator.
VariableAmount	getAttemptsPerChunk() Gets the number of fires to attempt to spawn per chunk, must be greater than zero.
VariableAmount	getHeightRange() Gets the height range that the object will be placed within.
PopulatorObject	getObject() Gets the PopulatorObject that this populator will attempt to place.
double	getSpawnChance() Gets the chance of spawning the object for each attempt.
default void	setAttemptsPerChunk(int count) Sets the number of fires to attempt to spawn per chunk, must be greater than zero.
void	setAttemptsPerChunk(VariableAmount count) Sets the number of fires to attempt to spawn per chunk, must be greater than zero.
void	setHeightRange(VariableAmount height) Sets the height range that the object will be placed within.
void	setObject(PopulatorObject obj) Sets the PopulatorObject for this populator to attempt to place.
void	setSpawnChance(double chance) Sets the chance of spawning the object for each attempt.

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

getType, populate, populate

Method Detail

builder

static RandomObject.Builder builder()

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

Returns:

The new builder

getAttemptsPerChunk

VariableAmount getAttemptsPerChunk()

Gets the number of fires 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 fires 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 fires to attempt to spawn per chunk, must be greater than zero.

Parameters:

count - The new number to spawn

getHeightRange

VariableAmount getHeightRange()

Gets the height range that the object will be placed within.

Returns:

The height range

setHeightRange

void setHeightRange(VariableAmount height)

Sets the height range that the object will be placed within.

Parameters:

height - The new height range

getObject

PopulatorObject getObject()

Gets the PopulatorObject that this populator will attempt to place.

Returns:

The populator object

setObject

void setObject(PopulatorObject obj)

Sets the PopulatorObject for this populator to attempt to place.

Parameters:

obj - The new populator object

getSpawnChance

double getSpawnChance()

Gets the chance of spawning the object for each attempt. This chance is applied before the checks for if the placement is valid. This value must be between zero and one (inclusive) with a chance of zero representing no chance of the object being placed, and a chance of 1 representing a 100% chance of the object being placed.

Returns:

The spawn chance

setSpawnChance

void setSpawnChance(double chance)

Sets the chance of spawning the object for each attempt. This chance is applied before the checks for if the placement is valid. This value must be between zero and one (inclusive) with a chance of zero representing no chance of the object being placed, and a chance of 1 representing a 100% chance of the object being placed.

Parameters:

chance - The new spawn chance