FMassProcessingPhase Struct Reference

#include <MassProcessingPhaseManager.h>

Inheritance diagram for FMassProcessingPhase:

Public Member Functions
	DECLARE_MULTICAST_DELEGATE_OneParam (FOnPhaseEvent, const float)
MASSENTITY_API	FMassProcessingPhase ()
	FMassProcessingPhase (const FMassProcessingPhase &Other)=delete
FMassProcessingPhase &	operator= (const FMassProcessingPhase &Other)=delete
MASSENTITY_API void	Initialize (FMassProcessingPhaseManager &InPhaseManager, const EMassProcessingPhase InPhase, const ETickingGroup InTickGroup, UMassCompositeProcessor &InPhaseProcessor)
void	AddSupportedTickType (const ELevelTick TickType)
void	RemoveSupportedTickType (const ELevelTick TickType)
Public Member Functions inherited from FTickFunction
	UPROPERTY (EditDefaultsOnly, Category="Tick", meta=(DisplayName="Tick Interval (secs)")) float TickInterval
ENGINE_API	FTickFunction ()
virtual ENGINE_API	~FTickFunction ()
ENGINE_API void	RegisterTickFunction (class ULevel *Level)
ENGINE_API void	UnRegisterTickFunction ()
bool	IsTickFunctionRegistered () const
ENGINE_API void	SetTickFunctionEnable (bool bInEnabled)
bool	IsTickFunctionEnabled () const
ENGINE_API void	UpdateTickIntervalAndCoolDown (float NewTickInterval)
ENGINE_API bool	IsCompletionHandleValid () const
ENGINE_API FGraphEventRef	GetCompletionHandle () const
virtual ENGINE_API bool	CanDispatchManually () const
virtual ENGINE_API bool	DispatchManually ()
TEnumAsByte< enum ETickingGroup >	GetActualTickGroup () const
TEnumAsByte< enum ETickingGroup >	GetActualEndTickGroup () const
ENGINE_API void	AddPrerequisite (UObject *TargetObject, struct FTickFunction &TargetTickFunction)
ENGINE_API void	RemovePrerequisite (UObject *TargetObject, struct FTickFunction &TargetTickFunction)
ENGINE_API void	SetPriorityIncludingPrerequisites (bool bInHighPriority)
TArray< struct FTickPrerequisite > &	GetPrerequisites ()
const TArray< struct FTickPrerequisite > &	GetPrerequisites () const
float	GetLastTickGameTime () const
ENGINE_API void	ExecuteNestedTick (float DeltaTime, ELevelTick TickType, ENamedThreads::Type CurrentThread, const FGraphEventRef &MyCompletionGraphEvent)
ENGINE_API float	CalculateDeltaTime (float DeltaTime, const class UWorld *TickingWorld)
ENGINE_API void	LogTickFunction (ENamedThreads::Type CurrentThread, bool bLogPrerequisites, int32 Indent=0)
ENGINE_API void	ShowPrerequistes (int32 Indent=1)
ENGINE_API void	ClearTaskInformation ()
virtual void virtual FString return	TEXT ("DiagnosticMessage() not implemented")
virtual void	ForEachNestedTick (TFunctionRef< void(FTickFunction &)> InFunc) const
FTickFunction &	operator= (const FTickFunction &)=delete

Protected Member Functions
virtual MASSENTITY_API void	ExecuteTick (float DeltaTime, ELevelTick TickType, ENamedThreads::Type CurrentThread, const FGraphEventRef &MyCompletionGraphEvent) override
virtual MASSENTITY_API FString	DiagnosticMessage () override
virtual MASSENTITY_API FName	DiagnosticContext (bool bDetailed) override
MASSENTITY_API void	OnParallelExecutionDone (const float DeltaTime)
bool	IsConfiguredForParallelMode () const
void	ConfigureForParallelMode ()
void	ConfigureForSingleThreadMode ()
bool	ShouldTick (const ELevelTick TickType) const

Protected Attributes
friend	FMassProcessingPhaseManager
TObjectPtr< UMassCompositeProcessor >	PhaseProcessor = nullptr
EMassProcessingPhase	Phase = EMassProcessingPhase::MAX
FOnPhaseEvent	OnPhaseStart
FOnPhaseEvent	OnPhaseEnd

