UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FMassArchetypeCompositionDescriptor Struct Reference

#include <MassEntityTypes.h>

Public Member Functions

 FMassArchetypeCompositionDescriptor ()=default
 
 FMassArchetypeCompositionDescriptor (const FMassFragmentBitSet &InFragments, const FMassTagBitSet &InTags, const FMassChunkFragmentBitSet &InChunkFragments, const FMassSharedFragmentBitSet &InSharedFragments, const FMassConstSharedFragmentBitSet &InConstSharedFragments)
 
 FMassArchetypeCompositionDescriptor (TConstArrayView< const UScriptStruct * > InFragments, const FMassTagBitSet &InTags, const FMassChunkFragmentBitSet &InChunkFragments, const FMassSharedFragmentBitSet &InSharedFragments, const FMassConstSharedFragmentBitSet &InConstSharedFragments)
 
 FMassArchetypeCompositionDescriptor (TConstArrayView< FInstancedStruct > InFragmentInstances, const FMassTagBitSet &InTags, const FMassChunkFragmentBitSet &InChunkFragments, const FMassSharedFragmentBitSet &InSharedFragments, const FMassConstSharedFragmentBitSet &InConstSharedFragments)
 
 FMassArchetypeCompositionDescriptor (FMassFragmentBitSet &&InFragments, FMassTagBitSet &&InTags, FMassChunkFragmentBitSet &&InChunkFragments, FMassSharedFragmentBitSet &&InSharedFragments, FMassConstSharedFragmentBitSet &&InConstSharedFragments)
 
 FMassArchetypeCompositionDescriptor (FMassFragmentBitSet &&InFragments)
 
 FMassArchetypeCompositionDescriptor (FMassTagBitSet &&InTags)
 
void Reset ()
 
bool IsEquivalent (const FMassArchetypeCompositionDescriptor &OtherDescriptor) const
 
bool IsIdentical (const FMassArchetypeCompositionDescriptor &OtherDescriptor) const
 
bool IsEmpty () const
 
bool HasAll (const FMassArchetypeCompositionDescriptor &OtherDescriptor) const
 
void Append (const FMassArchetypeCompositionDescriptor &OtherDescriptor)
 
void Remove (const FMassArchetypeCompositionDescriptor &OtherDescriptor)
 
FMassArchetypeCompositionDescriptor CalculateDifference (const FMassArchetypeCompositionDescriptor &OtherDescriptor) const
 
uint32 CalculateHash () const
 
MASSENTITY_API int32 CountStoredTypes () const
 
MASSENTITY_API void DebugOutputDescription (FOutputDevice &Ar) const
 
template<typename T >
autoGetContainer () const
 
template<typename T >
autoGetContainer ()
 
template<typename T >
bool Contains () const
 
template<typename T >
void Add ()
 
const FMassFragmentBitSetGetFragments () const
 
const FMassTagBitSetGetTags () const
 
const FMassChunkFragmentBitSetGetChunkFragments () const
 
const FMassSharedFragmentBitSetGetSharedFragments () const
 
const FMassConstSharedFragmentBitSetGetConstSharedFragments () const
 
FMassFragmentBitSetGetFragments ()
 
FMassTagBitSetGetTags ()
 
FMassChunkFragmentBitSetGetChunkFragments ()
 
FMassSharedFragmentBitSetGetSharedFragments ()
 
FMassConstSharedFragmentBitSetGetConstSharedFragments ()
 
void SetFragments (const FMassFragmentBitSet &InBitSet)
 
void SetTags (const FMassTagBitSet &InBitSet)
 
void SetChunkFragments (const FMassChunkFragmentBitSet &InBitSet)
 
void SetSharedFragments (const FMassSharedFragmentBitSet &InBitSet)
 
