FMassEntityQuery

[FMassEntityQuery](API\Plugins\MassEntity\FMassEntityQuery) is a structure that serves two main purposes:

Choose your operating system:

Windows

macOS

Linux

References

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

Syntax

USTRUCT()
struct FMassEntityQuery

Remarks

FMassEntityQuery is a structure that serves two main purposes:

Describe properties required of an archetype that's a subject of calculations

Trigger calculations on cached set of valid archetypes as described by Requirements

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

Variables

		Name	Description
	TArray< FMassFr...	ChunkRequirements
	TArray< FMassFr...	ConstSharedRequirements
	FMassChunkFragm...	RequiredAllChunkFragments
	FMassFragmentBi...	RequiredAllFragments
	FMassSharedFrag...	RequiredAllSharedFragments
	FMassTagBitSet	RequiredAllTags
	FMassFragmentBi...	RequiredAnyFragments
	FMassTagBitSet	RequiredAnyTags
	FMassChunkFragm...	RequiredNoneChunkFragments
	FMassFragmentBi...	RequiredNoneFragments
	FMassSharedFrag...	RequiredNoneSharedFragments
	FMassTagBitSet	RequiredNoneTags
	FMassChunkFragm...	RequiredOptionalChunkFragments
	FMassFragmentBi...	RequiredOptionalFragments
	FMassSharedFrag...	RequiredOptionalSharedFragments
	TArray< FMassFr...	Requirements
	TArray< FMassFr...	SharedRequirements

Constructors

	Name	Description
	FMassEntityQuery()
	FMassEntityQuery ( std::initializer_list< UScriptStruc... )
	FMassEntityQuery ( TConstArrayView< const UScriptStruc... )

Functions

	Name	Description
FMassEntityQ...	AddChunkRequirement ( const EMassFragmentAccess AccessMod..., const EMassFragmentPresence Presenc... )
FMassEntityQ...	AddConstSharedRequirement ( const EMassFragmentPresence Presenc... )
FMassEntityQ...	AddRequirement ( const EMassFragmentAccess AccessMod..., const EMassFragmentPresence Presenc... )	FMassEntityQuery ref returned for chaining
FMassEntityQ...	AddRequirement ( const UScriptStruct* FragmentT..., const EMassFragmentAccess AccessMod..., const EMassFragmentPresence Presenc... )
FMassEntityQ...	AddSharedRequirement ( const EMassFragmentAccess AccessMod..., const EMassFragmentPresence Presenc... )
FMassEntityQ...	AddTagRequirement ( const EMassFragmentPresence Presenc... )
void	AddTagRequirement ( const UScriptStruct& TagType, const EMassFragmentPresence Presenc... )
FMassEntityQ...	AddTagRequirements ( const FMassTagBitSet& TagBitSet )	Actual implementation in specializations
void	CacheArchetypes ( UMassEntitySubsystem& InEntitySubs... )	Will gather all archetypes from InEntitySubsystem matching this->Requirements.
bool	CheckValidity()	The function validates requirements we make for queries.
void	Clear()
void	ClearArchetypeFilter()
void	ClearChunkFilter()
FString	DebugGetArchetypeCompatibilityDescription ( const FArchetypeHandle& ArchetypeH... )
FString	DebugGetDescription()
void	DirtyCachedData()
bool	DoesArchetypeMatchRequirements ( const FArchetypeHandle& ArchetypeH... )
void	ForEachEntityChunk ( UMassEntitySubsystem& EntitySubsys..., FMassExecutionContext& ExecutionCo..., const FMassExecuteFunction& Execut... )	Runs ExecuteFunction on all entities matching Requirements
void	ForEachEntityChunk ( const FArchetypeChunkCollection& C..., UMassEntitySubsystem& EntitySubsys..., FMassExecutionContext& ExecutionCo..., const FMassExecuteFunction& Execut... )	Will first verify that the archetype given with Chunks matches the query's requirements, and if so will run the other, more generic ForEachEntityChunk implementation
const TArray...	GetArchetypes()
int32	GetNumMatchingEntities ( UMassEntitySubsystem& InEntitySubs... )	Goes through ValidArchetypes and sums up the number of entities contained in them.
const FMassC...	GetRequiredAllChunkFragments()
const FMassF...	GetRequiredAllFragments()
const FMassS...	GetRequiredAllSharedFragments()
const FMassT...	GetRequiredAllTags()
const FMassF...	GetRequiredAnyFragments()
const FMassT...	GetRequiredAnyTags()
const FMassC...	GetRequiredNoneChunkFragments()
const FMassF...	GetRequiredNoneFragments()
const FMassS...	GetRequiredNoneSharedFragments()
const FMassT...	GetRequiredNoneTags()
const FMassC...	GetRequiredOptionalChunkFragments()
const FMassF...	GetRequiredOptionalFragments()
const FMassS...	GetRequiredOptionalSharedFragments()
TConstArrayV...	GetRequirements()
bool	HasArchetypeFilter()
bool	HasChunkFilter()
bool	HasMatchingEntities ( UMassEntitySubsystem& InEntitySubs... )	Checks if any of ValidArchetypes has any entities.
void	ParallelForEachEntityChunk ( UMassEntitySubsystem& EntitySubsys..., FMassExecutionContext& ExecutionCo..., const FMassExecuteFunction& Execut... )	Attempts to process every chunk of every affected archetype in parallel.
void	ReadCommandlineParams()
void	SetArchetypeFilter ( const FMassArchetypeConditionFuncti... )	Sets a archetype filter condition that will applied to each valid archetypes.
void	SetChunkFilter ( const FMassChunkConditionFunction&... )	Sets a chunk filter condition that will applied to each chunk of all valid archetypes.
void	SortRequirements()