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.

Upgrade from 1.0.0

This page lists what to check when you move a project from version 1.0.0 to the current version. Read the C++ part if your game includes plugin headers.

  • All 15 Blueprint nodes of 1.0.0 keep their names and pins: Push / Dismiss Loading Screen, Is Loading Screen Visible, Get Active Loading Screen Widget, Set Custom Progress, Notify Custom, the four Metrics Overlay setters, Wait For Loading Screen Dismissed with its On Dismissed pin. Existing graphs load and run.
  • All widget events of SGC Loading Screen Widget (Set Custom Text 1/2/3, Set Custom Progress, Level Load Status, Notify Custom, Set Custom Image) are still called.
  • DefaultGame.ini keys keep their names and types in both sections (SGCLoadingScreenSettings, SGCStartupLoadingScreenSettings), including ShadowBlur (shown as Shadow Opacity). Debug overlay enums keep names and values.
  • bManualLoadingScreen=True without a mode entry is migrated to the Manual mode.
  • A new empty LoadingScreenWidget now shows the built-in screen instead of nothing.
  • Set Custom Text 1/2/3 are deprecated: use Add Loading Tips. They keep working and still call the widget events.
  • Set Custom Image is deprecated: use Add Loading Backgrounds. It keeps working.
  • Push Loading Screen and Dismiss Loading Screen can be hidden from the node menu, depending on Loading Screen Mode. Nodes already placed keep working. The default mode (Auto Show / Manual Dismiss) behaves as in 1.0.0.
  • Wait For Loading Screen Dismissed now also fires on a dedicated server (next frame).
  • Block Input While Visible: in PIE, Escape and Shift+F1 pass through. In all non-shipping builds the console key and the keyboard while the console is open pass through. Shipping builds block all game input.
  • Load Status Complete Delay Secs: the key is kept. Completion is now decided by holds.
  • Only the public headers of SGCLoadingScreenRuntime are stable. Headers of the other modules (Startup, Core, Editor) may change in any version.
  • USGCLoadingScreenSubsystem (PushLoadingScreen, DismissLoadingScreen, IsLoadingScreenVisible, HasLoadingScreenRequest, GetActiveLoadingScreenWidget, CallOrRegister_OnLoadingScreenDismissed, RemoveOnLoadingScreenDismissed, FOnSGCLoadingScreenDismissed) was exported and public. It is now Private and the include no longer works. Use USGCLoadingScreenBlueprintLibrary (Push, Dismiss, Is Loading Screen Visible, Get Active Loading Screen Widget) and FSGCScopedLoadingHold. To wait for the dismissal use USGCAsyncAction_WaitLoadingScreenDismissed. There is no replacement for HasLoadingScreenRequest and for the native FOnSGCLoadingScreenDismissed delegate.
  • USGCStartupLoadingScreenSettings::PersistDefaultConfig() and EditorSyncImagePathsFromDisk() (editor only) are removed, with no deprecated wrapper. There is no public replacement. Edit DefaultGame.ini or use Project Settings.
  • SGCStartupLoadingScreenStatusPage::Create(const FSGCStartupLoadingScreenViewConfig&, bool) is removed. FSGCStartupLoadingScreenViewConfig is now Private. Use CreateFromSettings(Settings).
  • SGCStartupLoadingScreenStatusPage::CreateFromSettings(Settings, bool): the bool parameter is removed. Calls with one argument still compile. Calls with an explicit bool and pointers to the old function type do not. The page is always created in preview mode.
  • FSGCLoadWorkSnapshot::Capture() (from 2.0.0): call it on the game thread only.
  • The headers of USGCLoadingScreenWidgetFactory and FSGCLoadingScreenEditorStyle are Private now. The factory creates a ready layout instead of an empty widget.
  • USGCLoadingScreenSettings::bManualLoadingScreen is kept only to migrate old ini files and is hidden from Details. Writing it from C++ at run time no longer changes the mode. Set LoadingScreenMode.

ShowRetryIntervalSecs (Show Retry Interval Secs) is removed. An old entry in DefaultGame.ini is ignored: it is not an error and has no effect. You can delete the line. C++ code that read or wrote it no longer compiles.

See What’s new for the full list of changes.