FTickableGameObject

This class provides an easy way to register gamethread-only tickable objects.

API > API/Runtime > API/Runtime/Engine

This class provides an easy way to register gamethread-only tickable objects. It is an abstract base class requiring you to implement the Tick() and GetStatId() methods. It is intended to be used for simple objects that cannot easily use other methods for ticking. It can optionally also be ticked in the Editor, allowing for an object that both ticks during edit time and at runtime.

NOTE: Do not use this class with UObjects unless you add explicit code to start and stop ticking. To do this, construct with ETickableTickType::Never and call SetTickableTickType to enable ticking later. Ticking cannot be safely started until after object construction finishes, and should be set back to Never in BeginDestroy or earlier. UObjects are often created and destroyed on background threads so it is not safe to control ticking from the constructor/destructor.

   
Name FTickableGameObject
Type class
Header File /Engine/Source/Runtime/Engine/Public/Tickable.h
Include Path #include "Tickable.h"

Syntax

class FTickableGameObject : public FTickableObjectBase

Inheritance Hierarchy

Derived Classes

FTickableGameObject derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
Tickable objects cannot be copied safely due to the auto registration Tickable.h  
  Tickable.h  

FTickableGameObject ( ETickableTickType StartingTickType
)

 Registers this instance with the static array of tickable objects, if it can ever tick. Tickable.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FTickableGameObject()

 Removes this instance from the static array of tickable objects. Tickable.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void SetTickableTickType ( ETickableTickType NewTickType
)

 Call to modify the tickable type of this instance. Tickable.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers
Used to determine the specific world this object is associated with. Tickable.h  

virtual bool IsTickableInEditor ()

 Used to determine whether the object should be ticked in the editor when there is no gameplay world. Tickable.h  

virtual bool IsTickableWhenPaused ()

 Used to determine if an object should be ticked when the game is paused. Tickable.h  

Static

Name Remarks Include Path Unreal Specifiers

static FTickableStatics & GetStatics()

 Returns the tracking struct for this type Tickable.h  

static void TickObjects ( UWorld* World,
ELevelTick LevelTickType,
bool bIsPaused,
float DeltaSeconds
)

 Tick all FTickableGameObject instances that match the parameters. Tickable.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Tickable.h  
  Tickable.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page