WorldProperties (SpongeAPI 7.3.0 API)

All Superinterfaces:

DataSerializable
```
public interface WorldProperties
extends DataSerializable
```
Represents the properties of a World which are persisted across runtime instances.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`areCommandsAllowed()` Gets whether commands are allowed within this world.
`boolean`	`doesGenerateBonusChest()` Gets whether the bonus chest should be generated.
`boolean`	`doesGenerateSpawnOnLoad()` Gets whether spawn chunks of this world will generate on load.
`boolean`	`doesKeepSpawnLoaded()` Gets whether spawn chunks of this world remain loaded when no players are present.
`DataContainer`	`getAdditionalProperties()` Gets a `DataContainer` containing any additional properties for this world.
`Difficulty`	`getDifficulty()` Gets the difficulty of this world.
`DimensionType`	`getDimensionType()` Gets the `DimensionType` of this world.
`GameMode`	`getGameMode()` Gets the default `GameMode` of this world.
`Optional<String>`	`getGameRule(String gameRule)` Gets the specified GameRule value.
`Map<String,String>`	`getGameRules()` Gets a map of the currently set game rules and their values.
`Collection<WorldGeneratorModifier>`	`getGeneratorModifiers()` Gets an immutable collection of the world generator modifiers currently in use.
`DataContainer`	`getGeneratorSettings()` Gets the generator settings.
`GeneratorType`	`getGeneratorType()` Gets the `GeneratorType` of this world.
`PortalAgentType`	`getPortalAgentType()` Gets the `PortalAgentType` for the world.
`Optional<DataView>`	`getPropertySection(DataQuery path)` Gets a section of the additional properties returned by `getAdditionalProperties()`.
`int`	`getRainTime()` Gets the number of ticks until the weather is next toggled to a new random value.
`long`	`getSeed()` Gets the seed of this world.
`SerializationBehavior`	`getSerializationBehavior()` Gets the `SerializationBehavior` in use.
`com.flowpowered.math.vector.Vector3i`	`getSpawnPosition()` Gets the default spawn position of this world.
`int`	`getThunderTime()` Gets the number of ticks until the `isThundering()` state is toggled to a new random value.
`long`	`getTotalTime()` Gets the number of ticks which have occurred since the world was created.
`UUID`	`getUniqueId()` Gets the `UUID` of the world.
`com.flowpowered.math.vector.Vector3d`	`getWorldBorderCenter()` Gets the center of the world border.
`double`	`getWorldBorderDamageAmount()` Gets the damage done to a player per block per tick when outside the buffer.
`double`	`getWorldBorderDamageThreshold()` Gets the distance a player may be outside the world border before taking damage.
`double`	`getWorldBorderDiameter()` Gets the diameter of the world border.
`double`	`getWorldBorderTargetDiameter()` Gets the diameter the world border is expanding or contracting to.
`long`	`getWorldBorderTimeRemaining()` Gets the time remaining until the world border stops expanding or contracting.
`int`	`getWorldBorderWarningDistance()` Gets the distance when a contracting world border will warn a player for whom the world border is `distance` blocks away.
`int`	`getWorldBorderWarningTime()` Gets the time when a contracting world border will warn a player for whom the world border will reach in `time` seconds.
`String`	`getWorldName()` Gets the name of this world.
`long`	`getWorldTime()` Gets the time of day, in ticks.
`boolean`	`isEnabled()` Gets whether this world is enabled.
`boolean`	`isHardcore()` Gets whether this world is set to hardcore mode.
`boolean`	`isInitialized()` Gets whether this world has been initialized.
`boolean`	`isPVPEnabled()` Gets whether PVP combat is enabled in this world.
`boolean`	`isRaining()` Gets whether this world is currently experiencing rain/snow/cloud-cover (depending on the biome of a specific location).
`boolean`	`isThundering()` Gets whether this world is currently experiencing a lightning storm.
`boolean`	`loadOnStartup()` Gets whether this world will load when the server starts up.
`boolean`	`removeGameRule(String gameRule)` Removes custom GameRule.
`void`	`setCommandsAllowed(boolean state)` Sets whether commands are allowed within this world.
`void`	`setDifficulty(Difficulty difficulty)` Sets the difficulty of this world.
`void`	`setEnabled(boolean state)` Sets this world as enabled.
`void`	`setGameMode(GameMode gamemode)` Sets the default `GameMode` of this world.
`void`	`setGameRule(String gameRule, String value)` Sets the specified GameRule value.
`void`	`setGenerateSpawnOnLoad(boolean state)` Sets whether the spawn chunks of the world will generate on load.
`void`	`setGeneratorModifiers(Collection<WorldGeneratorModifier> modifiers)` Sets the given world generator modifiers to be used.
`void`	`setGeneratorType(GeneratorType type)` Sets the `GeneratorType` of this world.
`void`	`setHardcore(boolean state)` Sets whether this world is set to hardcore mode.
`void`	`setKeepSpawnLoaded(boolean state)` Sets whether the spawn chunks of the world should remain loaded when no players are present.
`void`	`setLoadOnStartup(boolean state)` Sets whether this world should load when the server starts up.
`void`	`setMapFeaturesEnabled(boolean state)` Sets whether this world will generate map features such as villages and strongholds.
`void`	`setPropertySection(DataQuery path, DataView data)` Sets a path within the additional data to the given `DataView`.
`void`	`setPVPEnabled(boolean enabled)` Sets whether PVP combat is enabled in this world.
`void`	`setRaining(boolean state)` Sets whether this world is currently experiencing rain/snow/cloud-cover (depending on the biome of a specific location).
`void`	`setRainTime(int time)` Sets the number of ticks until the weather is next toggled to a new random value.
`void`	`setSeed(long seed)` Sets the seed of this world.
`void`	`setSerializationBehavior(SerializationBehavior behavior)` Sets the `SerializationBehavior` for use.
`void`	`setSpawnPosition(com.flowpowered.math.vector.Vector3i position)` Sets the default spawn position of this world.
`void`	`setThundering(boolean state)` Sets whether this world is currently experiencing a lightning storm.
`void`	`setThunderTime(int time)` Sets the number of ticks until the `isThundering()` state is toggled to a new random value.
`void`	`setWorldBorderCenter(double x, double z)` Sets the center of the world border.
`void`	`setWorldBorderDamageAmount(double damage)` Sets the damage done to a player per block per tick when outside the buffer.
`void`	`setWorldBorderDamageThreshold(double distance)` Sets the distance a player may be be outside the world border before taking damage.
`void`	`setWorldBorderDiameter(double diameter)` Sets the diameter of the world border.
`void`	`setWorldBorderTargetDiameter(double diameter)` Sets the target diameter of the world border.
`void`	`setWorldBorderTimeRemaining(long time)` Sets the time remaining until the world border stops expanding or contracting.
`void`	`setWorldBorderWarningDistance(int distance)` Sets the distance when a contracting world border will warn a player for whom the world border is `distance` blocks away.
`void`	`setWorldBorderWarningTime(int time)` Sets the time when a contracting world border will warn a player for whom the world border will reach in `time` seconds.
`void`	`setWorldTime(long time)` Sets the time of day, in ticks.
`boolean`	`usesMapFeatures()` Gets whether this world will generate map features such as villages and strongholds.

