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 > LevelSequence > ULevelSequence

Light Theme

Dark Theme

ULevelSequence

Movie scene animation for Actors.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMovieSceneSignedObject

UMovieSceneSequence

ULevelSequence

UControlRigSequence

References

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

Syntax

class ULevelSequence : public UMovieSceneSequence

Remarks

Movie scene animation for Actors.

Variables

	Name	Description
FLevelSequenceB...	BindingReferences	References to bound objects.
UBlueprint *...	DirectorBlueprint	A pointer to the director blueprint that generates this sequence's DirectorClass.
UClass *	DirectorClass	The class that is used to spawn this level sequence's director instance.
UMovieScene ...	MovieScene	Pointer to the movie scene that controls this animation.
FLevelSequenceO...	ObjectReferences	Legacy object references - should be read-only. Not deprecated because they need to still be saved

Constructors

	Name	Description
	ULevelSequence ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	ConvertPersistentBindingsToDefault ( UObject* FixupContext )	Convert old-style lazy object ptrs to new-style references using the specified context
MetaDataType...	CopyMetaData ( MetaDataType* InMetaData )	Copy the specified meta data into this level sequence, overwriting any existing meta-data of the same type Meta-data may implement the ILevelSequenceMetaData interface in order to hook into default ULevelSequence functionality.
UObject *...	CopyMetaData ( UObject* InMetaData )	Copy the specified meta data into this level sequence, overwriting any existing meta-data of the same type Meta-data may implement the ILevelSequenceMetaData interface in order to hook into default ULevelSequence functionality.
MetaDataType...	FindMetaData()	Find meta-data of a particular type for this level sequence instance
UObject *...	FindMetaDataByClass ( TSubclassOf< UObject > InClass )	Find meta-data of a particular type for this level sequence instance.
FGuid	FindOrAddBinding ( UObject* ObjectToPossess )
MetaDataType...	FindOrAddMetaData()	Find meta-data of a particular type for this level sequence instance, adding one if it was not found.
UObject *...	FindOrAddMetaDataByClass ( TSubclassOf< UObject > InClass )	Find meta-data of a particular type for this level sequence instance, adding it if it doesn't already exist.
UBlueprint &...	GetDirectorBlueprint()	Retrieve the currently assigned director blueprint for this level sequence
void	Initialize()	Initialize this level sequence.
void	LocateBoundObjects ( const FGuid& ObjectId, UObject* Context, FName StreamedLevelAssetPath, TArray< UObject*, TInlineAlloc... )
void	OnDirectorRecompiled ( UBlueprint* )	Invoked when this level sequence's director blueprint has been recompiled
void	RemoveMetaData()	Remove meta-data of a particular type for this level sequence instance, if it exists
void	RemoveMetaDataByClass ( TSubclassOf< UObject > InClass )	Remove meta-data of a particular type for this level sequence instance, if it exists
void	SetDirectorBlueprint ( UBlueprint* NewDirectorBluepri... )	Assign a new director blueprint to this level sequence.

Overridden from UMovieSceneSequence

	Name	Description
bool	AllowsSpawnableObjects()	Whether objects can be spawned at run-time.
void	BindPossessableObject ( const FGuid& ObjectId, UObject& PossessedObject, UObject* Context )	Called when Sequencer has created an object binding for a possessable object
bool	CanAnimateObject ( UObject& InObject )	Specifies whether this sequence can animate the object in question (either as a spawnable or possessable)
bool	CanPossessObject ( UObject& Object, UObject* InPlaybackContext )	Check whether the given object can be possessed by this animation.
bool	CanRebindPossessable ( const FMovieScenePossessable& InPo... )	Specifies whether this sequence allows rebinding of the specified possessable
UObject *...	CreateDirectorInstance ( IMovieScenePlayer& Player )	Called to retrieve or construct a director instance to be used for the specified player
FGuid	CreatePossessable ( UObject* ObjectToPossess )	Called to add a new possessable for the specified object
FGuid	CreateSpawnable ( UObject* ObjectToSpawn )	Called to add a new spawnable for the specified object
void	GatherExpiredObjects ( const FMovieSceneObjectCache& InOb..., TArray< FGuid >& OutInvalidIDs )	Called to validate the specified object cache by removing anything that should be deemed out of date
UMovieScene ...	GetMovieScene()	Get the movie scene that controls this animation.
UObject *...	GetParentObject ( UObject* Object )	Get the logical parent object for the supplied object (not necessarily its outer).
void	LocateBoundObjects ( const FGuid& ObjectId, UObject* Context, TArray< UObject*, TInlineAlloc... )	Locate all the objects that correspond to the specified object ID, using the specified context
UObject *...	MakeSpawnableTemplateFromInstance ( UObject& InSourceObject, FName ObjectName )	Create a spawnable object template from the specified source object
void	UnbindInvalidObjects ( const FGuid& ObjectId, UObject* Context )	Unbinds specific objects from the provided GUID that do not resolve
void	UnbindObjects ( const FGuid& ObjectId, const TArray< UObject* >& InO..., UObject* Context )	Unbinds specific objects from the provided GUID
void	UnbindPossessableObjects ( const FGuid& ObjectId )	Unbinds all possessable objects from the provided GUID.

Overridden from UObject

	Name	Description
void	GetAssetRegistryTagMetadata ( TMap< FName, FAssetRegistryTagMetad... )	Gathers a collection of asset registry tag metadata
void	GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTa... )	Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects
void	PostDuplicate ( bool bDuplicateForPIE )	Called after duplication & serialization and before PostLoad.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
bool	Rename ( const TCHAR* NewName, UObject* NewOuter, ERenameFlags Flags )	Rename this object to a unique name, or change its outer.

Deprecated Variables

		Name	Description
	TMap< FString, ...	PossessedObjects_DEPRECATED	Deprecated property housing old possessed object bindings

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

Take our survey

Dismiss