org.spongepowered.api.world.gen.populator

Interface RandomObject.Builder

All Superinterfaces:

ResettableBuilder<RandomObject,RandomObject.Builder>

Enclosing interface:

RandomObject

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

A builder for constructing RandomBlock populators.

Method Summary

Modifier and Type	Method and Description
RandomObject	build() Builds a new instance of a RandomBlock populator with the settings set within the builder.
RandomObject.Builder	height(VariableAmount height) Sets the height range that the object will be placed within.
RandomObject.Builder	object(PopulatorObject obj) Sets the PopulatorObject for the populator to attempt to place.
default RandomObject.Builder	perChunk(int count) Sets the number of fires to attempt to spawn per chunk, must be greater than zero.
RandomObject.Builder	perChunk(VariableAmount count) Sets the number of fires to attempt to spawn per chunk, must be greater than zero.
RandomObject.Builder	spawnChance(double chance) Sets the chance of spawning the object for each attempt.

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

from, reset

Method Detail

perChunk

RandomObject.Builder perChunk(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

Returns:

This builder, for chaining

perChunk

default RandomObject.Builder perChunk(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

Returns:

This builder, for chaining

height

RandomObject.Builder height(VariableAmount height)

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

Parameters:

height - The new height range

Returns:

This builder, for chaining

object

RandomObject.Builder object(PopulatorObject obj)

Sets the PopulatorObject for the populator to attempt to place.

Parameters:

obj - The new populator object

Returns:

This builder, for chaining

spawnChance

RandomObject.Builder spawnChance(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

Returns:

This builder, for chaining

build

RandomObject build()
            throws IllegalStateException

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