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.

Blueprint API

Waits until the server reports that every player has loaded the current map (Wait For All Players).

Waits until all players have loaded the current map, then fires On Ready. Call it after the map has loaded, for example before Dismiss Loading Screen in the manual modes. Fires at once when Wait For All Players is off or the game is not networked. Timed Out: the server stopped waiting because some players did not load in time. On a dedicated server, waits for the server’s current map readiness and uses only the server’s player wait timeout. If no player wait has started, keeps waiting until one starts or the world is cleaned up. World cleanup ends the wait without firing On Ready.

static USGCAsyncAction_WaitForAllPlayers* WaitForAllPlayersReady()
Parameter Type Direction Default Note
ReturnValue USGCAsyncAction_WaitForAllPlayers* output — —

FSGCAllPlayersReadyDelegate OnReady
Parameter Type Direction Default Note
bTimedOut bool output — —

USGCAsync Action Wait Loading Screen Dismissed

Section titled “USGCAsync Action Wait Loading Screen Dismissed”

Success-only wait until the loading screen is hidden (after Dismiss fade-out).

Success-only wait until the loading screen is hidden after the Dismiss fade-out. Fires on the next frame if no screen is shown or requested, and on a dedicated server (it has no screen).

static USGCAsyncAction_WaitLoadingScreenDismissed* WaitForLoadingScreenDismissed()
Parameter Type Direction Default Note
ReturnValue USGCAsyncAction_WaitLoadingScreenDismissed* output — —

FSGCLoadingScreenDismissedAsyncDelegate OnDismissed

USGCAsync Action Wait Loading Screen Shown

Section titled “USGCAsync Action Wait Loading Screen Shown”

Waits for the current pending request, or the next request when idle, to show its screen.

Waits until the current pending request is shown; when idle, waits for the next request. An already visible or fading screen succeeds on the next frame with its captured request context. Cancellation before showing, failure to create a screen, and an unavailable screen subsystem use On Not Shown. A dedicated server is Unavailable. No timeout is applied. Showing does not mean loading has completed.

static USGCAsyncAction_WaitLoadingScreenShown* WaitForLoadingScreenShown()
Parameter Type Direction Default Note
ReturnValue USGCAsyncAction_WaitLoadingScreenShown* output — —

The screen reached Visible. Context identifies the request, even if it has since finished.

FSGCLoadingScreenShownAsyncDelegate OnShown
Parameter Type Direction Default Note
Context FSGCLoadingScreenContext output — —

The request was cancelled before showing, failed to show, or has no available screen subsystem.

FSGCLoadingScreenNotShownAsyncDelegate OnNotShown
Parameter Type Direction Default Note
Outcome ESGCLoadingScreenShownOutcome output — —

Watches PSO precompilation (graphics pipelines prepared for this GPU and driver; long on the first run of a build). The plugin does not hold players for it: your game decides, for example shows a notice or warns before New Game.

On Started: precompilation is running (Total: PSOs left when watching started). On Progress: Remaining and Progress (0..1), at most 10 times per second. On Finished: nothing is left to precompile (Seconds watched). Fires at the first check (0.1 s) if nothing runs now.

static USGCAsyncAction_WatchPSOPrecompile* WatchPSOPrecompile()
Parameter Type Direction Default Note
ReturnValue USGCAsyncAction_WatchPSOPrecompile* output — —

FSGCPSOPrecompileStartedDelegate OnStarted
Parameter Type Direction Default Note
Total int32 output — —

FSGCPSOPrecompileProgressDelegate OnProgress
Parameter Type Direction Default Note
Remaining int32 output — —
Progress float output — —

FSGCPSOPrecompileFinishedDelegate OnFinished
Parameter Type Direction Default Note
Seconds float output — —

Blueprint access to the game-instance loading screen.

Requests the loading screen for the current game instance. Available in every mode. A visible request is kept; an ordinary dismiss fade is cancelled. A fade forced by Max Visible Secs cannot be cancelled; request a new screen after it finishes.

static void PushLoadingScreen()

Cancels a pending request, or fades out the visible screen even if loading or holds remain. With Continue On Input enabled, releases the manual gate instead: closing waits until loading reaches 100% and a new key, mouse button, gamepad button or touch confirms. Max Visible Secs can force closing. Available in every mode. Wait For Loading Screen Dismissed fires after the screen is removed.

static void DismissLoadingScreen()

Returns the Game Instance event source for shown, dismiss-started and finished notifications. Null when screens are unavailable.

static USGCLoadingScreenEvents* GetLoadingScreenEvents()
Parameter Type Direction Default Note
ReturnValue USGCLoadingScreenEvents* output — —

Returns Unavailable without a screen subsystem (including a dedicated server), otherwise its current lifecycle state.

static ESGCLoadingScreenState GetLoadingState()
Parameter Type Direction Default Note
ReturnValue ESGCLoadingScreenState output — —

