Modes and closing
This page explains when the screen appears and closes. Read it before you pick Loading Screen Mode in Project Settings.
| Mode | Shown | Closed |
|---|---|---|
| Automatic | on travel, server connection, game holds | when no hold is left |
| Auto Show, Manual Dismiss | on travel, server connection, game holds | only by Dismiss Loading Screen |
| Manual | only by Push Loading Screen | only by Dismiss Loading Screen |
| Manual Show, Auto Dismiss | only by Push Loading Screen | when no hold is left |
The default mode, Auto Show / Manual Dismiss, behaves as in 1.0.0.
Closing order
Section titled “Closing order”- Loading completes.
- World rendering resumes.
- The screen waits for a fresh texture streaming count, up to Auto Dismiss Max Texture Streaming Wait Secs. This applies to every mode.
- Progress runs out to 100 %.
- Fade-out, with an optional zoom (Dismiss Zoom Scale).
Dismiss Loading Screen closes at once, whatever holds remain.
Events and state
Section titled “Events and state”- Get Loading Screen Events returns an object with On Shown, On Dismiss Started and On Finished. You can subscribe before the widget exists.
- Get Loading State returns Unavailable, Idle, Pending, Visible or FadingOut.
- Wait For Loading Screen Shown is the async node. Its outcome is Ready, Cancelled, Timed Out or Show Failed.
Shown (visible), dismiss started (the fade-out begins) and finished (the screen is gone) are three different moments.
Max Visible Secs
Section titled “Max Visible Secs”Max Visible Secs (0 = off) closes the screen with the Timed Out outcome that many seconds after it first became visible. A forgotten Dismiss then does not hold the screen forever.
Continue On Input
Section titled “Continue On Input”Continue On Input is off by default. Switch it during the game with Set Loading Screen Continue On Input.
After 100 % the screen waits for a key, a click, a gamepad button or a touch. In the manual modes Dismiss waits for it too. The widgets of the screen receive input and focus while the rest of the game input stays blocked.
See also Accessibility and the settings reference.