UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | List of all members
FNullGameMoviePlayer Class Reference

#include <NullMoviePlayer.h>

+ Inheritance diagram for FNullGameMoviePlayer:

Public Member Functions

virtual void RegisterMovieStreamer (TSharedPtr< class IMovieStreamer, ESPMode::ThreadSafe > InMovieStreamer) override
 
virtual void Initialize (class FSlateRenderer &InSlateRenderer, TSharedPtr< SWindow > RenderTarget=nullptr) override
 
virtual void Shutdown () override
 
virtual void PassLoadingScreenWindowBackToGame () const override
 
virtual void SetupLoadingScreen (const FLoadingScreenAttributes &InLoadingScreenAttributes) override
 
virtual bool HasEarlyStartupMovie () const override
 
virtual bool IsInitialized () const override
 
virtual bool PlayEarlyStartupMovies () override
 
virtual bool PlayMovie () override
 
virtual void StopMovie () override
 
virtual void WaitForMovieToFinish (bool bAllowEngineTick=false) override
 
virtual bool IsLoadingFinished () const override
 
virtual bool IsMovieCurrentlyPlaying () const override
 
virtual bool LoadingScreenIsPrepared () const override
 
virtual void SetupLoadingScreenFromIni () override
 
virtual FOnPrepareLoadingScreen & OnPrepareLoadingScreen () override
 
virtual FOnMoviePlaybackStarted & OnMoviePlaybackStarted () override
 
virtual FOnMoviePlaybackTick & OnMoviePlaybackTick () override
 
virtual FOnMoviePlaybackFinished & OnMoviePlaybackFinished () override
 
virtual FOnMovieClipFinished & OnMovieClipFinished () override
 
virtual void SetSlateOverlayWidget (TSharedPtr< SWidget > NewOverlayWidget) override
 
virtual bool WillAutoCompleteWhenLoadFinishes () override
 
virtual FString GetMovieName () override
 
virtual bool IsLastMovieInPlaylist () override
 
- Public Member Functions inherited from IGameMoviePlayer
 DECLARE_EVENT_OneParam (IGameMoviePlayer, FOnMoviePlaybackTick, float DeltaTime) virtual FOnMoviePlaybackTick &OnMoviePlaybackTick()=0
 
 DECLARE_EVENT_OneParam (IGameMoviePlayer, FOnMovieClipFinished, const FString &) virtual FOnMovieClipFinished &OnMovieClipFinished()=0
 
virtual void SetViewportDPIScale (float InViewportDPIScale)
 
void BroadcastMoviePlaybackFinished ()
 
void BroadcastMovieClipFinished (const FString &MovieClipThatFinished)
 
virtual ~IGameMoviePlayer ()
 
virtual bool IsStartupMoviePlaying () const
 
virtual void ForceCompletion ()
 
virtual void Suspend ()
 
virtual void Resume ()
 
virtual void SetIsPlayOnBlockingEnabled (bool bIsEnabled)
 
- Public Member Functions inherited from TSharedFromThis< FNullGameMoviePlayer >
TSharedRef< FNullGameMoviePlayer, Mode > AsShared ()
 
TSharedRef< FNullGameMoviePlayer const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< FNullGameMoviePlayer, Mode > AsWeak ()
 
TWeakPtr< FNullGameMoviePlayer const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 

Static Public Member Functions

static void Create ()
 
static void Destroy ()
 
static FNullGameMoviePlayer * Get ()
 

Additional Inherited Members

- Protected Member Functions inherited from TSharedFromThis< FNullGameMoviePlayer >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThis & operator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 
- Static Protected Member Functions inherited from TSharedFromThis< FNullGameMoviePlayer >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 

Detailed Description

An placeholder implementation of the movie player for the editor

Member Function Documentation

◆ Create()

static void FNullGameMoviePlayer::Create ( )
inlinestatic

◆ Destroy()

static void FNullGameMoviePlayer::Destroy ( )
inlinestatic

◆ Get()

static FNullGameMoviePlayer * FNullGameMoviePlayer::Get ( )
inlinestatic

◆ GetMovieName()

virtual FString FNullGameMoviePlayer::GetMovieName ( )
inlineoverridevirtual

returns the name of the movie currently being played

Implements IGameMoviePlayer.

◆ HasEarlyStartupMovie()

virtual bool FNullGameMoviePlayer::HasEarlyStartupMovie ( ) const
inlineoverridevirtual
Returns
true if the movie player has been set up with an early startup movie

Implements IGameMoviePlayer.

◆ Initialize()

virtual void FNullGameMoviePlayer::Initialize ( class FSlateRenderer &  InSlateRenderer,
TSharedPtr< SWindow >  RenderTarget = nullptr 
)
inlineoverridevirtual

Initializes this movie player, creating the startup window and hiding the splash screen. To be called in the launch engine loop.

Implements IGameMoviePlayer.

◆ IsInitialized()

virtual bool FNullGameMoviePlayer::IsInitialized ( ) const
inlineoverridevirtual
Returns
true if Initialize was called

Implements IGameMoviePlayer.

◆ IsLastMovieInPlaylist()

virtual bool FNullGameMoviePlayer::IsLastMovieInPlaylist ( )
inlineoverridevirtual

