Class LevelStorage

Controls how the server saves to disk. Only available on dedicated server.

Source

export class LevelStorage {
    private constructor();
    saveHold(): void;
    saveQuery(): LevelStorageQuerySnapshotFile[];
    saveResume(): void;
}

Index

Constructors

constructor

Methods

saveHold saveQuery saveResume

Constructors

`Private`constructor

new LevelStorage(): LevelStorage
Returns LevelStorage

Methods

saveHold

saveHold(): void
Returns void
Remarks
Disables the server writing to the world files and begins creating a snapshot.

Throws
This function can throw errors.

LevelStorageSaveStateChangeError

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

saveQuery

saveQuery(): LevelStorageQuerySnapshotFile[]
Returns LevelStorageQuerySnapshotFile[]
Remarks
Returns the path and size of every file in the current snapshot if a snapshot is being taken.

Throws
This function can throw errors.

LevelStorageSaveStateChangeError

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

saveResume

saveResume(): void
Returns void
Remarks
Re-enables server writing world state to files and removes snapshot.

Throws
This function can throw errors.

LevelStorageSaveStateChangeError

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

Class LevelStorage

Source

Index

Constructors

Methods

Constructors

`Private`constructor

Returns LevelStorage

Methods

saveHold

Returns void

Remarks

Throws

World Ready

saveQuery

Returns LevelStorageQuerySnapshotFile[]

Remarks

Throws

World Ready

saveResume

Returns void

Remarks

Throws

World Ready

Settings

On This Page

Class LevelStorage

Source

Index

Constructors

Methods

Constructors

Privateconstructor

Returns LevelStorage

Methods

saveHold

Returns void

Remarks

Throws

World Ready

saveQuery

Returns LevelStorageQuerySnapshotFile[]

Remarks

Throws

World Ready

saveResume

Returns void

Remarks

Throws

World Ready

Settings

On This Page

`Private`constructor