1. Epic GamesDeveloper
  3. FMassObserverManager

FMassObserverManager

A type that encapsulates logic related to notifying interested parties of entity composition changes.

API > API/Runtime > API/Runtime/MassEntity

A type that encapsulates logic related to notifying interested parties of entity composition changes. Upon creation it reads information from UMassObserverRegistry and instantiates processors interested in handling given fragment type addition or removal.

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

Syntax

USTRUCT ()  
struct FMassObserverManager

Constructors

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

Structs

Name Remarks
FCollectionRefOrHandle Helper struct for holding either a single enity handle or an archetype collection reference.

Typedefs

Name Type Remarks Include Path
FBufferedNotification UE::Mass::ObserverManager::FBufferedNotification   MassObserverManager.h
FCreationContext UE::Mass::ObserverManager::FCreationContext   MassObserverManager.h
FCreationNotificationHandle UE::Mass::ObserverManager::FCreationNotificationHandle   MassObserverManager.h
FObserverLock UE::Mass::ObserverManager::FObserverLock Convenience aliases MassObserverManager.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddObserverInstance ( const UScriptStruct& ElementType,
EMassObservedOperation Operation,
UMassProcessor& ObserverProcessor
)

   MassObserverManager.h  

void AddObserverInstance ( TNotNull< const UScriptStruct* > ElementType,
EMassObservedOperationFlags OperationFlags,
TNotNull< UMassProcessor* > ObserverProcessor
)

   MassObserverManager.h  

void AddObserverInstance ( TNotNull< UMassObserverProcessor* > ObserverProcessor
)

   MassObserverManager.h  

void DebugGatherUniqueProcessors ( TArray< const UMassProcessor* >& OutProcessors
) const

   MassObserverManager.h  

FMassEntityManager & GetEntityManager()

 Inlines MassObserverManager.h  

const FMassFragmentBitSet * GetObservedFragmentBitSets()

   MassObserverManager.h  

const FMassFragmentBitSet & GetObservedFragmentsBitSet ( const EMassObservedOperation Operation
) const

   MassObserverManager.h  

const FMassTagBitSet * GetObservedTagBitSets()

   MassObserverManager.h  

const FMassTagBitSet & GetObservedTagsBitSet ( const EMassObservedOperation Operation
) const

   MassObserverManager.h  

bool HasObserversForBitSet ( const FMassTagBitSet& InQueriedBitSet,
const EMassObservedOperation Operation
) const

   MassObserverManager.h  

bool HasObserversForBitSet ( const FMassFragmentBitSet& InQueriedBitSet,
const EMassObservedOperation Operation
) const

   MassObserverManager.h  

bool HasObserversForComposition ( const FMassArchetypeCompositionDescriptor& Composition,
const EMassObservedOperation Operation
) const

   MassObserverManager.h  

bool OnCompositionChanged ( const FMassArchetypeEntityCollection& EntityCollection,
const FMassArchetypeCompositionDescriptor& Composition,
const EMassObservedOperation Operation,
UE::Mass::FProcessingContext* ProcessingContext
)

   MassObserverManager.h  

bool OnCompositionChanged ( FMassEntityHandle EntityHandle,
const FMassArchetypeCompositionDescriptor& Composition,
const EMassObservedOperation Operation,
UE::Mass::FProcessingContext* ProcessingContext
)

   MassObserverManager.h  

bool OnCompositionChanged ( const FMassArchetypeEntityCollection& EntityCollection,
T&& BitSet,
const EMassObservedOperation Operation,
UE::Mass::FProcessingContext* ProcessingContext
)

   MassObserverManager.h  

bool OnCompositionChanged ( UE::Mass::FProcessingContext& InProcessingContext,
const FMassArchetypeEntityCollection& EntityCollection,
const FMassArchetypeCompositionDescriptor& Composition,
const EMassObservedOperation Operation
)

   MassObserverManager.h  

bool OnCompositionChanged ( const FMassEntityHandle Entity,
T&& BitSet,
const EMassObservedOperation Operation,
UE::Mass::FProcessingContext* ProcessingContext
)

   MassObserverManager.h  

void OnFragmentOrTagOperation ( const UScriptStruct& FragmentOrTagType,
const FMassArchetypeEntityCollection& EntityCollection,
const EMassObservedOperation Operation
)

   MassObserverManager.h  

bool OnPostCompositionAdded ( const FMassEntityHandle Entity,
const FMassArchetypeCompositionDescriptor& Composition
)

   MassObserverManager.h  

bool OnPostEntitiesCreated ( UE::Mass::FProcessingContext& InProcessingContext,
TConstArrayView< FMassArchetypeEntityCollection > EntityCollections
)

   MassObserverManager.h  

bool OnPostEntitiesCreated ( const FMassArchetypeEntityCollection& EntityCollection
)

   MassObserverManager.h  

bool OnPostEntitiesCreated ( UE::Mass::FProcessingContext& InProcessingContext,
const FMassArchetypeEntityCollection& EntityCollection
)

   MassObserverManager.h  