returns true if the movie being played in the last one in the play list

Implements IGameMoviePlayer.

◆ IsLoadingFinished()

virtual bool FNullGameMoviePlayer::IsLoadingFinished ( ) const
inlineoverridevirtual

Called from to check if the game thread is finished loading.

Implements IGameMoviePlayer.

◆ IsMovieCurrentlyPlaying()

virtual bool FNullGameMoviePlayer::IsMovieCurrentlyPlaying ( ) const
inlineoverridevirtual

True if the loading screen is currently running (i.e. PlayMovie but no WaitForMovieToFinish has been called).

Implements IGameMoviePlayer.

◆ LoadingScreenIsPrepared()

virtual bool FNullGameMoviePlayer::LoadingScreenIsPrepared ( ) const
inlineoverridevirtual

True if we have either slate widgets or a movie to show.

Implements IGameMoviePlayer.

◆ OnMovieClipFinished()

virtual FOnMovieClipFinished & FNullGameMoviePlayer::OnMovieClipFinished ( )
inlineoverridevirtual

◆ OnMoviePlaybackFinished()

virtual FOnMoviePlaybackFinished & FNullGameMoviePlayer::OnMoviePlaybackFinished ( )
inlineoverridevirtual

Implements IGameMoviePlayer.

◆ OnMoviePlaybackStarted()

virtual FOnMoviePlaybackStarted & FNullGameMoviePlayer::OnMoviePlaybackStarted ( )
inlineoverridevirtual

Implements IGameMoviePlayer.

◆ OnMoviePlaybackTick()

virtual FOnMoviePlaybackTick & FNullGameMoviePlayer::OnMoviePlaybackTick ( )
inlineoverridevirtual

◆ OnPrepareLoadingScreen()

virtual FOnPrepareLoadingScreen & FNullGameMoviePlayer::OnPrepareLoadingScreen ( )
inlineoverridevirtual

Called before playing a movie if the loading screen has not been prepared.

Implements IGameMoviePlayer.

◆ PassLoadingScreenWindowBackToGame()

virtual void FNullGameMoviePlayer::PassLoadingScreenWindowBackToGame ( ) const
inlineoverridevirtual

Passes the loading screen window back to the game to use. For use by the launch engine loop only.

Implements IGameMoviePlayer.

◆ PlayEarlyStartupMovies()

virtual bool FNullGameMoviePlayer::PlayEarlyStartupMovies ( )
inlineoverridevirtual

Play any early start up movies that have been set up

Returns
true if a movie started playing

Implements IGameMoviePlayer.

◆ PlayMovie()

virtual bool FNullGameMoviePlayer::PlayMovie ( )
inlineoverridevirtual

Starts playing the movie given the last FLoadingScreenAttributes passed in

Returns
true of a movie started playing.

Implements IGameMoviePlayer.

◆ RegisterMovieStreamer()

virtual void FNullGameMoviePlayer::RegisterMovieStreamer ( TSharedPtr< class IMovieStreamer, ESPMode::ThreadSafe >  InMovieStreamer)
inlineoverridevirtual

IGameMoviePlayer Interface

Implements IGameMoviePlayer.

◆ SetSlateOverlayWidget()

virtual void FNullGameMoviePlayer::SetSlateOverlayWidget ( TSharedPtr< SWidget >  NewOverlayWidget)
inlineoverridevirtual

Allows for a slate overlay widget to be set after playback.

Implements IGameMoviePlayer.

◆ SetupLoadingScreen()

virtual void FNullGameMoviePlayer::SetupLoadingScreen ( const FLoadingScreenAttributes &  InLoadingScreenAttributes)
inlineoverridevirtual

Passes in a slate loading screen UI, movie paths, and any additional data.

Implements IGameMoviePlayer.

◆ SetupLoadingScreenFromIni()

virtual void FNullGameMoviePlayer::SetupLoadingScreenFromIni ( )
inlineoverridevirtual

Sets up an FLoadingScreenAttributes from the game's engine.ini, then calls the virtual SetupLoadingScreen.

Implements IGameMoviePlayer.

◆ Shutdown()

virtual void FNullGameMoviePlayer::Shutdown ( )
inlineoverridevirtual

Shutsdown the movie player.

Implements IGameMoviePlayer.

◆ StopMovie()

virtual void FNullGameMoviePlayer::StopMovie ( )
inlineoverridevirtual

Stops the currently playing movie, if any.

Implements IGameMoviePlayer.

◆ WaitForMovieToFinish()

virtual void FNullGameMoviePlayer::WaitForMovieToFinish ( bool  bAllowEngineTick = false)
inlineoverridevirtual

Call only on the game thread. Spins this thread until the movie stops. If bAllowEngineTick is true, the engine tick may run inside here

Implements IGameMoviePlayer.

◆ WillAutoCompleteWhenLoadFinishes()

virtual bool FNullGameMoviePlayer::WillAutoCompleteWhenLoadFinishes ( )
inlineoverridevirtual

This function shouild return true if the movie will auto-complete the sequence when background loading has finished

Implements IGameMoviePlayer.

The documentation for this class was generated from the following files: