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 > ALevelSequenceActor

Light Theme

Dark Theme

ALevelSequenceActor

Actor responsible for controlling a specific level sequence in the world.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

ALevelSequenceActor

References

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

Syntax

class ALevelSequenceActor :
    public AActor,
    public IMovieScenePlaybackClient,
    public IMovieSceneBindingOwnerInterface

Remarks

Actor responsible for controlling a specific level sequence in the world.

Variables

	Name	Description
TArray< AActor ...	AdditionalEventReceivers
UMovieSceneBind...	BindingOverrides	Mapping of actors to override the sequence bindings with
uint8: 1	bOverrideInstanceData	Enable specification of dynamic instance data to be supplied to the sequence during playback
uint8: 1	bReplicatePlayback	If true, playback of this level sequence on the server will be synchronized across other clients
ULevelSequenceB...	BurnInOptions
FLevelSequenceC...	CameraSettings
UObject *	DefaultInstanceData	Instance data that can be used to dynamically control sequence evaluation at runtime
FSoftObjectPath	LevelSequence
FMovieSceneSequ...	PlaybackSettings
ULevelSequenceP...	SequencePlayer

Constructors

	Name	Description
	ALevelSequenceActor ( const FObjectInitializer& Init )	Create and initialize a new instance.

Functions

	Name	Description
void	AddBinding ( FMovieSceneObjectBindingID Binding, AActor* Actor, bool bAllowBindingsFromAsset )	Adds the specified actor to the overridden bindings for the specified binding ID, optionally still allowing the bindings defined in the Level Sequence asset
void	AddBindingByTag ( FName BindingTag, AActor* Actor, bool bAllowBindingsFromAsset )	Binds an actor to all the bindings tagged with the specified name in this sequence.
FMovieSceneO...	FindNamedBinding ( FName Tag )	Retrieve the first object binding that has been tagged with the specified name
const TArray...	FindNamedBindings ( FName Tag )	Retrieve all the bindings that have been tagged with the specified name
ULevelSequen...	GetSequence()	Get the level sequence being played by this actor.
ULevelSequen...	GetSequencePlayer()	Access this actor's sequence player, or None if it is not yet initialized
void	HideBurnin()	Hide burnin
void	InitializePlayer()	Initialize the player object by loading the asset, using async loading when necessary
void	InitializePlayerWithSequence ( ULevelSequence* LevelSequenceA... )	Initialize the player object with the specified asset
ULevelSequen...	LoadSequence()	Get the level sequence being played by this actor.
void	OnSequenceLoaded ( const FName& PackageName, UPackage* Package, EAsyncLoadingResult::Type Result )
void	RefreshBurnIn()	Refresh this actor's burn in
void	RemoveBinding ( FMovieSceneObjectBindingID Binding, AActor* Actor )	Removes the specified actor from the specified binding's actor array
void	RemoveBindingByTag ( FName Tag, AActor* Actor )	Removes the specified actor from the specified binding's actor array
void	ResetBinding ( FMovieSceneObjectBindingID Binding )	Resets the specified binding back to the defaults defined by the Level Sequence asset
void	ResetBindings()	Resets all overridden bindings back to the defaults defined by the Level Sequence asset
void	SetBinding ( FMovieSceneObjectBindingID Binding, const TArray< AActor* >& Acto..., bool bAllowBindingsFromAsset )	Overrides the specified binding with the specified actors, optionally still allowing the bindings defined in the Level Sequence asset
void	SetBindingByTag ( FName BindingTag, const TArray< AActor* >& Acto..., bool bAllowBindingsFromAsset )	Assigns an set of actors to all the bindings tagged with the specified name in this sequence.
void	SetEventReceivers ( TArray< AActor* > AdditionalRe... )	Set an array of additional actors that will receive events triggerd from this sequence actor
void	SetReplicatePlayback ( bool ReplicatePlayback )	Set whether or not to replicate playback for this actor
void	SetSequence ( ULevelSequence* InSequence )	Set the level sequence being played by this actor.
void	ShowBurnin()	Show burnin

Overridden from AActor

	Name	Description
void	BeginPlay()	Overridable native event for when play begins for this actor.
void	EndPlay ( const EEndPlayReason::Type EndPlayR... )	Overridable function called whenever this actor is being removed from a level
bool	GetReferencedContentObjects ( TArray< UObject* >& Objects )	Used by the "Sync to Content Browser" right-click menu option in the editor.
void	PostInitializeComponents()	Allow actors to initialize themselves on the C++ side after all of their components have been initialized, only called during gameplay
bool	ReplicateSubobjects ( UActorChannel* Channel, FOutBunch* Bunch, FReplicationFlags* RepFlags )	Method that allows an actor to replicate subobjects on its actor channel
void	RewindForReplay()	Called on the actor before checkpoint data is applied during a replay.
void	Tick ( float DeltaSeconds )	Function called every frame on this Actor.

Overridden from UObject

		Name	Description
	void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
	void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Overridden from IMovieScenePlaybackClient

		Name	Description
	UObject *...	GetInstanceData()	Retrieve the optional instance data that should be used for this evaluation
	bool	RetrieveBindingOverrides ( const FGuid& InBindingId, FMovieSceneSequenceID InSequenceID, TArray< UObject*, TInlineAlloc... )	Locate bound objects that relate to the specified binding ID

Overridden from IMovieSceneBindingOwnerInterface

	Name	Description
TSharedPtr< ...	GetObjectPickerProxy ( TSharedPtr< IPropertyHandle > Objec... )	Return a proxy struct used for editing the bound object
UMovieSceneS...	RetrieveOwnedSequence()	Retrieve the sequence that we own
void	UpdateObjectFromProxy ( FStructOnScope& Proxy, IPropertyHandle& ObjectPropertyHan... )	Update the specified object property handle based on the proxy structure's contents

Classes

	Name	Description
	FOnLevelSequenceLoaded

Deprecated Variables

		Name	Description
	uint8: 1	bAutoPlay_DEPRECATED

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

Take our survey

Dismiss