FPreLoadMoviePlayerScreenBase

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

TSharedFromThis

IPreLoadScreen

FPreLoadScreenBase

FPreLoadMoviePlayerScreenBase

References

Module

PreLoadScreenMoviePlayer

Header

/Engine/Plugins/Runtime/PreLoadScreenMoviePlayer/Source/PreLoadScreenMoviePlayer/Public/PreLoadMoviePlayerScreenBase.h

Include

#include "PreLoadMoviePlayerScreenBase.h"

Syntax

class FPreLoadMoviePlayerScreenBase : public FPreLoadScreenBase

Variables

Name Description

Protected variable

bool

 

bInitialized

Protected variable

bool

 

bUserCalledFinish

User has called finish (needed if LoadingScreenAttributes.bAutoCompleteWhenLoadingCompletes is off)

Protected variable

double

 

LastPlayTime

The last time a movie was started

Protected variable

FPreLoadMovieAt...

 

MovieAttributes

Attributes of the loading screen we are currently displaying

Protected variable

TSharedPtr< SWi...

 

MoviePlayerContents

Protected variable

TSharedPtr< IMo...

 

MovieStreamer

Protected variable

FThreadSafeCoun...

 

MovieStreamingIsDone

True if all movies have successfully streamed and completed

Protected variable

TSharedPtr< SVi...

 

MovieViewport

Constructors

Destructors

Functions

Overridden from FPreLoadScreenBase

Name Description

Public function Virtual

void

 

InitSettingsFromConfig

(
    const FString& ConfigFileName
)

Handles constructing a FPreLoadSettingsContainerBase with the.

Overridden from IPreLoadScreen

Name Description

Public function Virtual

void

 

CleanUp()

Public function Virtual

TSharedPtr< ...

 

GetWidget()

Public function Virtual Const

const TShare...

 

GetWidget()

Public function Virtual

void

 

Init()

Public function Virtual Const

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.

Public function Virtual

void

 

OnPlay

(
    TWeakPtr< SWindow > TargetWindow
)

Store off TargetWindow.

Public function Virtual

void

 

OnStop()

Callback for when a PreLoadScreen is no longer being displayed.

Public function Virtual

void

 

RenderTick

(
    float DeltaTime
)

This tick happens as part of the slate render tick during an EarlyStartupLoadScreen @note Called on the render thread

Public function Virtual

void

 

Tick

(
    float DeltaTime
)

We don't use these in the FPreLoadScreenBase, but they are useful for game-specific implementations.