Methods inherited from interface org.spongepowered.api.data.DataSerializable
getContentVersion, toContainer

- Method Detail
  - isInitialized
```
boolean isInitialized()
```
    Gets whether this world has been initialized.
    
    Returns:
    
    Is initialized
  - getWorldName
```
String getWorldName()
```
    Gets the name of this world.
    
    Returns:
    
    The name
  - getUniqueId
```
UUID getUniqueId()
```
    Gets the UUID of the world.
    
    Returns:
    
    The unique Id
  - isEnabled
```
boolean isEnabled()
```
    Gets whether this world is enabled. A world which is 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:
    
    Is enabled
  - setEnabled
```
void setEnabled(boolean state)
```
    Sets this world as enabled. A world which is 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 - The new state
  - loadOnStartup
```
boolean loadOnStartup()
```
    Gets whether this world will load when the server starts up.
    
    Returns:
    
    Loads on startup
  - setLoadOnStartup
```
void setLoadOnStartup(boolean state)
```
    Sets whether this world should load when the server starts up.
    
    Parameters:
    
    state - Should load on startup
  - doesKeepSpawnLoaded
```
boolean doesKeepSpawnLoaded()
```
    Gets whether spawn chunks of this world remain loaded when no players are present.
    
    Returns:
    
    True if spawn chunks of this world remain loaded without players, false if not
  - setKeepSpawnLoaded
