Skip to content

LoadingSceneProgressBarOptions

Defined in: ui/src/LoadingSceneProgressBar.ts:18

Customization for the default loading progress bar.

optional anchor?: Anchor

Defined in: ui/src/LoadingSceneProgressBar.ts:35

Screen anchor for the bar. Default Anchor.Center.


optional backdrop?: BackgroundOptions

Defined in: ui/src/LoadingSceneProgressBar.ts:33

Full-viewport backdrop rendered behind the bar. Without one, the loading scene is transparent and the outgoing scene bleeds through during transitions. Set to a solid color or a textured background to cover the viewport.


optional fill?: BackgroundOptions

Defined in: ui/src/LoadingSceneProgressBar.ts:26

Fill (progress) background. Default solid cyan.


optional height?: number

Defined in: ui/src/LoadingSceneProgressBar.ts:22

Bar height in virtual pixels. Default 16.


optional layer?: string

Defined in: ui/src/LoadingSceneProgressBar.ts:39

Name of the UI layer to mount on. Default UI’s auto-provisioned layer.


optional offset?: object

Defined in: ui/src/LoadingSceneProgressBar.ts:37

Offset from the anchor in virtual pixels. Default { x: 0, y: 0 }.

x: number

y: number


optional track?: BackgroundOptions

Defined in: ui/src/LoadingSceneProgressBar.ts:24

Track (background) background. Default solid dark slate.


optional width?: number

Defined in: ui/src/LoadingSceneProgressBar.ts:20

Bar width in virtual pixels. Default 400.