Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > MovieScene > Evaluation > FMovieSceneEntityComponentFieldBuilder > AddOneShotEntity > FMovieSceneEntityComponentFieldBuilder::AddOneShotEntity

Light Theme

Dark Theme

FMovieSceneEntityComponentFieldBuilder::AddOneShotEntity

Add a one-shot 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 AddOneShotEntity
(
    const TRange< FFrameNumber > & OneShotRange,
    UObject * EntityOwner,
    uint32 EntityID,
    int32 InMetaDataIndex
)

Remarks

Add a one-shot entity to the field for a given range. Equivalent to AddOneShotEntity(Range, FindOrAddEntity(EntityOwner, EntityID)). @note One-shot entities are only ever alive for a single evaluation, regardless of the range within the field. This makes them ideal for events or triggers.

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