Changes Continue On Input for this Game Instance without writing Project Settings. Applies to the visible screen and future requests. Disabling releases its continue gate immediately. When enabled, closing waits for new discrete input after 100% progress; in manual modes Dismiss must release the manual gate too. Repeats, analog input, console/PIE exceptions and MoviePlayer input do not confirm. Each network machine waits independently. Max Visible Secs still closes the screen.

static void SetLoadingScreenContinueOnInput(bool bEnabled)
Parameter Type Direction Default Note
bEnabled bool input — —

Returns the displayed loading progress from 0 to 1. Resets for each new load cycle. Returns 0 without a screen.

static float GetLoadingProgress()
Parameter Type Direction Default Note
ReturnValue float output — —

Returns whether the loading screen is currently attached to the viewport.

static bool IsLoadingScreenVisible()
Parameter Type Direction Default Note
ReturnValue bool output — —

Returns the active loading screen widget, or null if it is not currently shown.

static USGCLoadingScreenWidget* GetActiveLoadingScreenWidget()
Parameter Type Direction Default Note
ReturnValue USGCLoadingScreenWidget* output — —

Fires Set Custom Text 1 on the active loading screen. No-op if none is visible.

static void SetCustomText1(const FText& CustomText)
Parameter Type Direction Default Note
CustomText const FText& input — —

Deprecated Replacement — Use Add Loading Tips and the SGC Loading Tip widget. Still works.

Fires Set Custom Text 2 on the active loading screen. No-op if none is visible.

static void SetCustomText2(const FText& CustomText)
Parameter Type Direction Default Note
CustomText const FText& input — —

Deprecated Replacement — Use Add Loading Tips and the SGC Loading Tip widget. Still works.

Fires Set Custom Text 3 on the active loading screen. No-op if none is visible.

static void SetCustomText3(const FText& CustomText)
Parameter Type Direction Default Note
CustomText const FText& input — —

Deprecated Replacement — Use Add Loading Tips and the SGC Loading Tip widget. Still works.

Fires Set Custom Progress on the active loading screen. No-op if none is visible.

static void SetCustomProgress(float Progress)
Parameter Type Direction Default Note
Progress float input — —

Fires Notify Custom on the active loading screen. Does not dismiss the screen. No-op if none is visible.

static void NotifyCustom()

Fires Set Custom Image on the active loading screen. No-op if none is visible.

static void SetCustomImage(UTexture2D* CustomImage)
Parameter Type Direction Default Note
CustomImage UTexture2D* input — —

Deprecated Replacement — Use Add Loading Backgrounds and the SGC Loading Background widget. Still works.

Saves the player’s motion preference in GameUserSettings.ini, overriding Project Settings. Applies immediately to all current loading screens on this machine; startup uses it from the next launch. Widget animations and movies are unaffected.

static void SetLoadingScreenReduceMotion(bool bReduceMotion)
Parameter Type Direction Default Note
bReduceMotion bool input — —

Returns the saved player preference, or the project default when no player choice has been saved.

static bool GetLoadingScreenReduceMotion()
Parameter Type Direction Default Note
ReturnValue bool output — —

Keeps the loading screen visible for a reason of your game (for example LoadingScreen.Hold.Quests), with an optional progress (0..1, -1 = unknown) and status line. Calling it again with the same reason updates the progress and the text. In the automatic show modes it also shows the screen. The calling object owns the hold: if it is destroyed, the hold is released (with a warning in the log).

static void SetLoadingScreenHold(FGameplayTag Reason, float Progress = -1.0f, const FText& StatusText = FText::GetEmpty())
Parameter Type Direction Default Note
Reason FGameplayTag input — —
Progress float input -1 —
StatusText const FText& input — Advanced pin

Advanced — StatusText

Releases a hold only when called by the object that set it.

static void ReleaseLoadingScreenHold(FGameplayTag Reason)
Parameter Type Direction Default Note
Reason FGameplayTag input — —

Returns whether a hold with this reason is set.

static bool IsLoadingScreenHeld(FGameplayTag Reason)
Parameter Type Direction Default Note
Reason FGameplayTag input — —
ReturnValue bool output — —

Every reason that keeps the screen now, including the plugin’s own (travel, assets, shaders, players…).

static TArray<FSGCLoadingHold> GetLoadingScreenHolds()
Parameter Type Direction Default Note
ReturnValue TArray&lt;FSGCLoadingHold&gt; output — —

Adds tips for SGC Loading Tip. Each tip is shown once per round, in a new order each round; the round continues after a game restart. A tip already in the list is not added twice. Selected Replace Common content sets hide these tips for their destination maps.

static void AddLoadingTips(const TArray<FText>& Tips)
Parameter Type Direction Default Note
Tips const TArray&lt;FText&gt;&amp; input — —

Removes tips added by Add Loading Tips. Matching tips from content sets remain. A removed tip shown now is replaced at once.

static void RemoveLoadingTips(const TArray<FText>& Tips)
Parameter Type Direction Default Note
Tips const TArray&lt;FText&gt;&amp; input — —

Removes all tips added by Add Loading Tips. Tips from content sets remain.

