WorldConfig

public class WorldConfig

Class WorldConfig. Provides worldconfig functionality for the Hytale server.

java.lang.Object > WorldConfig

Field Summary

uuid

private UUID uuid

Field uuid.

displayName

private String displayName

Field displayName.

seed

private long seed

Field seed.

spawnProvider

private ISpawnProvider spawnProvider

Field spawnProvider.

worldGenProvider

private IWorldGenProvider worldGenProvider

Field worldGenProvider.

worldMapProvider

private IWorldMapProvider worldMapProvider

Field worldMapProvider.

chunkStorageProvider

private IChunkStorageProvider chunkStorageProvider

Field chunkStorageProvider.

chunkConfig

private ChunkConfig chunkConfig

Field chunkConfig.

isTicking

private boolean isTicking

Field isTicking.

isBlockTicking

private boolean isBlockTicking

Field isBlockTicking.

isPvpEnabled

private boolean isPvpEnabled

Field isPvpEnabled.

isFallDamageEnabled

private boolean isFallDamageEnabled

Field isFallDamageEnabled.

isGameTimePaused

private boolean isGameTimePaused

Field isGameTimePaused.

gameTime

private Instant gameTime

Field gameTime.

forcedWeather

private String forcedWeather

Field forcedWeather.

clientEffects

private ClientEffectWorldSettings clientEffects

Field clientEffects.

gameMode

private GameMode gameMode

Field gameMode.

isSpawningNPC

private boolean isSpawningNPC

Field isSpawningNPC.

isSpawnMarkersEnabled

private boolean isSpawnMarkersEnabled

Field isSpawnMarkersEnabled.

isAllNPCFrozen

private boolean isAllNPCFrozen

Field isAllNPCFrozen.

gameplayConfig

private String gameplayConfig

Field gameplayConfig.

deathConfigOverride

private DeathConfig deathConfigOverride

Field deathConfigOverride.

daytimeDurationSecondsOverride

private Integer daytimeDurationSecondsOverride

Field daytimeDurationSecondsOverride.

nighttimeDurationSecondsOverride

private Integer nighttimeDurationSecondsOverride

Field nighttimeDurationSecondsOverride.

isCompassUpdating

private boolean isCompassUpdating

Field isCompassUpdating.

isSavingPlayers

private boolean isSavingPlayers

Field isSavingPlayers.

canSaveChunks

private boolean canSaveChunks

Field canSaveChunks.

saveNewChunks

private boolean saveNewChunks

Field saveNewChunks.

canUnloadChunks

private boolean canUnloadChunks

Field canUnloadChunks.

isObjectiveMarkersEnabled

private boolean isObjectiveMarkersEnabled

Field isObjectiveMarkersEnabled.

deleteOnUniverseStart

private boolean deleteOnUniverseStart

Field deleteOnUniverseStart.

deleteOnRemove

private boolean deleteOnRemove

Field deleteOnRemove.

resourceStorageProvider

private IResourceStorageProvider resourceStorageProvider

Field resourceStorageProvider.

pluginConfig

protected MapKeyMapCodec.TypeMap pluginConfig

Field pluginConfig.

config

final WorldConfig config

Field config.

document

final BsonDocument document

Field document.

pregenerateRegion

private Box2D pregenerateRegion

Field pregenerateRegion.

keepLoadedRegion

private Box2D keepLoadedRegion

Field keepLoadedRegion.

Method Detail

WorldConfig

public public WorldConfig ()

Method WorldConfig.

getUuid

public UUID getUuid ()

Method getUuid.

setUuid

public void setUuid (final UUID uuid)

Method setUuid.

Parameters:
final UUID uuid

isDeleteOnUniverseStart

public boolean isDeleteOnUniverseStart ()

Method isDeleteOnUniverseStart.

setDeleteOnUniverseStart

public void setDeleteOnUniverseStart (final boolean deleteOnUniverseStart)

Method setDeleteOnUniverseStart.

Parameters:
final boolean deleteOnUniverseStart

isDeleteOnRemove

public boolean isDeleteOnRemove ()

Method isDeleteOnRemove.

setDeleteOnRemove

public void setDeleteOnRemove (final boolean deleteOnRemove)

Method setDeleteOnRemove.

Parameters:
final boolean deleteOnRemove

isSavingConfig

public boolean isSavingConfig ()

Method isSavingConfig.

setSavingConfig

public void setSavingConfig (final boolean savingConfig)

Method setSavingConfig.

Parameters:
final boolean savingConfig

getDisplayName

public String getDisplayName ()

Method getDisplayName.

