Class WorldConfig

java.lang.Object
com.hypixel.hytale.server.core.universe.world.WorldConfig
public class WorldConfig extends Object
The configuration file containing the configuration values for World's.

Note that it is the user's responsibility to mark the worldconfig as "dirty". If you modify something in here, you should make a call to markChanged() in order to tell the server that the WorldConfig needs to be saved

  • Field Details

  • Constructor Details

    • WorldConfig

      public WorldConfig()

  • Method Details

    • getUuid

      @Nonnull public UUID getUuid()

    • setUuid

      public void setUuid(UUID uuid)

    • isDeleteOnUniverseStart

      public boolean isDeleteOnUniverseStart()

    • setDeleteOnUniverseStart

      public void setDeleteOnUniverseStart(boolean deleteOnUniverseStart)

    • isDeleteOnRemove

      public boolean isDeleteOnRemove()

    • setDeleteOnRemove

      public void setDeleteOnRemove(boolean deleteOnRemove)

    • getCrashRecovery

      @Nullable public CrashRecoveryConfig getCrashRecovery()
      Returns:
      the per-world crash recovery override, or null to inherit the server policy.

    • setCrashRecovery

      public void setCrashRecovery(@Nullable CrashRecoveryConfig crashRecovery)

    • isSavingConfig

      public boolean isSavingConfig()

    • setSavingConfig

      public void setSavingConfig(boolean savingConfig)

    • getDisplayName

      public String getDisplayName()

    • setDisplayName

      public void setDisplayName(String name)

    • formatDisplayName

      @Nonnull public static String formatDisplayName(@Nonnull String name)
      Formats a raw name into a human-readable display name. Drops any leading path segments, inserts spaces before capitals, between letters and numbers, and replaces underscores.
      Parameters:
      name - The raw name (e.g., "CreativeHub", "Zone3_Taiga1", "flat_world", "Gyms/Gym_Movement")
      Returns:
      The formatted name (e.g., "Creative Hub", "Zone 3 Taiga 1", "Flat World", "Gym Movement")

    • getSeed

      public long getSeed()

    • setSeed

      public void setSeed(long seed)

    • getSpawnProvider

      @Nullable public ISpawnProvider getSpawnProvider()

    • setSpawnProvider

      public void setSpawnProvider(ISpawnProvider spawnProvider)

    • setDefaultSpawnProvider

      public void setDefaultSpawnProvider(@Nonnull IWorldGen generator)

    • getWorldGenProvider

      public IWorldGenProvider getWorldGenProvider()

    • setWorldGenProvider

      public void setWorldGenProvider(IWorldGenProvider worldGenProvider)

    • getWorldMapProvider

      public IWorldMapProvider getWorldMapProvider()

    • setWorldMapProvider

      public void setWorldMapProvider(IWorldMapProvider worldMapProvider)

    • getWorldMapConfig

      @Nullable public WorldWorldMapConfig getWorldMapConfig()
      Returns:
      the per-world world map config, or null if not set.

    • setWorldMapConfig

      public void setWorldMapConfig(@Nullable WorldWorldMapConfig worldMapConfig)
      Sets the per-world world map config overrides. Pass null to use generator defaults.
      Parameters:
      worldMapConfig - the per-world world map config, or null.

    • getChunkStorageProvider

      public IChunkStorageProvider<?> getChunkStorageProvider()

    • setChunkStorageProvider

      public void setChunkStorageProvider(IChunkStorageProvider<?> chunkStorageProvider)

    • getChunkConfig

      @Nonnull public WorldConfig.ChunkConfig getChunkConfig()

    • setChunkConfig

      public void setChunkConfig(@Nonnull WorldConfig.ChunkConfig chunkConfig)

    • isTicking

      public boolean isTicking()

    • setTicking

      public void setTicking(boolean ticking)

    • isBlockTicking

      public boolean isBlockTicking()

    • setBlockTicking

      public void setBlockTicking(boolean ticking)

    • isPvpEnabled

      public boolean isPvpEnabled()

    • setPvpEnabled

      public void setPvpEnabled(boolean pvpEnabled)

    • isFallDamageEnabled

      public boolean isFallDamageEnabled()

    • setFallDamageEnabled

      public void setFallDamageEnabled(boolean fallDamageEnabled)

    • isGameTimePaused

      public boolean isGameTimePaused()

    • setGameTimePaused

      public void setGameTimePaused(boolean gameTimePaused)

    • getGameTime

      public Instant getGameTime()

    • setGameTime

      public void setGameTime(Instant gameTime)

    • getForcedWeather

      public String getForcedWeather()

    • setForcedWeather

      public void setForcedWeather(String forcedWeather)

    • setClientEffects

      public void setClientEffects(ClientEffectWorldSettings clientEffects)

    • getClientEffects

      public ClientEffectWorldSettings getClientEffects()

    • getRequiredPlugins

      @Nonnull public Map<PluginIdentifier, SemverRange> getRequiredPlugins()

    • setRequiredPlugins

      public void setRequiredPlugins(Map<PluginIdentifier, SemverRange> requiredPlugins)

    • getGameMode

      public GameMode getGameMode()

    • setGameMode

      public void setGameMode(GameMode gameMode)

    • getDefaultPermissionGroup

      @Nonnull public String getDefaultPermissionGroup()
      Returns:
      the default permission group for new players in this world, or "hytale:Adventurer" if not set.

    • setDefaultPermissionGroup

      public void setDefaultPermissionGroup(@Nullable String defaultPermissionGroup)

    • isSpawningNPC

      public boolean isSpawningNPC()

    • setSpawningNPC

      public void setSpawningNPC(boolean spawningNPC)

    • isBlockSpawnersResolved

      public boolean isBlockSpawnersResolved()

    • setBlockSpawnersResolved

      public void setBlockSpawnersResolved(boolean blockSpawnersResolved)

    • isSpawnMarkersEnabled

      public boolean isSpawnMarkersEnabled()

    • setIsSpawnMarkersEnabled

      public void setIsSpawnMarkersEnabled(boolean spawnMarkersEnabled)

    • isAllNPCFrozen

      public boolean isAllNPCFrozen()

    • setIsAllNPCFrozen

      public void setIsAllNPCFrozen(boolean allNPCFrozen)

    • getGameplayConfig

      public String getGameplayConfig()

    • setGameplayConfig

      public void setGameplayConfig(String gameplayConfig)

    • getDeathConfigOverride

      @Nullable public MutableDeathConfig getDeathConfigOverride()

    • setDeathConfigOverride

      public void setDeathConfigOverride(@Nullable MutableDeathConfig deathConfigOverride)
      Sets the per-world death config override. Pass null to fall back to the gameplay config's death settings.
      Parameters:
      deathConfigOverride - the per-world death config, or null.

    • getDaytimeDurationSecondsOverride

      @Nullable public Integer getDaytimeDurationSecondsOverride()

    • getNighttimeDurationSecondsOverride

      @Nullable public Integer getNighttimeDurationSecondsOverride()

    • isCompassUpdating

      public boolean isCompassUpdating()

    • setCompassUpdating

      public void setCompassUpdating(boolean compassUpdating)

    • isSavingPlayers

      public boolean isSavingPlayers()

    • setSavingPlayers

      public void setSavingPlayers(boolean savingPlayers)

    • canUnloadChunks

      public boolean canUnloadChunks()

    • setCanUnloadChunks

      public void setCanUnloadChunks(boolean unloadingChunks)

    • canSaveChunks

      public boolean canSaveChunks()

    • setCanSaveChunks

      public void setCanSaveChunks(boolean savingChunks)

    • shouldSaveNewChunks

      public boolean shouldSaveNewChunks()

    • setSaveNewChunks

      public void setSaveNewChunks(boolean saveNewChunks)

    • isObjectiveMarkersEnabled

      public boolean isObjectiveMarkersEnabled()

    • setObjectiveMarkersEnabled

      public void setObjectiveMarkersEnabled(boolean objectiveMarkersEnabled)

    • getDisabledFluidTickers

      @Nonnull public Set<String> getDisabledFluidTickers()

    • setDisabledFluidTickers

      public void setDisabledFluidTickers(@Nonnull Set<String> disabledFluidTickers)

    • getResourceStorageProvider

      public IResourceStorageProvider getResourceStorageProvider()

    • setResourceStorageProvider

      public void setResourceStorageProvider(@Nonnull IResourceStorageProvider resourceStorageProvider)

    • getPluginConfig

      public MapKeyMapCodec.TypeMap<Object> getPluginConfig()

    • markChanged

      public void markChanged()

    • consumeHasChanged

      public boolean consumeHasChanged()

    • load

      @Nonnull public static CompletableFuture<WorldConfig> load(@Nonnull Path path)

    • save

      @Nonnull public static CompletableFuture<Void> save(@Nonnull Path path, WorldConfig worldConfig)