FMassArchetypeCompositionDescriptor

The type summarily describing a composition of an entity or an archetype.

API > API/Runtime > API/Runtime/MassEntity

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

   
Name FMassArchetypeCompositionDescriptor
Type struct
Header File /Engine/Source/Runtime/MassEntity/Public/MassEntityTypes.h
Include Path #include "MassEntityTypes.h"

Syntax

struct FMassArchetypeCompositionDescriptor

Constructors

Name Remarks Include Path Unreal Specifiers
  MassEntityTypes.h  

FMassArchetypeCompositionDescriptor ( FMassElementBitSet&& InElements
)

   MassEntityTypes.h  

FMassArchetypeCompositionDescriptor ( const FMassElementBitSet& InElements
)

 Constructor deliberately not marked as explicit to support near-future change where we get rid of FMassArchetypeCompositionDescriptor since it's just a wrapper for FMassElementBitSet now. MassEntityTypes.h  

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

   MassEntityTypes.h  
  MassEntityTypes.h  

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

   MassEntityTypes.h  

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

   MassEntityTypes.h  

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

   MassEntityTypes.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ChunkFragments FMassChunkFragmentBitSet   MassEntityTypes.h  
ConstSharedFragments FMassConstSharedFragmentBitSet   MassEntityTypes.h  
Fragments FMassFragmentBitSet   MassEntityTypes.h  
SharedFragments FMassSharedFragmentBitSet   MassEntityTypes.h  
Tags FMassTagBitSet   MassEntityTypes.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Add ( TNotNull< const UScriptStruct* > ElementType
)

   MassEntityTypes.h  

void Add ()

   MassEntityTypes.h  

void Append ( const FMassArchetypeCompositionDescriptor& OtherDescriptor
)

   MassEntityTypes.h  

FMassArchetypeCompositionDescriptor CalculateDifference ( const FMassArchetypeCompositionDescriptor& OtherDescriptor
) const

 Finds all the elements contained in this_ while missing in OtherDescriptor_ and returns the data as a FMassArchetypeCompositionDescriptor instance MassEntityTypes.h  

uint32 CalculateHash ()

   MassEntityTypes.h  

bool Contains ()

   MassEntityTypes.h  

bool Contains ( TNotNull< const UScriptStruct* > ElementType
) const

   MassEntityTypes.h  

int32 CountStoredTypes()

   MassEntityTypes.h  

FMassChunkFragmentBitSet DebugGetChunkFragments()

   MassEntityTypes.h  

FMassConstSharedFragmentBitSet DebugGetConstSharedFragments()

   MassEntityTypes.h  

FMassFragmentBitSet DebugGetFragments()

   MassEntityTypes.h  

FMassSharedFragmentBitSet DebugGetSharedFragments()

   MassEntityTypes.h  

FMassTagBitSet DebugGetTags()

   MassEntityTypes.h  

void DebugOutputDescription ( FOutputDevice& Ar
) const

   MassEntityTypes.h  

TBitSet Get()

   MassEntityTypes.h  

FMassElementBitSet GetAllSharedFragments()

   MassEntityTypes.h  

FMassChunkFragmentBitSet GetChunkFragments()

   MassEntityTypes.h  

FMassConstSharedFragmentBitSet GetConstSharedFragments()

   MassEntityTypes.h  

auto & GetContainer ()

   MassEntityTypes.h  

auto GetContainer ()

 INLINES. MassEntityTypes.h  

FMassElementBitSet & GetElementsBitSet ()

   MassEntityTypes.h  

const FMassElementBitSet & GetElementsBitSet ()

   MassEntityTypes.h  

FMassFragmentBitSet GetFragments()

   MassEntityTypes.h  

FMassSharedFragmentBitSet GetSharedFragments()

   MassEntityTypes.h  

FMassTagBitSet GetTags()

   MassEntityTypes.h  

bool HasAll ()

   MassEntityTypes.h  

bool HasAll ( const FMassArchetypeCompositionDescriptor& OtherDescriptor
) const

   MassEntityTypes.h  

bool HasAny()

   MassEntityTypes.h  

bool IsEmpty()

   MassEntityTypes.h  

bool IsEquivalent ( const FMassArchetypeCompositionDescriptor& OtherDescriptor
) const

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

bool IsIdentical ( const FMassArchetypeCompositionDescriptor& OtherDescriptor
) const

 Checks whether contents of two FMassArchetypeCompositionDescriptor instances are identical. MassEntityTypes.h  

void Remove ()

   MassEntityTypes.h  

void Remove ( TNotNull< const UScriptStruct* > ElementType
)

   MassEntityTypes.h  

void Remove ( const FMassArchetypeCompositionDescriptor& OtherDescriptor
)

   MassEntityTypes.h  

void Reset()

   MassEntityTypes.h  

void SetAllSharedElements ( const FMassElementBitSet& InBitSet
)

   MassEntityTypes.h  

void SetChunkFragments ( const FMassChunkFragmentBitSet& InBitSet
)

   MassEntityTypes.h  

void SetConstSharedFragments ( const FMassConstSharedFragmentBitSet& InBitSet
)

   MassEntityTypes.h  

void SetElementsBitSet()

   MassEntityTypes.h  

void SetFragments ( const FMassFragmentBitSet& InBitSet
)

 Functions setting specific type of bits. MassEntityTypes.h  

void SetSharedFragments ( const FMassSharedFragmentBitSet& InBitSet
)

   MassEntityTypes.h  

void SetTags ( const FMassTagBitSet& InBitSet
)

   MassEntityTypes.h  

Static

Name Remarks Include Path Unreal Specifiers

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

   MassEntityTypes.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page