Class Config

Index

Constructors

Methods

getEnableProcessTitle getEnableQuery getEnableTicking getGamemode getLevelName getLogLevel getMaxPlayers getMotd getOnlineMode getPacketCompressionLevel getServerIp getServerPort getViewDistance getWorlds setGamemode setMotd

Lifecycle

Constructors

constructor

new Config(): Config
Returns Config
- Defined in packages/prismarine/src/config/Config.ts:44

Methods

getEnableProcessTitle

getEnableProcessTitle(): boolean
Returns boolean
- Defined in packages/prismarine/src/config/Config.ts:193

getEnableQuery

getEnableQuery(): boolean
Returns boolean
- Defined in packages/prismarine/src/config/Config.ts:189

getEnableTicking

getEnableTicking(): boolean
Returns boolean
- Defined in packages/prismarine/src/config/Config.ts:197

getGamemode

getGamemode(): string
Returns string
- Defined in packages/prismarine/src/config/Config.ts:131

getLevelName

getLevelName(): string
Returns the default world's name (id).

Returns string
The world's name as a string

Remarks
If the world doesn't exist as a part of the worlds array the worldManager will fail to initialize.
- Defined in packages/prismarine/src/config/Config.ts:115

getLogLevel

getLogLevel(): LogLevel
Returns LogLevel
- Defined in packages/prismarine/src/config/Config.ts:86

getMaxPlayers

getMaxPlayers(): number
Returns number
The max amount of players allowed onto the server at the same time.
- Defined in packages/prismarine/src/config/Config.ts:127

getMotd

getMotd(): string
Returns true or false depending on if online mode is enabled.

Returns string
The message of the day as a string
- Defined in packages/prismarine/src/config/Config.ts:151

getOnlineMode

getOnlineMode(): boolean
Returns true or false depending on if online mode is enabled.

Returns boolean
true if enabled, false otherwise
- Defined in packages/prismarine/src/config/Config.ts:181

getPacketCompressionLevel

getPacketCompressionLevel(): number
Returns number
- Defined in packages/prismarine/src/config/Config.ts:185

getServerIp

getServerIp(): string
Get the server's IP address.

Returns string
The server's IP address

Remarks
The default IP address is 0.0.0.0
- Defined in packages/prismarine/src/config/Config.ts:104

getServerPort

getServerPort(): number
Get the server's port.

Returns number
The server's port

Remarks
The default port is 19132.
- Defined in packages/prismarine/src/config/Config.ts:95

getViewDistance

getViewDistance(): number
Returns the view distance.

Returns number
The view distance as an integer
- Defined in packages/prismarine/src/config/Config.ts:172

getWorlds

getWorlds(): any
Returns any
- Defined in packages/prismarine/src/config/Config.ts:119

setGamemode

setGamemode(gamemode: number, commit?: boolean): void
Set the default gamemode.
Parameters
- gamemode: number
  the gamemode
- commit: boolean = false
  if the value should be written to the config.yml file
Returns void
- Defined in packages/prismarine/src/config/Config.ts:141

setMotd

setMotd(motd: string, commit?: boolean): void
Set the motd.
Parameters
- motd: string
  the gamemode
- commit: boolean = false
  if the value should be written to the config.yml file
Returns void
- Defined in packages/prismarine/src/config/Config.ts:161

Lifecycle

disable

disable(): Promise<void>
On disable hook.

Returns Promise<void>
- Defined in packages/prismarine/src/config/Config.ts:84

enable

enable(): Promise<void>
On enable hook.

Returns Promise<void>
- Defined in packages/prismarine/src/config/Config.ts:53