Navigation
API > API/Runtime > API/Runtime/UMG
| Name | UUMGSequencePlayer |
| Type | class |
| Header File | /Engine/Source/Runtime/UMG/Public/Animation/UMGSequencePlayer.h |
| Include Path | #include "Animation/UMGSequencePlayer.h" |
Syntax
UCLASS (Transient, BlueprintType, MinimalAPI)
class UUMGSequencePlayer :
public UObject ,
public IMovieScenePlayer
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UUMGSequencePlayer
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UUMGSequencePlayer
(
const FObjectInitializer& ObjectInitializer |
Animation/UMGSequencePlayer.h |
Classes
| Name | Remarks |
|---|---|
| FOnSequenceFinishedPlaying |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnSequenceFinishedPlayingEvent | FOnSequenceFinishedPlaying | Animation/UMGSequencePlayer.h | ||
| RootTemplateInstance | FMovieSceneRootEvaluationTemplateInstance | Animation/UMGSequencePlayer.h | ||
| WidgetAnimationHandle | FWidgetAnimationHandle | Animation/UMGSequencePlayer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BroadcastSequenceFinishedPlaying() |
Internal API. | Animation/UMGSequencePlayer.h | |
const UWidgetAnimation * GetAnimation() |
Animation/UMGSequencePlayer.h | ||
FQualifiedFrameTime GetCurrentTime() |
Animation/UMGSequencePlayer.h | ||
FName GetUserTag() |
Animation/UMGSequencePlayer.h |
|
|
void InitSequencePlayer
(
FWidgetAnimationState& InState |
Animation/UMGSequencePlayer.h | ||
void InitSequencePlayer
(
UWidgetAnimation& InAnimation, |
Animation/UMGSequencePlayer.h | ||
bool IsPlayingForward() |
Gets the current time position in the player (in seconds). | Animation/UMGSequencePlayer.h | |
bool IsStopping() |
Check whether this player is currently being stopped | Animation/UMGSequencePlayer.h | |
FOnSequenceFinishedPlaying & OnSequenceFinishedPlaying() |
Animation/UMGSequencePlayer.h | ||
void Pause() |
Pauses a running animation | Animation/UMGSequencePlayer.h | |
void Play
(
float StartAtTime, |
Begins playing or restarts an animation | Animation/UMGSequencePlayer.h | |
void PlayTo
(
float StartAtTime, |
Begins playing or restarts an animation and plays to the specified end time | Animation/UMGSequencePlayer.h | |
void RemoveEvaluationData() |
Disable this sequence player by removing any of its animation data from the entity manager | Animation/UMGSequencePlayer.h | |
void Reverse() |
Reverses a running animation | Animation/UMGSequencePlayer.h | |
void SetCurrentTime
(
float InTime |
Animation/UMGSequencePlayer.h | ||
void SetNumLoopsToPlay
(
int32 InNumLoopsToPlay |
Sets the number of loops to play | Animation/UMGSequencePlayer.h | |
void SetPlaybackSpeed
(
float PlaybackSpeed |
Sets the animation playback rate | Animation/UMGSequencePlayer.h | |
void SetUserTag
(
FName InUserTag |
Animation/UMGSequencePlayer.h |
|
|
void Stop() |
Stops a running animation and resets time | Animation/UMGSequencePlayer.h | |
void TearDown() |
Animation/UMGSequencePlayer.h | ||
void Tick
(
float DeltaTime |
Updates the running movie | Animation/UMGSequencePlayer.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
Animation/UMGSequencePlayer.h |
Overridden from IMovieScenePlayer
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UObject * AsUObject() |
Animation/UMGSequencePlayer.h | ||
virtual UMovieSceneEntitySystemLinker * ConstructEntitySystemLinker() |
Animation/UMGSequencePlayer.h | ||
virtual FMovieSceneRootEvaluationTemplateInstance & GetEvaluationTemplate() |
Animation/UMGSequencePlayer.h | ||
virtual IMovieScenePlaybackClient * GetPlaybackClient() |
Animation/UMGSequencePlayer.h | ||
virtual UObject * GetPlaybackContext() |
Animation/UMGSequencePlayer.h | ||
virtual EMovieScenePlayerStatus::Type GetPlaybackStatus() |
Animation/UMGSequencePlayer.h | ||
virtual FMovieSceneSpawnRegister & GetSpawnRegister() |
Animation/UMGSequencePlayer.h | ||
virtual void InitializeRootInstance
(
TSharedRef< UE::MovieScene::FSharedPlaybackState > NewSharedPlaybackState |
Animation/UMGSequencePlayer.h | ||
virtual void SetPlaybackStatus
(
EMovieScenePlayerStatus::Type InPlaybackStatus |
Animation/UMGSequencePlayer.h |