1. Epic GamesDeveloper
  3. ALevelSequenceActor

ALevelSequenceActor

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

API > API/Runtime > API/Runtime/LevelSequence

Inheritance Hierarchy

References

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

Syntax

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 TObjectPtr< UMovieSceneBindingOverrides > BindingOverrides Mapping of actors to override the sequence bindings with
Public variable uint8: 1 bOverrideInstanceData Enable specification of dynamic instance data to be supplied to the sequence during playback
Public variable uint8: 1 bReplicatePlayback If true, playback of this level sequence on the server will be synchronized across other clients
Public variable TObjectPtr< ULevelSequenceBurnInOptions > BurnInOptions  
Public variable FLevelSequenceCameraSettings CameraSettings  
Public variable TObjectPtr< UObject > DefaultInstanceData Instance data that can be used to dynamically control sequence evaluation at runtime
Public variable TObjectPtr< ULevelSequence > LevelSequenceAsset  
Public variable FMovieSceneSequencePlaybackSettings PlaybackSettings  
Public variable TObjectPtr< ULevelSequencePlayer > SequencePlayer  

Constructors

  Type Name Description
Public function   Create and initialize a new instance.

Functions

  Type Name Description
Public function 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 void

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

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

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

  
Public function Const FMovieSceneObjectBindingID Retrieve the first object binding that has been tagged with the specified name
Public function Const const TArray< FMovieSceneObjectBindingID > & Retrieve all the bindings that have been tagged with the specified name
Public function Const ULevelSequence * Get the level sequence being played by this actor.
Public function Const ULevelSequencePlayer * Access this actor's sequence player, or None if it is not yet initialized
Public function 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
)

  
Public function void Refresh this actor's burn in
Public function void Removes the specified actor from the specified binding's actor array
Public function void

RemoveBindingByTag ( FName Tag,
AActor* Actor
)

 Removes the specified actor from the specified binding's actor array
Public function void Resets the specified binding back to the defaults defined by the Level Sequence asset
Public function void Resets all overridden bindings back to the defaults defined by the Level Sequence asset
Public function 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 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 void

SetReplicatePlayback ( bool ReplicatePlayback
)

 Set whether or not to replicate playback for this actor
Public function void

SetSequence ( ULevelSequence* InSequence
)

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

Overridden from AActor

  Type Name Description
Protected function Virtual void Overridable native event for when play begins for this actor.
Protected function Virtual Const bool Returns true if this actor allows changing the spatially loaded flag.
Protected function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Overridable function called whenever this actor is being removed from a level
Public function Virtual Const bool Used by the "Sync to Content Browser" right-click menu option in the editor.
Protected function Virtual void Allow actors to initialize themselves on the C++ side after all of their components have been initialized, only called during gameplay
Protected function Virtual bool Method that allows an actor to replicate subobjects on its actor channel.
Protected function Virtual void Called on the actor before checkpoint data is applied during a replay.

Overridden from UObject

  Type Name Description
Protected function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Protected function Virtual void Do any object-specific cleanup required immediately after loading an object.
Protected function Virtual void Always called immediately after properties are received from the remote.

Overridden from IMovieScenePlaybackClient

  Type Name Description
Protected function Virtual Const TOptional< EAspectRatioAxisConstraint > Whether this playback client wants a specific aspect ratio axis constraint during playback.
Protected function Virtual Const UObject * Retrieve the optional instance data that should be used for this evaluation
Protected function Virtual Const bool Whether this playback client wants replicated playback.
Protected function Virtual Const bool

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

 Locate bound objects that relate to the specified binding ID

Overridden from IMovieSceneBindingOwnerInterface

  Type Name Description
Public function Virtual TSharedPtr< FStructOnScope >

GetObjectPickerProxy ( TSharedPtr< IPropertyHandle > ObjectPropertyHandle
)

 Return a proxy struct used for editing the bound object
Public function Virtual Const UMovieSceneSequence * Retrieve the sequence that we own
Public function Virtual void

UpdateObjectFromProxy ( FStructOnScope& Proxy,
IPropertyHandle& ObjectPropertyHandle
)

 Update the specified object property handle based on the proxy structure's contents

Overridden from IWorldPartitionObjectResolver

  Type Name Description
Public function Virtual Const const FWorldPartitionResolveData &  
Public function Virtual void

SetWorldPartitionResolveData ( const FWorldPartitionResolveData& InWorldPartitionResolveData
)

  

Classes

  Type Name Description
Public class FOnLevelSequenceLoaded    

Deprecated Variables

  Type Name Description
Public variable uint8: 1 bAutoPlay_DEPRECATED  
Public variable 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