Interface InitOptions

Settings for the client to initialize with.

interface InitOptions {
    backgroundColor?: number[];
    loadingScreenType?: LoadingScreenType;
    session?: InitSessionOptions;
    showLoadingScreen?: boolean;
}

Properties

backgroundColor? loadingScreenType? session? showLoadingScreen?

Properties

Optional backgroundColor

backgroundColor?: number[]

The background color of the canvas. An array of four numbers, ranging from 0 to 255. Default: [0, 0, 0, 0]

Deprecated

Set the background color of the canvas or parent HTML element instead

Optional loadingScreenType

loadingScreenType?: LoadingScreenType

The type of loading screen type to initialize with.

Optional session

session?: InitSessionOptions

Pass in session information to reload an existing session. A new session will be created if not defined.

Optional showLoadingScreen

showLoadingScreen?: boolean

Shows or hides the loading screen. Default: true.

Settings

Member Visibility

Theme

On This Page

backgroundColorloadingScreenTypesessionshowLoadingScreen

Generated using TypeDoc