FTickTaskManagerInterface | Unreal Engine 5.8 Documentation

API > API/Runtime > API/Runtime/Engine

Interface for the tick task manager, which is used to queue and execute FTickFunctions. These functions are called for a world to handle the "tick frame" that runs normal gameplay operations. The frame is split into multiple tick groups to allow broad coordination between different engine systems.


Name	FTickTaskManagerInterface
Type	class
Header File	/Engine/Source/Runtime/Engine/Public/TickTaskManagerInterface.h
Include Path	#include "TickTaskManagerInterface.h"

Syntax

class FTickTaskManagerInterface

Destructors

Name	Remarks	Include Path	Unreal Specifiers
virtual ~FTickTaskManagerInterface()		TickTaskManagerInterface.h

Functions

Public

Name	Remarks	Include Path
FTickTaskLevel * AllocateTickTaskLevel()	Allocate a new ticking structure to track registered ticks for a level.	TickTaskManagerInterface.h
void DumpAllTickFunctions ( FOutputDevice& Ar, UWorld* InWorld, bool bEnabled, bool bDisabled, bool bGrouped )	Dumps all registered tick functions to output device.	TickTaskManagerInterface.h
void EndFrame()	Finish a frame of ticks for all worlds that called StartFrame.	TickTaskManagerInterface.h
void FreeTickTaskLevel ( FTickTaskLevel* TickTaskLevel )	Free a ticking structure used for tracking registered ticks.	TickTaskManagerInterface.h
void GetEnabledTickFunctionCounts ( UWorld* InWorld, TSortedMap< FName, int32, FDefaultAllocator, FNameFastLess >& TickContextToCountMap, int32& EnabledCount, bool bDetailed, bool bFilterCoolingDown )	Returns a map of enabled ticks, grouped by 'diagnostic context' string, along with count of enabled ticks	TickTaskManagerInterface.h
void RunPauseFrame ( UWorld* InWorld, float DeltaSeconds, ELevelTick TickType, const TArray< ULevel* >& LevelsToTick )	Run all of the ticks for a pause frame synchronously on the game thread.	TickTaskManagerInterface.h
void RunTickGroup ( ETickingGroup Group, bool bBlockTillComplete )	Run a tick group, ticking all actors and components registered to execute in that tick group.	TickTaskManagerInterface.h
void StartFrame ( UWorld* InWorld, float DeltaSeconds, ELevelTick TickType, const TArray< ULevel* >& LevelsToTick )	Queue all of the ticks for one tick frame.	TickTaskManagerInterface.h

Public Virtual

Static

Name	Remarks	Include Path	Unreal Specifiers
static FTickTaskManagerInterface & Get ()	Accessor for the singleton global tick task manager.	TickTaskManagerInterface.h