Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > MovieScene > EntitySystem > FSequenceInstance

Light Theme

Dark Theme

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.

Windows

MacOS

Linux

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

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

Constructors

	Name	Description
	FSequenceInstance ( const FSequenceInstance& )	Sequence instances are not copyable
	FSequenceInstance ( FSequenceInstance&& )	Move constructors implemented in cpp to avoid includes for TUniquePtr
	FSequenceInstance ( UMovieSceneEntitySystemLinker..., IMovieScenePlayer Player, FInstanceHandle ThisInstanceHandle )	Constructor for top level sequences
	FSequenceInstance ( UMovieSceneEntitySystemLinker..., IMovieScenePlayer Player, FInstanceHandle ThisInstanceHandle, FInstanceHandle RootInstanceHandle, FMovieSceneSequenceID InSequenceID, FMovieSceneCompiledDataID InCompile... )	Constructor for sub sequences

Destructors

	Name	Description
	~FSequenceInstance()	Destructor

Functions

	Name	Description
void	DestroyImmediately ( UMovieSceneEntitySystemLinker*... )	Destroy this sequence instance immediately - Finish must previously have been called
void	DissectContext ( UMovieSceneEntitySystemLinker*..., const FMovieSceneContext& Context, TArray< TRange< FFrameTime >>& Out... )	Called only for top-level sequence instances before any updates to it with the specified context.
void	EnableGlobalPreAnimatedStateCapture ( UMovieSceneEntitySystemLinker*... )	Indicate that this sequence instance should capture any and all changes of state so they can be restored later
FMovieSceneE...	FindEntity ( UObject* Owner, uint32 EntityID )	Attempt to locate an entity given its owner and ID
FInstanceHan...	FindSubInstance ( FMovieSceneSequenceID SequenceID )	Attempt to locate a sub instance based on its sequence ID
void	Finish ( UMovieSceneEntitySystemLinker*... )	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.
const FMovie...	GetContext()	Get the evaluation context for the current frame
const FMovie...	GetLegacyEvaluator()	Retrieve the legacy evaluator for this sequence, if it is available (may return nullptr)
IMovieSceneP...	GetPlayer()	Retrieve the IMovieScenePlayer that is playing back the top level sequence for this instance
FInstanceHan...	GetRootInstanceHandle()	Get a handle to the root instance for this sub sequence instance
FMovieSceneS...	GetSequenceID()	Retrieve the SequenceID for this instance
uint16	GetSerialNumber()	Get the serial number for this sequence instance that it was created with on construction.
FSubSequence...	GetSubSequencePath()	Retrieve a path for this sequence instance back to the root
bool	HasEverUpdated()	Check whether this sequence instance has ever been updated or not
bool	HasFinished()	Check whether this sequence instance has finished evaluating
void	InvalidateCachedData ( UMovieSceneEntitySystemLinker*... )	Invalidate any cached data that may be being used for evaluation due to a change in the source asset data
bool	IsCapturingGlobalPreAnimatedState()	Check whether this sequence instance is capturing any and all changes of state so they can be restored later
bool	IsRootSequence()	Returns whether this instance is the root instance.
bool	IsSubSequence()	Returns whether this instance is a sub sequence.
void	OverrideRootSequence ( UMovieSceneEntitySystemLinker*..., FMovieSceneSequenceID NewRootSequen... )	Called to override the simulated root sequence ID for this instance.
void	PostEvaluation ( UMovieSceneEntitySystemLinker*... )	Called when this sequence instance has been evaluated in order for it to do any clean-up or other post-update work
void	PreEvaluation ( UMovieSceneEntitySystemLinker*... )	Called when this instance has been queued for evaluation in order for it to do any pre-work setup.
void	RunLegacyTrackTemplates()	Called to run legacy track templates
void	SetContext ( const FMovieSceneContext& InContex... )	Get the evaluation context for the current frame
void	SetFinished ( bool bInFinished )	Indicate that this sequence instance has finished evaluation and should remove its entities
void	Start ( UMovieSceneEntitySystemLinker*..., const FMovieSceneContext& InContex... )	Called for root level instances that have either never evaluated, or have previously finished evaluating
void	Update ( UMovieSceneEntitySystemLinker*..., const FMovieSceneContext& InContex... )	Called after dissection for root level instances in order for this sequence instacne to update any entities it needs for evaluation.

Operators

		Name	Description
	FSequenceIns...	operator= ( const FSequenceInstance& )
	FSequenceIns...	operator= ( FSequenceInstance&& )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss