1. Epic GamesDeveloper
  3. ALevelSequenceActor

ALevelSequenceActor

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

API > API/Runtime > API/Runtime/LevelSequence

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

   
Name ALevelSequenceActor
Type class
Header File /Engine/Source/Runtime/LevelSequence/Public/LevelSequenceActor.h
Include Path #include "LevelSequenceActor.h"

Syntax

UCLASS (HideCategories=(Rendering, Physics, HLOD, Activation, Input), MinimalAPI)  
class ALevelSequenceActor :  
    public AActor ,  
    public IMovieScenePlaybackClient ,  
    public IMovieSceneBindingOwnerInterface ,  
    public IWorldPartitionObjectResolver

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

ALevelSequenceActor ( const FObjectInitializer& Init
)

 Create and initialize a new instance. LevelSequenceActor.h  

Classes

Name Remarks
FOnLevelSequenceLoaded  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
BindingOverrides TObjectPtr< UMovieSceneBindingOverrides > Mapping of actors to override the sequence bindings with LevelSequenceActor.h
  • Instanced
  • BlueprintReadOnly
  • Category="General"
bOverrideInstanceData uint8 Enable specification of dynamic instance data to be supplied to the sequence during playback LevelSequenceActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="General"
bReplicatePlayback uint8 If true, playback of this level sequence on the server will be synchronized across other clients LevelSequenceActor.h
  • EditAnywhere
  • DisplayName="Replicate Playback"
  • BlueprintReadWrite
  • BlueprintSetter=SetReplicatePlayback
  • Category=Replication
  • Meta=(ExposeOnSpawn)
BurnInOptions TObjectPtr< ULevelSequenceBurnInOptions >   LevelSequenceActor.h
  • Instanced
  • BlueprintReadOnly
  • Category="General"
CameraSettings FLevelSequenceCameraSettings   LevelSequenceActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Cameras"
  • Meta=(ShowOnlyInnerProperties, ExposeOnSpawn)
DefaultInstanceData TObjectPtr< UObject > Instance data that can be used to dynamically control sequence evaluation at runtime LevelSequenceActor.h
  • Instanced
  • BlueprintReadWrite
  • Category="General"
LevelSequenceAsset TObjectPtr< ULevelSequence >   LevelSequenceActor.h
  • EditAnywhere
  • Replicated
  • BlueprintReadOnly
  • Category="General"
  • Meta=(AllowedClasses="/Script/LevelSequence.LevelSequence", ExposeOnSpawn)
PlaybackSettings FMovieSceneSequencePlaybackSettings   LevelSequenceActor.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Playback"
  • Meta=(ShowOnlyInnerProperties, ExposeOnSpawn)
SequencePlayer TObjectPtr< ULevelSequencePlayer >   LevelSequenceActor.h
  • Instanced
  • Transient
  • Replicated
  • BlueprintReadOnly
  • BlueprintGetter=GetSequencePlayer
  • Category="Playback"
  • Meta=(ExposeFunctionCategories="Sequencer|Player")

Protected

Name Type Remarks Include Path Unreal Specifiers
bShowBurnin bool   LevelSequenceActor.h  
BurnInInstance TObjectPtr< ULevelSequenceBurnIn > Burn-in widget LevelSequenceActor.h  
WorldPartitionResolveData FWorldPartitionResolveData   LevelSequenceActor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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 LevelSequenceActor.h
  • BlueprintCallable
  • Category="Sequencer|Player|Bindings"

void AddBindingByTag ( FName BindingTag,
AActor* Actor,
bool bAllowBindingsFromAsset
)

 Binds an actor to all the bindings tagged with the specified name in this sequence. LevelSequenceActor.h
  • BlueprintCallable
  • Category="Sequencer|Player|Bindings"

FMovieSceneObjectBindingID FindNamedBinding ( FName Tag
) const

 Retrieve the first object binding that has been tagged with the specified name LevelSequenceActor.h
  • BlueprintCallable
  • Category="Sequencer|Player|Bindings"
  • DisplayName="Find Binding by Tag"

const TArray< FMovieSceneObjectBindingID > & FindNamedBindings ( FName Tag
) const

 Retrieve all the bindings that have been tagged with the specified name LevelSequenceActor.h
  • BlueprintCallable
  • Category="Sequencer|Player|Bindings"
  • DisplayName="Find Bindings by Tag"
Get the level sequence being played by this actor. LevelSequenceActor.h
  • BlueprintCallable
  • Category="Sequencer|Player"

ULevelSequencePlayer * GetSequencePlayer()

 Access this actor's sequence player, or None if it is not yet initialized LevelSequenceActor.h
  • BlueprintGetter

void HideBurnin()

 Hide burnin LevelSequenceActor.h
  • BlueprintCallable
  • Category="Sequencer|Player"

void InitializePlayer()

 Initialize the player object by loading the asset, using async loading when necessary LevelSequenceActor.h  

void InitializePlayerWithSequence ( ULevelSequence* LevelSequenceAsset
)

 Initialize the player object with the specified asset LevelSequenceActor.h  

