Skip to main content

Introduction

The CommonLoadingScreen Plugin​

The CommonLoadingScreen plugin (CLS) is an extension of the loading screen that was released with the Lyra demo for Unreal Engine 5. It also adds support for earlier Unreal Engine versions.

The plugin shows a loading screen automatically while the game is loading, and keeps it up until nothing in the game needs it anymore. Any object can ask for the loading screen by implementing the Loading Process Interface.

Features​

  • Splash screen on game startup, shown before the engine has finished loading. Choose between a black screen, a loading text or an image. See Splash Screen.
  • Automatic loading screens when loading a level, during seamless travel and when connecting to a server. See When the Loading Screen Is Shown.
  • Your own UMG widget as the loading screen, set in Project Settings. See Using the Plugin.
  • Keep the loading screen up from your own code by implementing the Loading Process Interface on the Game State, Player Controller, their components or any Watcher.
  • Show it on demand from any Blueprint with a world context. See Show on Demand.
  • A reason for every loading screen, which you can show in the widget or print to the log. See Displaying Reason.
  • Extra hold time after loading finishes, so texture streaming can catch up before the world becomes visible.
  • Blocked maps that never show a loading screen, such as a main menu level.
  • Input is blocked while the loading screen is shown.

Requirements​

Target platformsWindows, Mac, Linux, Android, iOS
Dedicated serversNo loading screen is created on a dedicated server
Unreal EngineSee the Fab listing for the supported engine versions

Where to go next​

  1. Install the plugin
  2. Configure it in Project Settings
  3. Create your loading screen widget
  4. Read When the Loading Screen Is Shown to understand what keeps it up