org.spongepowered.api.world

Interface WorldArchetype.Builder

All Superinterfaces:

ResettableBuilder<WorldArchetype,WorldArchetype.Builder>

Enclosing interface:

WorldArchetype

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

Method Summary

Modifier and Type	Method and Description
WorldArchetype	build(String id, String name) Builds the WorldArchetype which can be used to create a World in Server.createWorldProperties(String, WorldArchetype).
WorldArchetype.Builder	commandsAllowed(boolean state) Sets whether commands are allowed to be executed.
WorldArchetype.Builder	difficulty(Difficulty difficulty) Sets the difficulty.
WorldArchetype.Builder	dimension(DimensionType type) Sets the dimension type.
WorldArchetype.Builder	enabled(boolean state) Sets enabled status.
WorldArchetype.Builder	from(WorldProperties properties) Fills this WorldArchetype.Builder for creating WorldArchetypes, the builder is then seeded with the values from the given WorldProperties object.
WorldArchetype.Builder	gameMode(GameMode gameMode) Sets the default GameMode.
WorldArchetype.Builder	generateBonusChest(boolean state) Sets whether the bonus chest should be created.
WorldArchetype.Builder	generateSpawnOnLoad(boolean state) Sets whether the spawn chunks generate on load.
WorldArchetype.Builder	generator(GeneratorType type) Sets the generator type.
WorldArchetype.Builder	generatorModifiers(WorldGeneratorModifier... modifier) Sets the generator modifiers.
WorldArchetype.Builder	generatorSettings(DataContainer settings) Sets any extra settings required by the GeneratorType or by the WorldGeneratorModifiers.
WorldArchetype.Builder	hardcore(boolean state) Sets whether hardcore mode is enabled.
WorldArchetype.Builder	keepsSpawnLoaded(boolean state) Sets whether the spawn chunks should remain loaded when no players are present.
WorldArchetype.Builder	loadsOnStartup(boolean state) Sets whether to load when the server starts.
WorldArchetype.Builder	portalAgent(PortalAgentType type) Sets the desired PortalAgentType for the world.
WorldArchetype.Builder	pvp(boolean state) Sets whether PVP combat is enabled in this world.
WorldArchetype.Builder	randomSeed() Sets the seed to be randomized for each world created.
WorldArchetype.Builder	seed(long seed) Sets the seed.
WorldArchetype.Builder	serializationBehavior(SerializationBehavior behavior) Sets the serialization behavior that will be used when saving.
WorldArchetype.Builder	usesMapFeatures(boolean state) Sets whether this should generate map features such as villages and strongholds.

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

from, reset

Method Detail

enabled

WorldArchetype.Builder enabled(boolean state)

Sets enabled status. Built worlds who are enabled but unloaded may be loaded automatically if an attempt is made to transfer an entity to the world using Entity.transferToWorld(org.spongepowered.api.world.World) .

Parameters:

state - Should be enabled

Returns:

The builder, for chaining

loadsOnStartup

WorldArchetype.Builder loadsOnStartup(boolean state)

Sets whether to load when the server starts.

Parameters:

state - Should load on startup

Returns:

The builder, for chaining

keepsSpawnLoaded

WorldArchetype.Builder keepsSpawnLoaded(boolean state)

Sets whether the spawn chunks should remain loaded when no players are present.

Parameters:

state - Should keep spawn loaded

Returns:

The builder, for chaining

generateSpawnOnLoad

WorldArchetype.Builder generateSpawnOnLoad(boolean state)

Sets whether the spawn chunks generate on load.

Parameters:

state - Should generate spawn chunks on load

Returns:

The builder, for chaining

seed

WorldArchetype.Builder seed(long seed)

Sets the seed. See randomSeed() if a random seed is desired.

Parameters:

seed - The seed

Returns:

The builder, for chaining

randomSeed

WorldArchetype.Builder randomSeed()

Sets the seed to be randomized for each world created.

Returns:

The builder, for chaining

gameMode

WorldArchetype.Builder gameMode(GameMode gameMode)

Sets the default GameMode. If not specified this will default to GameModes.SURVIVAL.

Parameters:

gameMode - The gamemode

Returns:

The builder, for chaining

generator

WorldArchetype.Builder generator(GeneratorType type)

Sets the generator type. If not specified this will default to GeneratorTypes.DEFAULT

Parameters:

type - The type

Returns:

The builder, for chaining

generatorModifiers

WorldArchetype.Builder generatorModifiers(WorldGeneratorModifier... modifier)

Sets the generator modifiers.

Parameters:

modifier - The modifiers

Returns:

The builder, for chaining

Throws:

IllegalArgumentException - If one of the modifiers is not registered in GameRegistry.

dimension

WorldArchetype.Builder dimension(DimensionType type)

Sets the dimension type.

Parameters:

type - The type

Returns:

The builder, for chaining

difficulty

WorldArchetype.Builder difficulty(Difficulty difficulty)

Sets the difficulty.

Parameters:

difficulty - The difficulty

Returns:

The builder, for chaining

usesMapFeatures

WorldArchetype.Builder usesMapFeatures(boolean state)

Sets whether this should generate map features such as villages and strongholds. If not specified this will default to true.

Parameters:

state - Are map features enabled

Returns:

The builder, for chaining

hardcore

WorldArchetype.Builder hardcore(boolean state)

Sets whether hardcore mode is enabled. On servers this will cause players to be banned upon death, on clients the world will be deleted! If not specified this will default to false.

Parameters:

state - Is hardcore mode enabled

Returns:

The builder, for chaining

generatorSettings

WorldArchetype.Builder generatorSettings(DataContainer settings)

Sets any extra settings required by the GeneratorType or by the WorldGeneratorModifiers. If not specified these will default to the settings within GeneratorType.getGeneratorSettings().

Parameters:

settings - The generator settings

Returns:

The builder, for chaining

portalAgent

WorldArchetype.Builder portalAgent(PortalAgentType type)

Sets the desired PortalAgentType for the world.

Parameters:

type - The type

Returns:

This builder, for chaining

pvp

WorldArchetype.Builder pvp(boolean state)

Sets whether PVP combat is enabled in this world.

Parameters:

state - Whether PVP is enabled

Returns:

The builder, for chaining

commandsAllowed

WorldArchetype.Builder commandsAllowed(boolean state)

Sets whether commands are allowed to be executed.

Parameters:

state - Whether commands are allowed

Returns:

The builder, for chaining

generateBonusChest

WorldArchetype.Builder generateBonusChest(boolean state)

Sets whether the bonus chest should be created.

Parameters:

state - Whether bonus chest is enabled

Returns:

The builder, for chaining

serializationBehavior

WorldArchetype.Builder serializationBehavior(SerializationBehavior behavior)

Sets the serialization behavior that will be used when saving.

Parameters:

behavior - The serialization behavior

Returns:

This builder, for chaining

from

WorldArchetype.Builder from(WorldProperties properties)

Fills this WorldArchetype.Builder for creating WorldArchetypes, the builder is then seeded with the values from the given WorldProperties object.

Parameters:

properties - The seed properties

Returns:

A new seeded builder

build

WorldArchetype build(String id,
                     String name)
              throws IllegalArgumentException,
                     CatalogTypeAlreadyRegisteredException

Builds the WorldArchetype which can be used to create a World in Server.createWorldProperties(String, WorldArchetype).

This will also register the settings as a new type in the GameRegistry.

Parameters:

id - The id that this settings will be registered under

name - The human readable name of this settings

Returns:

The settings

Throws:

IllegalArgumentException

CatalogTypeAlreadyRegisteredException