FTickTaskLevel Class Reference

Classes
struct	FTickScheduleDetails

Public Member Functions
	FTickTaskLevel ()
	~FTickTaskLevel ()
int32	StartFrame (const FTickContext &InContext)
void	StartFrameParallel (const FTickContext &InContext, TArray< FTickFunction * > &AllTickFunctions)
bool	UpdateRescheduleInterval (FTickFunction *TickFunction, float InInterval)
void	RescheduleForInterval (FTickFunction *TickFunction, float InInterval)
void	RescheduleForIntervalParallel (FTickFunction *TickFunction)
void	ReserveTickFunctionCooldowns (int32 NumToReserve)
void	DoDeferredRemoves ()
void	ScheduleTickFunctionCooldowns ()
void	QueueAllTicks ()
int32	QueueNewlySpawned (ETickingGroup CurrentTickGroup)
void	LogAndDiscardRunawayNewlySpawned (ETickingGroup CurrentTickGroup)
void	RunPauseFrame (const FTickContext &InContext)
void	EndFrame ()
bool	HasTickFunction (FTickFunction *TickFunction)
void	AddTickFunction (FTickFunction *TickFunction)
void	DumpTickFunction (FOutputDevice &Ar, FTickFunction *Function, UEnum *TickGroupEnum, const float RemainingCooldown=0.f)
void	DumpAllTickFunctions (FOutputDevice &Ar, int32 &EnabledCount, int32 &DisabledCount, bool bEnabled, bool bDisabled)
FORCEINLINE void	AddTickFunctionToMap (TSortedMap< FName, int32, FDefaultAllocator, FNameFastLess > &ClassNameToCountMap, FTickFunction *Function, bool bDetailed)
void	AddTickFunctionsToMap (TSortedMap< FName, int32, FDefaultAllocator, FNameFastLess > &ClassNameToCountMap, int32 &EnabledCount, bool bDetailed, bool bFilterCoolingDown, float CurrentTime, float CurrentUnpausedTime)
void	RemoveTickFunction (FTickFunction *TickFunction)

Constructor & Destructor Documentation

FTickTaskLevel()

FTickTaskLevel::FTickTaskLevel ( )

inline

Constructor, grabs, the sequencer singleton

~FTickTaskLevel()

FTickTaskLevel::~FTickTaskLevel ( )

inline

Member Function Documentation

AddTickFunction()

void FTickTaskLevel::AddTickFunction ( FTickFunction *  TickFunction )

inline

Add the tick function to the primary list

AddTickFunctionsToMap()

void FTickTaskLevel::AddTickFunctionsToMap ( TSortedMap< FName, int32, FDefaultAllocator, FNameFastLess > &  ClassNameToCountMap, int32 &  EnabledCount, bool  bDetailed, bool  bFilterCoolingDown, float  CurrentTime, float  CurrentUnpausedTime  )

inline

AddTickFunctionToMap()

FORCEINLINE void FTickTaskLevel::AddTickFunctionToMap ( TSortedMap< FName, int32, FDefaultAllocator, FNameFastLess > &  ClassNameToCountMap, FTickFunction *  Function, bool  bDetailed  )

inline

DoDeferredRemoves()

void FTickTaskLevel::DoDeferredRemoves ( )

inline

DumpAllTickFunctions()

void FTickTaskLevel::DumpAllTickFunctions ( FOutputDevice &  Ar, int32 &  EnabledCount, int32 &  DisabledCount, bool  bEnabled, bool  bDisabled  )

inline

Dumps all tick functions to output device.

DumpTickFunction()

void FTickTaskLevel::DumpTickFunction ( FOutputDevice &  Ar, FTickFunction *  Function, UEnum *  TickGroupEnum, const float  RemainingCooldown = 0.f  )

inline

Dumps info about a tick function to output device.

EndFrame()

void FTickTaskLevel::EndFrame ( )

inline

End a tick frame

HasTickFunction()

bool FTickTaskLevel::HasTickFunction ( FTickFunction *  TickFunction )

inline

Return true if this tick function is in the primary list

LogAndDiscardRunawayNewlySpawned()

void FTickTaskLevel::LogAndDiscardRunawayNewlySpawned ( ETickingGroup  CurrentTickGroup )

inline

If there is infinite recursive spawning, log that and discard them

QueueAllTicks()

void FTickTaskLevel::QueueAllTicks ( )

inline

QueueNewlySpawned()

int32 FTickTaskLevel::QueueNewlySpawned ( ETickingGroup  CurrentTickGroup )

inline

Queues the newly spawned ticks for this level

Returns

- the number of items

RemoveTickFunction()

void FTickTaskLevel::RemoveTickFunction ( FTickFunction *  TickFunction )

inline

Remove the tick function from the primary list

RescheduleForInterval()

void FTickTaskLevel::RescheduleForInterval ( FTickFunction *  TickFunction, float  InInterval  )

inline

RescheduleForIntervalParallel()

void FTickTaskLevel::RescheduleForIntervalParallel ( FTickFunction *  TickFunction )

inline

ReserveTickFunctionCooldowns()

void FTickTaskLevel::ReserveTickFunctionCooldowns ( int32  NumToReserve )

inline

RunPauseFrame()

void FTickTaskLevel::RunPauseFrame ( const FTickContext &  InContext )

inline

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

InContext

- information about the tick

ScheduleTickFunctionCooldowns()

void FTickTaskLevel::ScheduleTickFunctionCooldowns ( )

inline

StartFrame()

int32 FTickTaskLevel::StartFrame ( const FTickContext &  InContext )

inline

Queues the ticks for this level

Parameters

InContext

- information about the tick

Returns

the total number of ticks we will be ticking

StartFrameParallel()

void FTickTaskLevel::StartFrameParallel ( const FTickContext &  InContext, TArray< FTickFunction * > &  AllTickFunctions  )

inline

Queues the ticks for this level

Parameters

InContext

- information about the tick

UpdateRescheduleInterval()

bool FTickTaskLevel::UpdateRescheduleInterval ( FTickFunction *  TickFunction, float  InInterval  )

inline

Returns true if found in reschedule list and interval was updated

---

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

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