UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Protected Attributes | List of all members
FPreLoadScreenBase Class Reference

#include <PreLoadScreenBase.h>

+ Inheritance diagram for FPreLoadScreenBase:

Public Member Functions

virtual void Tick (float DeltaTime) override
 
virtual bool ShouldRender () const override
 
virtual void RenderTick (FRHICommandListImmediate &RHICmdList, float DeltaTime) override
 
virtual void OnStop () override
 
virtual void OnPlay (TWeakPtr< SWindow > TargetWindow) override
 
virtual float GetAddedTickDelay () override
 
virtual void Init () override
 
virtual TSharedPtr< SWidget > GetWidget () override
 
virtual const TSharedPtr< const SWidget > GetWidget () const override
 
virtual EPreLoadScreenTypes GetPreLoadScreenType () const override
 
virtual void SetEngineLoadingFinished (bool IsEngineLoadingFinished) override
 
virtual FName GetPreLoadScreenTag () const override
 
virtual PRELOADSCREEN_API void CleanUp () override
 
virtual PRELOADSCREEN_API bool IsDone () const override
 
 FPreLoadScreenBase ()
 
virtual ~FPreLoadScreenBase () override
 
virtual PRELOADSCREEN_API void InitSettingsFromConfig (const FString &ConfigFileName)
 
virtual void SetPluginName (const FString &PluginNameIn)
 
- Public Member Functions inherited from IPreLoadScreen
virtual ~IPreLoadScreen ()=default
 
- 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
 

Protected Attributes

TWeakPtr< SWindow > OwningWindow
 
TAtomic< bool > bIsEngineLoadingFinished
 

Additional Inherited Members

- Protected Member Functions inherited from TSharedFromThis< IPreLoadScreen >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThis & operator= (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

◆ FPreLoadScreenBase()

FPreLoadScreenBase::FPreLoadScreenBase ( )
inline

◆ ~FPreLoadScreenBase()

virtual FPreLoadScreenBase::~FPreLoadScreenBase ( )
inlineoverridevirtual

Member Function Documentation

◆ CleanUp()

void FPreLoadScreenBase::CleanUp ( )
overridevirtual

Implements IPreLoadScreen.

◆ GetAddedTickDelay()

virtual float FPreLoadScreenBase::GetAddedTickDelay ( )
inlineoverridevirtual

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.

Implements IPreLoadScreen.

◆ GetPreLoadScreenTag()

virtual FName FPreLoadScreenBase::GetPreLoadScreenTag ( ) const
inlineoverridevirtual

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

Implements IPreLoadScreen.

◆ GetPreLoadScreenType()

virtual EPreLoadScreenTypes FPreLoadScreenBase::GetPreLoadScreenType ( ) const
inlineoverridevirtual

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.

Implements IPreLoadScreen.

◆ GetWidget() [1/2]

virtual const TSharedPtr< const SWidget > FPreLoadScreenBase::GetWidget ( ) const
inlineoverridevirtual

Implements IPreLoadScreen.

◆ GetWidget() [2/2]

virtual TSharedPtr< SWidget > FPreLoadScreenBase::GetWidget ( )
inlineoverridevirtual

Implements IPreLoadScreen.

◆ Init()

virtual void FPreLoadScreenBase::Init ( )
inlineoverridevirtual

Implements IPreLoadScreen.

◆ InitSettingsFromConfig()

void FPreLoadScreenBase::InitSettingsFromConfig ( const FString &  ConfigFileName)
virtual

◆ IsDone()

bool FPreLoadScreenBase::IsDone ( ) const
overridevirtual

Returns true when the PreLoadScreen is completed.

Note
This need to be thread safe

Implements IPreLoadScreen.

◆ OnPlay()

virtual void FPreLoadScreenBase::OnPlay ( TWeakPtr< SWindow >  TargetWindow)
inlineoverridevirtual

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

Implements IPreLoadScreen.

◆ OnStop()

virtual void FPreLoadScreenBase::OnStop ( )
inlineoverridevirtual

Callback for when a PreLoadScreen is no longer being displayed.

Implements IPreLoadScreen.

◆ RenderTick()

virtual void FPreLoadScreenBase::RenderTick ( FRHICommandListImmediate &  RHICmdList,
float  DeltaTime 
)
inlineoverridevirtual

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

Note
Called on the render thread

Implements IPreLoadScreen.

◆ SetEngineLoadingFinished()

virtual void FPreLoadScreenBase::SetEngineLoadingFinished ( bool  IsEngineLoadingFinished)
inlineoverridevirtual

@See IsDone when GetPreLoadScreenType() returns EPreLoadScreenTypes::EngineLoadingScreen

Implements IPreLoadScreen.

◆ SetPluginName()

virtual void FPreLoadScreenBase::SetPluginName ( const FString &  PluginNameIn)
inlinevirtual

◆ ShouldRender()

virtual bool FPreLoadScreenBase::ShouldRender ( ) const
inlineoverridevirtual

Whether an EarlyStartupLoadScreen should render

Implements IPreLoadScreen.

◆ Tick()

virtual void FPreLoadScreenBase::Tick ( float  DeltaTime)
inlineoverridevirtual

Standard tick that happens every frame

Implements IPreLoadScreen.

Member Data Documentation

◆ bIsEngineLoadingFinished

TAtomic<bool> FPreLoadScreenBase::bIsEngineLoadingFinished
protected

◆ OwningWindow

TWeakPtr<SWindow> FPreLoadScreenBase::OwningWindow
protected
The documentation for this class was generated from the following files: