1. Epic GamesDeveloper
  3. FPreLoadScreenManager

FPreLoadScreenManager

Class that handles storing all registered PreLoadScreens and Playing/Stopping them.

API > API/Runtime > API/Runtime/PreLoadScreen

References

   
Module PreLoadScreen
Header /Engine/Source/Runtime/PreLoadScreen/Public/PreLoadScreenManager.h
Include #include "PreLoadScreenManager.h"

Syntax

class FPreLoadScreenManager

Remarks

Class that handles storing all registered PreLoadScreens and Playing/Stopping them.

Variables

  Type Name Description
Protected variable int32 ActivePreLoadScreenIndex  
Protected variable bool bHasRenderPreLoadScreenFrame_RenderThread  
Protected variable bool bInitialized  
Protected variable bool bIsEngineLoadingComplete  
Protected variable bool bIsResponsibleForRendering  
Protected variable friend FPreLoadScreenSlateSynchMechanism  
Public variable FIsPreloadScreenResponsibleForRenderingMultiDelegate IsResponsibleForRenderingDelegate  
Protected variable double LastRenderTickTime  
Protected variable double LastTickTime  
Protected variable TWeakPtr< class SWindow > MainWindow The window that the loading screen resides in
Public variable FOnPreLoadScreenManagerCleanUp OnPreLoadScreenManagerCleanUp  
Protected variable float OriginalSlateSleepVariableValue  
Protected variable TArray< TSharedPtr< IPreLoadScreen > > PreLoadScreens  
Protected variable FPreLoadScreenSlateSynchMechanism * SyncMechanism The threading mechanism with which we handle running slate on another thread
Protected variable TSharedPtr< class SVirtualWindow > VirtualRenderWindow Virtual window that we render to instead of the main slate window (for thread safety).
Protected variable TSharedPtr< FPreLoadSlateWidgetRenderer, ESPMode::ThreadSafe > WidgetRenderer Widget renderer used to tick and paint windows in a thread safe way

Constructors

  Type Name Description
Protected function   Default constructor. We don't want other classes to make these. Should just rely on Get()

Destructors

  Type Name Description
Protected function    

Functions

  Type Name Description
Public function Static bool  
Protected function void  
Protected function void  
Protected function void  
Public function Static void

Create ()

  
Public function Static void

Destroy ()

  
Protected function void Separate tick that handles.
Protected function void  
Public function Static void

EnableRendering ( bool bEnabled
)

  
Protected function void  
Public function Static FPreLoadScreenManager *

Get ()

 Gets the single instance of this settings object. Also creates it if needed.
Protected function IPreLoadScreen *  
Protected function Const const IPreLoadScreen *  
Public function TSharedPtr< SWindow >  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Public function Const bool

HasActivePreLoadScreenType ( EPreLoadScreenTypes PreLoadScreenTypeToCheck
)

  
Protected function Const bool  
Public function Const bool

HasRegisteredPreLoadScreenType ( EPreLoadScreenTypes PreLoadScreenTypeToCheck
)

  
Public function Const bool  
Public function void

Initialize ( FSlateRenderer& InSlateRenderer
)

  
Public function Const bool  
Public function Const bool  
Public function Const void  
Protected function void  
Public function bool

PlayFirstPreLoadScreen ( EPreLoadScreenTypes PreLoadScreenTypeToPlay
)

 Plays the first found PreLoadScreen that matches the bEarlyPreLoadScreen setting passed in.
Protected function void

PlayPreLoadScreenAtIndex ( int32 Index
)

  
Public function bool Plays the PreLoadScreen with a tag that matches InTag
Protected function void Helpers that setup and clean-up delegates that only need to be active while we are playing an EarlyStartup PreLoadScreen.
Public function void

RegisterPreLoadScreen ( const TSharedPtr< IPreLoadScreen >& PreLoadScreen
)

  
Protected function void Creates a tick on the Render Thread that we run every.
Public function void

SetEngineLoadingComplete ( bool IsEngineLoadingFinished
)

  
Protected function Static void Creates a tick on the Render Thread that we run every.
Public function void  
Public function void

UnRegisterPreLoadScreen ( const TSharedPtr< IPreLoadScreen >& PreLoadScreen
)

  
Public function void  

Classes

  Type Name Description
Protected struct FPreLoadScreenManagerDelete Singleton Instance.  

Typedefs

Name Description
FIsPreloadScreenResponsibleForRenderingMultiDelegate  
FOnPreLoadScreenManagerCleanUp Callback for handling cleaning up any resources you would like to remove after the PreLoadScreenManager cleans up Not needed for PreLoadScreens as those have a separate CleanUp method called.

Constants

Name Description
AcquireCriticalSection  
bRenderingEnabled  
Instance  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page