```
void setKeepSpawnLoaded(boolean state)
```
    Sets whether the spawn chunks of the world should remain loaded when no players are present.
    
    Parameters:
    
    state - Should keep spawn loaded
  - doesGenerateSpawnOnLoad
```
boolean doesGenerateSpawnOnLoad()
```
    Gets whether spawn chunks of this world will generate on load.
    
    Returns:
    
    True if spawn chunks of this world generate on load.
  - setGenerateSpawnOnLoad
```
void setGenerateSpawnOnLoad(boolean state)
```
    Sets whether the spawn chunks of the world will generate on load.
    
    Parameters:
    
    state - Should generate spawn chunks on load.
  - getSpawnPosition
```
com.flowpowered.math.vector.Vector3i getSpawnPosition()
```
    Gets the default spawn position of this world.
    
    Returns:
    
    The spawn position
  - setSpawnPosition
```
void setSpawnPosition(com.flowpowered.math.vector.Vector3i position)
```
    Sets the default spawn position of this world.
    
    Parameters:
    
    position - The spawn position
  - getGeneratorType
```
GeneratorType getGeneratorType()
```
    Gets the GeneratorType of this world.
    
    Returns:
    
    The type
  - setGeneratorType
```
void setGeneratorType(GeneratorType type)
```
    Sets the GeneratorType of this world.
    
    Parameters:
    
    type - The generator type
  - getSeed
```
long getSeed()
```
    Gets the seed of this world.
    
    Returns:
    
    The seed
  - setSeed
```
void setSeed(long seed)
```
    Sets the seed of this world.
    Warning: this may cause the edge of currently generated chunks to no longer align with newly generated chunks.
    
    Parameters:
    
    seed - The new world seed
  - getTotalTime
```
long getTotalTime()
```
    Gets the number of ticks which have occurred since the world was created.
    
    Returns:
    
    The total time in ticks
  - getWorldTime
```
long getWorldTime()
```
    Gets the time of day, in ticks. The total number of ticks in a day is 24000, however this value does not reset to zero at the start of each day but rather keeps counting passed 24000.
    
    Returns:
    
    The time of day
  - setWorldTime
```
void setWorldTime(long time)
```
    Sets the time of day, in ticks. The total number of ticks in a day is 24000, however this value does not reset to zero at the start of each day but rather keeps counting passed 24000.
    
    Parameters:
    
    time - The time of day
  - getDimensionType
```
DimensionType getDimensionType()
```
    Gets the DimensionType of this world.
    
    Returns:
    
    The dimension type
  - getPortalAgentType
```
PortalAgentType getPortalAgentType()
```
    Gets the PortalAgentType for the world.
    
    Returns:
    
    The portal agent type
  - isPVPEnabled
```
boolean isPVPEnabled()
```
    Gets whether PVP combat is enabled in this world.
    
    Returns:
    
    Whether PVP is enabled
  - setPVPEnabled
```
void setPVPEnabled(boolean enabled)
```
    Sets whether PVP combat is enabled in this world.
    
    Parameters:
    
    enabled - Whether PVP is enabled
  - isRaining
```
boolean isRaining()
```
    Gets whether this world is currently experiencing rain/snow/cloud-cover (depending on the biome of a specific location).
    
    Returns:
    
    Is raining
  - setRaining
