1. Epic GamesDeveloper
  3. FEntityLedger

FEntityLedger

An entity ledger is responsible for tracking the entites that have been imported for the currently relevant frame of a sequence instance.

Unreal Engine C++ API Reference > Runtime > MovieScene > EntitySystem

References

   
Module MovieScene
Header /Engine/Source/Runtime/MovieScene/Public/EntitySystem/MovieSceneEntityLedger.h
Include #include "EntitySystem/MovieSceneEntityLedger.h"

Syntax

struct FEntityLedger

Remarks

An entity ledger is responsible for tracking the entites that have been imported for the currently relevant frame of a sequence instance. It is responsible for linking and unlinking new and expired entities in the linker's entity manager based on the current set of entities required for evaluation.

Functions

  Type Name Description
Public function void

CleanupLinkerEntities ( const TSet< FMovieSceneEntityID >& LinkerEntities
)

 Remove linker entity IDs that exist in the specified set since they are no longer valid
Public function Const bool Check whether any of the entities in this ledger or their children match the specified filter
Public function Const void Find imported entities
Public function Const FMovieSceneEntityID Find an imported entity
Public function Const bool Check whether the specified entity is being tracked by this ledger at all
Public function void Indicate that the specified field entity is currently being evaluated
Public function void Invalidate any and all entities that are currently being tracked, causing new linker entities to be created on the next evaluation, and ones to become unlinked (preserving any components with the preserve flag)
Public function Const bool

IsEmpty ()

 Check whether this ledger contains any information at all (ie is tracking any global entities, even if it has not created any linker entities for them)
Public function Const void Mutate all the entities within this ledger by using the specified filter
Public function void Called in order to tag garbage as NeedsUnlink
Public function void Unlink all imported linker entities and their children, whilst maintaining the map of imported entities
Public function void Unlink all imported one-shot linker entities and their children and clear the list of one shots
Public function void

UpdateEntities ( UMovieSceneEntitySystemLinker* Linker,
const FEntityImportSequenceParams& ImportParams,
const FMovieSceneEntityComponentField* EntityField,
const FMovieSceneEvaluationFieldEntitySet& NewEntities
)

 To be called any time this ledger's instance is to be evaluated with a different set of entities - updates the set of entities that are required for the current evaluation environment
Public function void

UpdateOneShotEntities ( UMovieSceneEntitySystemLinker* Linker,
const FEntityImportSequenceParams& ImportParams,
const FMovieSceneEntityComponentField* EntityField,
const FMovieSceneEvaluationFieldEntitySet& NewEntities
)

 Update any one-shot entities for the current frame

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page