Class LoadingScreen

Shows or Hides a loading screen over the canvas.

Index

Constructors

Accessors

Methods

destroy hide show

Constructors

constructor

new LoadingScreen(visual, onShow?, onHide?, options?): LoadingScreen
Constructor. Creates a new LoadingScreen that will show/hide a loading screen over the canvas.
Parameters
- visual: Visual
- Optional onShow: (() => void)
  A function that will get called when the LoadingScreen show method has been called.
  - - (): void
    - Returns void
- Optional onHide: (() => void)
  A function that will get called when the LoadingScreen hide method has been called.
  - - (): void
    - Returns void
- Optional options: LoadingScreenOptions
  The set of options to be used during initialization.
Returns LoadingScreen
- Defined in visual/loadingScreen/loadingScreen.ts:51

Accessors

destroyed

get destroyed(): boolean
State of instance destructions.

Returns boolean
The state of instance destructions.
- Defined in visual/loadingScreen/loadingScreen.ts:185

Methods

destroy

destroy(): void
Destroys the LoadingScreen and releases all of it's resources.

Returns void
- Defined in visual/loadingScreen/loadingScreen.ts:168

hide

hide(): void
Hides the loading screen.

Returns void
- Defined in visual/loadingScreen/loadingScreen.ts:151

show

show(): void
Shows the loading screen.

Returns void
- Defined in visual/loadingScreen/loadingScreen.ts:74

Generated using TypeDoc