org.spongepowered.api.world

Interface WorldArchetype

All Superinterfaces:

CatalogType

@CatalogedBy(value=WorldArchetypes.class)
public interface WorldArchetype
extends CatalogType

A representation of the settings which define a World for creation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	WorldArchetype.Builder

Method Summary

Modifier and Type	Method and Description
boolean	areCommandsAllowed() Gets whether commands are allowed.
static WorldArchetype.Builder	builder() Gets a new Builder instance for WorldArchetype.
boolean	doesGenerateBonusChest() Gets whether the bonus chest should be generated.
boolean	doesGenerateSpawnOnLoad() Gets whether spawn chunks will generate on load.
boolean	doesKeepSpawnLoaded() Gets whether spawn chunks remain loaded when no players are present.
Difficulty	getDifficulty() Gets the difficulty.
DimensionType	getDimensionType() Gets the dimension type.
GameMode	getGameMode() Gets the gamemode.
Collection<WorldGeneratorModifier>	getGeneratorModifiers() Gets an immutable collection of the world generator modifiers.
DataContainer	getGeneratorSettings() Gets a DataContainer of any extra settings required by the generator.
GeneratorType	getGeneratorType() Gets the generator type.
PortalAgentType	getPortalAgentType() Gets the PortalAgentType for the world.
long	getSeed() Gets the seed.
SerializationBehavior	getSerializationBehavior() Gets the SerializationBehavior that worlds built from this will use.
boolean	isEnabled() Gets enabled status.
boolean	isHardcore() Gets whether hardcore mode is enabled.
boolean	isPVPEnabled() Gets whether PVP combat is enabled.
boolean	isSeedRandomized() Gets if the seed will be randomized for each world generated.
boolean	loadOnStartup() Gets whether to load when the server starts.
boolean	usesMapFeatures() Gets whether map features are enabled.

Methods inherited from interface org.spongepowered.api.CatalogType

getId, getName

Method Detail

builder

static WorldArchetype.Builder builder()

Gets a new Builder instance for WorldArchetype.

Returns:

A new builder instance

isEnabled

boolean isEnabled()

Gets 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) .

Returns:

True if enabled, false if not

loadOnStartup

boolean loadOnStartup()

Gets whether to load when the server starts.

Returns:

True to load when server starts, false if not

doesKeepSpawnLoaded

boolean doesKeepSpawnLoaded()

Gets whether spawn chunks remain loaded when no players are present.

Returns:

True to keep spawn chunks loaded, false if not

doesGenerateSpawnOnLoad

boolean doesGenerateSpawnOnLoad()

Gets whether spawn chunks will generate on load.

Returns:

True to generate spawn on load, false if not

getSeed

long getSeed()

Gets the seed.

Returns:

The seed

isSeedRandomized

boolean isSeedRandomized()

Gets if the seed will be randomized for each world generated.

Returns:

If the seed is randomized

getGameMode

GameMode getGameMode()

Gets the gamemode.

Returns:

The gamemode

getGeneratorType

GeneratorType getGeneratorType()

Gets the generator type.

Returns:

The generator type

getGeneratorModifiers

Collection<WorldGeneratorModifier> getGeneratorModifiers()

Gets an immutable collection of the world generator modifiers.

Returns:

The modifiers

usesMapFeatures

boolean usesMapFeatures()

Gets whether map features are enabled.

Examples include Villages, Temples, etc.

Returns:

True if map features are enabled, false if not

isHardcore

boolean isHardcore()

Gets whether hardcore mode is enabled.

Returns:

True if hardcore mode is enabled, false if not

areCommandsAllowed

boolean areCommandsAllowed()

Gets whether commands are allowed.

Returns:

True if commands are allowed, false if not

doesGenerateBonusChest

boolean doesGenerateBonusChest()

Gets whether the bonus chest should be generated.

This only applies on the initial load of the World created via the WorldProperties created from this settings.

Returns:

True if bonus chest is generated, false if not

getDimensionType

DimensionType getDimensionType()

Gets the dimension type.

Returns:

The dimension type

getPortalAgentType

PortalAgentType getPortalAgentType()

Gets the PortalAgentType for the world.

Returns:

The portal agent type

getDifficulty

Difficulty getDifficulty()

Gets the difficulty.

Returns:

The difficulty

isPVPEnabled

boolean isPVPEnabled()

Gets whether PVP combat is enabled.

Returns:

True if PVP combat is enabled, false if not

getGeneratorSettings

DataContainer getGeneratorSettings()

Gets a DataContainer of any extra settings required by the generator.

Returns:

The generator settings

getSerializationBehavior

SerializationBehavior getSerializationBehavior()

Gets the SerializationBehavior that worlds built from this will use.

Returns:

The serialization mode