void SetConstSharedFragments (const FMassConstSharedFragmentBitSet &InBitSet)
 
 FMassArchetypeCompositionDescriptor (const FMassFragmentBitSet &InFragments, const FMassTagBitSet &InTags, const FMassChunkFragmentBitSet &InChunkFragments, const FMassSharedFragmentBitSet &InSharedFragments)
 
 FMassArchetypeCompositionDescriptor (TConstArrayView< const UScriptStruct * > InFragments, const FMassTagBitSet &InTags, const FMassChunkFragmentBitSet &InChunkFragments, const FMassSharedFragmentBitSet &InSharedFragments)
 
 FMassArchetypeCompositionDescriptor (TConstArrayView< FInstancedStruct > InFragmentInstances, const FMassTagBitSet &InTags, const FMassChunkFragmentBitSet &InChunkFragments, const FMassSharedFragmentBitSet &InSharedFragments)
 
 FMassArchetypeCompositionDescriptor (FMassFragmentBitSet &&InFragments, FMassTagBitSet &&InTags, FMassChunkFragmentBitSet &&InChunkFragments, FMassSharedFragmentBitSet &&InSharedFragments)
 
template<typename T >
PRAGMA_DISABLE_DEPRECATION_WARNINGS autoGetContainer () const
 

Static Public Member Functions

static MASSENTITY_API uint32 CalculateHash (const FMassFragmentBitSet &InFragments, const FMassTagBitSet &InTags, const FMassChunkFragmentBitSet &InChunkFragments, const FMassSharedFragmentBitSet &InSharedFragmentBitSet, const FMassConstSharedFragmentBitSet &InConstSharedFragmentBitSet)
 

Public Attributes

FMassFragmentBitSet Fragments
 
FMassTagBitSet Tags
 
FMassChunkFragmentBitSet ChunkFragments
 
FMassSharedFragmentBitSet SharedFragments
 
FMassConstSharedFragmentBitSet ConstSharedFragments
 

Detailed Description

The type summarily describing a composition of an entity or an archetype. It contains information on both the fragments and tags

Constructor & Destructor Documentation

◆ FMassArchetypeCompositionDescriptor() [1/11]

FMassArchetypeCompositionDescriptor::FMassArchetypeCompositionDescriptor ( )
default

◆ FMassArchetypeCompositionDescriptor() [2/11]

FMassArchetypeCompositionDescriptor::FMassArchetypeCompositionDescriptor ( const FMassFragmentBitSet InFragments,
const FMassTagBitSet InTags,
const FMassChunkFragmentBitSet InChunkFragments,
const FMassSharedFragmentBitSet InSharedFragments,
const FMassConstSharedFragmentBitSet InConstSharedFragments 
)
inline

◆ FMassArchetypeCompositionDescriptor() [3/11]

FMassArchetypeCompositionDescriptor::FMassArchetypeCompositionDescriptor ( TConstArrayView< const UScriptStruct * >  InFragments,
const FMassTagBitSet InTags,
const FMassChunkFragmentBitSet InChunkFragments,
const FMassSharedFragmentBitSet InSharedFragments,
const FMassConstSharedFragmentBitSet InConstSharedFragments 
)
inline

◆ FMassArchetypeCompositionDescriptor() [4/11]

FMassArchetypeCompositionDescriptor::FMassArchetypeCompositionDescriptor ( TConstArrayView< FInstancedStruct InFragmentInstances,
const FMassTagBitSet InTags,
const FMassChunkFragmentBitSet InChunkFragments,
const FMassSharedFragmentBitSet InSharedFragments,
const FMassConstSharedFragmentBitSet InConstSharedFragments 
)
inline

◆ FMassArchetypeCompositionDescriptor() [5/11]

FMassArchetypeCompositionDescriptor::FMassArchetypeCompositionDescriptor ( FMassFragmentBitSet &&  InFragments,
FMassTagBitSet &&  InTags,
FMassChunkFragmentBitSet &&  InChunkFragments,
FMassSharedFragmentBitSet &&  InSharedFragments,
FMassConstSharedFragmentBitSet &&  InConstSharedFragments 
)
inline

◆ FMassArchetypeCompositionDescriptor() [6/11]

FMassArchetypeCompositionDescriptor::FMassArchetypeCompositionDescriptor ( FMassFragmentBitSet &&  InFragments)
inline

