UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
UE::Mass::FQueryExecutor Struct Referenceabstract

#include <MassQueryExecutor.h>

Public Member Functions

UE_API FQueryExecutor (FMassEntityQuery &InQuery, UObject *InLogOwner=nullptr)
 
virtual ~FQueryExecutor ()=default
 
virtual void Execute (FMassExecutionContext &Context)=0
 

Static Public Member Functions

template<typename T , typename = typename TEnableIf<TIsDerivedFrom<T, FQueryExecutor>::IsDerived>::Type>
static TSharedPtr< T > CreateQuery (FMassEntityQuery &InQuery, UObject *InLogOwner=nullptr)
 

Protected Member Functions

UObject * GetLogOwner ()
 
template<typename TAccessors , typename TFunc >
void ForEachEntityChunk (FMassExecutionContext &ExecutionContext, TAccessors &Accessors, const TFunc &&ExecuteFunction)
 
template<typename TAccessors , typename TFunc >
void ParallelForEachEntityChunk (FMassExecutionContext &ExecutionContext, const TAccessors &Accessors, const TFunc &&ExecuteFunction)
 
template<typename TAccessors , typename TFunc >
void ForEachEntity (FMassExecutionContext &ExecutionContext, TAccessors &Accessors, const TFunc &&ExecuteFunction)
 
template<typename TAccessors , typename TFunc >
void ParallelForEachEntity (FMassExecutionContext &ExecutionContext, TAccessors &Accessors, const TFunc &&ExecuteFunction)
 
UE_API FQueryExecutor ()
 

Friends

template<typename... Ts>
struct FQueryDefinition
 

Detailed Description

A MassEntityQuery wrapper with type-safe data access.

Constructor & Destructor Documentation

◆ FQueryExecutor() [1/2]

UE::Mass::FQueryExecutor::FQueryExecutor ( FMassEntityQuery &  InQuery,
UObject *  InLogOwner = nullptr 
)
explicit

◆ ~FQueryExecutor()

virtual UE::Mass::FQueryExecutor::~FQueryExecutor ( )
virtualdefault

◆ FQueryExecutor() [2/2]

UE::Mass::FQueryExecutor::FQueryExecutor ( )
protected

Member Function Documentation

◆ CreateQuery()

template<typename T , typename = typename TEnableIf<TIsDerivedFrom<T, FQueryExecutor>::IsDerived>::Type>
static TSharedPtr< T > UE::Mass::FQueryExecutor::CreateQuery ( FMassEntityQuery &  InQuery,
UObject *  InLogOwner = nullptr 
)
inlinestatic

◆ Execute()

virtual void UE::Mass::FQueryExecutor::Execute ( FMassExecutionContext &  Context)
pure virtual

Override with logic to perform against the entities returned by this query.

◆ ForEachEntity()

template<typename TAccessors , typename TFunc >
void UE::Mass::FQueryExecutor::ForEachEntity ( FMassExecutionContext &  ExecutionContext,
TAccessors &  Accessors,
const TFunc &&  ExecuteFunction 
)
inlineprotected

◆ ForEachEntityChunk()

template<typename TAccessors , typename TFunc >
void UE::Mass::FQueryExecutor::ForEachEntityChunk ( FMassExecutionContext &  ExecutionContext,
TAccessors &  Accessors,
const TFunc &&  ExecuteFunction 
)
inlineprotected

◆ GetLogOwner()

UObject * UE::Mass::FQueryExecutor::GetLogOwner ( )
inlineprotected

◆ ParallelForEachEntity()

template<typename TAccessors , typename TFunc >
void UE::Mass::FQueryExecutor::ParallelForEachEntity ( FMassExecutionContext &  ExecutionContext,
TAccessors &  Accessors,
const TFunc &&  ExecuteFunction 
)
inlineprotected

◆ ParallelForEachEntityChunk()

template<typename TAccessors , typename TFunc >
void UE::Mass::FQueryExecutor::ParallelForEachEntityChunk ( FMassExecutionContext &  ExecutionContext,
const TAccessors &  Accessors,
const TFunc &&  ExecuteFunction 
)
inlineprotected

Friends And Related Symbol Documentation

◆ FQueryDefinition

template<typename... Ts>
friend struct FQueryDefinition
friend
The documentation for this struct was generated from the following files: