1. Epic GamesDeveloper
  3. FMassEntityManager

FMassEntityManager

The type responsible for hosting Entities managing Archetypes.

API > API/Runtime > API/Runtime/MassEntity

The type responsible for hosting Entities managing Archetypes. Entities are stored as FEntityData entries in a chunked array. Each valid entity is assigned to an Archetype that stored fragments associated with a given entity at the moment.

FMassEntityManager supplies API for entity creation (that can result in archetype creation) and entity manipulation. Even though synchronized manipulation methods are available in most cases the entity operations are performed via a command buffer. The default command buffer can be obtained with a Defer() call. FMassEntityManager are meant to be stored with a TSharedPtr or TSharedRef. Some of Mass API pass around FMassEntityManager& but programmers can always use AsShared() call to obtain a shared ref for a given manager instance (as supplied by deriving from TSharedFromThis). IMPORTANT: if you create your own FMassEntityManager instance remember to call Initialize() before using it.

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

Syntax

struct FMassEntityManager :  
    public TSharedFromThis< FMassEntityManager > ,  
    public FGCObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
  MassEntityManager.h  
  MassEntityManager.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FMassEntityManager()

   MassEntityManager.h  

Structs

Name Remarks
FScopedProcessing  
TSharedFragmentsContainer This is a struct wrapping shared fragment management to ensure consistency between how shared and const shared fragment are added and fetched, across all the functions that do that

Enums

Public

Name Remarks
EDebugFeatures  

Typedefs

Name Type Remarks Include Path
FEntityCreationContext UE::Mass::ObserverManager::FCreationContext   MassEntityManager.h
FEntityStorageContainerType TVariant< FEmptyVariantState, UE::Mass::FSingleThreadedEntityStorage, UE::Mass::FConcurrentEntityStorage >   MassEntityManager.h
FOnNewArchetypeDelegate TMulticastDelegate_OneParam< void, const FMassArchetypeHandle & >   MassEntityManager.h
FStructInitializationCallback TFunctionRef< void(void *Fragment, const UScriptStruct &FragmentType)>   MassEntityManager.h

Constants

Name Type Remarks Include Path
InvalidEntity const FMassEntityHandle   MassEntityManager.h
NumCommandBuffers int32 This index will be enough to control which buffer is available for pushing commands since flashing is taking place in the game thread and pushing commands to the buffer fetched by Defer() is only supported also on the game thread (due to checking the cached thread ID). MassEntityManager.h
NumReservedEntities int32 Index 0 is reserved so we can treat that index as an invalid entity handle. MassEntityManager.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
FMassDebugger friend   MassEntityManager.h  
FMassEntityQuery friend   MassEntityManager.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
AllArchetypes TArray< TSharedPtr< FMassArchetypeData > > Contains all archetypes ever created. MassEntityManager.h  
ArchetypeDataVersion uint32 The "version" number increased every time an archetype gets added MassEntityManager.h  
bCommandBufferFlushingInProgress std::atomic< bool >   MassEntityManager.h  
bFirstCommandFlush bool   MassEntityManager.h  
ConstSharedFragmentsContainer TSharedFragmentsContainer< FConstSharedStruct >   MassEntityManager.h  
DebugEntityStoragePtr UE::Mass::FStorageType *   MassEntityManager.h  
DebugName FString   MassEntityManager.h  
DeferredCommandBuffers TStaticArray< TSharedPtr< FMassCommandBuffer >, NumCommandBuffers >   MassEntityManager.h  
EnabledDebugFeatures EDebugFeatures   MassEntityManager.h  
EntityStorage FEntityStorageContainerType   MassEntityManager.h  
FragmentHashToArchetypeMap TMap< uint32, TArray< TSharedPtr< FMassArchetypeData > > > Map of hash of sorted fragment list to archetypes with that hash. MassEntityManager.h  
FragmentTypeToArchetypeMap TMap< const UScriptStruct *, TArray< TSharedPtr< FMassArchetypeData > > > Map to list of archetypes that contain the specified fragment type. MassEntityManager.h  
GroupNameToTypeIndex TMap< const FName, const int32 >   MassEntityManager.h  
GroupTypes TArray< const FName >   MassEntityManager.h  
InitializationState EInitializationState   MassEntityManager.h  
ObserverManager FMassObserverManager   MassEntityManager.h  
OnNewArchetypeEvent FOnNewArchetypeDelegate   MassEntityManager.h  
OnPostForkHandle FDelegateHandle   MassEntityManager.h  
OpenedCommandBufferIndex uint8   MassEntityManager.h  
Owner TWeakObjectPtr< UObject >   MassEntityManager.h  
ProcessingScopeCount std::atomic< int32 >   MassEntityManager.h  
RelationManager UE::Mass::FRelationManager   MassEntityManager.h  
RequirementAccessDetector FMassRequirementAccessDetector   MassEntityManager.h  
SharedFragmentsContainer TSharedFragmentsContainer< FSharedStruct >   MassEntityManager.h  
TypeManager TSharedRef< UE::Mass::FTypeManager >   MassEntityManager.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddCompositionToEntity_GetDelta ( FMassEntityHandle EntityHandle,
FMassArchetypeCompositionDescriptor& InOutDescriptor,
const FMassArchetypeSharedFragmentValues* AddedSharedFragmentValues
)

 Adds elements indicated by InOutDescriptor to the entity indicated by EntityHandle. MassEntityManager.h  

