1. Epic GamesDeveloper
  3. FSequenceInstance

FSequenceInstance

A sequence instance represents a specific instance of a currently playing sequence, either as a top-level sequence in an [IMovieScenePlayer](API\Runtime\MovieScene\IMovieScenePlayer), or as a sub sequence.

Unreal Engine C++ API Reference > Runtime > MovieScene > EntitySystem

References

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

Syntax

struct FSequenceInstance

Remarks

A sequence instance represents a specific instance of a currently playing sequence, either as a top-level sequence in an IMovieScenePlayer, or as a sub sequence. Any given sequence asset may have any number of instances created for it at any given time depending on how many times it is referenced by playing sequences

Variables

  Type Name Description
Public variable FEntityLedger Ledger Ledger that tracks all currently instantiated entities for this instance

Constructors

  Type Name Description
Public function   Sequence instances are not copyable
Public function   Move constructors implemented in cpp to avoid includes for TUniquePtr
Public function   Constructor for top level sequences
Public function  

FSequenceInstance ( UMovieSceneEntitySystemLinker* Linker,
IMovieScenePlayer* Player,
FInstanceHandle ThisInstanceHandle,
FInstanceHandle InParentInstanceHandle,
FRootInstanceHandle RootInstanceHandle,
FMovieSceneSequenceID InSequenceID
)

 Constructor for sub sequences

Destructors

  Type Name Description
Public function   Destructor

Functions

  Type Name Description
Public function Const bool Returns whether this instance can be finished immediately without any last update.
Public function void Conditionally recompile this sequence if it needs to be
Public function void Destroy this sequence instance immediately - Finish must previously have been called
Public function void

DissectContext ( UMovieSceneEntitySystemLinker* Linker,
const FMovieSceneContext& Context,
TArray< TRange< FFrameTime >>& OutDissections
)

 Called only for top-level sequence instances before any updates to it with the specified context.
Public function Const void

FindEntities ( UObject* Owner,
TArray< FMovieSceneEntityID >& OutEntityIDs
)

 Attempt to locate all entities given their owner
Public function Const FMovieSceneEntityID

FindEntity ( UObject* Owner,
uint32 EntityID
)

 Attempt to locate an entity given its owner and ID
Public function Const FInstanceHandle Attempt to locate a sub instance based on its sequence ID
Public function void Mark this instance as finished, causing all its entities to be unlinked and the instance to become inactive at the end of the next update.
Public function Const const FMovieSceneContext & Get the evaluation context for the current frame
Public function Const FInstanceHandle Gets the handle to this instance
Public function Const const FMovieSceneTrackEvaluator * Retrieve the legacy evaluator for this sequence, if it is available (may return nullptr)
Public function Const FInstanceHandle Get a handle to the parent instance for this sequence instance, or an invalid handle if it is a root instance
Public function Const IMovieScenePlayer * Retrieve the IMovieScenePlayer that is playing back the top level sequence for this instance
Public function Const uint16 Retrieve the IMovieScenePlayer's unique index
Public function Const FRootInstanceHandle Get a handle to the root instance for this sub sequence instance
Public function Const FMovieSceneSequenceID Retrieve the SequenceID for this instance
Public function Const uint16 Get the serial number for this sequence instance that it was created with on construction.
Public function Const FSubSequencePath Retrieve a path for this sequence instance back to the root
Public function Const ESequenceInstanceUpdateFlags Retrieve this sequence's update flags
Public function Const bool Check whether this sequence instance has ever been updated or not
Public function Const bool Check whether this sequence instance has finished evaluating
Public function void Invalidate any cached data that may be being used for evaluation due to a change in the source asset data
Public function Const bool Returns whether this instance is the root instance.
Public function Const bool Returns whether this instance is a sub sequence.
Public function void Called to override the simulated root sequence ID for this instance.
Public function void Called when this sequence instance has been evaluated in order for it to do any clean-up or other post-update work
Public function void Called when this instance has been queued for evaluation in order for it to do any pre-work setup.
Public function void Called to run legacy track templates
Public function void

SetContext ( const FMovieSceneContext& InContext
)

 Get the evaluation context for the current frame
Public function void

SetFinished ( bool bInFinished
)

 Indicate that this sequence instance has finished evaluation and should remove its entities
Public function void Called for root level instances that have either never evaluated, or have previously finished evaluating
Public function void Called after dissection for root level instances in order for this sequence instacne to update any entities it needs for evaluation.

Operators

  Type Name Description
Public function FSequenceInstance &  
Public function FSequenceInstance &  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page