FLoadingScreenAttributes

Struct of all the attributes a loading screen will have.

Choose your operating system:

Windows

macOS

Linux

References

Module

MoviePlayer

Header

/Engine/Source/Runtime/MoviePlayer/Public/MoviePlayer.h

Include

#include "MoviePlayer.h"

Syntax

struct FLoadingScreenAttributes

Remarks

Struct of all the attributes a loading screen will have.

Variables

Name Description

Public variable

bool

 

bAllowEngineTick

If true, this will call the engine tick while the game thread is stalled waiting for a loading movie to finish.

Public variable

bool

 

bAllowInEarlyStartup

If true loading screens here cannot have any uobjects of any kind or use any engine features at all.

Public variable

bool

 

bAutoCompleteWhenLoadingCompletes

If true, the loading screen will disappear as soon as all movies are played and loading is done.

Public variable

bool

 

bMoviesAreSkippable

If true, movies can be skipped by clicking the loading screen as long as loading is done.

Public variable

bool

 

bWaitForManualStop

If true, movie playback continues until Stop is called.

Public variable

float

 

MinimumLoadingScreenDisplayTime

The minimum time that a loading screen should be opened for.

Public variable

TArray< FString...

 

MoviePaths

The movie paths local to the game's Content/Movies/ directory we will play.

Public variable

TEnumAsByte< EM...

 

PlaybackType

Should we just play back, loop, etc.

Public variable

TSharedPtr< cla...

 

WidgetLoadingScreen

The widget to be displayed on top of the movie or simply standalone if there is no movie.

Constructors

Name Description

Public function

FLoadingScreenAttributes()

Functions

Name Description

Public function Const

bool

 

IsValid()

True if there is either a standalone widget or any movie paths or both.

Public function Static

TSharedRef< ...

 

NewTestLoadingScreenWidget()

Creates a simple test loading screen widget.