setDisplayName

public void setDisplayName (final String name)

Method setDisplayName.

Parameters:
final String name

formatDisplayName

static String formatDisplayName (@Nonnull final String name)

Method formatDisplayName.

Parameters:
@Nonnull final String name

getSeed

public long getSeed ()

Method getSeed.

setSeed

public void setSeed (final long seed)

Method setSeed.

Parameters:
final long seed

getSpawnProvider

public ISpawnProvider getSpawnProvider ()

Method getSpawnProvider.

setSpawnProvider

public void setSpawnProvider (final ISpawnProvider spawnProvider)

Method setSpawnProvider.

Parameters:
final ISpawnProvider spawnProvider

setDefaultSpawnProvider

public void setDefaultSpawnProvider (@Nonnull final IWorldGen generator)

Method setDefaultSpawnProvider.

Parameters:
@Nonnull final IWorldGen generator

getWorldGenProvider

public IWorldGenProvider getWorldGenProvider ()

Method getWorldGenProvider.

setWorldGenProvider

public void setWorldGenProvider (final IWorldGenProvider worldGenProvider)

Method setWorldGenProvider.

Parameters:
final IWorldGenProvider worldGenProvider

getWorldMapProvider

public IWorldMapProvider getWorldMapProvider ()

Method getWorldMapProvider.

setWorldMapProvider

public void setWorldMapProvider (final IWorldMapProvider worldMapProvider)

Method setWorldMapProvider.

Parameters:
final IWorldMapProvider worldMapProvider

getChunkStorageProvider

public IChunkStorageProvider getChunkStorageProvider ()

Method getChunkStorageProvider.

setChunkStorageProvider

public void setChunkStorageProvider (final IChunkStorageProvider chunkStorageProvider)

Method setChunkStorageProvider.

Parameters:
final IChunkStorageProvider chunkStorageProvider

getChunkConfig

public ChunkConfig getChunkConfig ()

Method getChunkConfig.

setChunkConfig

public void setChunkConfig (@Nonnull final ChunkConfig chunkConfig)

Method setChunkConfig.

Parameters:
@Nonnull final ChunkConfig chunkConfig

isTicking

public boolean isTicking ()

Method isTicking.

setTicking

public void setTicking (final boolean ticking)

Method setTicking.

Parameters:
final boolean ticking

isBlockTicking

public boolean isBlockTicking ()

Method isBlockTicking.

setBlockTicking

public void setBlockTicking (final boolean ticking)

Method setBlockTicking.

Parameters:
final boolean ticking

isPvpEnabled

public boolean isPvpEnabled ()

Method isPvpEnabled.

isFallDamageEnabled

public boolean isFallDamageEnabled ()

Method isFallDamageEnabled.

setPvpEnabled

public void setPvpEnabled (final boolean pvpEnabled)

Method setPvpEnabled.

Parameters:
final boolean pvpEnabled

isGameTimePaused

public boolean isGameTimePaused ()

Method isGameTimePaused.

setGameTimePaused

public void setGameTimePaused (final boolean gameTimePaused)

Method setGameTimePaused.

Parameters:
final boolean gameTimePaused

getGameTime

public Instant getGameTime ()

Method getGameTime.

setGameTime

public void setGameTime (final Instant gameTime)

Method setGameTime.

Parameters:
final Instant gameTime

getForcedWeather

public String getForcedWeather ()

Method getForcedWeather.

setForcedWeather

public void setForcedWeather (final String forcedWeather)

Method setForcedWeather.

Parameters:
final String forcedWeather

setClientEffects

public void setClientEffects (final ClientEffectWorldSettings clientEffects)

Method setClientEffects.

Parameters:
final ClientEffectWorldSettings clientEffects

getClientEffects

public ClientEffectWorldSettings getClientEffects ()

Method getClientEffects.

getRequiredPlugins

public SemverRange> getRequiredPlugins ()

Method getRequiredPlugins.

setRequiredPlugins

public void setRequiredPlugins (final Map requiredPlugins)

Method setRequiredPlugins.

Parameters:
final Map requiredPlugins

getGameMode

public GameMode getGameMode ()

Method getGameMode.

setGameMode

public void setGameMode (final GameMode gameMode)

Method setGameMode.

Parameters:
final GameMode gameMode

isSpawningNPC

public boolean isSpawningNPC ()

Method isSpawningNPC.

setSpawningNPC

public void setSpawningNPC (final boolean spawningNPC)

Method setSpawningNPC.

Parameters:
final boolean spawningNPC

isSpawnMarkersEnabled

