Navigation
API > API/Runtime > API/Runtime/MovieScene > API/Runtime/MovieScene/EntitySystem
Inheritance Hierarchy
- UObject
- UMovieSceneEntitySystem
- UMovieSceneBindingLifetimeSystem
- UMovieSceneBlenderSystem
- UMovieSceneEntityGroupingSystem
- UMovieSceneEntityInstantiatorSystem
- UMovieSceneBoundSceneComponentInstantiator
- UMovieSceneCachePreAnimatedStateSystem
- UMovieSceneGenericBoundObjectInstantiator
- UMovieSceneRestorePreAnimatedStateSystem
- UMovieSceneRootInstantiatorSystem
- UMovieSceneTrackInstanceInstantiator
- UMovieSceneEvalTimeSystem
- UMovieSceneEvaluationHookSystem
- UMovieSceneSpawnablesSystem
- UMovieSceneTrackInstanceSystem
References
| Module | MovieScene |
| Header | /Engine/Source/Runtime/MovieScene/Public/EntitySystem/MovieSceneEntitySystem.h |
| Include | #include "EntitySystem/MovieSceneEntitySystem.h" |
Syntax
UCLASS (MinimalAPI)
class UMovieSceneEntitySystem : public UObject
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
bool | bSystemIsEnabled | When false, this system will not call its OnRun function, but will still be kept alive as long as IsRelevant is true |
 |
uint16 | GlobalDependencyGraphID | |
 |
uint16 | GraphID | |
  |
TObjectPtr< UMovieSceneEntitySystemLinker > | Linker | |
 |
UE::MovieScene::ESystemPhase | Phase | |
 |
FComponentTypeID | RelevantComponent | Defines a single component that makes this system automatically linked when it exists in an entity manager. |
 |
UE::MovieScene::EEntitySystemCategory | SystemCategories |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UMovieSceneEntitySystem
(
const FObjectInitializer& ObjInit |
Destructors
| Type | Name | Description | |
|---|---|---|---|
 |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | Abandon () |
Called when the linker is being destroyed |
 |
void | ||
  |
void | ConditionalLinkSystem
(
UMovieSceneEntitySystemLinker* InLinker |
|
  |
void | DebugPrintGlobalDependencyGraph
(
bool bUpdateCache |
Prints a graphviz markup for the global system dependency graph |
  |
void | DefineComponentConsumer
(
TSubclassOf< UMovieSceneEntitySystem > ClassType, |
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. |
  |
void | DefineComponentProducer
(
TSubclassOf< UMovieSceneEntitySystem > ClassType, |
Informs the dependency graph that the specified class type produces components of the specified type. |
  |
void | DefineImplicitPrerequisite
(
TSubclassOf< UMovieSceneEntitySystem > UpstreamSystemType, |
Creates a relationship between the two system types that ensures any systems of type UpstreamSystemType always execute before DownstreamSystemType if they are both present |
 |
void | Disable () |
Disable this system if it is not already. |
 |
void | Enable () |
Enable this system if it is not already. |
  |
void | ||
  |
UE::MovieScene::EEntitySystemCategory | Returns system categories | |
  |
uint16 | Gets the ID of this system's type in the global dependency graph | |
  |
uint16 | GetGraphID () |
Returns the ID of this system in the system graphs |
  |
UMovieSceneEntitySystemLinker * | GetLinker () |
Returns the linker that owns this system |
  |
UE::MovieScene::ESystemPhase | GetPhase () |
Returns the phase(s) during which this system should be run |
  |
void | GetSubsequentSystems
(
uint16 FromGlobalNodeID, |
Get the global IDs of all subsequent systems of the given system |
  |
bool | ||
  |
bool | IsRelevant
(
UMovieSceneEntitySystemLinker* InLinker |
Called to know if the system is still relevant and should be kept around |
 |
void | Link
(
UMovieSceneEntitySystemLinker* InLinker |
Called when the system is added to a linker |
  |
void | LinkAllSystems
(
UMovieSceneEntitySystemLinker* InLinker |
Link all systems that pass the given linker's filter |
  |
void | LinkCategorySystems
(
UMovieSceneEntitySystemLinker* InLinker, |
Link all systems in a given category |
  |
void | LinkRelevantSystems
(
UMovieSceneEntitySystemLinker* InLinker |
Ensure that any systems relevant to the specified linker's entity manager are linked |
  |
void | PrintFilteredFlowGraph
(
TArrayView< const TBitArray<> > GroupFilters, |
Print the global system graph in graphviz format filtered by the specified global system IDs, one filter per phase |
  |
UE::MovieScene::EEntitySystemCategory | Create a new system category | |
 |
void | Run
(
FSystemTaskPrerequisites& InPrerequisites, |
Called when the system should run its logic |
 |
void | SchedulePersistentTasks
(
UE::MovieScene::IEntitySystemScheduler* Scheduler |
Called to schedule work |
 |
void | SetGraphID
(
uint16 InGraphID |
Sets the ID of this system in the system graphs |
  |
void | SortByFlowOrder
(
TArray< uint16 >& InOutGlobalNodeIDs |
Sort the given systems by their flow order, suitable for execution |
 |
void | TagGarbage () |
|
 |
void | Unlink () |
Called when the system is removed from the linker |