◆ FMassArchetypeCompositionDescriptor() [7/11]

FMassArchetypeCompositionDescriptor::FMassArchetypeCompositionDescriptor ( FMassTagBitSet &&  InTags)
inline

◆ FMassArchetypeCompositionDescriptor() [8/11]

FMassArchetypeCompositionDescriptor::FMassArchetypeCompositionDescriptor ( const FMassFragmentBitSet InFragments,
const FMassTagBitSet InTags,
const FMassChunkFragmentBitSet InChunkFragments,
const FMassSharedFragmentBitSet InSharedFragments 
)
inline

◆ FMassArchetypeCompositionDescriptor() [9/11]

FMassArchetypeCompositionDescriptor::FMassArchetypeCompositionDescriptor ( TConstArrayView< const UScriptStruct * >  InFragments,
const FMassTagBitSet InTags,
const FMassChunkFragmentBitSet InChunkFragments,
const FMassSharedFragmentBitSet InSharedFragments 
)
inline

◆ FMassArchetypeCompositionDescriptor() [10/11]

FMassArchetypeCompositionDescriptor::FMassArchetypeCompositionDescriptor ( TConstArrayView< FInstancedStruct InFragmentInstances,
const FMassTagBitSet InTags,
const FMassChunkFragmentBitSet InChunkFragments,
const FMassSharedFragmentBitSet InSharedFragments 
)
inline

◆ FMassArchetypeCompositionDescriptor() [11/11]

FMassArchetypeCompositionDescriptor::FMassArchetypeCompositionDescriptor ( FMassFragmentBitSet &&  InFragments,
FMassTagBitSet &&  InTags,
FMassChunkFragmentBitSet &&  InChunkFragments,
FMassSharedFragmentBitSet &&  InSharedFragments 
)
inline

Member Function Documentation

◆ Add()

template<typename T >
void FMassArchetypeCompositionDescriptor::Add ( )

◆ Append()

void FMassArchetypeCompositionDescriptor::Append ( const FMassArchetypeCompositionDescriptor OtherDescriptor)
inline

◆ CalculateDifference()

FMassArchetypeCompositionDescriptor FMassArchetypeCompositionDescriptor::CalculateDifference ( const FMassArchetypeCompositionDescriptor OtherDescriptor) const
inline

Finds all the elements contained in this while missing in OtherDescriptor and returns the data as a FMassArchetypeCompositionDescriptor instance

◆ CalculateHash() [1/2]

uint32 FMassArchetypeCompositionDescriptor::CalculateHash ( ) const
inline

◆ CalculateHash() [2/2]

uint32 FMassArchetypeCompositionDescriptor::CalculateHash ( const FMassFragmentBitSet InFragments,
const FMassTagBitSet InTags,
const FMassChunkFragmentBitSet InChunkFragments,
const FMassSharedFragmentBitSet InSharedFragmentBitSet,
const FMassConstSharedFragmentBitSet InConstSharedFragmentBitSet 
)
static

◆ Contains()

template<typename T >
bool FMassArchetypeCompositionDescriptor::Contains ( ) const

◆ CountStoredTypes()

PRAGMA_DISABLE_DEPRECATION_WARNINGS int32 FMassArchetypeCompositionDescriptor::CountStoredTypes ( ) const

◆ DebugOutputDescription()

void FMassArchetypeCompositionDescriptor::DebugOutputDescription ( FOutputDevice Ar) const

◆ GetChunkFragments() [1/2]

FMassChunkFragmentBitSet & FMassArchetypeCompositionDescriptor::GetChunkFragments ( )
inline

◆ GetChunkFragments() [2/2]

const FMassChunkFragmentBitSet & FMassArchetypeCompositionDescriptor::GetChunkFragments ( ) const
inline

◆ GetConstSharedFragments() [1/2]

FMassConstSharedFragmentBitSet & FMassArchetypeCompositionDescriptor::GetConstSharedFragments ( )
inline

◆ GetConstSharedFragments() [2/2]

