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 > TFilteredEntityTask

Light Theme

Dark Theme

TFilteredEntityTask

Windows

MacOS

Linux

References

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

Syntax

template<typename... T>
struct TFilteredEntityTask

Constructors

	Name	Description
	TFilteredEntityTask ( const TEntityTaskComponents< T... >... )
	TFilteredEntityTask ( const TEntityTaskComponents< T... >..., const FEntityComponentFilter& InFi... )

Functions

	Name	Description
TFilteredEnt...	CombineFilter ( const FEntityComponentFilter& InFi... )	Combine this task's filter with the specified filter
FGraphEventR...	Dispatch_PerAllocation ( FEntityManager* EntityManager, const FSystemTaskPrerequisites& Pr..., FSystemSubsequentTasks* Subseq..., TaskConstructionArgs&&... InArgs )	Dispatch a task for every entity that matches the filters and component types.
FGraphEventR...	Dispatch_PerEntity ( FEntityManager* EntityManager, const FSystemTaskPrerequisites& Pr..., FSystemSubsequentTasks* Subseq..., TaskConstructionArgs&&... InArgs )	Dispatch a task for every entity that matches the filters and component types.
TFilteredEnt...	FilterAll ( std::initializer_list< FComponentTy... )	Constrain this task to only run for entities that have all the specified components or tags
TFilteredEnt...	FilterAll ( const FComponentMask& InComponentM... )	Constrain this task to only run for entities that have all the specified components or tags
TFilteredEnt...	FilterAny ( std::initializer_list< FComponentTy... )	Constrain this task to only run for entities that have at least one of the specified components or tags
TFilteredEnt...	FilterAny ( const FComponentMask& InComponentM... )	Constrain this task to only run for entities that have at least one of the specified components or tags
TFilteredEnt...	FilterNone ( const FComponentMask& InComponentM... )	Constrain this task to only run for entities that have none the specified components or tags
TFilteredEnt...	FilterNone ( std::initializer_list< FComponentTy... )	Constrain this task to only run for entities that have none the specified components or tags
TFilteredEnt...	FilterOut ( std::initializer_list< FComponentTy... )	Constrain this task to only run for entities that do not have the specific combination of components or tags
TFilteredEnt...	FilterOut ( const FComponentMask& InComponentM... )	Constrain this task to only run for entities that do not have the specific combination of components or tags
const TEntit...	GetComponents()	Access the underlying component access definitions
const FEntit...	GetFilter()	Access the pre-populated filter that should be used for iterating relevant entities for this task
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
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
void	RunInline_PerAllocation ( FEntityManager* EntityManager, TaskImpl& Task )
void	RunInline_PerEntity ( FEntityManager* EntityManager, TaskImpl Task )
TFilteredEnt...	SetCurrentThread ( ENamedThreads::Type InCurrentThread )	Assign the current thread for task dispatch to ensure that it is issued on the correct thread.
TFilteredEnt...	SetDesiredThread ( ENamedThreads::Type InDesiredThread )	Assign a desired thread for this task to run on
TFilteredEnt...	SetStat ( TStatId InStatId )	Assign a stat ID for this task

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

Take our survey

Dismiss