1. Epic GamesDeveloper
  3. TFilteredEntityTask

TFilteredEntityTask

API > API/Runtime > API/Runtime/MovieScene

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

Syntax

template<typename... T>  
struct TFilteredEntityTask

Constructors

Name Remarks Include Path Unreal Specifiers

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

   EntitySystem/MovieSceneEntitySystemTask.h  

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

   EntitySystem/MovieSceneEntitySystemTask.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Components TEntityTaskComponents< T... >   EntitySystem/MovieSceneEntitySystemTask.h  
DynamicReadMask FComponentMask   EntitySystem/MovieSceneEntitySystemTask.h  
DynamicWriteMask FComponentMask   EntitySystem/MovieSceneEntitySystemTask.h  
Filter FEntityComponentFilter   EntitySystem/MovieSceneEntitySystemTask.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TFilteredEntityTask< T... > & AddDynamicReadDependency ( const FComponentMask& InDynamicReadDependency
)

   EntitySystem/MovieSceneEntitySystemTask.h  

TFilteredEntityTask< T... > & AddDynamicReadDependency ( TArrayView< ComponentType > InReadDependencies
)

   EntitySystem/MovieSceneEntitySystemTask.h  

TFilteredEntityTask< T... > & AddDynamicReadDependency ( std::initializer_list< FComponentTypeID > InReadDependencies
)

   EntitySystem/MovieSceneEntitySystemTask.h  

TFilteredEntityTask< T... > & AddDynamicWriteDependency ( const FComponentMask& InDynamicWriteDependency
)

   EntitySystem/MovieSceneEntitySystemTask.h  

TFilteredEntityTask< T... > & AddDynamicWriteDependency ( TArrayView< ComponentType > InWriteDependencies
)

   EntitySystem/MovieSceneEntitySystemTask.h  

TFilteredEntityTask< T... > & AddDynamicWriteDependency ( std::initializer_list< FComponentTypeID > InWriteDependencies
)

   EntitySystem/MovieSceneEntitySystemTask.h  

TFilteredEntityTask< T... > & CombineFilter ( const FEntityComponentFilter& InFilter
)

 Combine this task's filter with the specified filter EntitySystem/MovieSceneEntitySystemTask.h  

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

 Dispatch a task for every entity that matches the filters and component types. EntitySystem/MovieSceneEntitySystemTask.h  

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

 Dispatch a task for every entity that matches the filters and component types. EntitySystem/MovieSceneEntitySystemTask.h  

TFilteredEntityTask< T... > & FilterAll ( std::initializer_list< FComponentTypeID > InComponentTypes
)

 Constrain this task to only run for entities that have all the specified components or tags EntitySystem/MovieSceneEntitySystemTask.h  

TFilteredEntityTask< T... > & FilterAll ( const FComponentMask& InComponentMask
)

 Constrain this task to only run for entities that have all the specified components or tags EntitySystem/MovieSceneEntitySystemTask.h  

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

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

TFilteredEntityTask< T... > & FilterNone ( std::initializer_list< FComponentTypeID > InComponentTypes
)

 Constrain this task to only run for entities that have none the specified components or tags EntitySystem/MovieSceneEntitySystemTask.h  

TFilteredEntityTask< T... > & FilterNone ( const FComponentMask& InComponentMask
)

 Constrain this task to only run for entities that have none the specified components or tags EntitySystem/MovieSceneEntitySystemTask.h  

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

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

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

   EntitySystem/MovieSceneEntitySystemTask.h  

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

   EntitySystem/MovieSceneEntitySystemTask.h  

const TEntityTaskComponents< T... > & GetComponents()

 Access the underlying component access definitions EntitySystem/MovieSceneEntitySystemTask.h  

ENamedThreads::Type GetDesiredThread()

 Get the desired thread for this task to run on EntitySystem/MovieSceneEntitySystemTask.h  

const FEntityComponentFilter & GetFilter()

 Access the pre-populated filter that should be used for iterating relevant entities for this task EntitySystem/MovieSceneEntitySystemTask.h  

TStatId GetStatId()

 Return this task's stat id EntitySystem/MovieSceneEntitySystemTask.h  

void Iterate_PerAllocation ( FEntityManager* EntityManager,
Callback&& InCallback
) const

 Perform a thread-safe iteration of all matching allocations within the specified entity manager using this task, inline on the current thread EntitySystem/MovieSceneEntitySystemTask.h  

void Iterate_PerEntity ( FEntityManager* EntityManager,
Callback&& InCallback
) const

 Perform a thread-safe iteration of all matching entities specified entity manager using this task, inline on the current thread EntitySystem/MovieSceneEntitySystemTask.h  

void RunInline_PerAllocation ( FEntityManager* EntityManager,
TaskImpl& Task
) const

   EntitySystem/MovieSceneEntitySystemTask.h  

void RunInline_PerEntity ( FEntityManager* EntityManager,
TaskImpl Task
) const

   EntitySystem/MovieSceneEntitySystemTask.h  

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

   EntitySystem/MovieSceneEntitySystemTask.h  

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

   EntitySystem/MovieSceneEntitySystemTask.h  

TFilteredEntityTask< T... > & SetDesiredThread ( ENamedThreads::Type InDesiredThread
)

 Assign a desired thread for this task to run on EntitySystem/MovieSceneEntitySystemTask.h  

TFilteredEntityTask< T... > & SetParams ( const FTaskParams& InOtherParams
)

 Assign the scheduled task parameters for this task EntitySystem/MovieSceneEntitySystemTask.h  

TFilteredEntityTask< T... > & SetStat ( TStatId InStatId
)

 Assign a stat ID for this task EntitySystem/MovieSceneEntitySystemTask.h  

bool ShouldBreakOnRun()

 Check whether we should break the debugger when this task is run EntitySystem/MovieSceneEntitySystemTask.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page