HytaleServerConfig

public class HytaleServerConfig

Class HytaleServerConfig. Provides hytaleserverconfig functionality for the Hytale server.

java.lang.Object > HytaleServerConfig

Field Summary

serverName

private String serverName

Field serverName.

motd

private String motd

Field motd.

password

private String password

Field password.

maxPlayers

private int maxPlayers

Field maxPlayers.

maxViewRadius

private int maxViewRadius

Field maxViewRadius.

localCompressionEnabled

private boolean localCompressionEnabled

Field localCompressionEnabled.

defaults

private Defaults defaults

Field defaults.

connectionTimeouts

private ConnectionTimeouts connectionTimeouts

Field connectionTimeouts.

rateLimitConfig

private RateLimitConfig rateLimitConfig

Field rateLimitConfig.

playerStorageProvider

private PlayerStorageProvider playerStorageProvider

Field playerStorageProvider.

authCredentialStoreConfig

private BsonDocument authCredentialStoreConfig

Field authCredentialStoreConfig.

displayTmpTagsInStrings

private boolean displayTmpTagsInStrings

Field displayTmpTagsInStrings.

hytaleServerConfig

final HytaleServerConfig hytaleServerConfig

Field hytaleServerConfig.

config

final HytaleServerConfig config

Field config.

document

final BsonDocument document

Field document.

enabled

private Boolean enabled

Field enabled.

world

private String world

Field world.

gameMode

private GameMode gameMode

Field gameMode.

initialTimeout

private Duration initialTimeout

Field initialTimeout.

authTimeout

private Duration authTimeout

Field authTimeout.

playTimeout

private Duration playTimeout

Field playTimeout.

packetsPerSecond

private Integer packetsPerSecond

Field packetsPerSecond.

burstCapacity

private Integer burstCapacity

Field burstCapacity.

requiredVersion

private SemverRange requiredVersion

Field requiredVersion.

Method Detail

HytaleServerConfig

public public HytaleServerConfig ()

Method HytaleServerConfig.

getServerName

public String getServerName ()

Method getServerName.

setServerName

public void setServerName (@Nonnull final String serverName)

Method setServerName.

Parameters:
@Nonnull final String serverName

getMotd

public String getMotd ()

Method getMotd.

setMotd

public void setMotd (@Nonnull final String motd)

Method setMotd.

Parameters:
@Nonnull final String motd

getPassword

public String getPassword ()

Method getPassword.

setPassword

public void setPassword (@Nonnull final String password)

Method setPassword.

Parameters:
@Nonnull final String password

isDisplayTmpTagsInStrings

public boolean isDisplayTmpTagsInStrings ()

Method isDisplayTmpTagsInStrings.

setDisplayTmpTagsInStrings

public void setDisplayTmpTagsInStrings (final boolean displayTmpTagsInStrings)

Method setDisplayTmpTagsInStrings.

Parameters:
final boolean displayTmpTagsInStrings

getMaxPlayers

public int getMaxPlayers ()

Method getMaxPlayers.

setMaxPlayers

public void setMaxPlayers (final int maxPlayers)

Method setMaxPlayers.

Parameters:
final int maxPlayers

getMaxViewRadius

public int getMaxViewRadius ()

Method getMaxViewRadius.

setMaxViewRadius

public void setMaxViewRadius (final int maxViewRadius)

Method setMaxViewRadius.

Parameters:
final int maxViewRadius

isLocalCompressionEnabled

public boolean isLocalCompressionEnabled ()

Method isLocalCompressionEnabled.

setLocalCompressionEnabled

public void setLocalCompressionEnabled (final boolean localCompression)

Method setLocalCompressionEnabled.

Parameters:
final boolean localCompression

getDefaults

public Defaults getDefaults ()

Method getDefaults.

setDefaults

public void setDefaults (@Nonnull final Defaults defaults)

Method setDefaults.

Parameters:
@Nonnull final Defaults defaults

getConnectionTimeouts

public ConnectionTimeouts getConnectionTimeouts ()

Method getConnectionTimeouts.

setConnectionTimeouts

public void setConnectionTimeouts (@Nonnull final ConnectionTimeouts connectionTimeouts)

Method setConnectionTimeouts.

Parameters:
@Nonnull final ConnectionTimeouts connectionTimeouts

getRateLimitConfig

public RateLimitConfig getRateLimitConfig ()

Method getRateLimitConfig.

setRateLimitConfig

public void setRateLimitConfig (@Nonnull final RateLimitConfig rateLimitConfig)

Method setRateLimitConfig.

Parameters:
@Nonnull final RateLimitConfig rateLimitConfig

getModules

public Module> getModules ()

Method getModules.

getModule

public Module getModule (final String moduleName)

Method getModule.

Parameters:
final String moduleName

Module

public new Module (this)

Method Module.

Parameters:
this this

setModules

public void setModules (@Nonnull final Map modules)

Method setModules.

Parameters:
@Nonnull final Map modules

getLogLevels

public Level> getLogLevels ()

Method getLogLevels.

setLogLevels

public void setLogLevels (@Nonnull final Map logLevels)

Method setLogLevels.

Parameters:
@Nonnull final Map logLevels

getModConfig

public ModConfig> getModConfig ()

Method getModConfig.

setModConfig

public void setModConfig (@Nonnull final Map modConfig)

Method setModConfig.

Parameters:
@Nonnull final Map modConfig

getPlayerStorageProvider

public PlayerStorageProvider getPlayerStorageProvider ()

Method getPlayerStorageProvider.

setPlayerStorageProvider

public void setPlayerStorageProvider (@Nonnull final PlayerStorageProvider playerStorageProvider)

