UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
IPreLoadScreen Class Referenceabstract

#include <PreLoadScreen.h>

+ Inheritance diagram for IPreLoadScreen:

Public Member Functions

virtual ~IPreLoadScreen ()=default
 
virtual void Init ()=0
 
virtual void Tick (float DeltaTime)=0
 
virtual float GetAddedTickDelay ()=0
 
virtual bool ShouldRender () const =0
 
virtual void RenderTick (FRHICommandListImmediate &RHICmdList, float DeltaTime)=0
 
virtual void OnPlay (TWeakPtr< SWindow > TargetWindow)=0
 
virtual void OnStop ()=0
 
virtual bool IsDone () const =0
 
virtual void CleanUp ()=0
 
virtual EPreLoadScreenTypes GetPreLoadScreenType () const =0
 
virtual FName GetPreLoadScreenTag () const =0
 
virtual void SetEngineLoadingFinished (bool IsEngineLoadingFinished)=0
 
virtual const TSharedPtr< const SWidgetGetWidget () const =0
 
virtual TSharedPtr< SWidgetGetWidget ()=0
 
- Public Member Functions inherited from TSharedFromThis< IPreLoadScreen >
TSharedRef< IPreLoadScreen, Mode > AsShared ()
 
TSharedRef< IPreLoadScreen const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< IPreLoadScreen, Mode > AsWeak ()
 
TWeakPtr< IPreLoadScreen const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 

Additional Inherited Members

- Protected Member Functions inherited from TSharedFromThis< IPreLoadScreen >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThisoperator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 
- Static Protected Member Functions inherited from TSharedFromThis< IPreLoadScreen >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 

Constructor & Destructor Documentation

◆ ~IPreLoadScreen()

virtual IPreLoadScreen::~IPreLoadScreen ( )
virtualdefault

Member Function Documentation

◆ CleanUp()

virtual void IPreLoadScreen::CleanUp ( )
pure virtual

Implemented in FPreLoadScreenBase.

◆ GetAddedTickDelay()

virtual float IPreLoadScreen::GetAddedTickDelay ( )
pure virtual

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.

Implemented in FPreLoadScreenBase.

◆ GetPreLoadScreenTag()

virtual FName IPreLoadScreen::GetPreLoadScreenTag ( ) const
pure virtual

Allows the PreLoadScreen to register a tag that can be later used to find a specific loading screen. PreLoadScreens not using this functionality should return NAME_None

Implemented in FPreLoadScreenBase.

◆ GetPreLoadScreenType()

virtual EPreLoadScreenTypes IPreLoadScreen::GetPreLoadScreenType ( ) const
pure virtual

Should override this function to determine if this screen should be used to handle EarlyStartupScreen behavior

Note
IMPORTANT: This changes a LOT of functionality and implementation details. EarlyStartupScreens happen before the engine is fully initialized and block engine initialization before they finish. this means they have to forgo even the most basic of engine features like UObject support, as they are displayed before those systems are initialized.

Implemented in FPreLoadScreenBase.

◆ GetWidget() [1/2]

virtual const TSharedPtr< const SWidget > IPreLoadScreen::GetWidget ( ) const
pure virtual

Implemented in FPreLoadScreenBase.

◆ GetWidget() [2/2]

virtual TSharedPtr< SWidget > IPreLoadScreen::GetWidget ( )
pure virtual

Implemented in FPreLoadScreenBase.

◆ Init()

virtual void IPreLoadScreen::Init ( )
pure virtual

Implemented in FPreLoadScreenBase.

◆ IsDone()

virtual bool IPreLoadScreen::IsDone ( ) const
pure virtual

Returns true when the PreLoadScreen is completed.

Note
This need to be thread safe

Implemented in FPreLoadScreenBase.

◆ OnPlay()

virtual void IPreLoadScreen::OnPlay ( TWeakPtr< SWindow TargetWindow)
pure virtual

Callback for when a PreLoadScreen starts being displayed. Provides a reference to the SWindow that will be used to display content

Implemented in FPreLoadScreenBase.

◆ OnStop()

virtual void IPreLoadScreen::OnStop ( )
pure virtual

Callback for when a PreLoadScreen is no longer being displayed.

Implemented in FPreLoadScreenBase.

◆ RenderTick()

virtual void IPreLoadScreen::RenderTick ( FRHICommandListImmediate RHICmdList,
float  DeltaTime 
)
pure virtual

This tick happens as part of the slate render tick during an EarlyStartupLoadScreen

Note
Called on the render thread

Implemented in FPreLoadScreenBase.

◆ SetEngineLoadingFinished()

virtual void IPreLoadScreen::SetEngineLoadingFinished ( bool  IsEngineLoadingFinished)
pure virtual

◆ ShouldRender()

virtual bool IPreLoadScreen::ShouldRender ( ) const
pure virtual

Whether an EarlyStartupLoadScreen should render

Implemented in FPreLoadScreenBase.

◆ Tick()

virtual void IPreLoadScreen::Tick ( float  DeltaTime)
pure virtual

Standard tick that happens every frame

Implemented in FPreLoadScreenBase.


The documentation for this class was generated from the following file: