FMovieSceneEntityComponentFieldBuilder::AddPersistentEntity

Add a persistent entity to the field for a given range.

Windows
MacOS
Linux

References

Module

MovieScene

Header

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

Include

#include "Evaluation/MovieSceneEvaluationField.h"

Source

/Engine/Source/Runtime/MovieScene/Private/Evaluation/MovieSceneEvaluationField.cpp

Syntax

void AddPersistentEntity
(
    const TRange< FFrameNumber > & Range,
    UObject * EntityOwner,
    uint32 EntityID,
    int32 InMetaDataIndex
)

Remarks

Add a persistent entity to the field for a given range. Equivalent to AddPersistentEntity(Range, FindOrAddEntity(EntityOwner, EntityID)). @note Persistent entities remain alive for the entire duration of their applicable ranges.

Parameters

Parameter

Description

Range

The range within which this entity should be alive

EntityOwner

The owner that produces the entity at runtime. Must implement the IMovieSceneEntityProvider interface

EntityID

(Optional) An identifier used to identify the entity inside IMovieSceneEntityProvider::ImportEntityImpl. Could be an index within an array or a set of flags.

MetaDataIndex

(Optional) Meta-data to use for this entitiy within this range. See AddMetaData.

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