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;
}
Index
autoFetchDataPackage?: boolean

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

true
debugLogVersions?: boolean

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

false

This functionality will be removed in version 3.0.0.

maximumMessages?: number

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

1000

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

timeout?: number

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

10000