org.spongepowered.api.world.gen.populator

Interface Dungeon

All Superinterfaces:

Populator

public interface Dungeon
extends Populator

Represents a Populator which places 'Dungeon's randomly underground. Each dungeon has some associated MobSpawnerData, and data regarding the contents of any chests generated within the dungeon.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static Dungeon.Builder	builder() Creates a new Dungeon.Builder to build a Dungeon populator.
VariableAmount	getAttemptsPerChunk() Gets the number of attempts at randomly spawning a generator per chunk.
Optional<WeightedTable<EntityArchetype>>	getChoices() Gets a weighted collection of possible EntityArchetypes that could be spawned.
Optional<MobSpawnerData>	getMobSpawnerData() Gets the MobSpawnerData which represents the MobSpawner which will be created within the dungeon.
LootTable<ItemStackSnapshot>	getPossibleContents() Gets a mutable weighted collection of possible contents of the chests.
default void	setAttemptsPerChunk(int attempts) Sets the number of attempts at randomly spawning a generator per chunk.
void	setAttemptsPerChunk(VariableAmount attempts) Sets the number of attempts at randomly spawning a generator per chunk.
void	setChoices(WeightedTable<EntityArchetype> choices) Sets the possible EntityArchetypes that could be spawned.
void	setMobSpawnerData(MobSpawnerData data) Sets MobSpawnerData which will be used to create the spawner within the dungeon.

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

getType, populate, populate

Method Detail

builder

static Dungeon.Builder builder()

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

Returns:

The new builder

getAttemptsPerChunk

VariableAmount getAttemptsPerChunk()

Gets the number of attempts at randomly spawning a generator per chunk.

Returns:

The number of attempts

setAttemptsPerChunk

void setAttemptsPerChunk(VariableAmount attempts)

Sets the number of attempts at randomly spawning a generator per chunk.

Parameters:

attempts - The new number of attempts

setAttemptsPerChunk

default void setAttemptsPerChunk(int attempts)

Sets the number of attempts at randomly spawning a generator per chunk.

Parameters:

attempts - The new number of attempts

getMobSpawnerData

Optional<MobSpawnerData> getMobSpawnerData()

Gets the MobSpawnerData which represents the MobSpawner which will be created within the dungeon.

Note: Only one of choices or mob spawner data will be present.

Returns:

The mob spawner data, if present

setMobSpawnerData

void setMobSpawnerData(MobSpawnerData data)

Sets MobSpawnerData which will be used to create the spawner within the dungeon.

Note: Only one of choices or mob spawner data will be present.

Parameters:

data - MobSpawnerData to use

getChoices

Optional<WeightedTable<EntityArchetype>> getChoices()

Gets a weighted collection of possible EntityArchetypes that could be spawned. One type is chosen when creating the dungeon, for more complex spawners see getMobSpawnerData().

Note: Only one of choices or mob spawner data will be present.

Returns:

Weighted table of possible types, if present

setChoices

void setChoices(WeightedTable<EntityArchetype> choices)

Sets the possible EntityArchetypes that could be spawned. One type is chosen when creating the dungeon, for more complex spawners see setMobSpawnerData(MobSpawnerData)

Note: Only one of choices or mob spawner data will be present.

Parameters:

choices - Weighted table of possible types

getPossibleContents

LootTable<ItemStackSnapshot> getPossibleContents()

Gets a mutable weighted collection of possible contents of the chests. Items will be randomly selected from this list based on weight in order to calculate the contents of chests placed within the dungeon.

Returns:

The contents list