FMovieSceneEvalTemplateBase

Base structure used for all movie scene evaluation templates

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

MovieScene

Header

/Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieSceneEvalTemplateBase.h

Include

#include "Evaluation/MovieSceneEvalTemplateBase.h"

Syntax

struct FMovieSceneEvalTemplateBase

Remarks

Base structure used for all movie scene evaluation templates

Variables

Name Description

Protected variable

uint8

 

OverrideMask

Mask of overridden properties - not serialized, but setup in SetupOverrides

Constructors

Name Description

Public function

FMovieSceneEvalTemplateBase()

Default constructor

Destructors

Name Description

Public function Virtual

~FMovieSceneEvalTemplateBase()

Virtual destruction

Functions

Name Description

Protected function

void

 

EnableOverrides

(
    uint8 OverrideFlag
)

Enable the overrides referred to by the specified flag mask

Public function Const

UScriptStruc...

 

GetScriptStruct()

Access the most derived script struct type of this instance for serialization purposes

Protected function Virtual Const

UScriptStruc...

 

GetScriptStructImpl()

Retrieve the script struct pertaining to the most-derived type of this instance.

Public function Const

void

 

OnBeginEvaluation

(
    FPersistentEvaluationData& Persist...,
    IMovieScenePlayer& Player
)

Called before this template is evaluated for the first time, or since OnEndEvaluation has been called

Public function Const

void

 

OnEndEvaluation

(
    FPersistentEvaluationData& Persist...,
    IMovieScenePlayer& Player
)

Called after this template is no longer being evaluated

Public function Const

bool

 

RequiresSetup()

Check whether this entity requires set up when it is first evaluated

Public function Const

bool

 

RequiresTearDown()

Check whether this entity requires tear up when it no longer being evaluated

Protected function Virtual Const

void

 

Setup

(
    FPersistentEvaluationData& Persist...,
    IMovieScenePlayer& Player
)

Called before this template is evaluated for the first time, or since OnEndEvaluation has been called.

Public function Virtual

void

 

SetupOverrides()

Called after construction to enable overridden functions required by this type.

Protected function Virtual Const

void

 

TearDown

(
    FPersistentEvaluationData& Persist...,
    IMovieScenePlayer& Player
)

Called after this template is no longer being evaluated.

Enums

Name

Description

Protected enum

EOverrideMask

Base class flag mask that should be considered by any implementations of FMovieSceneEvalTemplateBase

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