1. Epic GamesDeveloper
  3. FMassEntityQuery

FMassEntityQuery

[FMassEntityQuery](API\Plugins\MassEntity\FMassEntityQuery) is a structure that is used to trigger calculations on cached set of valid archetypes as described by requirements.

API > API/Plugins > API/Plugins/MassEntity

Inheritance Hierarchy

References

   
Module MassEntity
Header /Engine/Plugins/Runtime/MassEntity/Source/MassEntity/Public/MassEntityQuery.h
Include #include "MassEntityQuery.h"

Syntax

USTRUCT&40;&41;  
struct FMassEntityQuery :  
    public FMassFragmentRequirements,  
    public FMassSubsystemRequirements

Remarks

FMassEntityQuery is a structure that is used to trigger calculations on cached set of valid archetypes as described by requirements. See the parent classes FMassFragmentRequirements and FMassSubsystemRequirements for setting up the required fragments and subsystems.

A query to be considered valid needs declared at least one EMassFragmentPresence::All, EMassFragmentPresence::AnyEMassFragmentPresence::Optional fragment requirement.

Constructors

  Type Name Description
Public function    
Public function  

FMassEntityQuery ( std::initializer_list< UScriptStruct* > InitList
)

  
Public function  

FMassEntityQuery ( TConstArrayView< const UScriptStruct* > InitList
)

  
Public function    

Functions

  Type Name Description
Public function void

CacheArchetypes ( const FMassEntityManager& InEntityManager
)

 Will gather all archetypes from InEntityManager matching this->Requirements.
Public function void

Clear ()

  
Public function void  
Public function void  
Public function Const bool  
Public function Const void  
Public function void

ForEachEntityChunk ( const FMassArchetypeEntityCollection& Collection,
FMassEntityManager& EntitySubsystem,
FMassExecutionContext& ExecutionContext,
const FMassExecuteFunction& ExecuteFunction
)

 Will first verify that the archetype given with Collection matches the query's requirements, and if so will run the other, more generic ForEachEntityChunk implementation
Public function void

ForEachEntityChunk ( FMassEntityManager& EntityManager,
FMassExecutionContext& ExecutionContext,
const FMassExecuteFunction& ExecuteFunction
)

 Runs ExecuteFunction on all entities matching Requirements
Public function Const const TArray< FMassArchetypeHandle > &  
Public function int32 Goes through ValidArchetypes and sums up the number of entities contained in them.
Public function Const const FMassQueryRequirementIndicesMapping & If ArchetypeHandle is among ValidArchetypes then the function retrieves requirements mapping cached for it, otherwise an empty mapping will be returned (and the requirements binding will be done the slow way).
Public function Const bool  
Public function bool Checks if any of ValidArchetypes has any entities.
Protected function void  
Public function void  
Public function void  
Public function void Sets a chunk filter condition that will applied to each chunk of all valid archetypes.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page