FTickTaskManager Class Reference

Inheritance diagram for FTickTaskManager:

Public Member Functions
virtual FTickTaskLevel *	AllocateTickTaskLevel () override
virtual void	FreeTickTaskLevel (FTickTaskLevel *TickTaskLevel) override
virtual void	StartFrame (UWorld *InWorld, float InDeltaSeconds, ELevelTick InTickType, const TArray< ULevel * > &LevelsToTick) override
virtual void	RunPauseFrame (UWorld *InWorld, float InDeltaSeconds, ELevelTick InTickType, const TArray< ULevel * > &LevelsToTick) override
virtual void	RunTickGroup (ETickingGroup Group, bool bBlockTillComplete) override
virtual void	EndFrame () override
bool	HasTickFunction (ULevel *InLevel, FTickFunction *TickFunction)
void	AddTickFunction (ULevel *InLevel, FTickFunction *TickFunction)
void	RemoveTickFunction (FTickFunction *TickFunction)
Public Member Functions inherited from FTickTaskManagerInterface
virtual	~FTickTaskManagerInterface ()

Static Public Member Functions
static FTickTaskManager &	Get ()
Static Public Member Functions inherited from FTickTaskManagerInterface
static ENGINE_API FTickTaskManagerInterface &	Get ()

Detailed Description

Class that aggregates the individual levels and deals with parallel tick setup

Member Function Documentation

AddTickFunction()

void FTickTaskManager::AddTickFunction ( ULevel *  InLevel, FTickFunction *  TickFunction  )

inline

Add the tick function to the primary list

AllocateTickTaskLevel()

virtual FTickTaskLevel * FTickTaskManager::AllocateTickTaskLevel ( )

inlineoverridevirtual

Allocate a new ticking structure for a ULevel

Implements FTickTaskManagerInterface.

EndFrame()

virtual void FTickTaskManager::EndFrame ( )

inlineoverridevirtual

Finish a frame of ticks

Implements FTickTaskManagerInterface.

FreeTickTaskLevel()

virtual void FTickTaskManager::FreeTickTaskLevel ( FTickTaskLevel *  TickTaskLevel )

inlineoverridevirtual

Free a ticking structure for a ULevel

Implements FTickTaskManagerInterface.

Get()

static FTickTaskManager & FTickTaskManager::Get ( )

inlinestatic

Singleton to retrieve the global tick task manager

Returns

Reference to the global tick task manager

HasTickFunction()

bool FTickTaskManager::HasTickFunction ( ULevel *  InLevel, FTickFunction *  TickFunction  )

inline

Return true if this tick function is in the primary list

RemoveTickFunction()

void FTickTaskManager::RemoveTickFunction ( FTickFunction *  TickFunction )

inline

Remove the tick function from the primary list

RunPauseFrame()

virtual void FTickTaskManager::RunPauseFrame ( UWorld *  InWorld, float  InDeltaSeconds, ELevelTick  InTickType, const TArray< ULevel * > &  LevelsToTick  )

inlineoverridevirtual

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)

Implements FTickTaskManagerInterface.

RunTickGroup()

virtual void FTickTaskManager::RunTickGroup ( ETickingGroup  Group, bool  bBlockTillComplete  )

inlineoverridevirtual

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

Implements FTickTaskManagerInterface.

StartFrame()

virtual void FTickTaskManager::StartFrame ( UWorld *  InWorld, float  InDeltaSeconds, ELevelTick  InTickType, const TArray< ULevel * > &  LevelsToTick  )

inlineoverridevirtual

Ticks the dynamic actors in the given levels based upon their tick group. This function is called once for each ticking group

Parameters

World	- World currently ticking
DeltaSeconds	- time in seconds since last tick
TickType	- type of tick (viewports only, time only, etc)
LevelsToTick	- the levels to tick, may be a subset of InWorld->Levels

Implements FTickTaskManagerInterface.

---

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

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