org.spongepowered.api.world.gen.populator

Interface DesertWell

All Superinterfaces:

Populator

public interface DesertWell
extends Populator

Represents a populator which spawns desert wells. The wells will be created according to the spawn probability of getSpawnProbability() and if the spawn conditions are met (that the block its spawning on is sand).

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static DesertWell.Builder	builder() Creates a new DesertWell.Builder to build a DesertWell populator.
double	getSpawnProbability() Gets the probability of a desert well spawning.
PopulatorObject	getWellObject() Gets the PopulatorObject representing the well.
void	setSpawnProbability(double p) Sets the probability of a desert well spawning.
void	setWellObject(PopulatorObject obj) Sets the PopulatorObject representing the well.

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

getType, populate, populate

Method Detail

builder

static DesertWell.Builder builder()

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

Returns:

The new builder

getSpawnProbability

double getSpawnProbability()

Gets the probability of a desert well spawning.

Returns:

The spawn chance of a well

setSpawnProbability

void setSpawnProbability(double p)

Sets the probability of a desert well spawning.

Parameters:

p - The new spawn probability

getWellObject

PopulatorObject getWellObject()

Gets the PopulatorObject representing the well.

Returns:

The populator object

setWellObject

void setWellObject(PopulatorObject obj)

Sets the PopulatorObject representing the well.

Parameters:

obj - The new populator object