bool AddConstSharedFragmentToEntity ( const FMassEntityHandle EntityHandle,
const FConstSharedStruct& InConstSharedFragment
)

 Adds a new const shared fragment to the given entity. MassEntityManager.h  

void AddElementToEntities ( TConstArrayView< FMassEntityHandle > Entities,
TNotNull< const UScriptStruct* > ElementType
)

 Adds ElementType to the entities, treating it accordingly based on which element type it represents (i.e. Fragment or Tag). MassEntityManager.h  

void AddElementToEntity ( FMassEntityHandle Entity,
TNotNull< const UScriptStruct* > ElementType
)

 Adds ElementType to the entity, treating it accordingly based on which element type it represents (i.e. Fragment or Tag). MassEntityManager.h  

void AddFragmentInstanceListToEntity ( FMassEntityHandle EntityHandle,
TConstArrayView< FInstancedStruct > FragmentInstanceList
)

   MassEntityManager.h  

void AddFragmentListToEntity ( FMassEntityHandle EntityHandle,
TConstArrayView< const UScriptStruct* > FragmentList
)

 Ensures that only unique fragments are added. MassEntityManager.h  

void AddFragmentToEntity ( FMassEntityHandle EntityHandle,
const UScriptStruct* FragmentType
)

   MassEntityManager.h  

void AddFragmentToEntity ( FMassEntityHandle EntityHandle,
const UScriptStruct* FragmentType,
const FStructInitializationCallback& Initializer
)

   MassEntityManager.h  

bool AddSharedFragmentToEntity ( const FMassEntityHandle EntityHandle,
const FSharedStruct& InSharedFragment
)

 Adds a new shared fragment to the given entity. MassEntityManager.h  

void AddTagToEntity ( FMassEntityHandle EntityHandle,
const UScriptStruct* TagType
)

   MassEntityManager.h  

void AppendCommands ( const TSharedPtr< FMassCommandBuffer >& InOutCommandBuffer
)

 Depending on the current state of Manager's command buffer the function will either move all the commands out of InOutCommandBuffer into the main command buffer or append it to the list of command buffers waiting to be flushed. MassEntityManager.h  

void BatchAddFragmentInstancesForEntities ( TConstArrayView< FMassArchetypeEntityCollectionWithPayload > EntityCollections,
const FMassFragmentBitSet& FragmentsAffected
)

   MassEntityManager.h  

void BatchAddSharedFragmentsForEntities ( TConstArrayView< FMassArchetypeEntityCollection > EntityCollections,
const FMassArchetypeSharedFragmentValues& AddedFragmentValues
)

 Adds a new const and non-const shared fragments to all entities provided via EntityCollections MassEntityManager.h  

TSharedRef< FEntityCreationContext > BatchBuildEntities ( const FMassArchetypeEntityCollectionWithPayload& EncodedEntitiesWithPayload,
const FMassArchetypeCompositionDescriptor& Composition,
const FMassArchetypeSharedFragmentValues& SharedFragmentValues,
const FMassArchetypeCreationParams& CreationParams
)

   MassEntityManager.h  

