IPreLoadScreen | Unreal Engine 5.6 Documentation

API > API/Runtime > API/Runtime/PreLoadScreen

Interface that defines the class that handles all the logic for controlling / displaying a particular PreLoadScreen. Designed to be implemented in a Plugin that calls FPreLoadScreenManager::RegisterPreLoadScreen so that functions are called by PreLoadScreenManager correctly. Really should probably inherit from FPreLoadScreenBase instead of this class for more functionality


Name	IPreLoadScreen
Type	class
Header File	/Engine/Source/Runtime/PreLoadScreen/Public/PreLoadScreen.h
Include Path	#include "PreLoadScreen.h"

Syntax

class IPreLoadScreen : public TSharedFromThis< IPreLoadScreen >

Inheritance Hierarchy

FSharedFromThisBase → TSharedFromThis → IPreLoadScreen

Derived Classes

FPreLoadScreenBase

Destructors

Name	Remarks	Include Path	Unreal Specifiers
virtual ~IPreLoadScreen()		PreLoadScreen.h

Functions

Public

Name	Remarks	Include Path
void CleanUp()		PreLoadScreen.h
float GetAddedTickDelay()	This function is used to determine if an extra platform sleep should be performed every tick (to slow down the tick rate) keeps us from spinning super fast when we aren't doing much beyond loading data / etc on other threads.	PreLoadScreen.h
FName GetPreLoadScreenTag ()	Allows the PreLoadScreen to register a tag that can be later used to find a specific loading screen.	PreLoadScreen.h
EPreLoadScreenTypes GetPreLoadScreenType ()	Should override this function to determine if this screen should be used to handle EarlyStartupScreen behavior	PreLoadScreen.h
const TSharedPtr< const SWidget > GetWidget ()		PreLoadScreen.h
TSharedPtr< SWidget > GetWidget ()		PreLoadScreen.h
void Init()		PreLoadScreen.h
bool IsDone()	Returns true when the PreLoadScreen is completed. This need to be thread safe	PreLoadScreen.h
void OnPlay ( TWeakPtr< SWindow > TargetWindow )	Callback for when a PreLoadScreen starts being displayed.	PreLoadScreen.h
void OnStop()	Callback for when a PreLoadScreen is no longer being displayed.	PreLoadScreen.h
void RenderTick ( float DeltaTime )	This tick happens as part of the slate render tick during an EarlyStartupLoadScreen	PreLoadScreen.h
void SetEngineLoadingFinished ( bool IsEngineLoadingFinished )	@See IsDone when GetPreLoadScreenType() returns EPreLoadScreenTypes::EngineLoadingScreen	PreLoadScreen.h
bool ShouldRender()	Whether an EarlyStartupLoadScreen should render	PreLoadScreen.h
void Tick ( float DeltaTime )	Standard tick that happens every frame	PreLoadScreen.h