Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > PreLoadScreen > IPreLoadScreen

Light Theme

Dark Theme

IPreLoadScreen

Interface that defines the class that handles all the logic for controlling / displaying a particular PreLoadScreen.

Windows

MacOS

Linux

Inheritance Hierarchy

IPreLoadScreen

FPreLoadScreenBase

FPreLoadMoviePlayerScreenBase

References

Module	PreLoadScreen
Header	/Engine/Source/Runtime/PreLoadScreen/Public/PreLoadScreen.h
Include	#include "PreLoadScreen.h"

Syntax

class 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

	Name	Description
	~IPreLoadScreen()

Functions

	Name	Description
void	CleanUp()
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.
FName	GetPreLoadScreenTag()	Allows the PreLoadScreen to register a tag that can be later used to find a specific loading screen.
EPreLoadScre...	GetPreLoadScreenType()	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.
const TShare...	GetWidget()
TSharedPtr< ...	GetWidget()
void	Init()
bool	IsDone()	Returns true when the PreLoadScreen is completed. @note This need to be thread safe
void	OnPlay ( TWeakPtr< SWindow > TargetWindow )	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 @note Called on the render thread
void	SetEngineLoadingFinished ( bool IsEngineLoadingFinished )	IsDone when GetPreLoadScreenType() returns EPreLoadScreenTypes::EngineLoadingScreen
bool	ShouldRender()	Whether an EarlyStartupLoadScreen should render
void	Tick ( float DeltaTime )	Standard tick that happens every frame

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss