Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > PreLoadScreen > FPreLoadScreenManager

Light Theme

Dark Theme

FPreLoadScreenManager

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

Windows

MacOS

Linux

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

	Name	Description
int32	ActivePreLoadScreenIndex
bool	bHasRenderPreLoadScreenFrame_RenderThread
bool	bInitialized
bool	bIsEngineLoadingComplete
bool	bIsResponsibleForRendering
friend	FPreLoadScreenSlateSynchMechanism
FIsPreloadScree...	IsResponsibleForRenderingDelegate
double	LastRenderTickTime
double	LastTickTime
TWeakPtr< class...	MainWindow	The window that the loading screen resides in
FOnPreLoadScree...	OnPreLoadScreenManagerCleanUp
float	OriginalSlateSleepVariableValue
TArray< TShared...	PreLoadScreens
FPreLoadScreenS...	SyncMechanism	The threading mechanism with which we handle running slate on another thread
TSharedPtr< cla...	VirtualRenderWindow	Virtual window that we render to instead of the main slate window (for thread safety).
TSharedPtr< FPr...	WidgetRenderer	Widget renderer used to tick and paint windows in a thread safe way

Constructors

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

Destructors

	Name	Description
	~FPreLoadScreenManager()

Functions

	Name	Description
bool	ArePreLoadScreensEnabled()
void	BeginPlay()
void	CleanUpResources()
void	Create()
void	Destroy()
void	EarlyPlayFrameTick()	Separate tick that handles.
void	EarlyPlayRenderFrameTick()
void	EnableRendering ( bool bEnabled )
void	GameLogicFrameTick()
FPreLoadScre...	Get()	Gets the single instance of this settings object. Also creates it if needed.
IPreLoadScre...	GetActivePreLoadScreen()
const IPreLo...	GetActivePreLoadScreen()
TSharedPtr< ...	GetRenderWindow()
void	HandleCustomSplashScreenPlay()
void	HandleEarlyStartupPlay()
void	HandleEngineLoadingPlay()
void	HandleStopPreLoadScreen()
bool	HasActivePreLoadScreenType ( EPreLoadScreenTypes PreLoadScreenTy... )
bool	HasActivePreLoadScreenTypeForEarlyStartup()
bool	HasRegisteredPreLoadScreenType ( EPreLoadScreenTypes PreLoadScreenTy... )
bool	HasValidActivePreLoadScreen()
void	Initialize ( FSlateRenderer& InSlateRenderer )
bool	IsEngineLoadingComplete()
bool	IsUsingMainWindow()
void	PassPreLoadScreenWindowBackToGame()
void	PlatformSpecificGameLogicFrameTick()
bool	PlayFirstPreLoadScreen ( EPreLoadScreenTypes PreLoadScreenTy... )	Plays the first found PreLoadScreen that matches the bEarlyPreLoadScreen setting passed in.
void	PlayPreLoadScreenAtIndex ( int32 Index )
bool	PlayPreLoadScreenWithTag ( FName InTag )	Plays the PreLoadScreen with a tag that matches InTag
void	RegisterPreLoadScreen ( const TSharedPtr< IPreLoadScreen > ... )
void	RenderTick_RenderThread()	Creates a tick on the Render Thread that we run every.
void	SetEngineLoadingComplete ( bool IsEngineLoadingFinished )
void	StaticRenderTick_RenderThread()	Creates a tick on the Render Thread that we run every.
void	StopPreLoadScreen()
void	UnRegisterPreLoadScreen ( const TSharedPtr< IPreLoadScreen > ... )
void	WaitForEngineLoadingScreenToFinish()

Classes

	Name	Description
	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

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss