ATemplateSequenceActor

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

Windows
MacOS
Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

ATemplateSequenceActor

References

Module

TemplateSequence

Header

/Engine/Plugins/MovieScene/TemplateSequence/Source/TemplateSequence/Public/TemplateSequenceActor.h

Include

#include "TemplateSequenceActor.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(HideCategories=(Rendering, Physics, LOD, Activation, Input))
class ATemplateSequenceActor :
    public AActor,
    public IMovieSceneSequenceActor,
    public IMovieScenePlaybackClient

Remarks

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

Variables

Name Description

Public variable UProperty Category BlueprintReadOnly

FTemplateSequen...

 

BindingOverride

The override for the template sequence's root object binding. See SetBinding.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

FMovieSceneSequ...

 

PlaybackSettings

Public variable UProperty Category, Meta BlueprintReadOnly Transient, Replicated blueprintgetter, instanced

UTemplateSequen...

 

SequencePlayer

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

FSoftObjectPath

 

TemplateSequence

Constructors

Name Description

Public function

ATemplateSequenceActor

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const UFunction BlueprintCallable, Category

UTemplateSeq...

 

GetSequence()

Get the template sequence being played by this actor.

Public function Const UFunction blueprintgetter

UTemplateSeq...

 

GetSequencePlayer()

Get the actor's sequence player, or nullptr if it not yet initialized.

Public function

void

 

InitializePlayer()

Public function Const UFunction BlueprintCallable, Category

UTemplateSeq...

 

LoadSequence()

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

Name Description

Protected function Virtual

void

 

BeginPlay()

Overridable native event for when play begins for this actor.

Protected function Virtual

void

 

EndPlay

(
    const EEndPlayReason::Type EndPlayR...
)

Overridable function called whenever this actor is being removed from a level

Public function Virtual Const

bool

 

GetReferencedContentObjects

(
    TArray< UObject* >& Objects
)

Used by the "Sync to Content Browser" right-click menu option in the editor.

Protected function Virtual

void

 

PostInitializeComponents()

Allow actors to initialize themselves on the C++ side after all of their components have been initialized, only called during gameplay

Overridden from UObject

Name Description

Protected function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Overridden from IMovieSceneSequenceActor

Name Description

Protected function Virtual

void

 

TickFromSequenceTickManager

(
    float DeltaSeconds
)

Overridden from IMovieScenePlaybackClient

Name Description

Protected function Virtual Const

UObject *...

 

GetInstanceData()

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*, TInlineAlloc...
)

Locate bound objects that relate to the specified binding ID

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