1. Epic GamesDeveloper
  3. FMassProcessingPhaseManager

FMassProcessingPhaseManager

MassProcessingPhaseManager owns separate [FMassProcessingPhase](API\Plugins\MassEntity\FMassProcessingPhase) instances for every ETickingGroup.

API > API/Plugins > API/Plugins/MassEntity

Inheritance Hierarchy

References

   
Module MassEntity
Header /Engine/Plugins/Runtime/MassEntity/Source/MassEntity/Public/MassProcessingPhaseManager.h
Include #include "MassProcessingPhaseManager.h"

Syntax

struct FMassProcessingPhaseManager : public FGCObject

Remarks

MassProcessingPhaseManager owns separate FMassProcessingPhase instances for every ETickingGroup. When activated via Start function it registers and enables the FMassProcessingPhase instances which themselves are tick functions that host UMassCompositeProcessor which they trigger as part of their Tick function. MassProcessingPhaseManager serves as an interface to said FMassProcessingPhase instances and allows initialization with collections of processors (via Initialize function) as well as registering arbitrary functions to be called when a particular phase starts or ends (via GetOnPhaseStart and GetOnPhaseEnd functions).

Variables

  Type Name Description
Protected variable bool bIsAllowedToTick  
Protected variable EMassProcessingPhase CurrentPhase  
Protected variable TArray< TObjectPtr< UMassProcessor > > DynamicProcessors  
Protected variable TSharedPtr< FMassEntityManager > EntityManager  
Protected variable friend FMassProcessingPhase  
Protected variable FDelegateHandle OnNewArchetypeHandle  
Protected variable TWeakObjectPtr< UObject > Owner  
Protected variable FPhaseGraphBuildState[(uint8) EMassProcessingPhase::MAX] ProcessingGraphBuildStates  
Protected variable FMassProcessingPhase[(uint8) EMassProcessingPhase::MAX] ProcessingPhases  
Protected variable TArray< FMassProcessingPhaseConfig > ProcessingPhasesConfig  

Constructors

  Type Name Description
Public function    
Public function    

Functions

  Type Name Description
Protected function void Creates phase processors instances for each declared phase name, based on MassEntitySettings
Public function void Needs to be called before destruction, ideally before owner's BeginDestroy (a FGCObject's limitation)
Protected function void

EnableTickFunctions ( const UWorld& World
)

  
Public function const TSharedPtr< FMassEntityManager > &  
Public function FMassEntityManager &  
Public function Const FString

GetName ()

  
Public function FMassProcessingPhase::FOnPhaseEvent & Retrieves OnPhaseEnd multicast delegate's reference for a given Phase
Public function FMassProcessingPhase::FOnPhaseEvent & Retrieves OnPhaseStart multicast delegate's reference for a given Phase
Public function void

Initialize ( UObject& InOwner,
TConstArrayView< FMassProcessingPhaseConfig > ProcessingPhasesConfig,
const FString& DependencyGraphFileName
)

 Populates hosted FMassProcessingPhase instances with Processors read from MassEntitySettings configuration.
Public function Const bool  
Protected function void

OnNewArchetype ( const FMassArchetypeHandle& NewArchetype
)

  
Protected function void Called by the given Phase at the very end of its execution function (the FMassProcessingPhase::ExecuteTick), after the FMassProcessingPhase.OnPhaseEnd broadcast delegate
Protected function void Called by the given Phase at the very start of its execution function (the FMassProcessingPhase::ExecuteTick), even before the FMassProcessingPhase.OnPhaseStart broadcast delegate
Public function void Registers a dynamic processor.
Public function void

Start ( UWorld& World
)

 Stores EntityManager associated with given world's MassEntitySubsystem and kicks off phase ticking.
Public function void

Start ( const TSharedPtr< FMassEntityManager >& InEntityManager
)

 Stores InEntityManager as the entity manager.
Public function void

Stop ()

  
Public function const FGraphEventRef &

TriggerPhase ( const EMassProcessingPhase Phase,
const float DeltaTime,
const FGraphEventRef& MyCompletionGraphEvent
)

  
Public function void Removes a previously registered dynamic processor of throws an assert if not found.

Overridden from FGCObject

  Type Name Description
Protected function Virtual void Pure virtual that must be overloaded by the inheriting class.
Protected function Virtual Const FString Overload this method to report a name for your referencer

Operators

  Type Name Description
Public function FMassProcessingPhaseManager &  

Classes

  Type Name Description
Protected struct FPhaseGraphBuildState    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page