1. Epic GamesDeveloper
  3. UMovieSceneEntitySystem

UMovieSceneEntitySystem

API > API/Runtime > API/Runtime/MovieScene

   
Name UMovieSceneEntitySystem
Type class
Header File /Engine/Source/Runtime/MovieScene/Public/EntitySystem/MovieSceneEntitySystem.h
Include Path #include "EntitySystem/MovieSceneEntitySystem.h"

Syntax

UCLASS (MinimalAPI)  
class UMovieSceneEntitySystem : public UObject

Inheritance Hierarchy

Derived Classes

UMovieSceneEntitySystem derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UMovieSceneEntitySystem ( const FObjectInitializer& ObjInit
)

   EntitySystem/MovieSceneEntitySystem.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~UMovieSceneEntitySystem()

   EntitySystem/MovieSceneEntitySystem.h  

Typedefs

Name Type Remarks Include Path
FComponentMask UE::MovieScene::FComponentMask   EntitySystem/MovieSceneEntitySystem.h
FComponentTypeID UE::MovieScene::FComponentTypeID   EntitySystem/MovieSceneEntitySystem.h
FSystemSubsequentTasks UE::MovieScene::FSystemSubsequentTasks   EntitySystem/MovieSceneEntitySystem.h
FSystemTaskPrerequisites UE::MovieScene::FSystemTaskPrerequisites   EntitySystem/MovieSceneEntitySystem.h
TComponentTypeID UE::MovieScene::TComponentTypeID< T >   EntitySystem/MovieSceneEntitySystem.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Abandon()

 Called when the linker is being destroyed EntitySystem/MovieSceneEntitySystem.h  

void CleanTaggedGarbage()

   EntitySystem/MovieSceneEntitySystem.h  

void ConditionalLinkSystem ( UMovieSceneEntitySystemLinker* InLinker
) const

   EntitySystem/MovieSceneEntitySystem.h  

void Disable ()

 Disable this system if it is not already. EntitySystem/MovieSceneEntitySystem.h  

void Enable()

 Enable this system if it is not already. EntitySystem/MovieSceneEntitySystem.h  
Returns system categories EntitySystem/MovieSceneEntitySystem.h  

uint16 GetGlobalDependencyGraphID()

 Gets the ID of this system's type in the global dependency graph EntitySystem/MovieSceneEntitySystem.h  

uint16 GetGraphID()

 Returns the ID of this system in the system graphs EntitySystem/MovieSceneEntitySystem.h  
Returns the linker that owns this system EntitySystem/MovieSceneEntitySystem.h  
Returns the phase(s) during which this system should be run EntitySystem/MovieSceneEntitySystem.h  

bool IsRelevant ( UMovieSceneEntitySystemLinker* InLinker
) const

 Called to know if the system is still relevant and should be kept around EntitySystem/MovieSceneEntitySystem.h  

void Link ( UMovieSceneEntitySystemLinker* InLinker
)

 Called when the system is added to a linker EntitySystem/MovieSceneEntitySystem.h  

void Run ( FSystemTaskPrerequisites& InPrerequisites,
FSystemSubsequentTasks& Subsequents
)

 Called when the system should run its logic EntitySystem/MovieSceneEntitySystem.h  

void SchedulePersistentTasks ( UE::MovieScene::IEntitySystemScheduler* Scheduler
)

 Called to schedule work EntitySystem/MovieSceneEntitySystem.h  

void SetGraphID ( uint16 InGraphID
)

 Sets the ID of this system in the system graphs EntitySystem/MovieSceneEntitySystem.h  

void TagGarbage()

   EntitySystem/MovieSceneEntitySystem.h  

void Unlink()

 Called when the system is removed from the linker EntitySystem/MovieSceneEntitySystem.h  

Protected

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void FinishDestroy()

   EntitySystem/MovieSceneEntitySystem.h  

virtual bool IsReadyForFinishDestroy()

   EntitySystem/MovieSceneEntitySystem.h  

Static

Name Remarks Include Path Unreal Specifiers

static void DebugPrintGlobalDependencyGraph ( bool bUpdateCache
)

 Prints a graphviz markup for the global system dependency graph EntitySystem/MovieSceneEntitySystem.h  

static void DefineComponentConsumer ( TSubclassOf< UMovieSceneEntitySystem > ClassType,
FComponentTypeID ComponentType
)

 Informs the dependency graph that the specified class type consumes components of the specified type, and as such should always execute after any producers of that component type. EntitySystem/MovieSceneEntitySystem.h  

static void DefineComponentProducer ( TSubclassOf< UMovieSceneEntitySystem > ClassType,
FComponentTypeID ComponentType
)

 Informs the dependency graph that the specified class type produces components of the specified type. EntitySystem/MovieSceneEntitySystem.h  

static void DefineImplicitPrerequisite ( TSubclassOf< UMovieSceneEntitySystem > UpstreamSystemType,
TSubclassOf< UMovieSceneEntitySystem > DownstreamSystemType
)

 Creates a relationship between the two system types that ensures any systems of type UpstreamSystemType always execute before DownstreamSystemType if they are both present EntitySystem/MovieSceneEntitySystem.h  

static void GetSubsequentSystems ( uint16 FromGlobalNodeID,
TArray< uint16 >& OutSubsequentGlobalNodeIDs
)

 Get the global IDs of all subsequent systems of the given system EntitySystem/MovieSceneEntitySystem.h  

static bool IsCustomSchedulingEnabled ()

 Checks whether custom task sheduling is enabled or not EntitySystem/MovieSceneEntitySystem.h  

static void LinkAllSystems ( UMovieSceneEntitySystemLinker* InLinker
)

 Link all systems that pass the given linker's filter EntitySystem/MovieSceneEntitySystem.h  

static void LinkCategorySystems ( UMovieSceneEntitySystemLinker* InLinker,
UE::MovieScene::EEntitySystemCategory InCategory
)

 Link all systems in a given category EntitySystem/MovieSceneEntitySystem.h  

static void LinkRelevantSystems ( UMovieSceneEntitySystemLinker* InLinker
)

 Ensure that any systems relevant to the specified linker's entity manager are linked EntitySystem/MovieSceneEntitySystem.h  

static void PrintFilteredFlowGraph ( TArrayView< const TBitArray<> > GroupFilters,
FStringBuilderBase& OutString
)

 Print the global system graph in graphviz format filtered by the specified global system IDs, one filter per phase EntitySystem/MovieSceneEntitySystem.h  

static UE::MovieScene::EEntitySystemCategory RegisterCustomSystemCategory()

 Create a new system category EntitySystem/MovieSceneEntitySystem.h  

static void SortByFlowOrder ( TArray< uint16 >& InOutGlobalNodeIDs
)

 Sort the given systems by their flow order, suitable for execution EntitySystem/MovieSceneEntitySystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page