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 > FPreLoadScreenBase

Light Theme

Dark Theme

FPreLoadScreenBase

Base implementation of the [IPreLoadScreen](API\Runtime\PreLoadScreen\IPreLoadScreen) that handles all the logic for controlling / updating the UI for PreLoadScreens.

Windows

MacOS

Linux

Inheritance Hierarchy

IPreLoadScreen

FPreLoadScreenBase

FPreLoadMoviePlayerScreenBase

References

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

Syntax

class FPreLoadScreenBase : public IPreLoadScreen

Remarks

Base implementation of the IPreLoadScreen that handles all the logic for controlling / updating the UI for PreLoadScreens. Designed to be overriden by a game specific Plugin that calls FPreloadScreenManager::RegisterPreLoadScreen so that functions are called by the PreLoadScreenManager correctly.

Variables

		Name	Description
	bool	bIsEngineLoadingFinished
	TWeakPtr< SWind...	OwningWindow

Constructors

	Name	Description
	FPreLoadScreenBase()

Destructors

	Name	Description
	~FPreLoadScreenBase()

Functions

		Name	Description
	void	InitSettingsFromConfig ( const FString& ConfigFileName )	Handles constructing a FPreLoadSettingsContainerBase with the.
	void	SetPluginName ( const FString& PluginNameIn )	Set what plugin is creating this PreLoadScreenBase.

Overridden from IPreLoadScreen

	Name	Description
void	CleanUp()
float	GetAddedTickDelay()	By default have a small added tick delay so we don't super spin out while waiting on other threads to load data / etc.
FName	GetPreLoadScreenTag()	PreLoadScreens not using this functionality should return NAME_None.
EPreLoadScre...	GetPreLoadScreenType()	IMPORTANT: This changes a LOT of functionality and implementation details.
TSharedPtr< ...	GetWidget()
const TShare...	GetWidget()
void	Init()
bool	IsDone()	Default behavior is just to see if we have an active widget. Should really overload with our own behavior to see if we are done displaying.
void	OnPlay ( TWeakPtr< SWindow > TargetWindow )	Store off TargetWindow.
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 )
bool	ShouldRender()	Whether an EarlyStartupLoadScreen should render.
void	Tick ( float DeltaTime )	We don't use these in the FPreLoadScreenBase, but they are useful for game-specific implementations.

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

Take our survey

Dismiss