Class DedicatedServerUtils

Contains apis that are only available when in Bedrock Dedicated Server.

Index

Constructors

Properties

allowList levelStorage

Methods

reloadCDNConfig reloadPermissions reloadScriptingConfig stopServer

Constructors

`Private`constructor

new DedicatedServerUtils(): DedicatedServerUtils
Returns DedicatedServerUtils

Properties

`Readonly`allowList

allowList: AllowList

Remarks

Returns an object that manages the server's allow list.

World Ready

This property can't be read in early-execution mode.

`Readonly`levelStorage

levelStorage: LevelStorage

Remarks

Returns an object that manages the level's storage.

World Ready

This property can't be read in early-execution mode.

Methods

reloadCDNConfig

reloadCDNConfig(): void
Returns void
Remarks
Reloads the cdn configuration from disk.

Throws
This function can throw errors.

minecraftcommon.EngineError

World Ready
This function can't be called in early-execution mode.

reloadPermissions

reloadPermissions(): void
Returns void
Remarks
Reloads the permissions for the server from disk.

Throws
This function can throw errors.

minecraftcommon.EngineError

World Ready
This function can't be called in early-execution mode.

reloadScriptingConfig

reloadScriptingConfig(): void
Returns void
Remarks
Reloads the script configuration for the server from disk.

Throws
This function can throw errors.

minecraftcommon.EngineError

World Ready
This function can't be called in early-execution mode.

stopServer

stopServer(): void
Returns void
Remarks
Shuts down the dedicated server.

World Ready
This function can't be called in early-execution mode.