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

UUMGSequencePlayer

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UUMGSequencePlayer

References

Module	UMG
Header	/Engine/Source/Runtime/UMG/Public/Animation/UMGSequencePlayer.h
Include	#include "Animation/UMGSequencePlayer.h"

Syntax

class UUMGSequencePlayer :
public UObject,
public IMovieScenePlayer

Constructors

	Name	Description
	UUMGSequencePlayer ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
const UWidge...	GetAnimation()
FQualifiedFr...	GetCurrentTime()
FName	GetUserTag()
void	InitSequencePlayer ( UWidgetAnimation& InAnimation, UUserWidget& InUserWidget )
bool	IsPlayingForward()	Gets the current time position in the player (in seconds).
FOnSequenceF...	OnSequenceFinishedPlaying()
void	Pause()	Pauses a running animation
void	Play ( float StartAtTime, int32 InNumLoopsToPlay, EUMGSequencePlayMode::Type InPlayMo..., float InPlaybackSpeed, bool bRestoreState )	Begins playing or restarts an animation
void	PlayTo ( float StartAtTime, float EndAtTime, int32 InNumLoopsToPlay, EUMGSequencePlayMode::Type InPlayMo..., float InPlaybackSpeed, bool bRestoreState )	Begins playing or restarts an animation and plays to the specified end time
void	Reverse()	Reverses a running animation
void	SetNumLoopsToPlay ( int32 InNumLoopsToPlay )	Sets the number of loops to play
void	SetPlaybackSpeed ( float PlaybackSpeed )	Sets the animation playback rate
void	SetUserTag ( FName InUserTag )
void	Stop()	Stops a running animation and resets time
void	Tick ( float DeltaTime )	Updates the running movie

Overridden from IMovieScenePlayer

	Name	Description
UObject *...	AsUObject()	Cast this player instance as a UObject if possible
FMovieSceneR...	GetEvaluationTemplate()	IMovieScenePlayer interface
TArray< UObj...	GetEventContexts()	Access the event contexts for this movie scene player
UObject *...	GetPlaybackContext()	Access the playback context for this movie scene player
EMovieSceneP...	GetPlaybackStatus()
void	GetViewportSettings ( TMap< FViewportClient*, EMovie... )	Get the current perspective viewport settings
void	SetPlaybackStatus ( EMovieScenePlayerStatus::Type InPla... )
void	SetViewportSettings ( const TMap< FViewportClient*, ... )	Set the perspective viewport settings
void	UpdateCameraCut ( UObject* CameraObject, const EMovieSceneCameraCutParams& ... )	Updates the perspective viewports with the actor to view through

Classes

	Name	Description
	FOnSequenceFinishedPlaying

Enums

	Name	Description
	ELatentAction

Deprecated Functions

		Name	Description
	double	GetTimeCursorPosition()	Please use GetCurrentTime instead.

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

Take our survey

Dismiss