TSharedRef< FEntityCreationContext > BatchBuildEntities ( const FMassArchetypeEntityCollectionWithPayload& EncodedEntitiesWithPayload,
const FMassFragmentBitSet& FragmentsAffected,
const FMassArchetypeSharedFragmentValues& SharedFragmentValues,
const FMassArchetypeCreationParams& CreationParams
)

   MassEntityManager.h  

void BatchChangeFragmentCompositionForEntities ( TConstArrayView< FMassArchetypeEntityCollection > EntityCollections,
const FMassFragmentBitSet& FragmentsToAdd,
const FMassFragmentBitSet& FragmentsToRemove
)

   MassEntityManager.h  

void BatchChangeTagsForEntities ( TConstArrayView< FMassArchetypeEntityCollection > EntityCollections,
const FMassTagBitSet& TagsToAdd,
const FMassTagBitSet& TagsToRemove
)

   MassEntityManager.h  

TSharedRef< FEntityCreationContext > BatchCreateEntities ( const FMassArchetypeHandle& ArchetypeHandle,
const int32 Count,
TArray< FMassEntityHandle >& InOutEntities
)

   MassEntityManager.h  

TSharedRef< FEntityCreationContext > BatchCreateEntities ( const FMassArchetypeHandle& ArchetypeHandle,
const FMassArchetypeSharedFragmentValues& SharedFragmentValues,
const int32 Count,
TArray< FMassEntityHandle >& InOutEntities
)

 A version of CreateEntity that's creating a number of entities (Count) in one go MassEntityManager.h  
  MassEntityManager.h  

bool BatchCreateRelations ( const UE::Mass::FTypeHandle RelationTypeHandle,
TArrayView< FMassEntityHandle > Subjects,
TArrayView< FMassEntityHandle > Objects
)

   MassEntityManager.h  

TSharedRef< FEntityCreationContext > BatchCreateReservedEntities ( const FMassArchetypeHandle& ArchetypeHandle,
TConstArrayView< FMassEntityHandle > OutEntities
)

   MassEntityManager.h  

TSharedRef< FEntityCreationContext > BatchCreateReservedEntities ( const FMassArchetypeHandle& ArchetypeHandle,
const FMassArchetypeSharedFragmentValues& SharedFragmentValues,
TConstArrayView< FMassEntityHandle > ReservedEntities
)

 A version of CreateEntity that's creating a number of entities (Count) in one go MassEntityManager.h  

void BatchDestroyEntities ( TConstArrayView< FMassEntityHandle > InEntities
)

 Destroys all the entities in the provided array of entities. MassEntityManager.h  
Destroys all the entities provided via the Collection. MassEntityManager.h  

void BatchDestroyEntityChunks ( TConstArrayView< FMassArchetypeEntityCollection > Collections
)

   MassEntityManager.h  

void BatchGroupEntities ( const UE::Mass::FArchetypeGroupHandle GroupHandle,
TConstArrayView< FMassArchetypeEntityCollection > Collections
)

 Assigns all entities indicated by Collections to a given archetype group. MassEntityManager.h  

void BatchGroupEntities ( const UE::Mass::FArchetypeGroupHandle GroupHandle,
TConstArrayView< FMassEntityHandle > InEntities
)

 Assigns all entities indicated by InEntities to a given archetype group. MassEntityManager.h  

TConstArrayView< FMassEntityHandle > BatchReserveEntities ( const int32 Count,
TArray< FMassEntityHandle >& InOutEntities
)

 Reserves Count number of entities and appends them to InOutEntities MassEntityManager.h  
Reserves number of entities corresponding to number of entries in the provided array view InOutEntities. MassEntityManager.h  

void BatchSetEntityFragmentValues ( const FMassArchetypeEntityCollection& SparseEntities,
TArrayView< const FInstancedStruct > FragmentInstanceList
)

 Copies values from FragmentInstanceList over to fragments of given entities collection. MassEntityManager.h  

void BatchSetEntityFragmentValues ( TConstArrayView< FMassArchetypeEntityCollection > EntityCollections,
TArrayView< const FInstancedStruct > FragmentInstanceList
)

   MassEntityManager.h  

void BuildEntity ( FMassEntityHandle EntityHandle,
const FMassArchetypeHandle& ArchetypeHandle,
const FMassArchetypeSharedFragmentValues& SharedFragmentValues
)

 Builds an entity for it to be ready to be used by the subsystem MassEntityManager.h  

