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

#include <Tickable.h>

+ Inheritance diagram for FTickableObjectBase:

Classes

struct  FTickableObjectEntry
 
struct  FTickableStatics
 

Public Member Functions

virtual void Tick (float DeltaTime)=0
 
virtual ETickableTickType GetTickableTickType () const
 
virtual bool IsTickable () const
 
virtual bool IsAllowedToTick () const
 
virtual TStatId GetStatId () const =0
 

Static Protected Member Functions

static ENGINE_API void SimpleTickObjects (FTickableStatics &Statics, TFunctionRef< void(FTickableObjectBase *)> TickFunc)
 

Detailed Description

Base class for tickable objects

Member Function Documentation

◆ GetStatId()

virtual TStatId FTickableObjectBase::GetStatId ( ) const
pure virtual

Return the stat id used to track the performance of this object

Implemented in FCrowdTickHelper, FPinDeletionQueue, FNavTestTickHelper, UAISubsystem, UAIPerceptionSystem, UQuartzSubsystem, UARBaseAsyncTaskBlueprintProxy, UAutoDestroySubsystem, UInputDeviceSubsystem, FPhysicsThreadSyncCaller, FStreamableDelegateDelayHelper, FSkinWeightProfileManager, UExternalDataLayerEngineSubsystem, UWorldPartitionSubsystem, UDataflowSimulationManager, ULandscapeSubsystem, FHttpNetworkReplayStreamingFactory, FInMemoryNetworkReplayStreamer, FLocalFileNetworkReplayStreamingFactory, FNullNetworkReplayStreamer, and FSlateRHIResourceManager.

◆ GetTickableTickType()

virtual ETickableTickType FTickableObjectBase::GetTickableTickType ( ) const
inlinevirtual

Virtual that can be overloaded by the inheriting class and is called before first tick. It is used to determine whether an object can possibly tick, and if not, it will not get added to the tickable objects array. If the tickable tick type is Conditional then the virtual IsTickable will be called to determine whether to tick the object on each given frame.

Returns
an enum defining the rules for ticking this object.

Reimplemented in UAISubsystem, UAutoDestroySubsystem, UInputDeviceSubsystem, FStreamableDelegateDelayHelper, UTickableWorldSubsystem, UExternalDataLayerEngineSubsystem, UWorldPartitionSubsystem, UDataflowSimulationManager, ULandscapeSubsystem, FHttpNetworkReplayStreamingFactory, FInMemoryNetworkReplayStreamer, FLocalFileNetworkReplayStreamingFactory, FNullNetworkReplayStreamer, and FSlateRHIResourceManager.

◆ IsAllowedToTick()

virtual bool FTickableObjectBase::IsAllowedToTick ( ) const
inlinevirtual

Function called before IsTickable, used to change rules without breaking existing API. This was used to allow checking for tickable safety before calling GetTickableGameObjectWorld.

Returns
true if object is allowed to be ticked, false otherwise.

Reimplemented in UTickableWorldSubsystem.

◆ IsTickable()

virtual bool FTickableObjectBase::IsTickable ( ) const
inlinevirtual

Virtual that can be overloaded by the inheriting class. It is used to determine whether an object should be conditionally ticked.

Returns
true if object is ready to be ticked, false otherwise.

Reimplemented in FCrowdTickHelper, FNavTestTickHelper, UQuartzSubsystem, UARBaseAsyncTaskBlueprintProxy, UInputDeviceSubsystem, FPinDeletionQueue, FSkinWeightProfileManager, and UExternalDataLayerEngineSubsystem.

◆ SimpleTickObjects()

void FTickableObjectBase::SimpleTickObjects ( FTickableStatics &  Statics,
TFunctionRef< void(FTickableObjectBase *)>  TickFunc 
)
staticprotected

Perform a simple tick using a class-specific statics struct and a function ref

◆ Tick()

virtual void FTickableObjectBase::Tick ( float  DeltaTime)
pure virtual

Pure virtual that must be overloaded by the inheriting class. It will be called at different times in the frame depending on the subclass.

Parameters
DeltaTimeGame time passed since the last call.

Implemented in UWorldPartitionSubsystem, FInMemoryNetworkReplayStreamer, FNullNetworkReplayStreamer, FSlateRHIResourceManager, FCrowdTickHelper, FNavTestTickHelper, UAISubsystem, UAIPerceptionSystem, UQuartzSubsystem, UARBaseAsyncTaskBlueprintProxy, UAutoDestroySubsystem, FPinDeletionQueue, FPhysicsThreadSyncCaller, FStreamableDelegateDelayHelper, FSkinWeightProfileManager, UTickableWorldSubsystem, UExternalDataLayerEngineSubsystem, UDataflowSimulationManager, ULandscapeSubsystem, FHttpNetworkReplayStreamingFactory, FLocalFileNetworkReplayStreamingFactory, and UInputDeviceSubsystem.

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