1. Epic GamesDeveloper
  3. ATemplateSequenceActor

ATemplateSequenceActor

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

API > API/Plugins > API/Plugins/TemplateSequence

Inheritance Hierarchy

References

   
Module TemplateSequence
Header /Engine/Plugins/MovieScene/TemplateSequence/Source/TemplateSequence/Public/TemplateSequenceActor.h
Include #include "TemplateSequenceActor.h"

Syntax

UCLASS&40;HideCategories&61;&40;Rendering, Physics, LOD, Activation, Input&41;&41;  
class ATemplateSequenceActor :  
    public AActor,  
    public IMovieScenePlaybackClient

Remarks

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

Variables

  Type Name Description
Public variable UProperty Category BlueprintReadOnly FTemplateSequenceBindingOverrideData BindingOverride The override for the template sequence's root object binding. See SetBinding.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FMovieSceneSequencePlaybackSettings PlaybackSettings  
Public variable UProperty Category, Meta BlueprintReadOnly Transient, Replicated blueprintgetter, instanced TObjectPtr< UTemplateSequencePlayer > SequencePlayer  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FSoftObjectPath TemplateSequence  

Constructors

  Type Name Description
Public function  

ATemplateSequenceActor ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const UFunction BlueprintCallable, Category UTemplateSequence * Get the template sequence being played by this actor.
Public function Const UFunction blueprintgetter UTemplateSequencePlayer * Get the actor's sequence player, or nullptr if it not yet initialized.
Public function void  
Public function Const UFunction BlueprintCallable, Category UTemplateSequence * Get the template sequence being played by this actor.
Public function UFunction BlueprintCallable, Category void

SetBinding ( AActor* Actor,
bool bOverridesDefault
)

 Set the actor to play the template sequence onto, by setting up an override for the template sequence's root object binding.
Public function UFunction BlueprintCallable, Category void

SetSequence ( UTemplateSequence* InSequence
)

 Set the template sequence being played by this actor.

Overridden from AActor

  Type Name Description
Protected function Virtual void Overridable native event for when play begins for this actor.
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

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.

Overridden from IMovieScenePlaybackClient

  Type Name Description
Protected function Virtual Const UObject * Retrieve the optional instance data that should be used for this evaluation
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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page