1. Epic GamesDeveloper
  3. ALevelSequenceActor

ALevelSequenceActor

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

Unreal Engine C++ API Reference > Runtime > LevelSequence

Inheritance Hierarchy

References

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

Syntax

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

Remarks

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

Variables

  Type Name Description
Public variable UProperty Category BlueprintReadOnly instanced TObjectPtr< UMovieSceneBindingOverrides > BindingOverrides Mapping of actors to override the sequence bindings with
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint8: 1 bOverrideInstanceData Enable specification of dynamic instance data to be supplied to the sequence during playback
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter, displayname uint8: 1 bReplicatePlayback If true, playback of this level sequence on the server will be synchronized across other clients
Public variable UProperty Category BlueprintReadOnly instanced TObjectPtr< ULevelSequenceBurnInOptions > BurnInOptions  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FLevelSequenceCameraSettings CameraSettings  
Public variable UProperty Category BlueprintReadWrite instanced TObjectPtr< UObject > DefaultInstanceData Instance data that can be used to dynamically control sequence evaluation at runtime
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly Replicated TObjectPtr< ULevelSequence > LevelSequenceAsset  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FMovieSceneSequencePlaybackSettings PlaybackSettings  
Public variable UProperty Category, Meta BlueprintReadOnly Transient, Replicated blueprintgetter, instanced TObjectPtr< ULevelSequencePlayer > SequencePlayer  

Constructors

  Type Name Description
Public function  

ALevelSequenceActor ( const FObjectInitializer& Init
)

 Create and initialize a new instance.

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category 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
Public function UFunction BlueprintCallable, Category void

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

 Binds an actor to all the bindings tagged with the specified name in this sequence.
Protected function Virtual void  
Protected function Virtual Const bool  
Public function Static void

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

  
Protected function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

  
Public function Const UFunction BlueprintCallable, Category displayname FMovieSceneObjectBindingID

FindNamedBinding ( FName Tag
)

 Retrieve the first object binding that has been tagged with the specified name
Public function Const UFunction BlueprintCallable, Category displayname const TArray< FMovieSceneObjectBindingID > &

FindNamedBindings ( FName Tag
)

 Retrieve all the bindings that have been tagged with the specified name
Protected function Virtual Const TOptional< EAspectRatioAxisConstraint >  
Protected function Virtual Const UObject *  
Protected function Virtual Const bool  
Public function Virtual TSharedPtr< FStructOnScope >

GetObjectPickerProxy ( TSharedPtr< IPropertyHandle > PropertyHandle
)

  
Public function Virtual Const bool

GetReferencedContentObjects ( TArray< UObject* >& Objects
)

  
Public function Const UFunction BlueprintCallable, Category ULevelSequence * Get the level sequence being played by this actor.
Public function Const UFunction blueprintgetter ULevelSequencePlayer * Access this actor's sequence player, or None if it is not yet initialized
Public function Const const FWorldPartitionResolveData &  
Public function UFunction BlueprintCallable, Category void Hide burnin
Public function void Initialize the player object by loading the asset, using async loading when necessary
Public function void Initialize the player object with the specified asset
Public function void

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

  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void  
Public function void Refresh this actor's burn in
Public function UFunction BlueprintCallable, Category void

RemoveBinding ( FMovieSceneObjectBindingID Binding,
AActor* Actor
)

 Removes the specified actor from the specified binding's actor array
Public function UFunction BlueprintCallable, Category void

RemoveBindingByTag ( FName Tag,
AActor* Actor
)

 Removes the specified actor from the specified binding's actor array
Public function UFunction BlueprintCallable, Category void

ResetBinding ( FMovieSceneObjectBindingID Binding
)

 Resets the specified binding back to the defaults defined by the Level Sequence asset
Public function UFunction BlueprintCallable, Category void Resets all overridden bindings back to the defaults defined by the Level Sequence asset
Protected function Virtual Const bool

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

  
Public function Virtual Const UMovieSceneSequence *  
Protected function Virtual void  
Public function UFunction BlueprintCallable, Category 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
Public function UFunction BlueprintCallable, Category 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.
Public function UFunction blueprintsetter void

SetReplicatePlayback ( bool ReplicatePlayback
)

 Set whether or not to replicate playback for this actor
Public function UFunction BlueprintCallable, Category void

SetSequence ( ULevelSequence* InSequence
)

 Set the level sequence being played by this actor.
Public function Virtual void

SetWorldPartitionResolveData ( const FWorldPartitionResolveData& InWorldPartitionResolveData
)

  
Public function UFunction BlueprintCallable, Category void Show burnin
Public function Virtual void

UpdateObjectFromProxy ( FStructOnScope& Proxy,
IPropertyHandle& ObjectPropertyHandle
)

  

Classes

  Type Name Description
Public class FOnLevelSequenceLoaded    

Deprecated Variables

  Type Name Description
Public variable UProperty uint8: 1 bAutoPlay_DEPRECATED  
Public variable UProperty FSoftObjectPath LevelSequence_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page