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

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

FIsPreloadScree ...

 

IsResponsibleForRenderingDelegate

Protected variable

double

 

LastRenderTickTime

Protected variable

double

 

LastTickTime

Protected variable

TWeakPtr < class...

 

MainWindow

The window that the loading screen resides in

Public variable

FOnPreLoadScree ...

 

OnPreLoadScreenManagerCleanUp

Protected variable

float

 

OriginalSlateSleepVariableValue

Protected variable

TArray < TShared ...

 

PreLoadScreens

Protected variable

FPreLoadScreenS ...

 

SyncMechanism

The threading mechanism with which we handle running slate on another thread

Protected variable

TSharedPtr < cla...

 

VirtualRenderWindow

Virtual window that we render to instead of the main slate window (for thread safety).

Protected variable

TSharedPtr < FPr ...

 

WidgetRenderer

Widget renderer used to tick and paint windows in a thread safe way

Constructors

Name Description

Protected function

FPreLoadScreenManager()

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

Destructors

Name Description

Protected function

~FPreLoadScreenManager()

Functions

Name Description

Public function Static

bool

 

ArePreLoadScreensEnabled()

Protected function

void

 

BeginPlay()

Protected function

void

 

CleanUpResources()

Public function Static

void

 

Create()

Public function Static

void

 

Destroy()

Protected function

void

 

EarlyPlayFrameTick()

Separate tick that handles.

Protected function

void

 

EarlyPlayRenderFrameTick()

Public function Static

void

 

EnableRendering

(
    bool bEnabled
)

Protected function

void

 

GameLogicFrameTick()

Public function Static

FPreLoadScre ...

 

Get()

Gets the single instance of this settings object. Also creates it if needed.

Protected function

IPreLoadScre ...

 

GetActivePreLoadScreen()

Protected function Const

const IPreLo ...

 

GetActivePreLoadScreen()

Public function

TSharedPtr < ...

 

GetRenderWindow()

Protected function

void

 

HandleCustomSplashScreenPlay()

Protected function

void

 

HandleEarlyStartupPlay()

Protected function

void

 

HandleEngineLoadingPlay()

Protected function

void

 

HandleStopPreLoadScreen()

Public function Const

bool

 

HasActivePreLoadScreenType

(
    EPreLoadScreenTypes PreLoadScreenTy...
)

Protected function Const

bool

 

HasActivePreLoadScreenTypeForEarlyStartup()

Public function Const

bool

 

HasRegisteredPreLoadScreenType

(
    EPreLoadScreenTypes PreLoadScreenTy...
)

Public function Const

bool

 

HasValidActivePreLoadScreen()

Public function

void

 

Initialize

(
    FSlateRenderer & InSlateRenderer
)

Public function Const

bool

 

IsEngineLoadingComplete()

Public function Const

bool

 

IsUsingMainWindow()

Public function Const

void

 

PassPreLoadScreenWindowBackToGame()

Protected function

void

 

PlatformSpecificGameLogicFrameTick()

Public function

bool

 

PlayFirstPreLoadScreen

(
    EPreLoadScreenTypes PreLoadScreenTy...
)

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

Protected function

void

 

PlayPreLoadScreenAtIndex

(
    int32 Index
)

Public function

bool

 

PlayPreLoadScreenWithTag

(
    FName InTag
)

Plays the PreLoadScreen with a tag that matches InTag

Public function

void

 

RegisterPreLoadScreen

(
    const TSharedPtr < IPreLoadScreen > ...
)

Protected function

void

 

RenderTick_RenderThread()

Creates a tick on the Render Thread that we run every.

Public function

void

 

SetEngineLoadingComplete

(
    bool IsEngineLoadingFinished
)

Protected function Static

void

 

StaticRenderTick_RenderThread()

Creates a tick on the Render Thread that we run every.

Public function

void

 

StopPreLoadScreen()

Public function

void

 

UnRegisterPreLoadScreen

(
    const TSharedPtr < IPreLoadScreen > ...
)

Public function

void

 

WaitForEngineLoadingScreenToFinish()

Classes

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

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback