FTickFunction

Inheritance Hierarchy

Syntax

struct FTickFunction

Remarks

Abstract Base class for all tick functions.

Variables

Name Description

Protected variable

TEnumAsByte < en...

 

ActualEndTickGroup

Internal data that indicates the tick group we actually started in (it may have been delayed due to prerequisites)

Protected variable

TEnumAsByte < en...

 

ActualStartTickGroup

Internal data that indicates the tick group we actually started in (it may have been delayed due to prerequisites)

Public variable

uint8 : 1

 

bAllowTickOnDedicatedServer

If we allow this tick to run on a dedicated server

Public variable

uint8 : 1

 

bCanEverTick

If false, this tick function will never be registered and will never tick.

Public variable

uint8 : 1

 

bHighPriority

Run this tick first within the tick group, presumably to start async tasks that must be completed with this tick group, hiding the latency.

Public variable

uint8 : 1

 

bRunOnAnyThread

If false, this tick will run on the game thread, otherwise it will run on any thread in parallel with the game thread and in parallel with other "async ticks"

Public variable

uint8 : 1

 

bStartWithTickEnabled

If true, this tick function will start enabled, but can be disabled later on.

Public variable

uint8 : 1

 

bTickEvenWhenPaused

Bool indicating that this function should execute even if the game is paused.

Public variable

TEnumAsByte < en...

 

EndTickGroup

Defines the tick group that this tick function must finish in.

Public variable

TEnumAsByte < en...

 

TickGroup

The following UPROPERTYs are for configuration and inherited from the CDO/archetype/blueprint etc.

Public variable

float

 

TickInterval

The frequency in seconds at which this tick function will be executed.

Public variable

FTickTaskLevel ...

 

TickTaskLevel

Back pointer to the FTickTaskLevel containing this tick function if it is registered

Constructors

Name Description

Public function

FTickFunction()

Default constructor, intitalizes to reasonable defaults

Destructors

Name Description

Public function Virtual

~FTickFunction()

Destructor, unregisters the tick function

Functions

Name Description

Public function

void

 

AddPrerequisite

(
    UObject * TargetObject,
    FTickFunction & TargetTickFunction
)

Adds a tick function to the list of prerequisites...in other words, adds the requirement that TargetTickFunction is called before this tick function is

Public function

TEnumAsByte <...

 

GetActualEndTickGroup()

Gets the action tick group that this function will be required to end in.

Public function

TEnumAsByte <...

 

GetActualTickGroup()

Gets the action tick group that this function will be elligible to start in.

Public function

FGraphEventR ...

 

GetCompletionHandle()

Gets the current completion handle of this tick function, so it can be delayed until a later point when some additional tasks have been completed.

Public function

TArray < stru...

 

GetPrerequisites()

A reference to prerequisites for this tick function.

Public function

const TArray ...

 

GetPrerequisites()

A reference to prerequisites for this tick function (const).

Public function

bool

 

IsCompletionHandleValid()

Returns whether it is valid to access this tick function's completion handle

Public function

bool

 

IsTickFunctionEnabled()

Returns whether the tick function is currently enabled

Public function

bool

 

IsTickFunctionRegistered()

See if the tick function is currently registered

Public function

void

 

RegisterTickFunction

(
    ULevel * Level
)

Adds the tick function to the master list of tick functions.

Public function

void

 

RemovePrerequisite

(
    UObject * TargetObject,
    FTickFunction & TargetTickFunction
)

Removes a prerequisite that was previously added.

Public function

void

 

SetPriorityIncludingPrerequisites

(
    bool bInHighPriority
)

Sets this function to hipri and all prerequisites recursively

Public function

void

 

SetTickFunctionEnable

(
    bool bInEnabled
)

Enables or disables this tick function.

Public function

void

 

UnRegisterTickFunction()

Removes the tick function from the master list of tick functions.

Enums

Name

Description

Private enum

ETickState

References

Module

Engine

Header

Runtime/Engine/Classes/Engine/EngineBaseTypes.h