UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::Mass::ObserverManager::FCreationContext Struct Reference

#include <MassObserverNotificationTypes.h>

Public Member Functions

UE_API TArray< FMassArchetypeEntityCollectionGetEntityCollections (const FMassEntityManager &EntityManager) const
 
UE_API bool DebugAreEntityCollectionsUpToDate () const
 
UE_API ~FCreationContext ()
 
UE_API TConstArrayView< FMassArchetypeEntityCollectionGetEntityCollections () const
 
UE_API int32 GetSpawnedNum () const
 
UE_API bool IsDirty () const
 
UE_API void AppendEntities (const TConstArrayView< FMassEntityHandle >)
 
UE_API void AppendEntities (const TConstArrayView< FMassEntityHandle >, FMassArchetypeEntityCollection &&)
 
UE_API FCreationContext (const int32)
 
UE_API const FMassArchetypeEntityCollectionGetEntityCollection () const
 
void MarkDirty ()
 

Static Public Member Functions

static UE_API TSharedRef< FCreationContextDebugCreateDummyCreationContext ()
 

Detailed Description

A dedicated structure for ensuring the "on entities creation" observers get notified only once all other initialization operations are done and this creation context instance gets released.

Constructor & Destructor Documentation

◆ ~FCreationContext()

UE::Mass::ObserverManager::FCreationContext::~FCreationContext ( )

◆ FCreationContext()

FMassObserverManager::FCreationContext::FCreationContext ( const int32  )
explicit

Member Function Documentation

◆ AppendEntities() [1/2]

void FMassObserverManager::FCreationContext::AppendEntities ( const TConstArrayView< FMassEntityHandle )

◆ AppendEntities() [2/2]

void FMassObserverManager::FCreationContext::AppendEntities ( const TConstArrayView< FMassEntityHandle ,
FMassArchetypeEntityCollection &&   
)

◆ DebugAreEntityCollectionsUpToDate()

bool UE::Mass::ObserverManager::FCreationContext::DebugAreEntityCollectionsUpToDate ( ) const

Function for debugging/testing purposes. We don't expect users to ever call it, always get collections via GetEntityCollections

◆ DebugCreateDummyCreationContext()

TSharedRef< FCreationContext > UE::Mass::ObserverManager::FCreationContext::DebugCreateDummyCreationContext ( )
static

◆ GetEntityCollection()

const FMassArchetypeEntityCollection & FMassObserverManager::FCreationContext::GetEntityCollection ( ) const

◆ GetEntityCollections() [1/2]

TConstArrayView< FMassArchetypeEntityCollection > FMassObserverManager::FCreationContext::GetEntityCollections ( ) const

◆ GetEntityCollections() [2/2]

TArray< FMassArchetypeEntityCollection > UE::Mass::ObserverManager::FCreationContext::GetEntityCollections ( const FMassEntityManager EntityManager) const

◆ GetSpawnedNum()

int32 FMassObserverManager::FCreationContext::GetSpawnedNum ( ) const

◆ IsDirty()

bool FMassObserverManager::FCreationContext::IsDirty ( ) const

◆ MarkDirty()

void UE::Mass::ObserverManager::FCreationContext::MarkDirty ( )
inline

Called in response to composition mutating operation - these operations invalidate stored collections


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