```
void setRaining(boolean state)
```
    Sets whether this world is currently experiencing rain/snow/cloud-cover (depending on the biome of a specific location).
    
    Parameters:
    
    state - Is raining
  - getRainTime
```
int getRainTime()
```
    Gets the number of ticks until the weather is next toggled to a new random value.
    
    Returns:
    
    The time until the weather changes
  - setRainTime
```
void setRainTime(int time)
```
    Sets the number of ticks until the weather is next toggled to a new random value.
    
    Parameters:
    
    time - The time until the weather changes
  - isThundering
```
boolean isThundering()
```
    Gets whether this world is currently experiencing a lightning storm.
    
    Returns:
    
    Is thundering
  - setThundering
```
void setThundering(boolean state)
```
    Sets whether this world is currently experiencing a lightning storm.
    
    Parameters:
    
    state - Is thundering
  - getThunderTime
```
int getThunderTime()
```
    Gets the number of ticks until the isThundering() state is toggled to a new random value.
    
    Returns:
    
    The time until the thundering state changes
  - setThunderTime
```
void setThunderTime(int time)
```
    Sets the number of ticks until the isThundering() state is toggled to a new random value.
    
    Parameters:
    
    time - The time until the thundering state changes
  - getGameMode
```
GameMode getGameMode()
```
    Gets the default GameMode of this world.
    
    Returns:
    
    The game mode
  - setGameMode
```
void setGameMode(GameMode gamemode)
```
    Sets the default GameMode of this world.
    
    Parameters:
    
    gamemode - The game mode
  - usesMapFeatures
```
boolean usesMapFeatures()
```
    Gets whether this world will generate map features such as villages and strongholds.
    
    Returns:
    
    Whether map features enabled
  - setMapFeaturesEnabled
```
void setMapFeaturesEnabled(boolean state)
```
    Sets whether this world will generate map features such as villages and strongholds.
    
    Parameters:
    
    state - Whether map features enabled
  - isHardcore
```
boolean isHardcore()
```
    Gets whether this world is set to hardcore mode.
    
    Returns:
    
    Is hardcore
  - setHardcore
```
void setHardcore(boolean state)
```
    Sets whether this world is set to hardcore mode.
    
    Parameters:
    
    state - Is hardcore
  - areCommandsAllowed
```
boolean areCommandsAllowed()
```
    Gets whether commands are allowed within this world. May not be respected when not in single player.
    
    Returns:
    
    Whether commands are allowed
  - setCommandsAllowed
```
void setCommandsAllowed(boolean state)
```
    Sets whether commands are allowed within this world. May not be respected when not in single player.
    
    Parameters:
    
    state - Whether commands are allowed
  - getDifficulty
```
Difficulty getDifficulty()
```
    Gets the difficulty of this world.
    
    Returns:
    
    The difficulty
  - setDifficulty
```
void setDifficulty(Difficulty difficulty)
```
    Sets the difficulty of this world.
    
    Parameters:
    
    difficulty - The difficulty
  - doesGenerateBonusChest
```
boolean doesGenerateBonusChest()
```
    Gets whether the bonus chest should be generated.
    This only applies on the initial load of the World created via this properties.
    
    Returns:
    
    True if bonus chest is generated, false if not
  - getWorldBorderCenter
```
com.flowpowered.math.vector.Vector3d getWorldBorderCenter()
```
    Gets the center of the world border.
    The returned position is three-dimensional. As the world border extends over the entire y-axis, the returned position will always have a y set to 0.
    
    Returns:
    
    The center
  - setWorldBorderCenter
```
void setWorldBorderCenter(double x,
                          double z)
```
    Sets the center of the world border.
    
    Parameters:
    
    x - The x-axis center of the world border
    
    z - The z-axis center of the world border
  - getWorldBorderDiameter
```
double getWorldBorderDiameter()
```
    Gets the diameter of the world border.
    The returned diameter applies to the x and z axis. The world border extends over the entire y-axis.
    
    Returns:
    
    The diameter
  - setWorldBorderDiameter
