Reference
Blueprint Nodes
Loading Screen Manager
Get it with the Loading Screen Manager node, which is a Game Instance Subsystem getter. It doesn't exist on a dedicated server.
Functions
| Node | Description |
|---|---|
| Get Loading Screen Display Status | True while the loading screen is shown. |
| Get Debug Reason for Showing or Hiding Loading Screen | Why the loading screen is shown or hidden. See Displaying Reason. |
| Get Loading Screen Custom Text | The text set with Set Loading Screen Custom Text. |
| Get Current Loading Map | The name of the map that is loading, or was loaded last. |
| Add Loading Screen Watcher | Adds an object that is asked whether the loading screen should be shown. See Watchers. |
| Remove Loading Screen Watcher | Removes a watcher. |
| Set Loading Screen Custom Text | Sets a text that your widget can show. Takes a world context, so it can be called from anywhere without the manager. |
Events
Bind these on the Loading Screen Manager.
| Event | Parameter | Description |
|---|---|---|
| On Loading Screen Visibility Changed Delegate | New State | The loading screen was shown (true) or hidden (false). |
| On Show Loading Screen Additional Secs Triggered | Is Active | The extra hold time started (true), or the loading screen was hidden (false). |
| On Pre Load Map Triggered | Map Name | A map started loading. |
| On Post Load Map Triggered | A map finished loading. | |
| On Seamless Travel Start | Map Name | Seamless travel started. |
Loading Process Task
Shows the loading screen on demand. See Show on Demand.
| Node | Description |
|---|---|
| Create Loading Screen Process Task | Creates a task and shows the loading screen with the given reason. Returns the task. |
| Unregister | Removes the task, so it no longer keeps the loading screen up. |
| Set Show Loading Screen Reason | Changes the reason of the task. |
Loading Process Interface
Implement it on the Game State, a Player Controller, one of their components or a Watcher.
| Function | Description |
|---|---|
| Should Show Loading Screen | Return true to show the loading screen. Set Out Debug Reason to say why. |