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.

API > API/Runtime > API/Runtime/MovieScene

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.

   
Name FEntityLedger
Type struct
Header File /Engine/Source/Runtime/MovieScene/Public/EntitySystem/MovieSceneEntityLedger.h
Include Path #include "EntitySystem/MovieSceneEntityLedger.h"

Syntax

struct FEntityLedger

Structs

Name Remarks
FImportedEntityData  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bInvalidated bool Whether we have been invalidated, and need to re-instantiate everything EntitySystem/MovieSceneEntityLedger.h  
ImportedEntities TMap< FMovieSceneEvaluationFieldEntityKey, FImportedEntityData > Map of source field entity key -> imported linker entities EntitySystem/MovieSceneEntityLedger.h  
OneShotEntities TArray< FMovieSceneEntityID > Map of source entities that were swept this frame EntitySystem/MovieSceneEntityLedger.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CanImportEntity ( UMovieSceneEntitySystemLinker* Linker,
const FEntityImportSequenceParams& ImportParams,
const FMovieSceneEntityComponentField* EntityField,
const FMovieSceneEvaluationFieldEntityQuery& Query,
FMovieSceneEvaluationFieldEntitySet& OutPerTickConditionalEntities,
TMap< uint32, bool >& ConditionResultCache,
bool bUpdatingPerTickEntities
)

 Checks to see whether we can currently import the requested entity, evaluating any conditions that may exist first. EntitySystem/MovieSceneEntityLedger.h  

void CleanupLinkerEntities ( const TSet< FMovieSceneEntityID >& LinkerEntities
)

 Remove linker entity IDs that exist in the specified set since they are no longer valid EntitySystem/MovieSceneEntityLedger.h  

bool Contains ( UMovieSceneEntitySystemLinker* Linker,
const FEntityComponentFilter& Filter
) const

 Check whether any of the entities in this ledger or their children match the specified filter EntitySystem/MovieSceneEntityLedger.h  

void FindImportedEntities ( TWeakObjectPtr< UObject > EntityOwner,
TArray< FMovieSceneEntityID >& OutEntityIDs
) const

 Find imported entities EntitySystem/MovieSceneEntityLedger.h  

FMovieSceneEntityID FindImportedEntity ( const FMovieSceneEvaluationFieldEntityKey& EntityKey
) const

 Find an imported entity EntitySystem/MovieSceneEntityLedger.h  

bool HasImportedEntity ( const FMovieSceneEvaluationFieldEntityKey& EntityKey
) const

 Check whether the specified entity is being tracked by this ledger at all EntitySystem/MovieSceneEntityLedger.h  

void ImportEntity ( UMovieSceneEntitySystemLinker* Linker,
const FEntityImportSequenceParams& ImportParams,
const FMovieSceneEntityComponentField* EntityField,
const FMovieSceneEvaluationFieldEntityQuery& Query,
FMovieSceneEvaluationFieldEntitySet& OutPerTickConditionalEntities,
TMap< uint32, bool >& ConditionResultCache
)

 Indicate that the specified field entity is currently being evaluated EntitySystem/MovieSceneEntityLedger.h  
  EntitySystem/MovieSceneEntityLedger.h  

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) EntitySystem/MovieSceneEntityLedger.h  

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) EntitySystem/MovieSceneEntityLedger.h  

bool IsInvalidated()

 Check whether the ledger has been invalidated. EntitySystem/MovieSceneEntityLedger.h  

void MutateAll ( UMovieSceneEntitySystemLinker* Linker,
const FEntityComponentFilter& Filter,
const IMovieScenePerEntityMutation& Mutation
) const

 Mutate all the entities within this ledger by using the specified filter EntitySystem/MovieSceneEntityLedger.h  

void TagGarbage ( UMovieSceneEntitySystemLinker* Linker
)

 Called in order to tag garbage as NeedsUnlink EntitySystem/MovieSceneEntityLedger.h  

void UnlinkEverything ( UMovieSceneEntitySystemLinker* Linker,
EUnlinkEverythingMode Garbage
)

 Unlink all imported linker entities and their children, whilst maintaining the map of imported entities EntitySystem/MovieSceneEntityLedger.h  

void UnlinkOneShots ( UMovieSceneEntitySystemLinker* Linker
)

 Unlink all imported one-shot linker entities and their children and clear the list of one shots EntitySystem/MovieSceneEntityLedger.h  

void UpdateConditionalEntities ( UMovieSceneEntitySystemLinker* Linker,
const FEntityImportSequenceParams& ImportParams,
const FMovieSceneEntityComponentField* EntityField,
const FMovieSceneEvaluationFieldEntitySet& ConditionalEntities
)

 Update any conditional entities for the current frame EntitySystem/MovieSceneEntityLedger.h  

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

   EntitySystem/MovieSceneEntityLedger.h  

void UpdateEntities ( UMovieSceneEntitySystemLinker* Linker,
const FEntityImportSequenceParams& ImportParams,
const FMovieSceneEntityComponentField* EntityField,
const FMovieSceneEvaluationFieldEntitySet& NewEntities,
FMovieSceneEvaluationFieldEntitySet& OutPerTickConditionalEntities,
TMap< uint32, bool >& ConditionResultCache
)

 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 EntitySystem/MovieSceneEntityLedger.h  

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

   EntitySystem/MovieSceneEntityLedger.h  

void UpdateOneShotEntities ( UMovieSceneEntitySystemLinker* Linker,
const FEntityImportSequenceParams& ImportParams,
const FMovieSceneEntityComponentField* EntityField,
const FMovieSceneEvaluationFieldEntitySet& NewEntities,
TMap< uint32, bool >& ConditionResultCache
)

 Update any one-shot entities for the current frame EntitySystem/MovieSceneEntityLedger.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page