net.tridentsdk.world.settings

Class WorldCreateOptions

java.lang.Object

net.tridentsdk.world.settings.WorldCreateOptions

public final class WorldCreateOptions
extends Object

World settings which are applied when a world is created by a worldloader

Author:

The TridentSDK Team

Constructor Summary

Constructors

Constructor and Description
WorldCreateOptions()

Method Summary

Modifier and Type	Method and Description
boolean	allowPvp()
GameMode	defaultGameMode() Obtains the default gamemode of the world created using these options
Difficulty	difficulty() Obtains the difficulty of the world created using these options
WorldCreateOptions	difficulty(Difficulty difficulty) Sets the difficulty of the world to be generated
Dimension	dimension() Obtains the dimension of the world created using these options
WorldCreateOptions	dimension(Dimension dimension) Sets the dimension for the world generator
WorldCreateOptions	gameMode(GameMode gameMode) Sets the gamemode of the world to be generated
Map<GameRule,GameRule.Value>	gameRules()
boolean	generateStructures()
Class<? extends ChunkGenerator>	generator()
WorldCreateOptions	generator(Class<? extends ChunkGenerator> generator) Uses the specified generator to generate chunks in the world
boolean	isRule(GameRule rule, GameRule.Value value) Checks whether the rule is enabled
WorldCreateOptions	level(LevelType levelType) Sets the leveltype of the world to be generated
LevelType	levelType() Obtains the level type of the world created using these options
WorldCreateOptions	pvp(boolean enable) Sets the PvP enabled flag
WorldCreateOptions	rule(GameRule rule, GameRule.Value value) Sets the game rules of the world to be generated
long	seed()
WorldCreateOptions	seed(long seed) Sets the seed used to generate the world
WorldCreateOptions	seed(String seed) Sets the seed used to generate the world
WorldCreateOptions	structures(boolean gen) Sets whether or not to generate structures (caves, villages, etc)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorldCreateOptions

public WorldCreateOptions()

Method Detail

dimension

public WorldCreateOptions dimension(Dimension dimension)

Sets the dimension for the world generator

Parameters:

dimension - the dimension

Returns:

the current instance

difficulty

public WorldCreateOptions difficulty(Difficulty difficulty)

Sets the difficulty of the world to be generated

Parameters:

difficulty - the difficulty

Returns:

the the current instance

gameMode

public WorldCreateOptions gameMode(GameMode gameMode)

Sets the gamemode of the world to be generated

Parameters:

gameMode - the gamemode

Returns:

the current instance

level

public WorldCreateOptions level(LevelType levelType)

Sets the leveltype of the world to be generated

Parameters:

levelType - the leveltype

Returns:

the current instance

rule

public WorldCreateOptions rule(GameRule rule,
                               GameRule.Value value)

Sets the game rules of the world to be generated

Parameters:

rule - the game rule to add

value - the game rule's parameter value

Returns:

the current instance

structures

public WorldCreateOptions structures(boolean gen)

Sets whether or not to generate structures (caves, villages, etc)

Parameters:

gen - true to generate structures

Returns:

the current instance

pvp

public WorldCreateOptions pvp(boolean enable)

Sets the PvP enabled flag

Parameters:

enable - true to allow pvp

Returns:

the current instance

generator

public WorldCreateOptions generator(Class<? extends ChunkGenerator> generator)

Uses the specified generator to generate chunks in the world

Parameters:

generator - the generator to use

Returns:

the current instance

seed

public WorldCreateOptions seed(String seed)

Sets the seed used to generate the world

Parameters:

seed - the seed used to generate the world

Returns:

the current instance

seed

public WorldCreateOptions seed(long seed)

Sets the seed used to generate the world

Parameters:

seed - the seed used to generate the world

Returns:

the current instance

dimension

public Dimension dimension()

Obtains the dimension of the world created using these options

Returns:

the world's dimension

difficulty

public Difficulty difficulty()

Obtains the difficulty of the world created using these options

Returns:

the world's difficulty

defaultGameMode

public GameMode defaultGameMode()

Obtains the default gamemode of the world created using these options

Returns:

the game mode

levelType

public LevelType levelType()

Obtains the level type of the world created using these options

Returns:

the level type of the world

isRule

public boolean isRule(GameRule rule,
                      GameRule.Value value)

Checks whether the rule is enabled

Parameters:

rule - the game rule

Returns:

true if the game rule is equal to the provided argument

gameRules

public Map<GameRule,GameRule.Value> gameRules()

generateStructures

public boolean generateStructures()

allowPvp

public boolean allowPvp()

generator

public Class<? extends ChunkGenerator> generator()

seed

public long seed()