FTestTickFunction Struct Reference

Inheritance diagram for FTestTickFunction:

Public Member Functions
	FTestTickFunction ()
virtual void	ExecuteTick (float DeltaTime, ELevelTick TickType, ENamedThreads::Type CurrentThread, const FGraphEventRef &MyCompletionGraphEvent) override
virtual FString	DiagnosticMessage () override
virtual FName	DiagnosticContext (bool bDetailed) override
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

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

FTestTickFunction()

FTestTickFunction::FTestTickFunction ( )

inline

Member Function Documentation

DiagnosticContext()

virtual FName FTestTickFunction::DiagnosticContext ( bool  bDetailed )

inlineoverridevirtual

Function used to describe this tick for active tick reporting.

Reimplemented from FTickFunction.

DiagnosticMessage()

virtual FString FTestTickFunction::DiagnosticMessage ( )

inlineoverridevirtual

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

Reimplemented from FTickFunction.

ExecuteTick()

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

inlineoverridevirtual

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.

---

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

• Engine/Source/Runtime/Engine/Private/TickTaskManager.cpp