1. Epic GamesDeveloper
  3. TFilteredEntityTask

TFilteredEntityTask

Unreal Engine C++ API Reference > Runtime > MovieScene > EntitySystem

References

   
Module MovieScene
Header /Engine/Source/Runtime/MovieScene/Public/EntitySystem/MovieSceneEntitySystemTask.h
Include #include "EntitySystem/MovieSceneEntitySystemTask.h"

Syntax

template<typename... T>  
struct TFilteredEntityTask

Constructors

  Type Name Description
Public function  

TFilteredEntityTask ( const TEntityTaskComponents< T... >& InComponents
)

  
Public function  

TFilteredEntityTask ( const TEntityTaskComponents< T... >& InComponents,
const FEntityComponentFilter& InFilter
)

  

Functions

  Type Name Description
Public function TFilteredEntityTask< T... > &

AddDynamicReadDependency ( const FComponentMask& InDynamicReadDependency
)

  
Public function TFilteredEntityTask< T... > &

AddDynamicReadDependency ( TArrayView< ComponentType > InReadDependencies
)

  
Public function TFilteredEntityTask< T... > &

AddDynamicReadDependency ( std::initializer_list< FComponentTypeID > InReadDependencies
)

  
Public function TFilteredEntityTask< T... > &

AddDynamicWriteDependency ( const FComponentMask& InDynamicWriteDependency
)

  
Public function TFilteredEntityTask< T... > &

AddDynamicWriteDependency ( TArrayView< ComponentType > InWriteDependencies
)

  
Public function TFilteredEntityTask< T... > &

AddDynamicWriteDependency ( std::initializer_list< FComponentTypeID > InWriteDependencies
)

  
Public function TFilteredEntityTask< T... > & Combine this task's filter with the specified filter
Public function Const FGraphEventRef

Dispatch_PerAllocation ( FEntityManager* EntityManager,
const FSystemTaskPrerequisites& Prerequisites,
FSystemSubsequentTasks* Subsequents,
TaskConstructionArgs&&... InArgs
)

 Dispatch a task for every entity that matches the filters and component types.
Public function Const FGraphEventRef

Dispatch_PerEntity ( FEntityManager* EntityManager,
const FSystemTaskPrerequisites& Prerequisites,
FSystemSubsequentTasks* Subsequents,
TaskConstructionArgs&&... InArgs
)

 Dispatch a task for every entity that matches the filters and component types.
Public function TFilteredEntityTask< T... > &

FilterAll ( std::initializer_list< FComponentTypeID > InComponentTypes
)

 Constrain this task to only run for entities that have all the specified components or tags
Public function TFilteredEntityTask< T... > &

FilterAll ( const FComponentMask& InComponentMask
)

 Constrain this task to only run for entities that have all the specified components or tags
Public function TFilteredEntityTask< T... > &

FilterAny ( const FComponentMask& InComponentMask
)

 Constrain this task to only run for entities that have at least one of the specified components or tags
Public function TFilteredEntityTask< T... > &

FilterAny ( std::initializer_list< FComponentTypeID > InComponentTypes
)

 Constrain this task to only run for entities that have at least one of the specified components or tags
Public function TFilteredEntityTask< T... > &

FilterNone ( std::initializer_list< FComponentTypeID > InComponentTypes
)

 Constrain this task to only run for entities that have none the specified components or tags
Public function TFilteredEntityTask< T... > &

FilterNone ( const FComponentMask& InComponentMask
)

 Constrain this task to only run for entities that have none the specified components or tags
Public function TFilteredEntityTask< T... > &

FilterOut ( std::initializer_list< FComponentTypeID > InComponentTypes
)

 Constrain this task to only run for entities that do not have the specific combination of components or tags
Public function TFilteredEntityTask< T... > &

FilterOut ( const FComponentMask& InComponentMask
)

 Constrain this task to only run for entities that do not have the specific combination of components or tags
Public function Const FTaskID

Fork_PerAllocation ( FEntityManager* EntityManager,
IEntitySystemScheduler* InScheduler,
TaskConstructionArgs&&... InArgs
)

  
Public function Const FTaskID

Fork_PerEntity ( FEntityManager* EntityManager,
IEntitySystemScheduler* InScheduler,
TaskConstructionArgs&&... InArgs
)

  
Public function Const const TEntityTaskComponents< T... > & Access the underlying component access definitions
Public function Const ENamedThreads::Type Get the desired thread for this task to run on
Public function Const const FEntityComponentFilter & Access the pre-populated filter that should be used for iterating relevant entities for this task
Public function Const TStatId Return this task's stat id
Public function Const void

Iterate_PerAllocation ( FEntityManager* EntityManager,
Callback&& InCallback
)

 Perform a thread-safe iteration of all matching allocations within the specified entity manager using this task, inline on the current thread
Public function Const void

Iterate_PerEntity ( FEntityManager* EntityManager,
Callback&& InCallback
)

 Perform a thread-safe iteration of all matching entities specified entity manager using this task, inline on the current thread
Public function Const void

RunInline_PerAllocation ( FEntityManager* EntityManager,
TaskImpl& Task
)

  
Public function Const void

RunInline_PerEntity ( FEntityManager* EntityManager,
TaskImpl Task
)

  
Public function Const FTaskID

Schedule_PerAllocation ( FEntityManager* EntityManager,
IEntitySystemScheduler* InScheduler,
TaskConstructionArgs&&... InArgs
)

  
Public function Const FTaskID

Schedule_PerEntity ( FEntityManager* EntityManager,
IEntitySystemScheduler* InScheduler,
TaskConstructionArgs&&... InArgs
)

  
Public function TFilteredEntityTask< T... > & Assign a desired thread for this task to run on
Public function TFilteredEntityTask< T... > &

SetParams ( const FTaskParams& InOtherParams
)

 Assign the scheduled task parameters for this task
Public function TFilteredEntityTask< T... > &

SetStat ( TStatId InStatId
)

 Assign a stat ID for this task
Public function Const bool Check whether we should break the debugger when this task is run

Deprecated Functions

  Type Name Description
Public function TFilteredEntityTask< T... > & This function is not required.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page