Interface ClientOptions

An interface of client options that can be set on a Client object.

interface ClientOptions {
    autoFetchDataPackage?: boolean;
    debugLogVersions: boolean;
    maximumMessages?: number;
    timeout?: number;
}

Properties

autoFetchDataPackage? debugLogVersions maximumMessages? timeout?

Properties

OptionalautoFetchDataPackage

autoFetchDataPackage?: boolean

Automatically requests the DataPackage from the server during Client.login, if the packages are missing in the DataPackageManager.

Default

true

debugLogVersions

debugLogVersions: boolean

If enabled, logs the game, library version, and user agent to data storage, which can be used for debugging purposes.

Default

true

OptionalmaximumMessages

maximumMessages?: number

Determines the maximum number of chat messages to log in MessageManager.

Default

1000

Remarks

If 0 or fewer, message logging will effectively be disabled.

Optionaltimeout

timeout?: number

The maximum number of milliseconds to wait for a response from the server when awaiting a response to a client packet.

Default

10000

Settings

Member Visibility

On This Page

Properties