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 > EntitySystem > FEntityLedger

Light Theme

Dark Theme

FEntityLedger

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

Windows

MacOS

Linux

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

	Name	Description
void	CleanupLinkerEntities ( const TSet< FMovieSceneEntityID >&... )	Remove linker entity IDs that exist in the specified set since they are no longer valid
FMovieSceneE...	FindImportedEntity ( const FMovieSceneEvaluationFieldEnt... )	Find an imported entity
bool	HasImportedEntity ( const FMovieSceneEvaluationFieldEnt... )	Check whether the specified entity is being tracked by this ledger at all
void	ImportEntity ( UMovieSceneEntitySystemLinker*..., const FEntityImportSequenceParams&..., const FMovieSceneEntityComponentFie..., const FMovieSceneEvaluationFieldEnt... )	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	TagGarbage ( UMovieSceneEntitySystemLinker*... )	Called in order to tag garbage as NeedsUnlink
void	UnlinkEverything ( UMovieSceneEntitySystemLinker*... )	Unlink all imported linker entities and their children, whilst maintaining the map of imported entities
void	UnlinkOneShots ( UMovieSceneEntitySystemLinker*... )	Unlink all imported one-shot linker entities and their children and clear the list of one shots
void	UpdateEntities ( UMovieSceneEntitySystemLinker*..., const FEntityImportSequenceParams&..., const FMovieSceneEntityComponentFie..., const FMovieSceneEvaluationFieldEnt... )	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*..., const FEntityImportSequenceParams&..., const FMovieSceneEntityComponentFie..., const FMovieSceneEvaluationFieldEnt... )	Update any one-shot entities for the current frame

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

Take our survey

Dismiss