Navigation
API > API/Runtime > API/Runtime/MassEntity
Inheritance Hierarchy
- FMassFragmentRequirements
- FMassEntityQuery
References
| Module | MassEntity |
| Header | /Engine/Source/Runtime/MassEntity/Public/MassRequirements.h |
| Include | #include "MassRequirements.h" |
Syntax
USTRUCT ()
struct FMassFragmentRequirements
Remarks
FMassFragmentRequirements is a structure that describes properties required of an archetype that's a subject of calculations.
Variables
| Type | Name | Description | |
|---|---|---|---|
| TArray< FMassFragmentRequirementDescription > | ChunkFragmentRequirements | ||
| TArray< FMassFragmentRequirementDescription > | ConstSharedFragmentRequirements | ||
| friend | FMassDebugger | ||
| friend | FMassRequirementAccessDetector | ||
| TArray< FMassFragmentRequirementDescription > | FragmentRequirements | ||
| FMassChunkFragmentBitSet | RequiredAllChunkFragments | ||
| FMassConstSharedFragmentBitSet | RequiredAllConstSharedFragments | ||
| FMassFragmentBitSet | RequiredAllFragments | ||
| FMassSharedFragmentBitSet | RequiredAllSharedFragments | ||
| FMassTagBitSet | RequiredAllTags | ||
| FMassFragmentBitSet | RequiredAnyFragments | ||
| FMassTagBitSet | RequiredAnyTags | ||
| FMassChunkFragmentBitSet | RequiredNoneChunkFragments | ||
| FMassConstSharedFragmentBitSet | RequiredNoneConstSharedFragments | ||
| FMassFragmentBitSet | RequiredNoneFragments | ||
| FMassSharedFragmentBitSet | RequiredNoneSharedFragments | ||
| FMassTagBitSet | RequiredNoneTags | ||
| FMassChunkFragmentBitSet | RequiredOptionalChunkFragments | ||
| FMassConstSharedFragmentBitSet | RequiredOptionalConstSharedFragments | ||
| FMassFragmentBitSet | RequiredOptionalFragments | ||
| FMassSharedFragmentBitSet | RequiredOptionalSharedFragments | ||
| FMassTagBitSet | RequiredOptionalTags | Note that optional tags have meaning only if there are no other strict requirements, i.e. everything is optional, so we're looking for anything matching any of the optionals (both tags as well as fragments). | |
| TArray< FMassFragmentRequirementDescription > | SharedFragmentRequirements |
Constructors
| Type | Name | Description | |
|---|---|---|---|
FMassFragmentRequirements
(
std::initializer_list< UScriptStruct* > InitList |
|||
FMassFragmentRequirements
(
TConstArrayView< const UScriptStruct* > InitList |
Functions
| Type | Name | Description | |
|---|---|---|---|
| FMassFragmentRequirements & | AddChunkRequirement
(
const EMassFragmentAccess AccessMode, |
||
| FMassFragmentRequirements & | AddConstSharedRequirement
(
const EMassFragmentPresence Presence |
||
| FMassFragmentRequirements & | AddConstSharedRequirement
(
const UScriptStruct* FragmentType, |
||
| FMassFragmentRequirements & | AddRequirement
(
const EMassFragmentAccess AccessMode, |
FMassFragmentRequirements ref returned for chaining | |
| FMassFragmentRequirements & | AddRequirement
(
const UScriptStruct* FragmentType, |
||
| FMassFragmentRequirements & | AddSharedRequirement
(
const EMassFragmentAccess AccessMode, |
||
| void | AddTagRequirement
(
const UScriptStruct& TagType, |
||
| FMassFragmentRequirements & | AddTagRequirement
(
const EMassFragmentPresence Presence |
||
| FMassFragmentRequirements & | AddTagRequirements
(
const FMassTagBitSet& TagBitSet |
Actual implementation in specializations | |
| bool | The function validates requirements we make for queries. | ||
| FMassFragmentRequirements & | ClearTagRequirements
(
const FMassTagBitSet& TagsToRemoveBitSet |
Clears given tags out of all collected requirements, including negative ones | |
| void | |||
| bool | DoesArchetypeMatchRequirements
(
const FMassArchetypeCompositionDescriptor& ArchetypeComposition |
||
| bool | DoesArchetypeMatchRequirements
(
const FMassArchetypeHandle& ArchetypeHandle |
||
| bool | DoesMatchAnyOptionals
(
const FMassArchetypeCompositionDescriptor& ArchetypeComposition |
||
| bool | |||
| void | ExportRequirements
(
FMassExecutionRequirements& OutRequirements |
||
| TConstArrayView< FMassFragmentRequirementDescription > | |||
| TConstArrayView< FMassFragmentRequirementDescription > | |||
| TConstArrayView< FMassFragmentRequirementDescription > | |||
| const FMassChunkFragmentBitSet & | |||
| const FMassConstSharedFragmentBitSet & | |||
| const FMassFragmentBitSet & | |||
| const FMassSharedFragmentBitSet & | |||
| const FMassTagBitSet & | |||
| const FMassFragmentBitSet & | |||
| const FMassTagBitSet & | |||
| const FMassChunkFragmentBitSet & | |||
| const FMassConstSharedFragmentBitSet & | |||
| const FMassFragmentBitSet & | |||
| const FMassSharedFragmentBitSet & | |||
| const FMassTagBitSet & | |||
| const FMassChunkFragmentBitSet & | |||
| const FMassConstSharedFragmentBitSet & | |||
| const FMassFragmentBitSet & | |||
| const FMassSharedFragmentBitSet & | |||
| const FMassTagBitSet & | |||
| TConstArrayView< FMassFragmentRequirementDescription > | |||
| bool | |||
| bool | |||
| bool | |||
| bool | |||
| void | |||
| bool | IsEmpty () |
||
| void | Reset () |
||
| void |