void BuildEntity ( FMassEntityHandle EntityHandle,
TConstArrayView< FInstancedStruct > FragmentInstanceList,
const FMassArchetypeSharedFragmentValues& SharedFragmentValues
)

 Builds an entity for it to be ready to be used by the subsystem MassEntityManager.h  

void CheckIfEntityIsActive ( FMassEntityHandle EntityHandle
) const

 Asserts that IsEntityBuilt MassEntityManager.h  

void CheckIfEntityIsValid ( FMassEntityHandle EntityHandle
) const

 Asserts that IsEntityValid MassEntityManager.h  

FMassArchetypeHandle CreateArchetype ( TConstArrayView< const UScriptStruct* > FragmentsAndTagsList,
const FMassArchetypeCreationParams& CreationParams
)

 A special, relaxed but slower version of CreateArchetype functions that allows FragmentAngTagsList to contain both fragments and tags. MassEntityManager.h  
CreateArchetype from a composition descriptor and initial values MassEntityManager.h  

FMassArchetypeHandle CreateArchetype ( const TSharedPtr< FMassArchetypeData >& SourceArchetype,
const FMassFragmentBitSet& InFragments
)

 Creates an archetype like SourceArchetype + InFragments. MassEntityManager.h  

FMassArchetypeHandle CreateArchetype ( FMassArchetypeHandle SourceArchetype,
TConstArrayView< const UScriptStruct* > FragmentsAndTagsList,
const FMassArchetypeCreationParams& CreationParams
)

 A special, relaxed but slower version of CreateArchetype functions that allows FragmentAngTagsList to contain both fragments and tags. MassEntityManager.h  

FMassArchetypeHandle CreateArchetype ( const TSharedPtr< FMassArchetypeData >& SourceArchetype,
const FMassFragmentBitSet& InFragments,
const FMassArchetypeCreationParams& CreationParams
)

 Creates an archetype like SourceArchetype + InFragments. MassEntityManager.h  

FMassArchetypeHandle CreateArchetype ( FMassArchetypeHandle SourceArchetype,
TConstArrayView< const UScriptStruct* > FragmentsAndTagsList
)

 A special, relaxed but slower version of CreateArchetype functions that allows FragmentAngTagsList to contain both fragments and tags. MassEntityManager.h  

FMassEntityHandle CreateEntity ( const FMassArchetypeHandle& ArchetypeHandle,
const FMassArchetypeSharedFragmentValues& SharedFragmentValues
)

 Creates fully built entity ready to be used by the subsystem MassEntityManager.h  

FMassEntityHandle CreateEntity ( TConstArrayView< FInstancedStruct > FragmentInstanceList,
const FMassArchetypeSharedFragmentValues& SharedFragmentValues,
const FMassArchetypeCreationParams& CreationParams
)

 Creates fully built entity ready to be used by the subsystem MassEntityManager.h  

FMassEntityHandle CreateEntityIndexHandle ( const int32 EntityIndex
) const

 Generate valid, up-to-date entity handle for the entity at given index. MassEntityManager.h  

FMassExecutionContext CreateExecutionContext ( const float DeltaSeconds
)

 Creates and initializes a FMassExecutionContext instance. MassEntityManager.h  

void DebugDisableDebugFeature ( EDebugFeatures Features
)

   MassEntityManager.h  

void DebugEnableDebugFeature ( EDebugFeatures Features
)

   MassEntityManager.h  

void DebugForceArchetypeDataVersionBump()

   MassEntityManager.h  

int32 DebugGetArchetypeEntitiesCount ( const FMassArchetypeHandle& Archetype
) const

   MassEntityManager.h  

int32 DebugGetArchetypeEntitiesCountPerChunk ( const FMassArchetypeHandle& Archetype
) const

   MassEntityManager.h  

void DebugGetArchetypeFragmentTypes ( const FMassArchetypeHandle& Archetype,
TArray< const UScriptStruct* >& InOutFragmentList
) const

   MassEntityManager.h  

int32 DebugGetArchetypesCount()

   MassEntityManager.h  

void DebugGetArchetypesStringDetails ( FOutputDevice& Ar,
const bool bIncludeEmpty
) const

   MassEntityManager.h  

void DebugGetArchetypeStrings ( const FMassArchetypeHandle& Archetype,
TArray< FName >& OutFragmentNames,
TArray< FName >& OutTagNames
)

   MassEntityManager.h  