const FMassConstSharedFragmentBitSet & FMassArchetypeCompositionDescriptor::GetConstSharedFragments ( ) const
inline

◆ GetContainer() [1/3]

template<typename T >
auto & FMassArchetypeCompositionDescriptor::GetContainer ( )

◆ GetContainer() [2/3]

template<typename T >
auto & FMassArchetypeCompositionDescriptor::GetContainer ( ) const

◆ GetContainer() [3/3]

template<typename T >
PRAGMA_DISABLE_DEPRECATION_WARNINGS auto & FMassArchetypeCompositionDescriptor::GetContainer ( ) const

◆ GetFragments() [1/2]

FMassFragmentBitSet & FMassArchetypeCompositionDescriptor::GetFragments ( )
inline

◆ GetFragments() [2/2]

const FMassFragmentBitSet & FMassArchetypeCompositionDescriptor::GetFragments ( ) const
inline

◆ GetSharedFragments() [1/2]

FMassSharedFragmentBitSet & FMassArchetypeCompositionDescriptor::GetSharedFragments ( )
inline

◆ GetSharedFragments() [2/2]

const FMassSharedFragmentBitSet & FMassArchetypeCompositionDescriptor::GetSharedFragments ( ) const
inline

◆ GetTags() [1/2]

FMassTagBitSet & FMassArchetypeCompositionDescriptor::GetTags ( )
inline

◆ GetTags() [2/2]

const FMassTagBitSet & FMassArchetypeCompositionDescriptor::GetTags ( ) const
inline

◆ HasAll()

bool FMassArchetypeCompositionDescriptor::HasAll ( const FMassArchetypeCompositionDescriptor OtherDescriptor) const
inline

◆ IsEmpty()

bool FMassArchetypeCompositionDescriptor::IsEmpty ( ) const
inline

◆ IsEquivalent()

bool FMassArchetypeCompositionDescriptor::IsEquivalent ( const FMassArchetypeCompositionDescriptor OtherDescriptor) const
inline

Compares contents of two FMassArchetypeCompositionDescriptor instances, ignoring the trailing empty bits in the bitsets

◆ IsIdentical()

bool FMassArchetypeCompositionDescriptor::IsIdentical ( const FMassArchetypeCompositionDescriptor OtherDescriptor) const
inline

Checks whether contents of two FMassArchetypeCompositionDescriptor instances are identical.

◆ Remove()

void FMassArchetypeCompositionDescriptor::Remove ( const FMassArchetypeCompositionDescriptor OtherDescriptor)
inline

◆ Reset()

void FMassArchetypeCompositionDescriptor::Reset ( )
inline

◆ SetChunkFragments()

void FMassArchetypeCompositionDescriptor::SetChunkFragments ( const FMassChunkFragmentBitSet InBitSet)
inline

◆ SetConstSharedFragments()

void FMassArchetypeCompositionDescriptor::SetConstSharedFragments ( const FMassConstSharedFragmentBitSet InBitSet)
inline

◆ SetFragments()

void FMassArchetypeCompositionDescriptor::SetFragments ( const FMassFragmentBitSet InBitSet)
inline

◆ SetSharedFragments()

void FMassArchetypeCompositionDescriptor::SetSharedFragments ( const FMassSharedFragmentBitSet InBitSet)
inline

◆ SetTags()

void FMassArchetypeCompositionDescriptor::SetTags ( const FMassTagBitSet InBitSet)
inline

Member Data Documentation

◆ ChunkFragments

FMassChunkFragmentBitSet FMassArchetypeCompositionDescriptor::ChunkFragments

◆ ConstSharedFragments

FMassConstSharedFragmentBitSet FMassArchetypeCompositionDescriptor::ConstSharedFragments

◆ Fragments

FMassFragmentBitSet FMassArchetypeCompositionDescriptor::Fragments

◆ SharedFragments

FMassSharedFragmentBitSet FMassArchetypeCompositionDescriptor::SharedFragments

◆ Tags

FMassTagBitSet FMassArchetypeCompositionDescriptor::Tags

The documentation for this struct was generated from the following files: