Skip to content
This documentation describes SGC Loading Screen 2.5.0, which is coming to FAB soon. The version on FAB now is 1.0.0.

Runtime settings

Runtime loading screen settings.

Editor name Description Default Constraints
Reduce Motion
bReduceMotion
Default for the plugin’s own motion. A saved player choice overrides this value; startup reads it on the next launch. Widget animations and movies are unaffected. false —
Editor name Description Default Constraints
Loading Screen Widget
LoadingScreenWidget
Widget class displayed by the runtime loading screen. Preloaded at Game Instance start and kept loaded. None (built-in loading screen) —
Loading Screen Mode
LoadingScreenMode
When the loading screen is shown and dismissed. Push Loading Screen and Dismiss Loading Screen remain available in every mode. Continue On Input adds a confirmation gate after 100% progress; Max Visible Secs can force closing in every mode. Auto Show, Manual Dismiss —
Keep Elements Alive During Map Load
bKeepElementsAliveDuringMapLoad
During a blocking map load the screen is drawn on the loading thread (MoviePlayer): the plugin’s elements keep moving (animation, slides, tips), your UMG stays still. Off: the screen freezes for the load, as before. The screen comes back before BeginPlay of the new map. Not in the editor or PIE (MoviePlayer is off there), and not for a screen with property bindings, a Blueprint OnPaint, list views or a Retainer Box (a compile warning tells). A see-through screen shows black behind it during the load instead of the frozen world. true —
Loading Screen ZOrder
LoadingScreenZOrder
Viewport Z-order of the loading screen. 10000 —
Block Input While Visible
bBlockInputWhileVisible
Routes input to the loading screen and consumes input aimed at the rest of this game’s viewport while visible. Interactive controls inside the screen keep working; unhandled screen input does not reach gameplay. While MoviePlayer owns the screen, input is blocked before UMG callbacks. Outside MoviePlayer, in non-shipping builds the console key and the keyboard while the console is open pass through. In the editor (PIE) only input aimed at this game’s viewport is consumed, and Escape and Shift+F1 always pass, so Stop, the editor UI and other PIE windows keep working. false —
Fast PSOPrecompile While Visible
bFastPSOPrecompileWhileVisible
Switches PSO precompilation to fast batch mode while the screen is visible, back to background after. Turn off if the project manages FShaderPipelineCache batch mode itself. true —
Disable World Rendering While Visible
bDisableWorldRenderingWhileVisible
Disables world rendering during loading and settling. Rendering resumes when loading completes, before texture streaming and the dismiss fade. false —
Dismiss Fade Out Secs
DismissFadeOutSecs
Seconds to fade the widget out after Dismiss Loading Screen. World rendering resumes when loading completes, before texture streaming, or at fade start after an early Dismiss. 0 removes the widget immediately. 0.4 Minimum — 0.0
Fixed units — s
Max Visible Secs
MaxVisibleSecs
Maximum seconds from the first Visible frame of a request, including MoviePlayer and waiting for players. Returning from a cancelled fade does not restart the limit. 0 disables it. On expiry the screen fades out with TimedOut even if loading or holds remain; successful load history is not recorded. The fade duration is additional. A blocking map load cannot be interrupted: expiry is handled when the game thread resumes. 0 Minimum — 0.0
Fixed units — s
Continue on Input
bContinueOnInput
Waits for a new key, mouse button, gamepad button or touch after loading progress reaches 100%. Replaces automatic closing. In manual dismiss modes, Dismiss releases the manual gate and closing waits for this input too. The continue gate does not count as loading work or delay readiness. Repeats, pointer motion, analog controls and console or PIE escape keys do not confirm. Input is unavailable while MoviePlayer owns the screen. Intended for a single player: each network machine waits for its own input, independently of Wait For All Players. Max Visible Secs still closes the screen. Can be changed for the current Game Instance with Set Loading Screen Continue On Input. false —
Dismiss Zoom Scale
DismissZoomScale
Scale reached at the end of the dismiss fade, zooming around the screen center. 1 disables the zoom. 1.04 Minimum — 1.0
Maximum — 1.2
Load Status Complete Delay Secs
LoadStatusCompleteDelaySecs
Seconds without holds before loading counts as complete, so late Game Feature or deferred assets can still appear. Auto-dismiss modes then close the screen. With Wait For All Players, this player reports that it has loaded. 1 Minimum — 0.0
Fixed units — s
Load Status Max PSO Wait Secs
LoadStatusMaxPSOWaitSecs
Limits the wait when only PSO precompilation is left. Timing starts when PSOs are the only work. Any other work resets it. On expiry, the PSO hold is released and loading completes after Load Status Complete Delay, allowing auto-dismiss to close the screen. SGC Load Status shows “PSO compiling in background: N”. PSOs keep compiling in the background, so short hitches are possible. Useful on the first run of a new build, when the driver PSO cache is empty. 0 = no limit. 0 Minimum — 0.0
Fixed units — s
Auto Dismiss Max Texture Streaming Wait Secs
AutoDismissMaxTextureStreamingWaitSecs
After loading completes and world rendering resumes, waits for a fresh texture streaming count, up to this many seconds, before progress reaches 100%. Applies in every mode. 0 skips this wait. 3 Minimum — 0.0
Fixed units — s
Editor name Description Default Constraints
Content Sets
ContentSets
Sets prepared asynchronously at Game Instance start. Sets without maps supply common content. — —
Editor name Description Default Constraints
Enable Game Feature Actions
bEnableGameFeatureActions
Enables Add Loading Content actions. Requires the GameFeatures plugin to be enabled in the project and an editor restart. false Restart required — TRUE
Editor name Description Default Constraints
Wait for All Players
bWaitForAllPlayers
Network games: after a map change the loading screen closes on every machine at the same time, when all players have loaded. While waiting, SGC Load Status shows “Waiting for players: N of M”. Read at Game Instance start; restart after changing it. false —
Wait for Players Timeout Secs
WaitForPlayersTimeoutSecs
Server: how long to wait for players who have not loaded. Then On Wait For Players Timeout fires in the widget. 30 Active when — Wait for All Players on
Minimum — 1.0
Fixed units — s
Timeout Travel Map
TimeoutTravelMap
Server: level to travel everyone to after the timeout (for example a lobby). Empty: continue without the missing players. None Active when — Wait for All Players on
Editor name Description Default Constraints
Enable Debug Overlay
bEnableDebugOverlay
Enables the runtime metrics overlay at Game Instance start. false —
Debug Overlay Mode
DebugOverlayMode
Metrics shown by the overlay. FPS and Memory Active when — Enable Debug Overlay on
Debug Update Interval Secs
DebugUpdateIntervalSecs
Metrics refresh interval. 0.5 Active when — Enable Debug Overlay on
Minimum — 0.1
Fixed units — s
Debug Overlay Corner
DebugOverlayCorner
Screen corner used by the metrics overlay. Top Left Active when — Enable Debug Overlay on
Debug Overlay ZOrder
DebugOverlayZOrder
Viewport Z-order of the metrics overlay. 25000 Active when — Enable Debug Overlay on
Debug Overlay Padding
DebugOverlayPadding
Padding around the metrics overlay. 12 on every side Active when — Enable Debug Overlay on
Debug Overlay Font
DebugOverlayFont
Font used by the metrics overlay. Engine default Regular, size 10 Active when — Enable Debug Overlay on
Debug Overlay Color
DebugOverlayColor
Text color used by the metrics overlay. Green (RGBA 0, 1, 0, 1) Active when — Enable Debug Overlay on