1. Epic GamesDeveloper
  3. UUMGSequencePlayer

UUMGSequencePlayer

API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Animation

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

  Type Name Description
Public function  

UUMGSequencePlayer ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const const UWidgetAnimation *  
Public function Const FQualifiedFrameTime  
Public function Const FName  
Public function void

InitSequencePlayer ( UWidgetAnimation& InAnimation,
UUserWidget& InUserWidget
)

  
Public function Const bool Gets the current time position in the player (in seconds).
Public function Const bool Check whether this player is currently being stopped
Public function FOnSequenceFinishedPlaying &  
Public function void

Pause ()

 Pauses a running animation
Public function void

Play ( float StartAtTime,
int32 InNumLoopsToPlay,
EUMGSequencePlayMode::Type InPlayMode,
float InPlaybackSpeed,
bool bRestoreState
)

 Begins playing or restarts an animation
Public function void

PlayTo ( float StartAtTime,
float EndAtTime,
int32 InNumLoopsToPlay,
EUMGSequencePlayMode::Type InPlayMode,
float InPlaybackSpeed,
bool bRestoreState
)

 Begins playing or restarts an animation and plays to the specified end time
Public function void 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  
Public function void

Tick ( float DeltaTime
)

 Updates the running movie

Overridden from UObject

  Type Name Description
Public function Virtual void UObject interface

Overridden from IMovieScenePlayer

  Type Name Description
Public function Virtual UObject * Cast this player instance as a UObject if possible
Public function Virtual UMovieSceneEntitySystemLinker * Called to retrieve or construct an entity linker for the specified playback context
Public function Virtual FMovieSceneRootEvaluationTemplateInstance & IMovieScenePlayer interface
Public function Virtual Const TArray< UObject * > Access the event contexts for this movie scene player
Public function Virtual Const UObject * Access the playback context for this movie scene player
Public function Virtual Const EMovieScenePlayerStatus::Type  
Public function Virtual Const void Get the current perspective viewport settings
Public function Virtual void Called to initialize the flag structure that denotes what functions need to be called on this updater
Public function Virtual void  
Public function Virtual void Set the perspective viewport settings
Public function Virtual void

UpdateCameraCut ( UObject* CameraObject,
const EMovieSceneCameraCutParams& CameraCutParams
)

 Updates the perspective viewports with the actor to view through

Classes

  Type Name Description
Public class FOnSequenceFinishedPlaying    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page