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

Light Theme

Dark Theme

FPreLoadMoviePlayerScreenBase

Windows

MacOS

Linux

Inheritance Hierarchy

FPreLoadScreenBase

TSharedFromThis

FPreLoadMoviePlayerScreenBase

References

Module	PreLoadScreenMoviePlayer
Header	/Engine/Plugins/Runtime/PreLoadScreenMoviePlayer/Source/PreLoadScreenMoviePlayer/Public/PreLoadMoviePlayerScreenBase.h
Include	#include "PreLoadMoviePlayerScreenBase.h"

Syntax

Variables

	Name	Description
bool	bInitialized
bool	bUserCalledFinish	User has called finish (needed if LoadingScreenAttributes.bAutoCompleteWhenLoadingCompletes is off)
double	LastPlayTime	The last time a movie was started
FPreLoadMovieAt...	MovieAttributes	Attributes of the loading screen we are currently displaying
TSharedPtr< SWi...	MoviePlayerContents
TSharedPtr< IMo...	MovieStreamer
FThreadSafeCoun...	MovieStreamingIsDone	True if all movies have successfully streamed and completed
TSharedPtr< SVi...	MovieViewport

Constructors

	Name	Description
	FPreLoadMoviePlayerScreenBase()

Destructors

	Name	Description
	~FPreLoadMoviePlayerScreenBase()

Functions

	Name	Description
FOptionalSiz...	GetMovieHeight()
FVector2D	GetMovieSize()	Callbacks for movie viewport
FOptionalSiz...	GetMovieWidth()
EVisibility	GetSlateBackgroundVisibility()
EVisibility	GetViewportVisibility()
bool	IsMovieStreamingFinished()
bool	MovieStreamingIsPrepared()
FReply	OnAnyDown()
FReply	OnLoadingScreenKeyDown ( const FGeometry& Geometry, const FKeyEvent& KeyEvent )
FReply	OnLoadingScreenMouseButtonDown ( const FGeometry& Geometry, const FPointerEvent& PointerEvent )
void	RegisterMovieStreamer ( TSharedPtr< IMovieStreamer > MovieS... )
void	SetMovieAttributes ( const FPreLoadMovieAttributes& Mov... )

Overridden from FPreLoadScreenBase

		Name	Description
	void	InitSettingsFromConfig ( const FString& ConfigFileName )	Handles constructing a FPreLoadSettingsContainerBase with the.

Overridden from IPreLoadScreen

	Name	Description
void	CleanUp()
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	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