```
void setWorldBorderDiameter(double diameter)
```
    Sets the diameter of the world border.
    The specified diameter applies to the x and z axis. The world border extends over the entire y-axis.
    
    Parameters:
    
    diameter - The diameter
  - getWorldBorderTimeRemaining
```
long getWorldBorderTimeRemaining()
```
    Gets the time remaining until the world border stops expanding or contracting.
    
    Returns:
    
    The time remaining, in milliseconds
  - setWorldBorderTimeRemaining
```
void setWorldBorderTimeRemaining(long time)
```
    Sets the time remaining until the world border stops expanding or contracting.
    
    Parameters:
    
    time - The new remaining time
  - getWorldBorderTargetDiameter
```
double getWorldBorderTargetDiameter()
```
    Gets the diameter the world border is expanding or contracting to.
    This will return the same value as getWorldBorderDiameter() unless getWorldBorderTimeRemaining() is greater than 0.
    
    Returns:
    
    The diameter being changed to
  - setWorldBorderTargetDiameter
```
void setWorldBorderTargetDiameter(double diameter)
```
    Sets the target diameter of the world border.
    The world border diameter increases/decrease linearly over time specified in getWorldBorderTimeRemaining(). The specified diameter applies to the x and z axis. The world border extends over the entire y-axis.
    
    Parameters:
    
    diameter - The diameter where the border will expand/contract to
  - getWorldBorderDamageThreshold
```
double getWorldBorderDamageThreshold()
```
    Gets the distance a player may be outside the world border before taking damage.
    
    Returns:
    
    The distance
  - setWorldBorderDamageThreshold
```
void setWorldBorderDamageThreshold(double distance)
```
    Sets the distance a player may be be outside the world border before taking damage.
    
    Parameters:
    
    distance - The distance
  - getWorldBorderDamageAmount
```
double getWorldBorderDamageAmount()
```
    Gets the damage done to a player per block per tick when outside the buffer.
    
    Returns:
    
    The damage amount
  - setWorldBorderDamageAmount
```
void setWorldBorderDamageAmount(double damage)
```
    Sets the damage done to a player per block per tick when outside the buffer.
    
    Parameters:
    
    damage - The damage amount
  - getWorldBorderWarningTime
```
int getWorldBorderWarningTime()
```
    Gets the time when a contracting world border will warn a player for whom the world border will reach in time seconds.
    In Minecraft, the warning is displayed in the form of a reddish tint.
    
    Returns:
    
    The time, in seconds
  - setWorldBorderWarningTime
```
void setWorldBorderWarningTime(int time)
```
    Sets the time when a contracting world border will warn a player for whom the world border will reach in time seconds.
    In Minecraft, the warning is displayed in the form of a reddish tint.
    
    Parameters:
    
    time - The time, in seconds
  - getWorldBorderWarningDistance
```
int getWorldBorderWarningDistance()
```
    Gets the distance when a contracting world border will warn a player for whom the world border is distance blocks away.
    In Minecraft, the warning is displayed in the form of a reddish tint.
    
    Returns:
    
    The distance, in blocks
  - setWorldBorderWarningDistance
```
void setWorldBorderWarningDistance(int distance)
```
    Sets the distance when a contracting world border will warn a player for whom the world border is distance blocks away.
    In Minecraft, the warning is displayed in the form of a reddish tint.
    
    Parameters:
    
    distance - The distance, in blocks
  - getGameRule
```
Optional<String> getGameRule(String gameRule)
```
    Gets the specified GameRule value.
    
    Parameters:
    
    gameRule - The name of the GameRule.
    
    Returns:
    
    The GameRule value, if it exists.
  - getGameRules
```
Map<String,String> getGameRules()
```
    Gets a map of the currently set game rules and their values.
    
    Returns:
    
    An immutable map of the game rules
  - setGameRule
```
void setGameRule(String gameRule,
                 String value)
```
    Sets the specified GameRule value. If one with this name does not exist, it will be created.
    
    Parameters:
    
    gameRule - The name of the GameRule.
    
    value - The value to set the GameRule to.
  - removeGameRule