static void ClearLoadingTips()

Adds backgrounds for SGC Loading Background: an image and an optional text of its own. Images load in the background only while the loading screen shows them; one that fails to load is removed. Each background is shown once per round, in a new order each round; the round continues after a game restart. Selected Replace Common content sets hide these backgrounds for their destination maps.

static void AddLoadingBackgrounds(const TArray<FSGCLoadingBackground>& Backgrounds)
Parameter Type Direction Default Note
Backgrounds const TArray&lt;FSGCLoadingBackground&gt;&amp; input — —

Removes backgrounds added by Add Loading Backgrounds. Matching backgrounds from content sets remain. A removed background shown now is replaced at once.

static void RemoveLoadingBackgrounds(const TArray<FSGCLoadingBackground>& Backgrounds)
Parameter Type Direction Default Note
Backgrounds const TArray&lt;FSGCLoadingBackground&gt;&amp; input — —

Removes all backgrounds added by Add Loading Backgrounds. Backgrounds from content sets remain.

static void ClearLoadingBackgrounds()

Whether PSO precompilation runs now (graphics pipelines prepared for this GPU and driver), and how many are left. Use it, for example, to warn the player before New Game that the first minutes may stutter.

static bool GetPSOPrecompileStatus(int32& Remaining)
Parameter Type Direction Default Note
Remaining int32&amp; output — —
ReturnValue bool output — —

Shows or hides the metrics overlay. Does not write Project Settings.

static void SetMetricsOverlayEnabled(bool bEnabled)
Parameter Type Direction Default Note
bEnabled bool input — —

Selects FPS, Memory, or both. Does not write Project Settings.

static void SetMetricsOverlayMode(ESGCDebugOverlayMode Mode)
Parameter Type Direction Default Note
Mode ESGCDebugOverlayMode input — —

Moves the overlay to a screen corner. Does not write Project Settings.

static void SetMetricsOverlayCorner(ESGCDebugOverlayCorner Corner)
Parameter Type Direction Default Note
Corner ESGCDebugOverlayCorner input — —

Sets overlay text color. Does not write Project Settings.

static void SetMetricsOverlayColor(FLinearColor Color)
Parameter Type Direction Default Note
Color FLinearColor input — —

A loading screen background. The image loads in the background only while the screen needs it.

Editor name Description Default Constraints
Image
Image
Image of the slide. Best in the UI texture group without mips. None —
Tip
Tip
Text shown with this image by SGC Loading Tip. Empty: the next tip from Add Loading Tips. — —

How a selected map-specific set combines with common content.

Value Description
Add to Common Include common sets and content added through Add Loading Tips and Add Loading Backgrounds.
Replace Common Exclude common sets and content added through Add Loading Tips and Add Loading Backgrounds.

One reason that keeps the loading screen visible.

Editor name Description Default Constraints
Reason
Reason
Hold reason (LoadingScreen.Hold.*). Empty gameplay tag —
Progress
Progress
0..1, or negative when the progress is unknown. -1 —
Status Text
StatusText
Status line of this hold. Empty: the hold has no line. — —
Held Secs
HeldSecs
Seconds since the hold was set. 0 —

When the loading screen is shown and dismissed.

Value Description
Auto Show, Manual Dismiss Shown automatically on map travel, seamless travel, server connection and game holds. Closed only by Dismiss Loading Screen.
Automatic Shown automatically on map travel, seamless travel, server connection and game holds. Closed automatically when no hold is left.
Manual Shown only by Push Loading Screen. Closed only by Dismiss Loading Screen.
Manual Show, Auto Dismiss Shown only by Push Loading Screen. Closed automatically when no hold is left.

Value Description
Top Left —
Top Right —
Bottom Left —
Bottom Right —

Value Description
FPS —
Memory —
FPS and Memory —

Current phase of the game-instance loading screen.

Value Description
Unavailable —
Idle —
Pending —
Visible —
Fading Out —

Origin of a loading screen request.

Value Description
None —
Manual —
Hold —
Map Travel —
Seamless Travel —
Client Travel —
Server Connection —

Final result of a loading screen request. Ready means loading completed, not merely that the screen was shown.

Value Description
Ready —
Cancelled —
Timed Out —
Show Failed —

Result of waiting for a screen to appear; Unavailable includes a dedicated server, which has no screen.

Value Description
Cancelled —
Show Failed —
Unavailable —

Immutable identity and origin of one loading screen request.

Editor name Description Default Constraints
Request Id
RequestId
Identifies this request within its Game Instance. 0 —
Reason
Reason
What requested the loading screen. None —
Map Key
MapKey
Destination map path or name, or an empty string when no map is known. — —

Result paired with the request that produced it, including when a callback starts another request.

Editor name Description Default Constraints
Context
Context
Identifies the request associated with this result, even if another screen has since been requested. RequestId 0, Reason None, empty MapKey —
Outcome
Outcome
Whether loading completed, was cancelled, exceeded Max Visible Secs, or failed to show a screen. Cancelled —