Additional Inherited Members
Public Attributes inherited from FTickFunction
TEnumAsByte< enum ETickingGroup >	TickGroup
TEnumAsByte< enum ETickingGroup >	EndTickGroup
uint8	bTickEvenWhenPaused:1
uint8	bCanEverTick:1
uint8	bStartWithTickEnabled:1
uint8	bAllowTickOnDedicatedServer:1
uint8	bAllowTickBatching:1
uint8	bHighPriority:1
uint8	bRunOnAnyThread:1
uint8	bRunTransactionally:1
uint8	bDispatchManually: 1

Constructor & Destructor Documentation

FMassProcessingPhase() [1/2]

FMassProcessingPhase::FMassProcessingPhase

(

)

FMassProcessingPhase() [2/2]

FMassProcessingPhase::FMassProcessingPhase ( const FMassProcessingPhase &  Other )

delete

Member Function Documentation

AddSupportedTickType()

void FMassProcessingPhase::AddSupportedTickType ( const ELevelTick  TickType )

inline

ConfigureForParallelMode()

void FMassProcessingPhase::ConfigureForParallelMode ( )

inlineprotected

ConfigureForSingleThreadMode()

void FMassProcessingPhase::ConfigureForSingleThreadMode ( )

inlineprotected

DECLARE_MULTICAST_DELEGATE_OneParam()

FMassProcessingPhase::DECLARE_MULTICAST_DELEGATE_OneParam	(	FOnPhaseEvent	,
		const float
	)

DiagnosticContext()

FName FMassProcessingPhase::DiagnosticContext ( bool  bDetailed )

overrideprotectedvirtual

Function to give a 'context' for this tick, used for grouped active tick reporting

Reimplemented from FTickFunction.

DiagnosticMessage()

FString FMassProcessingPhase::DiagnosticMessage ( )

overrideprotectedvirtual

Abstract function to describe this tick. Used to print messages about illegal cycles in the dependency graph

Reimplemented from FTickFunction.

ExecuteTick()

void FMassProcessingPhase::ExecuteTick ( float  DeltaTime, ELevelTick  TickType, ENamedThreads::Type  CurrentThread, const FGraphEventRef &  MyCompletionGraphEvent  )

overrideprotectedvirtual

Abstract function actually execute the tick. Batched tick managers should use ExecuteNestedTick

Parameters

DeltaTime	- frame time to advance, in seconds
TickType	- kind of tick for this frame
CurrentThread	- thread we are executing on, useful to pass along as new tasks are created
MyCompletionGraphEvent	- completion event for this task. Useful for holding the completetion of this task until certain child tasks are complete.

Reimplemented from FTickFunction.

Initialize()

void FMassProcessingPhase::Initialize	(	FMassProcessingPhaseManager &	InPhaseManager,
		const EMassProcessingPhase	InPhase,
		const ETickingGroup	InTickGroup,
		UMassCompositeProcessor &	InPhaseProcessor
	)

IsConfiguredForParallelMode()

bool FMassProcessingPhase::IsConfiguredForParallelMode ( ) const

inlineprotected

OnParallelExecutionDone()

void FMassProcessingPhase::OnParallelExecutionDone ( const float  DeltaTime )

protected

operator=()

FMassProcessingPhase & FMassProcessingPhase::operator= ( const FMassProcessingPhase &  Other )

delete

RemoveSupportedTickType()

void FMassProcessingPhase::RemoveSupportedTickType ( const ELevelTick  TickType )

inline

ShouldTick()

bool FMassProcessingPhase::ShouldTick ( const ELevelTick  TickType ) const

inlineprotected

Member Data Documentation

FMassProcessingPhaseManager

friend FMassProcessingPhase::FMassProcessingPhaseManager

protected

OnPhaseEnd

FOnPhaseEvent FMassProcessingPhase::OnPhaseEnd

protected

OnPhaseStart

FOnPhaseEvent FMassProcessingPhase::OnPhaseStart

protected

Phase

EMassProcessingPhase FMassProcessingPhase::Phase = EMassProcessingPhase::MAX

protected

PhaseProcessor

TObjectPtr<UMassCompositeProcessor> FMassProcessingPhase::PhaseProcessor = nullptr

protected

---

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

• Engine/Source/Runtime/MassEntity/Public/MassProcessingPhaseManager.h
• Engine/Source/Runtime/MassEntity/Private/MassProcessingPhaseManager.cpp