int32 DebugGetEntityCount()

   MassEntityManager.h  

FMassEntityHandle DebugGetEntityIndexHandle ( const int32 EntityIndex
) const

   MassEntityManager.h  

const UE::Mass::FStorageType & DebugGetEntityStorageInterface ()

 For use by the friend MassDebugger. MassEntityManager.h  

UE::Mass::FStorageType & DebugGetEntityStorageInterface ()

 For use by the friend MassDebugger. MassEntityManager.h  

const FString & DebugGetName()

   MassEntityManager.h  

bool DebugHasAllDebugFeatures ( EDebugFeatures Features
) const

   MassEntityManager.h  

bool DebugHasCommandsToFlush()

   MassEntityManager.h  

void DebugPrintArchetypes ( FOutputDevice& Ar,
const bool bIncludeEmpty
) const

   MassEntityManager.h  

void DebugRemoveAllEntities()

   MassEntityManager.h  

FMassCommandBuffer & Defer()

   MassEntityManager.h  

void Deinitialize()

   MassEntityManager.h  

void DestroyEntity ( FMassEntityHandle EntityHandle
)

 Destroys a fully built entity, use ReleaseReservedEntity if entity was not yet built. MassEntityManager.h  

void DoEntityCompaction ( const double TimeAllowed
)

 Go through all archetypes and compact entities MassEntityManager.h  

bool DoesEntityHaveElement ( FMassEntityHandle Entity,
TNotNull< const UScriptStruct* > ElementType
) const

   MassEntityManager.h  
Fetches FArchetypeGroupType instance (copy) associated with the given GroupName. MassEntityManager.h  

void FlushCommands ()

   MassEntityManager.h  

void FlushCommands ( const TSharedPtr< FMassCommandBuffer >& InCommandBuffer
)

   MassEntityManager.h  

void ForEachArchetype ( int32 BeginRange,
int32 EndRange,
const CallableT& Callable
) const

   MassEntityManager.h  

void ForEachConstSharedFragment ( TFunctionRef< void(const T&) > ExecuteFunction
)

   MassEntityManager.h  

void ForEachConstSharedFragmentConditional ( TFunctionRef< bool(const T&) > ConditionFunction,
TFunctionRef< void(const T&) > ExecuteFunction
)

   MassEntityManager.h  

void ForEachSharedFragment ( TFunctionRef< void(T&) > ExecuteFunction
)

   MassEntityManager.h  

void ForEachSharedFragment ( TFunctionRef< void(T&) > ExecuteFunction
)

   MassEntityManager.h  

void ForEachSharedFragmentConditional ( TFunctionRef< bool(T&) > ConditionFunction,
TFunctionRef< void(T&) > ExecuteFunction
)

   MassEntityManager.h  

void ForEachSharedFragmentConditional ( TFunctionRef< bool(T&) > ConditionFunction,
TFunctionRef< void(T&) > ExecuteFunction
)

   MassEntityManager.h  

const FMassArchetypeCompositionDescriptor & GetArchetypeComposition ( const FMassArchetypeHandle& ArchetypeHandle
) const

   MassEntityManager.h  

uint32 GetArchetypeDataVersion()

   MassEntityManager.h  
Fetches the archetype for a given EntityHandle. MassEntityManager.h  
Fetches the archetype for a given EntityHandle. MassEntityManager.h  

ConstSharedFragmentType & GetConstSharedFragmentDataChecked ( FMassEntityHandle EntityHandle
) const

   MassEntityManager.h  

ConstSharedFragmentType * GetConstSharedFragmentDataPtr ( FMassEntityHandle EntityHandle
) const

   MassEntityManager.h  

FConstStructView GetConstSharedFragmentDataStruct ( FMassEntityHandle EntityHandle,
const UScriptStruct* ConstSharedFragmentType
) const

   MassEntityManager.h  

FConstStructView GetElementDataStruct ( FMassEntityHandle EntityHandle,
TNotNull< const UScriptStruct* > FragmentType
) const

   MassEntityManager.h  

FragmentType & GetFragmentDataChecked ( FMassEntityHandle EntityHandle
) const

   MassEntityManager.h  

FragmentType * GetFragmentDataPtr ( FMassEntityHandle EntityHandle
) const

   MassEntityManager.h  

