UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | List of all members
FTickTaskManagerInterface Class Referenceabstract

#include <TickTaskManagerInterface.h>

+ Inheritance diagram for FTickTaskManagerInterface:

Public Member Functions

virtual ~FTickTaskManagerInterface ()
 
virtual FTickTaskLevel * AllocateTickTaskLevel ()=0
 
virtual void FreeTickTaskLevel (FTickTaskLevel *TickTaskLevel)=0
 
virtual void StartFrame (UWorld *InWorld, float DeltaSeconds, ELevelTick TickType, const TArray< ULevel * > &LevelsToTick)=0
 
virtual void RunPauseFrame (UWorld *InWorld, float DeltaSeconds, ELevelTick TickType, const TArray< ULevel * > &LevelsToTick)=0
 
virtual void RunTickGroup (ETickingGroup Group, bool bBlockTillComplete)=0
 
virtual void EndFrame ()=0
 
virtual void DumpAllTickFunctions (FOutputDevice &Ar, UWorld *InWorld, bool bEnabled, bool bDisabled, bool bGrouped)=0
 
virtual void GetEnabledTickFunctionCounts (UWorld *InWorld, TSortedMap< FName, int32, FDefaultAllocator, FNameFastLess > &TickContextToCountMap, int32 &EnabledCount, bool bDetailed, bool bFilterCoolingDown=false)=0
 

Static Public Member Functions

static ENGINE_API FTickTaskManagerInterface & Get ()
 

Detailed Description

Interface for the tick task manager

Constructor & Destructor Documentation

◆ ~FTickTaskManagerInterface()

virtual FTickTaskManagerInterface::~FTickTaskManagerInterface ( )
inlinevirtual

Member Function Documentation

◆ AllocateTickTaskLevel()

virtual FTickTaskLevel * FTickTaskManagerInterface::AllocateTickTaskLevel ( )
pure virtual

Allocate a new ticking structure for a ULevel

Implemented in FTickTaskManager.

◆ DumpAllTickFunctions()

virtual void FTickTaskManagerInterface::DumpAllTickFunctions ( FOutputDevice &  Ar,
UWorld *  InWorld,
bool  bEnabled,
bool  bDisabled,
bool  bGrouped 
)
pure virtual

Dumps all registered tick functions to output device.

◆ EndFrame()

virtual void FTickTaskManagerInterface::EndFrame ( )
pure virtual

Finish a frame of ticks

Implemented in FTickTaskManager.

◆ FreeTickTaskLevel()

virtual void FTickTaskManagerInterface::FreeTickTaskLevel ( FTickTaskLevel *  TickTaskLevel)
pure virtual

Free a ticking structure for a ULevel

Implemented in FTickTaskManager.

◆ Get()

FTickTaskManagerInterface & FTickTaskManagerInterface::Get ( )
static

Singleton to retrieve the GLOBAL tick task manager

Returns
Reference to the global cache tick task manager

Singleton to retrieve the global tick task manager

Returns
Reference to the global tick task manager

◆ GetEnabledTickFunctionCounts()

virtual void FTickTaskManagerInterface::GetEnabledTickFunctionCounts ( UWorld *  InWorld,
TSortedMap< FName, int32, FDefaultAllocator, FNameFastLess > &  TickContextToCountMap,
int32 &  EnabledCount,
bool  bDetailed,
bool  bFilterCoolingDown = false 
)
pure virtual

Returns a map of enabled ticks, grouped by 'diagnostic context' string, along with count of enabled ticks

◆ RunPauseFrame()

virtual void FTickTaskManagerInterface::RunPauseFrame ( UWorld *  InWorld,
float  DeltaSeconds,
ELevelTick  TickType,
const TArray< ULevel * > &  LevelsToTick 
)
pure virtual

Run all of the ticks for a pause frame synchronously on the game thread. The capability of pause ticks are very limited. There are no dependencies or ordering or tick groups.

Parameters
World- World currently ticking
DeltaSeconds- time in seconds since last tick
TickType- type of tick (viewports only, time only, etc)

Implemented in FTickTaskManager.

◆ RunTickGroup()

virtual void FTickTaskManagerInterface::RunTickGroup ( ETickingGroup  Group,
bool  bBlockTillComplete 
)
pure virtual

Run a tick group, ticking all actors and components

Parameters
Group- Ticking group to run
bBlockTillComplete- if true, do not return until all ticks are complete

Implemented in FTickTaskManager.

◆ StartFrame()

virtual void FTickTaskManagerInterface::StartFrame ( UWorld *  InWorld,
float  DeltaSeconds,
ELevelTick  TickType,
const TArray< ULevel * > &  LevelsToTick 
)
pure virtual

Queue all of the ticks for a frame

Parameters
World- World currently ticking
DeltaSeconds- time in seconds since last tick
TickType- type of tick (viewports only, time only, etc)

Implemented in FTickTaskManager.

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