public boolean isSpawnMarkersEnabled ()

Method isSpawnMarkersEnabled.

setIsSpawnMarkersEnabled

public void setIsSpawnMarkersEnabled (final boolean spawnMarkersEnabled)

Method setIsSpawnMarkersEnabled.

Parameters:
final boolean spawnMarkersEnabled

isAllNPCFrozen

public boolean isAllNPCFrozen ()

Method isAllNPCFrozen.

setIsAllNPCFrozen

public void setIsAllNPCFrozen (final boolean allNPCFrozen)

Method setIsAllNPCFrozen.

Parameters:
final boolean allNPCFrozen

getGameplayConfig

public String getGameplayConfig ()

Method getGameplayConfig.

setGameplayConfig

public void setGameplayConfig (final String gameplayConfig)

Method setGameplayConfig.

Parameters:
final String gameplayConfig

getDeathConfigOverride

public DeathConfig getDeathConfigOverride ()

Method getDeathConfigOverride.

getDaytimeDurationSecondsOverride

public Integer getDaytimeDurationSecondsOverride ()

Method getDaytimeDurationSecondsOverride.

getNighttimeDurationSecondsOverride

public Integer getNighttimeDurationSecondsOverride ()

Method getNighttimeDurationSecondsOverride.

isCompassUpdating

public boolean isCompassUpdating ()

Method isCompassUpdating.

setCompassUpdating

public void setCompassUpdating (final boolean compassUpdating)

Method setCompassUpdating.

Parameters:
final boolean compassUpdating

isSavingPlayers

public boolean isSavingPlayers ()

Method isSavingPlayers.

setSavingPlayers

public void setSavingPlayers (final boolean savingPlayers)

Method setSavingPlayers.

Parameters:
final boolean savingPlayers

canUnloadChunks

public boolean canUnloadChunks ()

Method canUnloadChunks.

setCanUnloadChunks

public void setCanUnloadChunks (final boolean unloadingChunks)

Method setCanUnloadChunks.

Parameters:
final boolean unloadingChunks

canSaveChunks

public boolean canSaveChunks ()

Method canSaveChunks.

setCanSaveChunks

public void setCanSaveChunks (final boolean savingChunks)

Method setCanSaveChunks.

Parameters:
final boolean savingChunks

shouldSaveNewChunks

public boolean shouldSaveNewChunks ()

Method shouldSaveNewChunks.

setSaveNewChunks

public void setSaveNewChunks (final boolean saveNewChunks)

Method setSaveNewChunks.

Parameters:
final boolean saveNewChunks

isObjectiveMarkersEnabled

public boolean isObjectiveMarkersEnabled ()

Method isObjectiveMarkersEnabled.

setObjectiveMarkersEnabled

public void setObjectiveMarkersEnabled (final boolean objectiveMarkersEnabled)

Method setObjectiveMarkersEnabled.

Parameters:
final boolean objectiveMarkersEnabled

getResourceStorageProvider

public IResourceStorageProvider getResourceStorageProvider ()

Method getResourceStorageProvider.

setResourceStorageProvider

public void setResourceStorageProvider (@Nonnull final IResourceStorageProvider resourceStorageProvider)

Method setResourceStorageProvider.

Parameters:
@Nonnull final IResourceStorageProvider resourceStorageProvider

getPluginConfig

public MapKeyMapCodec.TypeMap getPluginConfig ()

Method getPluginConfig.

markChanged

public void markChanged ()

Method markChanged.

consumeHasChanged

public boolean consumeHasChanged ()

Method consumeHasChanged.

load

static CompletableFuture load (@Nonnull final Path path)

Method load.

Parameters:
@Nonnull final Path path

save

static CompletableFuture save (@Nonnull final Path path, final WorldConfig worldConfig)

Method save.

Parameters:
@Nonnull final Path path
final WorldConfig worldConfig

parameters

public certain parameters (e.g. *UUID*)

Method parameters.

Parameters:
e.g. *UUID*

getPregenerateRegion

public Box2D getPregenerateRegion ()

Method getPregenerateRegion.

setPregenerateRegion

public void setPregenerateRegion (@Nullable final Box2D pregenerateRegion)

Method setPregenerateRegion.

Parameters:
@Nullable final Box2D pregenerateRegion

getKeepLoadedRegion

public Box2D getKeepLoadedRegion ()

Method getKeepLoadedRegion.

setKeepLoadedRegion

public void setKeepLoadedRegion (@Nullable final Box2D keepLoadedRegion)

Method setKeepLoadedRegion.

Parameters:
@Nullable final Box2D keepLoadedRegion