FStructView GetFragmentDataStruct ( FMassEntityHandle EntityHandle,
const UScriptStruct* FragmentType
) const

   MassEntityManager.h  

UE::Mass::FArchetypeGroupHandle GetGroupForEntity ( FMassEntityHandle EntityHandle,
UE::Mass::FArchetypeGroupType GroupType
) const

   MassEntityManager.h  

const UE::Mass::FArchetypeGroups & GetGroupsForArchetype ( const FMassArchetypeHandle& ArchetypeHandle
) const

   MassEntityManager.h  

void GetMatchingArchetypes ( const FMassFragmentRequirements& Requirements,
TArray< FMassArchetypeHandle >& OutValidArchetypes
) const

 Searches through all known archetypes and matches them to the provided requirements. MassEntityManager.h  

FMassObserverManager & GetObserverManager()

   MassEntityManager.h  

FOnNewArchetypeDelegate & GetOnNewArchetypeEvent()

   MassEntityManager.h  

const FConstSharedStruct & GetOrCreateConstSharedFragment ( const UScriptStruct& InScriptStruct,
const uint8* InStructMemory
)

 Returns or creates a shared struct associated to a given shared fragment set of values identified internally by a CRC. MassEntityManager.h  

const FConstSharedStruct & GetOrCreateConstSharedFragment ( TArgs&&... InArgs
)

 Returns or creates a shared struct associated to a given shared fragment set of values identified internally by a CRC. MassEntityManager.h  

const FConstSharedStruct & GetOrCreateConstSharedFragment ( const T& Fragment
)

 Returns or creates a shared struct associated to a given shared fragment set of values identified internally by a CRC. MassEntityManager.h  

const FConstSharedStruct & GetOrCreateConstSharedFragment ( const FConstStructView HashingHelperStruct,
TArgs&&... InArgs
)

 Returns or creates a shared struct associated to a given shared fragment set of values identified internally by a CRC. MassEntityManager.h  

const FConstSharedStruct & GetOrCreateConstSharedFragmentByHash ( const uint32 Hash,
const T& Fragment
)

   MassEntityManager.h  

const FSharedStruct & GetOrCreateSharedFragment ( TArgs&&... InArgs
)

 Returns or creates a shared struct associated to a given shared fragment set of values identified internally by a CRC. MassEntityManager.h  

const FSharedStruct & GetOrCreateSharedFragment ( const UScriptStruct& InScriptStruct,
const uint8* InStructMemory
)

 Returns or creates a shared struct associated to a given shared fragment set of values identified internally by a CRC. MassEntityManager.h  

const FSharedStruct & GetOrCreateSharedFragment ( const FConstStructView HashingHelperStruct,
TArgs&&... InArgs
)

 Returns or creates a shared struct associated to a given shared fragment set of values identified internally by a CRC. MassEntityManager.h  

const FSharedStruct & GetOrCreateSharedFragment ( const T& Fragment
)

 Returns or creates a shared struct associated to a given shared fragment set of values identified internally by a CRC. MassEntityManager.h  

const FSharedStruct & GetOrCreateSharedFragmentByHash ( const uint32 Hash,
TArgs&&... InArgs
)

 Shared fragments. MassEntityManager.h  

FMassArchetypeHandle GetOrCreateSuitableArchetype ( const FMassArchetypeHandle& ArchetypeHandle,
const FMassSharedFragmentBitSet& SharedFragmentBitSet,
const FMassConstSharedFragmentBitSet& ConstSharedFragmentBitSet,
const FMassArchetypeCreationParams& CreationParams
)

 A helper function to be used when creating entities with shared fragments provided, or when adding shared fragments to existing entities MassEntityManager.h  

TSharedRef< FEntityCreationContext > GetOrMakeCreationContext ()

 The main use-case for this function is to create a blank FEntityCreationContext and hold on to it while creating a bunch of entities (with multiple calls to BatchCreate* and/or BatchBuild*) and modifying them (with mutating batched API) while not causing multiple Observers to trigger. MassEntityManager.h  
Fetches the observers lock (as hosted by FMassObserverManager). MassEntityManager.h  

UObject * GetOwner()

   MassEntityManager.h  

UE::Mass::FRelationManager & GetRelationManager()

 Relations. MassEntityManager.h  

FMassRequirementAccessDetector & GetRequirementAccessDetector()

   MassEntityManager.h  

