Navigation
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 | |
---|---|---|---|
![]() |
void | CleanupLinkerEntities
(
const TSet< FMovieSceneEntityID >& LinkerEntities |
Remove linker entity IDs that exist in the specified set since they are no longer valid |
![]() ![]() |
bool | Contains
(
UMovieSceneEntitySystemLinker* Linker, |
Check whether any of the entities in this ledger or their children match the specified filter |
![]() ![]() |
void | FindImportedEntities
(
TWeakObjectPtr< UObject > EntityOwner, |
Find imported entities |
![]() ![]() |
FMovieSceneEntityID | FindImportedEntity
(
const FMovieSceneEvaluationFieldEntityKey& EntityKey |
Find an imported entity |
![]() ![]() |
bool | HasImportedEntity
(
const FMovieSceneEvaluationFieldEntityKey& EntityKey |
Check whether the specified entity is being tracked by this ledger at all |
![]() |
void | ImportEntity
(
UMovieSceneEntitySystemLinker* Linker, |
Indicate that the specified field entity is currently being evaluated |
![]() |
void | Invalidate () |
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) |
![]() ![]() |
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) |
![]() ![]() |
void | MutateAll
(
UMovieSceneEntitySystemLinker* Linker, |
Mutate all the entities within this ledger by using the specified filter |
![]() |
void | TagGarbage
(
UMovieSceneEntitySystemLinker* Linker |
Called in order to tag garbage as NeedsUnlink |
![]() |
void | UnlinkEverything
(
UMovieSceneEntitySystemLinker* Linker |
Unlink all imported linker entities and their children, whilst maintaining the map of imported entities |
![]() |
void | UnlinkOneShots
(
UMovieSceneEntitySystemLinker* Linker |
Unlink all imported one-shot linker entities and their children and clear the list of one shots |
![]() |
void | UpdateEntities
(
UMovieSceneEntitySystemLinker* Linker, |
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 |
![]() |
void | UpdateOneShotEntities
(
UMovieSceneEntitySystemLinker* Linker, |
Update any one-shot entities for the current frame |