```
boolean removeGameRule(String gameRule)
```
    Removes custom GameRule.
    
    Parameters:
    
    gameRule - The name of the GameRule.
    
    Returns:
    
    True if GameRule was deleted, false if not
  - getAdditionalProperties
```
DataContainer getAdditionalProperties()
```
    Gets a DataContainer containing any additional properties for this world. The returned data is a snapshot of the data and is not live.
    
    Returns:
    
    Any additional properties
  - getPropertySection
```
Optional<DataView> getPropertySection(DataQuery path)
```
    Gets a section of the additional properties returned by getAdditionalProperties(). The returned data is a snapshot of the data and is not live.
    
    Parameters:
    
    path - The path for the section.
    
    Returns:
    
    The data view representing the requested section
  - setPropertySection
```
void setPropertySection(DataQuery path,
                        DataView data)
```
    Sets a path within the additional data to the given DataView. If you are using this to store data related to your mod/plugin is is HIGHLY recommended that the identifier you pass in be your mod/plugin id.
    
    Parameters:
    
    path - The path for the section
    
    data - The new data
  - getGeneratorModifiers
```
Collection<WorldGeneratorModifier> getGeneratorModifiers()
```
    Gets an immutable collection of the world generator modifiers currently in use.
    
    Returns:
    
    The world generator modifiers in use.
  - setGeneratorModifiers
```
void setGeneratorModifiers(Collection<WorldGeneratorModifier> modifiers)
```
    Sets the given world generator modifiers to be used.
    
    Parameters:
    
    modifiers - The modifiers to set.
    
    Throws:
    
    IllegalArgumentException - If any of the modifiers has not been registered in the GameRegistry.
  - getGeneratorSettings
```
DataContainer getGeneratorSettings()
```
    Gets the generator settings. These can be used by the generator type and/or by the generator modifiers.
    
    Returns:
    
    The generator settings.
  - getSerializationBehavior
```
SerializationBehavior getSerializationBehavior()
```
    Gets the SerializationBehavior in use.
    
    Returns:
    
    The serialization behavior
  - setSerializationBehavior
```
void setSerializationBehavior(SerializationBehavior behavior)
```
    Sets the SerializationBehavior for use.
    
    Parameters:
    
    behavior - The serialization behavior

Interface WorldProperties

Method Summary

Methods inherited from interface org.spongepowered.api.data.DataSerializable

Method Detail

isInitialized

getWorldName

getUniqueId

isEnabled

setEnabled

loadOnStartup

setLoadOnStartup

doesKeepSpawnLoaded

setKeepSpawnLoaded

doesGenerateSpawnOnLoad

setGenerateSpawnOnLoad

getSpawnPosition

setSpawnPosition

getGeneratorType

setGeneratorType

getSeed

setSeed

getTotalTime

getWorldTime

setWorldTime

getDimensionType

getPortalAgentType

isPVPEnabled

setPVPEnabled

isRaining

setRaining

getRainTime

setRainTime

isThundering

setThundering

getThunderTime

setThunderTime

getGameMode

setGameMode

usesMapFeatures

setMapFeaturesEnabled

isHardcore

setHardcore

areCommandsAllowed

setCommandsAllowed

getDifficulty

setDifficulty

doesGenerateBonusChest

getWorldBorderCenter

setWorldBorderCenter

getWorldBorderDiameter

setWorldBorderDiameter

getWorldBorderTimeRemaining

setWorldBorderTimeRemaining

getWorldBorderTargetDiameter

setWorldBorderTargetDiameter

getWorldBorderDamageThreshold

setWorldBorderDamageThreshold

getWorldBorderDamageAmount

setWorldBorderDamageAmount

getWorldBorderWarningTime

setWorldBorderWarningTime

getWorldBorderWarningDistance

setWorldBorderWarningDistance

getGameRule

getGameRules

setGameRule

removeGameRule

getAdditionalProperties

getPropertySection

setPropertySection

getGeneratorModifiers

setGeneratorModifiers

getGeneratorSettings

getSerializationBehavior

setSerializationBehavior