UUMGSequencePlayer

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

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

Public function

UUMGSequencePlayer

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const

const UWidge...

 

GetAnimation()

Public function Const

FQualifiedFr...

 

GetCurrentTime()

Public function Const

FName

 

GetUserTag()

Public function

void

 

InitSequencePlayer

(
    UWidgetAnimation& InAnimation,
    UUserWidget& InUserWidget
)

Public function Const

bool

 

IsPlayingForward()

Gets the current time position in the player (in seconds).

Public function

FOnSequenceF...

 

OnSequenceFinishedPlaying()

Public function

void

 

Pause()

Pauses a running animation

Public function

void

 

Play

(
    float StartAtTime,
    int32 InNumLoopsToPlay,
    EUMGSequencePlayMode::Type InPlayMo...,
    float InPlaybackSpeed,
    bool bRestoreState
)

Begins playing or restarts an animation

Public function

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

Public function

void

 

RemoveEvaluationData()

Disable this sequence player by removing any of its animation data from the entity manager

Public function

void

 

Reverse()

Reverses a running animation

Public function

void

 

SetCurrentTime

(
    float InTime
)

Public function

void

 

SetNumLoopsToPlay

(
    int32 InNumLoopsToPlay
)

Sets the number of loops to play

Public function

void

 

SetPlaybackSpeed

(
    float PlaybackSpeed
)

Sets the animation playback rate

Public function

void

 

SetUserTag

(
    FName InUserTag
)

Public function

void

 

Stop()

Stops a running animation and resets time

Public function

void

 

TearDown()

Public function

void

 

Tick

(
    float DeltaTime
)

Updates the running movie

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginDestroy()

UObject interface

Overridden from IMovieScenePlayer

Name Description

Public function Virtual

UObject *...

 

AsUObject()

Cast this player instance as a UObject if possible

Public function Virtual

UMovieSceneE...

 

ConstructEntitySystemLinker()

Called to retrieve or construct an entity linker for the specified playback context

Public function Virtual

FMovieSceneR...

 

GetEvaluationTemplate()

IMovieScenePlayer interface

Public function Virtual Const

TArray< UObj...

 

GetEventContexts()

Access the event contexts for this movie scene player

Public function Virtual Const

UObject *...

 

GetPlaybackContext()

Access the playback context for this movie scene player

Public function Virtual Const

EMovieSceneP...

 

GetPlaybackStatus()

Public function Virtual Const

void

 

GetViewportSettings

(
    TMap< FViewportClient*, EMovie...
)

Get the current perspective viewport settings

Public function Virtual

void

 

PostEvaluation

(
    const FMovieSceneContext& Context
)

Called by the evaluation system after evaluation has occured

Public function Virtual

void

 

PreEvaluation

(
    const FMovieSceneContext& Context
)

Called by the evaluation system when evaluation has just started.

Public function Virtual

void

 

SetPlaybackStatus

(
    EMovieScenePlayerStatus::Type InPla...
)

Public function Virtual

void

 

SetViewportSettings

(
    const TMap< FViewportClient*, ...
)

Set the perspective viewport settings

Public function Virtual

void

 

UpdateCameraCut

(
    UObject* CameraObject,
    const EMovieSceneCameraCutParams& ...
)

Updates the perspective viewports with the actor to view through

Classes

Name

Description

Public class

FOnSequenceFinishedPlaying

Deprecated Functions

Name Description

Public function Const

double

 

GetTimeCursorPosition()

Please use GetCurrentTime instead.