#include <Tickable.h>

Public Member Functions
ENGINE_API void	QueueTickableObjectForAdd (FTickableObjectBase *InTickable, ETickableTickType NewTickType=ETickableTickType::NewObject)

ENGINE_API void	SetTickTypeForTickableObject (FTickableObjectBase *TickableObject, ETickableTickType NewTickType)

ENGINE_API void	StartTicking ()

ENGINE_API void	FinishTicking ()

Public Attributes
FTransactionallySafeCriticalSection	TickableObjectsCritical

TArray< FTickableObjectBase::FTickableObjectEntry >	TickableObjects

FTransactionallySafeCriticalSection	NewTickableObjectsCritical

TMap< FTickableObjectBase *, ETickableTickType >	NewTickableObjects

bool	bIsTickingObjects = false

bool	bNeedsCleanup = false

Detailed Description

Implementation struct for internals of ticking, there should be one instance of this for each direct subclass

Member Function Documentation

◆ FinishTicking()

void FTickableObjectBase::FTickableStatics::FinishTicking ( )

Finishes ticking and handle cleanup for entries that were invalidated

◆ QueueTickableObjectForAdd()

void FTickableObjectBase::FTickableStatics::QueueTickableObjectForAdd	(	FTickableObjectBase *	InTickable,
		ETickableTickType	NewTickType = `ETickableTickType::NewObject`
	)

Call from anywhere to lock and add to the new objects list

◆ SetTickTypeForTickableObject()

void FTickableObjectBase::FTickableStatics::SetTickTypeForTickableObject	(	FTickableObjectBase *	TickableObject,
		ETickableTickType	NewTickType
	)

Call from anywhere to lock critical sections and set the tick type for an object which could modify both arrays

◆ StartTicking()

void FTickableObjectBase::FTickableStatics::StartTicking ( )

Call after locking TickableObjectsCritical to process the NewTickableObjects array and prepare for tick

Member Data Documentation

◆ bIsTickingObjects

bool FTickableObjectBase::FTickableStatics::bIsTickingObjects = false

True if any of the tick arrays are being iterated

◆ bNeedsCleanup

bool FTickableObjectBase::FTickableStatics::bNeedsCleanup = false

True if any objects were deleted and this needs cleanup after tick

◆ NewTickableObjects

TMap<FTickableObjectBase*, ETickableTickType> FTickableObjectBase::FTickableStatics::NewTickableObjects

Set of objects that have not yet been queried for tick type

◆ NewTickableObjectsCritical

FTransactionallySafeCriticalSection FTickableObjectBase::FTickableStatics::NewTickableObjectsCritical

Lock for modifying new list, this is automatically acquired by functions below

◆ TickableObjects

TArray<FTickableObjectBase::FTickableObjectEntry> FTickableObjectBase::FTickableStatics::TickableObjects

List of objects that are fully ticking

◆ TickableObjectsCritical

FTransactionallySafeCriticalSection FTickableObjectBase::FTickableStatics::TickableObjectsCritical

This critical section should be locked during entire tick process

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

Engine/Source/Runtime/Engine/Public/Tickable.h
Engine/Source/Runtime/Engine/Private/Tickable.cpp

Public Member Functions

Public Attributes