1. Epic GamesDeveloper
  3. UMovieSceneSequencePlayer

UMovieSceneSequencePlayer

Abstract class that provides consistent player behaviour for various animation players

Unreal Engine C++ API Reference > Runtime > MovieScene

Inheritance Hierarchy

References

   
Module MovieScene
Header /Engine/Source/Runtime/MovieScene/Public/MovieSceneSequencePlayer.h
Include #include "MovieSceneSequencePlayer.h"

Syntax

class UMovieSceneSequencePlayer :  
    public UObject,  
    public IMovieScenePlayer,  
    public IMovieSceneSequenceTickManagerClient

Remarks

Abstract class that provides consistent player behaviour for various animation players

Variables

  Type Name Description
Protected variable bool bIgnorePlaybackReplication When true, ignore playback replication events.
Protected variable uint32: 1 bIsAsyncUpdate Set to true when the player is currently in the main level update
Protected variable uint32: 1 bPendingOnStartedPlaying Set to true to invoke OnStartedPlaying on first update tick for started playing
Protected variable uint32: 1 bReversePlayback Whether we're currently playing in reverse.
Protected variable uint32: 1 bSkipNextUpdate Flag that allows the player to tick its time controller without actually evaluating the sequence
Protected variable uint32: 1 bUpdateNetSync Flag that notifies the player to check network synchronization on next update
Protected variable int32 CurrentNumLoops The number of times we have looped in the current playback
Protected variable FMovieSceneEntitySystemRunner * CurrentRunner Usually nullptr, but will be set when we are updating inside a TickFromSequenceTickManager call
Protected variable TOptional< FFrameTime > DisableEventTriggersUntilTime Disable event triggers until given time
Protected variable int32 DurationFrames Time (in playback frames) at which to stop playing the sequence (defaults to the upper bound of the sequence's play range)
Protected variable float DurationSubFrames  
Protected variable FMovieSceneLatentActionManager LatentActionManager Local latent action manager for when we're running a blocking sequence
Protected variable FMovieSceneSequenceReplProperties NetSyncProps Replicated playback status and current time that are replicated to clients
Public variable TScriptInterface< IMovieSceneSequencePlayerObserver > Observer Obeserver interface used for controlling whether the effects of this sequence can be seen even when it is playing back.
Public variable FOnMovieSceneSequencePlayerEvent OnFinished Event triggered when the level sequence player finishes naturally (without explicitly calling stop)
Public variable FOnMovieSceneSequencePlayerEvent OnPause Event triggered when the level sequence player is paused
Public variable FOnMovieSceneSequencePlayerEvent OnPlay Event triggered when the level sequence player is played
Public variable FOnMovieSceneSequencePlayerEvent OnPlayReverse Event triggered when the level sequence player is played in reverse
Public variable FOnMovieSceneSequencePlayerEvent OnStop Event triggered when the level sequence player is stopped
Protected variable TScriptInterface< IMovieScenePlaybackClient > PlaybackClient External client pointer in charge of playing back this sequence
Protected variable FMovieSceneSequencePlaybackSettings PlaybackSettings Specific playback settings for the animation.
Protected variable FMovieScenePlaybackPosition PlayPosition Play position helper
Protected variable FMovieSceneRootEvaluationTemplateInstance RootTemplateInstance The root template instance we're evaluating
Protected variable TObjectPtr< UMovieSceneSequence > Sequence The sequence to play back
Protected variable TUniquePtr< UE::MovieScene::FSequenceWeights > SequenceWeights Sequence Weights
Protected variable int32 SerialNumber The serial number for the current update lifespan It is incremented every time we pass a "gate" such as an RPC call that stops/finishes the sequence.
Protected variable TArray< FServerTimeSample > ServerTimeSamples Array of server sequence times in seconds, with ping compensation baked in.
Protected variable TSharedPtr< FMovieSceneSpawnRegister > SpawnRegister Spawn register
Protected variable FFrameNumber StartTime Time (in playback frames) at which to start playing the sequence (defaults to the lower bound of the sequence's play range)
Protected variable TEnumAsByte< EMovieScenePlayerStatus::Type > Status Movie player status.
Protected variable TSharedPtr< FMovieSceneEntitySystemRunner > SynchronousRunner (Optional) Synchronous runner to use when no tick manager is in use
Protected variable TObjectPtr< UMovieSceneSequenceTickManager > TickManager Global tick manager, held here to keep it alive while world sequences are in play
Protected variable TSharedPtr< FMovieSceneTimeController > TimeController (Optional) Externally supplied time controller

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function Virtual Const bool

CanPlay ()

  
Public function void Changes the direction of playback (go in reverse if it was going forward, or vice versa)
Protected function void

FinishPlaybackInternal ( FFrameTime TimeToFinishAt
)

  
Public function TArray< UObject * > Retrieve all objects currently bound to the specified binding identifier
Public function Const FQualifiedFrameTime Get the current playback position
Public function bool Set whether to disable camera cuts
Protected function Const FFrameRate  
Public function Const FQualifiedFrameTime Get the total duration of the sequence
Public function Const FQualifiedFrameTime Get the offset within the level sequence to finish playing
Public function Const int32 Get this sequence's duration in frames
Public function Const FFrameRate Get this sequence's display rate.
Protected function Const FFrameTime  
Public function TArray< FMovieSceneObjectBindingID >

GetObjectBindings ( UObject* InObject
)

 Get the object bindings for the requested object
Protected function Const TOptional< TRange< FFrameTime > >

GetPauseRange ( const FFrameTime& NewPosition
)

 If the current sequence should pause (due to NewPosition overshooting a previously set ShouldPause) then a range of time that should be evaluated to reach there will be returned.
Protected function Const UWorld *  
Public function Const float Get the playback rate of this player.
Public function Const UMovieSceneSequence * Access the sequence this player is playing
Public function Const FString

GetSequenceName ( bool bAddClientInfo
)

 Get the name of the sequence this player is playing
Public function Const FQualifiedFrameTime Get the offset within the level sequence to start playing
Public function Const UMovieSceneSequenceTickManager * Access this player's tick manager
Public function Const TSharedPtr< FMovieSceneTimeController > Retrieve the currently assigned time controller
Public function void Go to end and stop.
Public function void Initialize this player using its existing playback settings
Public function void Initialize this player with a sequence and some settings
Public function void

InitializeForTick ( UObject* Context
)

 Ensure that this player's tick manager is set up correctly for the specified context
Public function Const bool Check whether the sequence is paused.
Public function Const bool Check whether the sequence is actively playing.
Public function Const bool Check whether playback is reversed.
Protected function Const bool  
Protected function Virtual void  
Protected function Virtual void  
Public function Const FOnMovieSceneSequencePlayerUpdated &  
Protected function Virtual void  
Protected function Virtual void  
Public function void

Pause ()

 Pause playback.
Public function void

Play ()

 Start playback forwards from the current time cursor position, using the current play rate.
Protected function void  
Public function void

PlayLooping ( int32 NumLoops
)

 Start playback from the current time cursor position, looping the specified number of times.
Public function void Reverse playback.
Public function void Play from the current position to the requested position and pause.
Protected function void

QueueLatentAction ( FMovieSceneSequenceLatentActionDelegate Delegate
)

  
Public function void Removes a previously assigned weight
Public function void Removes a previously assigned weight
Public function void Restore any changes made by this player to their original state
Protected function void  
Public function void

Scrub ()

 Scrub playback.
Public function void

SetDisableCameraCuts ( bool bInDisableCameraCuts
)

 Set whether to disable camera cuts
Public function void

SetFrameRange ( int32 StartFrame,
int32 Duration,
float SubFrames
)

 Set the valid play range for this sequence, determined by a starting frame number (in this sequence player's plaback frame), and a number of frames duration
Public function void

SetFrameRate ( FFrameRate FrameRate
)

 Set the frame-rate that this player should play with, making all frame numbers in the specified time-space
Public function void Sets whether to listen or ignore playback replication events.
Public function void Assign a playback client interface for this sequence player, defining instance data and binding overrides
Public function void Set the current time of the player by evaluating from the current time to the specified time, as if the sequence is playing.
Public function void Assign this player's playback settings
Public function void

SetPlayRate ( float PlayRate
)

 Set the playback rate of this player. Negative values will play the animation in reverse.
Public function void Assign a time controller for this sequence player allowing custom time management implementations.
Public function void Assign a time controller for this sequence player allowing custom time management implementations.
Public function void

SetTimeRange ( float StartTime,
float Duration
)

 Set the valid play range for this sequence, determined by a starting time and a duration (in seconds)
Public function void

SetWeight ( double InWeight,
FMovieSceneSequenceID SequenceID
)

 Set a manual weight to be multiplied with all blendable elements within the specified sequence
Public function void

SetWeight ( double InWeight
)

 Set a manual weight to be multiplied with all blendable elements within this sequence
Protected function Const bool

ShouldStopOrLoop ( FFrameTime NewPosition
)

  
Public function void

Stop ()

 Stop playback and move the cursor to the end (or start, for reversed playback) of the sequence.
Public function void Stop playback without moving the cursor.
Protected function void

StopInternal ( FFrameTime TimeToResetTo
)

  
Public function void Perform any tear-down work when this player is no longer (and will never) be needed
Public function void

Update ( const float DeltaSeconds
)

 Update the sequence for the current time, if playing
Public function void

UpdateAsync ( const float DeltaSeconds
)

 Update the sequence for the current time, if playing, asynchronously
Protected function void  
Protected function Virtual void  
Protected function void

UpdateTimeCursorPosition ( FFrameTime NewPosition,
EUpdatePositionMethod Method,
bool bHasJumpedOverride
)

  

Overridden from UObject

  Type Name Description
Protected function Virtual void Called before destroying the object.
Protected function Virtual bool

CallRemoteFunction ( UFunction* Function,
void* Parms,
FOutParmRec* OutParms,
FFrame* Stack
)

 Call the actor's function remotely
Protected function Virtual int32

GetFunctionCallspace ( UFunction* Function,
FFrame* Stack
)

 Return the space this function should be called.
Protected function Virtual Const bool IsSupportedForNetworking means an object can be referenced over the network
Protected function Virtual void Called right after receiving a bunch

Overridden from IMovieScenePlayer

  Type Name Description
Protected function Virtual UObject * Cast this player instance as a UObject if possible
Protected function Virtual Const bool Whether this player can update the camera cut
Protected function Virtual UMovieSceneEntitySystemLinker * Called to retrieve or construct an entity linker for the specified playback context
Public function Virtual FMovieSceneRootEvaluationTemplateInstance & Access the evaluation template that we are playing back
Protected function Virtual IMovieScenePlaybackClient * Access the client in charge of playback
Protected function Virtual Const EMovieScenePlayerStatus::Type  
Protected function Virtual FMovieSceneSpawnRegister & Obtain an object responsible for managing movie scene spawnables
Protected function Virtual Const void Get the current perspective viewport settings
Protected function Virtual Const bool Whether this player utilizes dynamic weighting
Protected function Virtual Const bool

IsDisablingEventTriggers ( FFrameTime& DisabledUntilTime
)

 Returns whether event triggers are disabled and if so, until what time.
Protected function Virtual void

PostEvaluation ( const FMovieSceneContext& Context
)

 Called by the evaluation system after evaluation has occured
Protected function Virtual void

PreEvaluation ( const FMovieSceneContext& Context
)

 Called by the evaluation system when evaluation has just started.
Protected function Virtual Const void

ResolveBoundObjects ( const FGuid& InBindingId,
FMovieSceneSequenceID SequenceID,
UMovieSceneSequence& Sequence,
UObject* ResolutionContext,
TArray< UObject*, TInlineAllocator< 1 >>& OutObjects
)

 Resolve objects bound to the specified binding ID
Protected function Virtual void  
Protected function Virtual void Set the perspective viewport settings
Protected function Virtual void

UpdateCameraCut ( UObject* CameraObject,
const EMovieSceneCameraCutParams& CameraCutParams
)

 Updates the perspective viewports with the actor to view through

Overridden from IMovieSceneSequenceTickManagerClient

  Type Name Description
Protected function Virtual void  

Classes

  Type Name Description
Protected struct FMovieSceneUpdateArgs    
Public class FOnMovieSceneSequencePlayerUpdated An event that is broadcast each time this level sequence player is updated  
Protected struct FServerTimeSample    

Typedefs

Name Description
FOnEvaluationCallback Pre and post evaluation callbacks, for async evaluations

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page