Navigation
API > API/Runtime > API/Runtime/MassEntity
FMassFragmentRequirements is a structure that describes properties required of an archetype that's a subject of calculations.
| Name | FMassFragmentRequirements |
| Type | struct |
| Header File | /Engine/Source/Runtime/MassEntity/Public/MassRequirements.h |
| Include Path | #include "MassRequirements.h" |
Syntax
struct FMassFragmentRequirements
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| MassRequirements.h | |||
FMassFragmentRequirements
(
const TSharedPtr< FMassEntityManager >& EntityManager |
MassRequirements.h | ||
FMassFragmentRequirements
(
const TSharedRef< FMassEntityManager >& EntityManager |
MassRequirements.h | ||
FMassFragmentRequirements
(
std::initializer_list< UScriptStruct* > InitList |
MassRequirements.h | ||
FMassFragmentRequirements
(
TConstArrayView< const UScriptStruct* > InitList |
MassRequirements.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FMassDebugger | friend | MassRequirements.h | ||
| FMassRequirementAccessDetector | friend | MassRequirements.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bHasNegativeRequirements | uint16 | MassRequirements.h | ||
| bHasOptionalRequirements | uint16 | Indicates that the requirements specify only optional elements, which means any composition having any one of the optional elements will be accepted. | MassRequirements.h | |
| bHasPositiveRequirements | uint16 | MassRequirements.h | ||
| bInitialized | uint16 | MassRequirements.h | ||
| bPropertiesCached | uint16 | MassRequirements.h | ||
| bRequiresGameThreadExecution | bool | MassRequirements.h | ||
| IncrementalChangesCount | uint16 | MassRequirements.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMassFragmentRequirements & AddChunkRequirement
(
const EMassFragmentAccess AccessMode, |
MassRequirements.h | ||
FMassFragmentRequirements & AddChunkRequirement
(
TNotNull< const UScriptStruct* > ChunkFragmentType, |
MassRequirements.h | ||
FMassFragmentRequirements & AddConstSharedRequirement
(
const UScriptStruct* FragmentType, |
MassRequirements.h | ||
FMassFragmentRequirements & AddConstSharedRequirement
(
const EMassFragmentPresence Presence |
MassRequirements.h | ||
FMassFragmentRequirements & AddElementRequirement
(
TNotNull< const UScriptStruct* > ElementType, |
MassRequirements.h | ||
FMassFragmentRequirements & AddRequirement
(
const EMassFragmentAccess AccessMode, |
FMassFragmentRequirements ref returned for chaining | MassRequirements.h | |
FMassFragmentRequirements & AddRequirement
(
const UScriptStruct* FragmentType, |
MassRequirements.h | ||
FMassFragmentRequirements & AddSharedRequirement
(
const EMassFragmentAccess AccessMode, |
MassRequirements.h | ||
FMassFragmentRequirements & AddSharedRequirement
(
TNotNull< const UScriptStruct* > SharedFragmentType, |
MassRequirements.h | ||
FMassFragmentRequirements & AddTagRequirement
(
TNotNull< const UScriptStruct* > TagType, |
MassRequirements.h | ||
void AddTagRequirement
(
const UScriptStruct& TagType, |
MassRequirements.h | ||
FMassFragmentRequirements & AddTagRequirement
(
const EMassFragmentPresence Presence |
MassRequirements.h | ||
FMassFragmentRequirements & AddTagRequirements
(
const FMassTagBitSet& TagBitSet |
Actual implementation in specializations | MassRequirements.h | |
bool CheckValidity () |
The function validates requirements we make for queries. | MassRequirements.h | |
FMassFragmentRequirements & ClearTagRequirements
(
const FMassTagBitSet& TagsToRemoveBitSet |
Clears given tags out of all collected requirements, including negative ones | MassRequirements.h | |
bool DoesArchetypeMatchRequirements
(
const FMassArchetypeCompositionDescriptor& ArchetypeComposition |
MassRequirements.h | ||
bool DoesArchetypeMatchRequirements
(
const FMassArchetypeHandle& ArchetypeHandle |
MassRequirements.h | ||
bool DoesMatchAnyOptionals
(
const FMassArchetypeCompositionDescriptor& ArchetypeComposition |
MassRequirements.h | ||
bool DoesRequireGameThreadExecution() |
MassRequirements.h | ||
void ExportRequirements
(
FMassExecutionRequirements& OutRequirements |
MassRequirements.h | ||
TConstArrayView< FMassFragmentRequirementDescription > GetChunkFragmentRequirements() |
MassRequirements.h | ||
TConstArrayView< FMassFragmentRequirementDescription > GetConstSharedFragmentRequirements() |
MassRequirements.h | ||
TConstArrayView< FMassFragmentRequirementDescription > GetFragmentRequirements() |
MassRequirements.h | ||
const FMassChunkFragmentBitSet & GetRequiredAllChunkFragments() |
MassRequirements.h | ||
const FMassConstSharedFragmentBitSet & GetRequiredAllConstSharedFragments() |
MassRequirements.h | ||
const FMassFragmentBitSet & GetRequiredAllFragments() |
MassRequirements.h | ||
const FMassSharedFragmentBitSet & GetRequiredAllSharedFragments() |
MassRequirements.h | ||
const FMassTagBitSet & GetRequiredAllTags() |
MassRequirements.h | ||
const FMassFragmentBitSet & GetRequiredAnyFragments() |
MassRequirements.h | ||
const FMassTagBitSet & GetRequiredAnyTags() |
MassRequirements.h | ||
const FMassChunkFragmentBitSet & GetRequiredNoneChunkFragments() |
MassRequirements.h | ||
const FMassConstSharedFragmentBitSet & GetRequiredNoneConstSharedFragments() |
MassRequirements.h | ||
const FMassFragmentBitSet & GetRequiredNoneFragments() |
MassRequirements.h | ||
const FMassSharedFragmentBitSet & GetRequiredNoneSharedFragments() |
MassRequirements.h | ||
const FMassTagBitSet & GetRequiredNoneTags() |
MassRequirements.h | ||
const FMassChunkFragmentBitSet & GetRequiredOptionalChunkFragments() |
MassRequirements.h | ||
const FMassConstSharedFragmentBitSet & GetRequiredOptionalConstSharedFragments() |
MassRequirements.h | ||
const FMassFragmentBitSet & GetRequiredOptionalFragments() |
MassRequirements.h | ||
const FMassSharedFragmentBitSet & GetRequiredOptionalSharedFragments() |
MassRequirements.h | ||
const FMassTagBitSet & GetRequiredOptionalTags() |
MassRequirements.h | ||
TConstArrayView< FMassFragmentRequirementDescription > GetSharedFragmentRequirements() |
MassRequirements.h | ||
bool HasNegativeRequirements() |
MassRequirements.h | ||
bool HasOptionalRequirements() |
MassRequirements.h | ||
bool HasPositiveRequirements() |
MassRequirements.h | ||
void Initialize
(
const TSharedRef< FMassEntityManager >& EntityManager |
MassRequirements.h | ||
bool IsEmpty() |
MassRequirements.h | ||
bool IsInitialized() |
MassRequirements.h | ||
void Reset() |
MassRequirements.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ConsumeIncrementalChangesCount() |
MassRequirements.h | ||
bool HasIncrementalChanges() |
MassRequirements.h | ||
void IncrementChangeCounter() |
MassRequirements.h | ||
bool IsGameThreadOnlySharedFragment
(
TNotNull< const UScriptStruct* > SharedFragmentType |
A helper function that passes the query over to CachedEntityManager. | MassRequirements.h | |
void SortRequirements() |
MassRequirements.h |