bool OnPostEntityCreated ( const FMassEntityHandle Entity,
const FMassArchetypeCompositionDescriptor& Composition
)

   MassObserverManager.h  

void OnPostFragmentOrTagAdded ( const UScriptStruct& FragmentOrTagType,
const FMassArchetypeEntityCollection& EntityCollection
)

   MassObserverManager.h  

bool OnPreCompositionRemoved ( const FMassEntityHandle Entity,
const FMassArchetypeCompositionDescriptor& Composition
)

   MassObserverManager.h  

bool OnPreEntitiesDestroyed ( const FMassArchetypeEntityCollection& EntityCollection
)

   MassObserverManager.h  

bool OnPreEntitiesDestroyed ( UE::Mass::FProcessingContext& ProcessingContext,
const FMassArchetypeEntityCollection& EntityCollection
)

   MassObserverManager.h  

bool OnPreEntityDestroyed ( const FMassArchetypeCompositionDescriptor& ArchetypeComposition,
const FMassEntityHandle Entity
)

   MassObserverManager.h  

void OnPreFragmentOrTagRemoved ( const UScriptStruct& FragmentOrTagType,
const FMassArchetypeEntityCollection& EntityCollection
)

   MassObserverManager.h  

void ReleaseCreationHandle ( UE::Mass::ObserverManager::FCreationNotificationHandle InCreationNotificationHandle
)

   MassObserverManager.h  

void RemoveObserverInstance ( const UScriptStruct& ElementType,
EMassObservedOperation Operation,
UMassProcessor& ObserverProcessor
)

   MassObserverManager.h  

void RemoveObserverInstance ( TNotNull< const UScriptStruct* > ElementType,
EMassObservedOperationFlags OperationFlags,
TNotNull< UMassProcessor* > ObserverProcessor
)

   MassObserverManager.h  

Protected

Name Remarks Include Path Unreal Specifiers

void DeInitialize()

   MassObserverManager.h  

TSharedPtr< FCreationContext > GetCreationContext()

   MassObserverManager.h  

TSharedPtr< FObserverLock > GetObserverLock()

   MassObserverManager.h  

TSharedRef< FCreationContext > GetOrMakeCreationContext ( TConstArrayView< FMassEntityHandle > ReservedEntities,
FMassArchetypeEntityCollection&& EntityCollection
)

   MassObserverManager.h  

TSharedRef< FCreationContext > GetOrMakeCreationContext ()

   MassObserverManager.h  

TSharedRef< FObserverLock > GetOrMakeObserverLock()

 TSharedRef GetOrMakeObserverLock(TConstArrayView ReservedEntities, FMassArchetypeEntityCollection&& EntityCollection);. MassObserverManager.h  

void HandleSingleEntityImpl ( const UScriptStruct& FragmentType,
const FMassArchetypeEntityCollection& EntityCollection,
FMassObserversMap& HandlersContainer
)

   MassObserverManager.h  

void Initialize()

   MassObserverManager.h  

bool IsLocked()

   MassObserverManager.h  
  MassObserverManager.h  

bool OnCollectionsCreatedImpl ( UE::Mass::FProcessingContext& ProcessingContext,
TConstArrayView< FMassArchetypeEntityCollection > EntityCollections
)

 Coalesces all the elements observed in all the collections and executes all the observers at once MassObserverManager.h  

bool OnCompositionChanged ( FCollectionRefOrHandle&& EntityCollection,
const FMassArchetypeCompositionDescriptor& Composition,
const EMassObservedOperation Operation,
UE::Mass::FProcessingContext* ProcessingContext
)

   MassObserverManager.h  

void OnModulePackagesUnloaded ( TConstArrayView< UPackage* > Packages
)

   MassObserverManager.h  

void OnPostFork ( EForkProcessRole
)

   MassObserverManager.h  

void ResumeExecution ( FObserverLock& LockBeingReleased
)

 Resumes observer triggering. MassObserverManager.h  

Static

Name Remarks Include Path Unreal Specifiers

static void HandleElementsImpl ( UE::Mass::FProcessingContext& ProcessingContext,
TConstArrayView< FMassArchetypeEntityCollection > EntityCollections,
TArrayView< const UScriptStruct* > ObservedTypes,
FMassObserversMap& HandlersContainer
)

   MassObserverManager.h  

static void HandleElementsImpl ( UE::Mass::FProcessingContext& ProcessingContext,
TConstArrayView< FMassArchetypeEntityCollection > EntityCollections,
FMassObserverExecutionContext&& ObserverContext,
FMassObserversMap& HandlersContainer
)

   MassObserverManager.h  

static void HandleFragmentsImpl ( UE::Mass::FProcessingContext& ProcessingContext,
const FMassArchetypeEntityCollection& EntityCollection,
TArrayView< const UScriptStruct* > ObservedTypes,
FMassObserversMap& HandlersContainer
)

   MassObserverManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page