void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

   MassEntityManager.h  

SharedFragmentType & GetSharedFragmentDataChecked ( FMassEntityHandle EntityHandle
) const

   MassEntityManager.h  

SharedFragmentType * GetSharedFragmentDataPtr ( FMassEntityHandle EntityHandle
) const

   MassEntityManager.h  

FConstStructView GetSharedFragmentDataStruct ( FMassEntityHandle EntityHandle,
const UScriptStruct* SharedFragmentType
) const

   MassEntityManager.h  

TConstArrayView< FSharedStruct > GetSharedFragmentsOfType()

   MassEntityManager.h  
  MassEntityManager.h  
Sub-Managers. MassEntityManager.h  
Fetches the world associated with the Owner. MassEntityManager.h  

void Initialize ( const FMassEntityManagerStorageInitParams& InitializationParams
)

   MassEntityManager.h  

void Initialize ()

 Default to use single threaded implementation. MassEntityManager.h  

bool IsDuringEntityCreation()

   MassEntityManager.h  

bool IsEntityActive ( FMassEntityHandle EntityHandle
) const

   MassEntityManager.h  

bool IsEntityBuilt ( FMassEntityHandle EntityHandle
) const

 Whether the entity handle represents an entity that has been fully built (expecting a valid EntityHandle) MassEntityManager.h  

bool IsEntityReserved ( FMassEntityHandle EntityHandle
) const

   MassEntityManager.h  

bool IsEntityValid ( FMassEntityHandle EntityHandle
) const

   MassEntityManager.h  

bool IsProcessing ()

 Indicates whether there are processors out there performing operations on this instance of MassEntityManager. MassEntityManager.h  

UE::Mass::FEntityBuilder MakeEntityBuilder()

 Entity Builder. MassEntityManager.h  

void MoveEntityToAnotherArchetype ( FMassEntityHandle EntityHandle,
FMassArchetypeHandle NewArchetypeHandle,
const FMassArchetypeSharedFragmentValues* SharedFragmentValuesOverride
)

 Moves an entity over to a new archetype by copying over fragments common to both archetypes MassEntityManager.h  

FScopedProcessing NewProcessingScope()

   MassEntityManager.h  

void OnNewTypeRegistered ( UE::Mass::FTypeHandle RegisteredTypeHandle
)

 Type management. MassEntityManager.h  

void PostInitialize()

   MassEntityManager.h  

void ReleaseReservedEntity ( FMassEntityHandle EntityHandle
)

 Releases a previously reserved entity handle that was not yet built, otherwise call DestroyEntity MassEntityManager.h  

void RemoveCompositionFromEntity ( FMassEntityHandle EntityHandle,
const FMassArchetypeCompositionDescriptor& InDescriptor
)

   MassEntityManager.h  

bool RemoveConstSharedFragmentFromEntity ( const FMassEntityHandle EntityHandle,
const UScriptStruct& ConstSharedFragmentType
)

 Removes a const shared fragment of the given type from the entity. MassEntityManager.h  

void RemoveElementFromEntities ( TConstArrayView< FMassEntityHandle > Entities,
TNotNull< const UScriptStruct* > ElementType
)

 Removes ElementType from the entities, treating it accordingly based on which element type it represents (i.e. Fragment or Tag). MassEntityManager.h  

void RemoveElementFromEntity ( FMassEntityHandle Entity,
TNotNull< const UScriptStruct* > ElementType
)

 Removes ElementType from the entity, treating it accordingly based on which element type it represents (i.e. Fragment or Tag). MassEntityManager.h  

void RemoveEntityFromGroupType ( FMassEntityHandle EntityHandle,
UE::Mass::FArchetypeGroupType GroupType
)

 Removes EntityHandle from any-and-all groups of given type - i.e. the entity will be moved to an archetype not in any of the groups of the given type. MassEntityManager.h  

void RemoveFragmentFromEntity ( FMassEntityHandle EntityHandle,
const UScriptStruct* FragmentType
)

   MassEntityManager.h  

void RemoveFragmentListFromEntity ( FMassEntityHandle EntityHandle,
TConstArrayView< const UScriptStruct* > FragmentList
)

   MassEntityManager.h  

bool RemoveSharedFragmentFromEntity ( const FMassEntityHandle EntityHandle,
const UScriptStruct& SharedFragmentType
)

 Removes a shared fragment of the given type from the entity. MassEntityManager.h  

