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.
Works unchanged
Section titled “Works unchanged”- 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.inikeys keep their names and types in both sections (SGCLoadingScreenSettings,SGCStartupLoadingScreenSettings), includingShadowBlur(shown asShadow Opacity). Debug overlay enums keep names and values.bManualLoadingScreen=Truewithout a mode entry is migrated to the Manual mode.- A new empty
LoadingScreenWidgetnow shows the built-in screen instead of nothing.
Changed for Blueprint
Section titled “Changed for Blueprint”- 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.
Changed for C++
Section titled “Changed for C++”- Only the public headers of
SGCLoadingScreenRuntimeare 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. UseUSGCLoadingScreenBlueprintLibrary(Push, Dismiss, Is Loading Screen Visible, Get Active Loading Screen Widget) andFSGCScopedLoadingHold. To wait for the dismissal useUSGCAsyncAction_WaitLoadingScreenDismissed. There is no replacement forHasLoadingScreenRequestand for the nativeFOnSGCLoadingScreenDismisseddelegate.USGCStartupLoadingScreenSettings::PersistDefaultConfig()andEditorSyncImagePathsFromDisk()(editor only) are removed, with no deprecated wrapper. There is no public replacement. EditDefaultGame.inior use Project Settings.SGCStartupLoadingScreenStatusPage::Create(const FSGCStartupLoadingScreenViewConfig&, bool)is removed.FSGCStartupLoadingScreenViewConfigis now Private. UseCreateFromSettings(Settings).SGCStartupLoadingScreenStatusPage::CreateFromSettings(Settings, bool): theboolparameter is removed. Calls with one argument still compile. Calls with an explicitbooland 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
USGCLoadingScreenWidgetFactoryandFSGCLoadingScreenEditorStyleare Private now. The factory creates a ready layout instead of an empty widget. USGCLoadingScreenSettings::bManualLoadingScreenis kept only to migrate old ini files and is hidden from Details. Writing it from C++ at run time no longer changes the mode. SetLoadingScreenMode.
Removed settings
Section titled “Removed settings”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.