void OnSequenceLoaded ( const FName& PackageName,
UPackage* Package,
EAsyncLoadingResult::Type Result
)

   LevelSequenceActor.h  

void RefreshBurnIn()

 Refresh this actor's burn in LevelSequenceActor.h  

void RemoveBinding ( FMovieSceneObjectBindingID Binding,
AActor* Actor
)

 Removes the specified actor from the specified binding's actor array LevelSequenceActor.h
  • BlueprintCallable
  • Category="Sequencer|Player|Bindings"

void RemoveBindingByTag ( FName Tag,
AActor* Actor
)

 Removes the specified actor from the specified binding's actor array LevelSequenceActor.h
  • BlueprintCallable
  • Category="Sequencer|Player|Bindings"

void ResetBinding ( FMovieSceneObjectBindingID Binding
)

 Resets the specified binding back to the defaults defined by the Level Sequence asset LevelSequenceActor.h
  • BlueprintCallable
  • Category="Sequencer|Player|Bindings"

void ResetBindings()

 Resets all overridden bindings back to the defaults defined by the Level Sequence asset LevelSequenceActor.h
  • BlueprintCallable
  • Category="Sequencer|Player|Bindings"

void SetBinding ( FMovieSceneObjectBindingID Binding,
const TArray< AActor* >& Actors,
bool bAllowBindingsFromAsset
)

 Overrides the specified binding with the specified actors, optionally still allowing the bindings defined in the Level Sequence asset LevelSequenceActor.h
  • BlueprintCallable
  • Category="Sequencer|Player|Bindings"

void SetBindingByTag ( FName BindingTag,
const TArray< AActor* >& Actors,
bool bAllowBindingsFromAsset
)

 Assigns an set of actors to all the bindings tagged with the specified name in this sequence. LevelSequenceActor.h
  • BlueprintCallable
  • Category="Sequencer|Player|Bindings"

void SetReplicatePlayback ( bool ReplicatePlayback
)

 Set whether or not to replicate playback for this actor LevelSequenceActor.h
  • BlueprintSetter

void SetSequence ( ULevelSequence* InSequence
)

 Set the level sequence being played by this actor. LevelSequenceActor.h
  • BlueprintCallable
  • Category="Sequencer|Player"

void ShowBurnin()

 Show burnin LevelSequenceActor.h
  • BlueprintCallable
  • Category="Sequencer|Player"

Overridden from AActor

Name Remarks Include Path Unreal Specifiers

virtual bool GetReferencedContentObjects ( TArray< UObject* >& Objects
) const

   LevelSequenceActor.h  

Overridden from IMovieSceneBindingOwnerInterface

Name Remarks Include Path Unreal Specifiers

virtual TSharedPtr< FStructOnScope > GetObjectPickerProxy ( TSharedPtr< IPropertyHandle > PropertyHandle
)

   LevelSequenceActor.h  

virtual UMovieSceneSequence * RetrieveOwnedSequence()

   LevelSequenceActor.h  

virtual void UpdateObjectFromProxy ( FStructOnScope& Proxy,
IPropertyHandle& ObjectPropertyHandle
)

   LevelSequenceActor.h  

Overridden from IWorldPartitionObjectResolver

Name Remarks Include Path Unreal Specifiers

virtual const FWorldPartitionResolveData & GetWorldPartitionResolveData()

   LevelSequenceActor.h  

virtual void SetWorldPartitionResolveData ( const FWorldPartitionResolveData& InWorldPartitionResolveData
)

   LevelSequenceActor.h  

Protected

Overridden from AActor

Name Remarks Include Path Unreal Specifiers

virtual void BeginPlay()

   LevelSequenceActor.h  

virtual bool CanChangeIsSpatiallyLoadedFlag()

   LevelSequenceActor.h  

virtual void EndPlay ( const EEndPlayReason::Type EndPlayReason
)

   LevelSequenceActor.h  

virtual void PostInitializeComponents()

   LevelSequenceActor.h  

virtual void PreInitializeComponents()

   LevelSequenceActor.h  

virtual void RewindForReplay()

   LevelSequenceActor.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostInitProperties()

   LevelSequenceActor.h  

virtual void PostLoad()

   LevelSequenceActor.h  

virtual void PostNetReceive()

   LevelSequenceActor.h  

Overridden from IMovieScenePlaybackClient

Name Remarks Include Path Unreal Specifiers

virtual TOptional< EAspectRatioAxisConstraint > GetAspectRatioAxisConstraint()

   LevelSequenceActor.h  

virtual UObject * GetInstanceData()

   LevelSequenceActor.h  

virtual bool GetIsReplicatedPlayback()

   LevelSequenceActor.h  

virtual bool RetrieveBindingOverrides ( const FGuid& InBindingId,
FMovieSceneSequenceID InSequenceID,
TArray< UObject*, TInlineAllocator< 1 > >& OutObjects
) const

   LevelSequenceActor.h  

Static

Name Remarks Include Path Unreal Specifiers

static void DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

   LevelSequenceActor.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bAutoPlay_DEPRECATED uint8   LevelSequenceActor.h  
LevelSequence_DEPRECATED FSoftObjectPath   LevelSequenceActor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page