Namespace: client

Classes

Interfaces

Type Aliases

LoadCallback

Ƭ LoadCallback: (onProgress: (…args: [progress: number] | [at: number, total: number]) => void) => Promise<void>

Load callback passed to the client load. The load callback will receive an updateProgress function as a parameter which the load function should call in order to update the platform specific load progress indicator.

The progress callback itself supports two types of arguments:

  • (progress: number) - Should be a number between 0 and 100
  • (at: number, total: number) - At should be lower than or equal to total

Type declaration

▸ (onProgress): Promise<void>

Parameters
Name Type
onProgress (…args: [progress: number] | [at: number, total: number]) => void
Returns

Promise<void>


StartCallback

Ƭ StartCallback: () => Promise<void>

Start callback passed to the client start. The start callback is called just before the platform specific splash screen is hidden. It’s usually a good idea to render the first frame during this to ensure there are no flashes of unitialized content.

Type declaration

▸ (): Promise<void>

Returns

Promise<void>