void RemoveTagFromEntity ( FMassEntityHandle EntityHandle,
const UScriptStruct* TagType
)

   MassEntityManager.h  

FMassEntityHandle ReserveEntity()

 Reserves an entity in the subsystem, the entity is still not ready to be used by the subsystem, need to call BuildEntity() MassEntityManager.h  

void SetDebugName ( const FString& NewDebugGame
)

   MassEntityManager.h  

void SetEntityFragmentsValues ( FMassEntityHandle EntityHandle,
TArrayView< const FInstancedStruct > FragmentInstanceList
)

   MassEntityManager.h  

void SetEntityFragmentValues ( FMassEntityHandle EntityHandle,
TArrayView< const FInstancedStruct > FragmentInstanceList
)

 Copies values from FragmentInstanceList over to target entity's fragment. MassEntityManager.h  

void SwapTagsForEntity ( FMassEntityHandle EntityHandle,
const UScriptStruct* FromFragmentType,
const UScriptStruct* ToFragmentType
)

   MassEntityManager.h  

Overridden from FGCObject

Name Remarks Include Path Unreal Specifiers

virtual void AddReferencedObjects ( FReferenceCollector& Collector
)

   MassEntityManager.h  

virtual FString GetReferencerName()

   MassEntityManager.h  

Protected

Name Remarks Include Path Unreal Specifiers

void GetMatchingArchetypes ( const FMassFragmentRequirements& Requirements,
TArray< FMassArchetypeHandle >& OutValidArchetypes,
const uint32 FromArchetypeDataVersion
) const

   MassEntityManager.h  

void InternalAppendFragmentsAndTagsToArchetypeCompositionDescriptor ( FMassArchetypeCompositionDescriptor& InOutComposition,
TConstArrayView< const UScriptStruct* > FragmentsAndTagsList
) const

   MassEntityManager.h  

FMassArchetypeHandle InternalCreateSimilarArchetype ( const TSharedPtr< FMassArchetypeData >& SourceArchetype,
const UE::Mass::FArchetypeGroups& GroupsOverride
)

   MassEntityManager.h  

FMassArchetypeHandle InternalCreateSimilarArchetype ( const TSharedPtr< FMassArchetypeData >& SourceArchetype,
const FMassFragmentBitSet& OverrideFragments
)

   MassEntityManager.h  

FMassArchetypeHandle InternalCreateSimilarArchetype ( const TSharedPtr< FMassArchetypeData >& SourceArchetype,
const FMassTagBitSet& OverrideTags
)

 A "similar" archetype is an archetype exactly the same as SourceArchetype except for one composition aspect like Fragments or "Tags" MassEntityManager.h  

FMassArchetypeHandle InternalCreateSimilarArchetype ( const FMassArchetypeData& SourceArchetypeRef,
FMassArchetypeCompositionDescriptor&& NewComposition,
const UE::Mass::FArchetypeGroups& GroupsOverride
)

   MassEntityManager.h  

FMassArchetypeHandle InternalCreateSimilarArchetype ( const FMassArchetypeData& SourceArchetypeRef,
FMassArchetypeCompositionDescriptor&& NewComposition
)

 DEPRECATED. MassEntityManager.h  

void OnPostFork ( EForkProcessRole Role
)

 Called on the child process upon process's forking MassEntityManager.h  

void OnRelationTypeRegistered ( UE::Mass::FTypeHandle RegisteredTypeHandle,
const UE::Mass::FRelationTypeTraits& RelationTypeTraits
)

   MassEntityManager.h  

Static

Name Remarks Include Path Unreal Specifiers

static void BatchSetEntityFragmentsValues ( TConstArrayView< FMassArchetypeEntityCollection > EntityCollections,
TArrayView< const FInstancedStruct > FragmentInstanceList
)

   MassEntityManager.h  

static void BatchSetEntityFragmentsValues ( const FMassArchetypeEntityCollection& SparseEntities,
TArrayView< const FInstancedStruct > FragmentInstanceList
)

   MassEntityManager.h  

static void ForEachArchetypeFragmentType ( const FMassArchetypeHandle& ArchetypeHandle,
TFunction< void(const UScriptStruct*)> Function
)

 Method to iterate on all the fragment types of an archetype MassEntityManager.h  

See Also

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page