FMovieSceneEvaluationState

Provides runtime evaluation functions with the ability to look up state from the main game environment

Choose your operating system:

Windows

macOS

Linux

References

Module

MovieScene

Header

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

Include

#include "Evaluation/MovieSceneEvaluationState.h"

Syntax

struct FMovieSceneEvaluationState

Remarks

Provides runtime evaluation functions with the ability to look up state from the main game environment

Variables

Name Description

Public variable

TMap< FMovieSce...

 

PersistentEntityData

A map of persistent evaluation data mapped by movie scene evaluation entity (i.e, a given track or section)

Public variable

TMap< FSharedPe...

 

PersistentSharedData

A map of persistent evaluation data mapped by shared evaluation key.

Functions

Name Description

Public function

void

 

AssignSequence

(
    FMovieSceneSequenceIDRef InSequence...,
    UMovieSceneSequence& InSequence,
    IMovieScenePlayer& Player
)

Assign a sequence to a specific ID

Public function

void

 

ClearObjectCaches

(
    IMovieScenePlayer& Player
)

Forcably clear all object caches

Public function

void

 

FilterObjectBindings

(
    UObject* PredicateObject,
    IMovieScenePlayer& Player,
    TArray< FMovieSceneObjectBindingID ...
)

Filter all the object bindings in this object cache that contain the specified predicate object

Public function

FGuid

 

FindCachedObjectId

(
    UObject& Object,
    FMovieSceneSequenceIDRef InSequence...,
    IMovieScenePlayer& Player
)

Attempt deduce the posessable or spawnable that relates to the specified object @note Does not clear the existing cache

Public function

FMovieSceneO...

 

FindObjectCache

(
    FMovieSceneSequenceIDRef SequenceID
)

Find an object cache pertaining to the specified sequence

Public function

FGuid

 

FindObjectId

(
    UObject& Object,
    FMovieSceneSequenceIDRef InSequence...,
    IMovieScenePlayer& Player
)

Attempt deduce the posessable or spawnable that relates to the specified object @note Will forcably resolve any out of date bindings in the entire sequence

Public function Const

UMovieSceneS...

 

FindSequence

(
    FMovieSceneSequenceIDRef InSequence...
)

Attempt to locate a sequence from its ID

Public function Const

FMovieSceneS...

 

FindSequenceId

(
    UMovieSceneSequence* InSequenc...
)

Attempt to locate a sequence ID from a sequence

Public function

FMovieSceneO...

 

GetObjectCache

(
    FMovieSceneSequenceIDRef SequenceID
)

Get an object cache pertaining to the specified sequence

Public function

uint32

 

GetSerialNumber()

Get the serial number for this state.

Public function

void

 

Invalidate

(
    const FGuid& InGuid,
    FMovieSceneSequenceIDRef InSequence...
)

Forcably invalidate the specified object binding in the specified sequence

Public function

void

 

InvalidateExpiredObjects()

Invalidate any object caches that may now contain expired objects