Method setPlayerStorageProvider.

Parameters:
@Nonnull final PlayerStorageProvider playerStorageProvider

getAuthCredentialStoreProvider

public AuthCredentialStoreProvider getAuthCredentialStoreProvider ()

Method getAuthCredentialStoreProvider.

setAuthCredentialStoreProvider

public void setAuthCredentialStoreProvider (@Nonnull final AuthCredentialStoreProvider provider)

Method setAuthCredentialStoreProvider.

Parameters:
@Nonnull final AuthCredentialStoreProvider provider

removeModule

public void removeModule (@Nonnull final String module)

Method removeModule.

Parameters:
@Nonnull final String module

markChanged

public void markChanged ()

Method markChanged.

consumeHasChanged

public boolean consumeHasChanged ()

Method consumeHasChanged.

load

static HytaleServerConfig load ()

Method load.

RuntimeException

public new RuntimeException ("Failed to load server config from " + String.valueOf(path)

Method RuntimeException.

Parameters:
"Failed to load server config from " + String.valueOf(path

save

static CompletableFuture save (@Nonnull final HytaleServerConfig hytaleServerConfig)

Method save.

Parameters:
@Nonnull final HytaleServerConfig hytaleServerConfig

isEnabled

public boolean isEnabled (final boolean def)

Method isEnabled.

Parameters:
final boolean def

setEnabled

public void setEnabled (final boolean enabled)

Method setEnabled.

Parameters:
final boolean enabled

getEnabled

public Boolean getEnabled ()

Method getEnabled.

getDocument

public BsonDocument getDocument ()

Method getDocument.

decode

public T decode (@Nonnull final Codec codec)

Method decode.

Parameters:
@Nonnull final Codec codec

encode

public void encode (@Nonnull final Codec codec, @Nonnull final T t)

Method encode.

Parameters:
@Nonnull final Codec codec
@Nonnull final T t

getData

public Optional getData (@Nonnull final KeyedCodec keyedCodec)

Method getData.

Parameters:
@Nonnull final KeyedCodec keyedCodec

getDataOrNull

public T getDataOrNull (@Nonnull final KeyedCodec keyedCodec)

Method getDataOrNull.

Parameters:
@Nonnull final KeyedCodec keyedCodec

getDataNow

public T getDataNow (@Nonnull final KeyedCodec keyedCodec)

Method getDataNow.

Parameters:
@Nonnull final KeyedCodec keyedCodec

put

public void put (@Nonnull final KeyedCodec keyedCodec, final T t)

Method put.

Parameters:
@Nonnull final KeyedCodec keyedCodec
final T t

setDocument

public void setDocument (@Nonnull final BsonDocument document)

Method setDocument.

Parameters:
@Nonnull final BsonDocument document

setHytaleServerConfig

public void setHytaleServerConfig (@Nonnull final HytaleServerConfig hytaleServerConfig)

Method setHytaleServerConfig.

Parameters:
@Nonnull final HytaleServerConfig hytaleServerConfig

getWorld

public String getWorld ()

Method getWorld.

setWorld

public void setWorld (final String world)

Method setWorld.

Parameters:
final String world

getGameMode

public GameMode getGameMode ()

Method getGameMode.

setGameMode

public void setGameMode (final GameMode gameMode)

Method setGameMode.

Parameters:
final GameMode gameMode

getInitialTimeout

public Duration getInitialTimeout ()

Method getInitialTimeout.

setInitialTimeout

public void setInitialTimeout (final Duration initialTimeout)

Method setInitialTimeout.

Parameters:
final Duration initialTimeout

getAuthTimeout

public Duration getAuthTimeout ()

Method getAuthTimeout.

setAuthTimeout

public void setAuthTimeout (final Duration authTimeout)

Method setAuthTimeout.

Parameters:
final Duration authTimeout

getPlayTimeout

public Duration getPlayTimeout ()

Method getPlayTimeout.

setPlayTimeout

public void setPlayTimeout (final Duration playTimeout)

Method setPlayTimeout.

Parameters:
final Duration playTimeout

getJoinTimeouts

public Duration> getJoinTimeouts ()

Method getJoinTimeouts.

setJoinTimeouts

public void setJoinTimeouts (final Map joinTimeouts)

Method setJoinTimeouts.

Parameters:
final Map joinTimeouts

KeyedCodec

public new KeyedCodec ("AuthTimeout", Codec.DURATION)

Method KeyedCodec.

Parameters:
"AuthTimeout" "AuthTimeout"
Codec.DURATION Codec.DURATION

getPacketsPerSecond

public int getPacketsPerSecond ()

Method getPacketsPerSecond.

setPacketsPerSecond

public void setPacketsPerSecond (final int packetsPerSecond)

Method setPacketsPerSecond.

Parameters:
final int packetsPerSecond

getBurstCapacity

public int getBurstCapacity ()

Method getBurstCapacity.

setBurstCapacity

public void setBurstCapacity (final int burstCapacity)

Method setBurstCapacity.

Parameters:
final int burstCapacity

getRequiredVersion

public SemverRange getRequiredVersion ()

Method getRequiredVersion.

setRequiredVersion

public void setRequiredVersion (final SemverRange requiredVersion)

Method setRequiredVersion.

Parameters:
final SemverRange requiredVersion

setBoot

static void setBoot (final HytaleServerConfig serverConfig, final PluginIdentifier identifier, final boolean enabled)

Method setBoot.

Parameters:
final HytaleServerConfig serverConfig
final PluginIdentifier identifier
final boolean enabled

ModConfig

public new ModConfig ()

Method ModConfig.