Navigation
Unreal Engine C++ API Reference > Runtime > PreLoadScreen
Inheritance Hierarchy
References
Module | PreLoadScreen |
Header | /Engine/Source/Runtime/PreLoadScreen/Public/PreLoadScreen.h |
Include | #include "PreLoadScreen.h" |
Syntax
class IPreLoadScreen : public TSharedFromThis< IPreLoadScreen >
Remarks
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
Destructors
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
Functions
Type | Name | Description | |
---|---|---|---|
![]() |
void | CleanUp () |
|
![]() |
float | 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. | |
![]() ![]() |
FName | Allows the PreLoadScreen to register a tag that can be later used to find a specific loading screen. | |
![]() ![]() |
EPreLoadScreenTypes | Should override this function to determine if this screen should be used to handle EarlyStartupScreen behavior | |
![]() ![]() |
const TSharedPtr< const SWidget > | GetWidget () |
|
![]() |
TSharedPtr< SWidget > | GetWidget () |
|
![]() |
void | Init () |
|
![]() ![]() |
bool | IsDone () |
Returns true when the PreLoadScreen is completed. This need to be thread safe |
![]() |
void | Callback for when a PreLoadScreen starts being displayed. | |
![]() |
void | OnStop () |
Callback for when a PreLoadScreen is no longer being displayed. |
![]() |
void | RenderTick
(
float DeltaTime |
This tick happens as part of the slate render tick during an EarlyStartupLoadScreen |
![]() |
void | SetEngineLoadingFinished
(
bool IsEngineLoadingFinished |
@See IsDone when GetPreLoadScreenType() returns EPreLoadScreenTypes::EngineLoadingScreen |
![]() ![]() |
bool | ShouldRender () |
Whether an EarlyStartupLoadScreen should render |
![]() |
void | Tick
(
float DeltaTime |
Standard tick that happens every frame |