org.spongepowered.api.world.gen.populator

Interface Dungeon.Builder

All Superinterfaces:

ResettableBuilder<Dungeon,Dungeon.Builder>

Enclosing interface:

Dungeon

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

A builder for constructing Dungeon populators.

Method Summary

Modifier and Type	Method and Description
default Dungeon.Builder	attempts(int attempts) Sets the number of attempts at randomly spawning a generator per chunk.
Dungeon.Builder	attempts(VariableAmount attempts) Sets the number of attempts at randomly spawning a generator per chunk.
Dungeon	build() Builds a new instance of a Dungeon populator with the settings set within the builder.
Dungeon.Builder	choices(WeightedTable<EntityArchetype> choices) Sets the possible EntityArchetypes that could be spawned.
Dungeon.Builder	mobSpawnerData(MobSpawnerData data) Sets MobSpawnerData that will be used to create the spawner within the dungeon.
Dungeon.Builder	possibleItems(LootTable<ItemStackSnapshot> items) Defines a LootTable of ItemStackSnapshots from which items will be randomly selected based on weight in order to calculate the contents of chests placed within the dungeon.

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

from, reset

Method Detail

attempts

Dungeon.Builder attempts(VariableAmount attempts)

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

Parameters:

attempts - The new number of attempts

Returns:

This builder, for chaining

attempts

default Dungeon.Builder attempts(int attempts)

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

Parameters:

attempts - The new number of attempts

Returns:

This builder, for chaining

mobSpawnerData

Dungeon.Builder mobSpawnerData(MobSpawnerData data)

Sets MobSpawnerData that 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

Returns:

This builder, for chaining

choices

Dungeon.Builder choices(@Nullable
                        WeightedTable<EntityArchetype> choices)

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

To use the default set of choices, pass null instead of a table.

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

Parameters:

choices - Weighted table of possible types

Returns:

This builder, for chaining

possibleItems

Dungeon.Builder possibleItems(LootTable<ItemStackSnapshot> items)

Defines a LootTable of ItemStackSnapshots from which items will be randomly selected based on weight in order to calculate the contents of chests placed within the dungeon.

Parameters:

items - The possible items

Returns:

This builder, for chaining

build

Dungeon build()
       throws IllegalStateException

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