LoadingScreenProps
Extends
Section titled “Extends”LoadingScreenOptions.Partial<Omit<GameLoadingScreenProps,"value"|"stage">>
Properties
Section titled “Properties”| Property | Type | Description |
|---|---|---|
art? |
string |
The address of an image drawn behind the screen, filling it, such as a file in the game’s public folder. The screen darkens it toward the bar, so the words stay readable over it. |
label? |
string |
That stage in plain words, such as “Preparing shaders”. |
line? |
string |
One line under the name. |
problem? |
LoadingProblem | null |
A stall or a failure to show, or null. |
retry? |
() => void |
Reloads the page, for the button a problem shows. |
tips? |
readonly string[] |
Lines shown one at a time over the bar, each for a few seconds, in their order. |
title? |
string |
The game’s name, large, over the bar. |
value |
number | null |
How far the load is, from 0 to 1; null for a screen with no load to show, such as the one an error leaves. |