1. Epic GamesDeveloper
  3. FTickFunction

FTickFunction

Abstract Base class for all tick functions.

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Engine

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Engine/EngineBaseTypes.h
Include #include "Engine/EngineBaseTypes.h"

Syntax

struct FTickFunction

Remarks

Abstract Base class for all tick functions.

Variables

  Type Name Description
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< enum ETickingGroup > EndTickGroup Defines the tick group that this tick function must finish in.
Public variable TEnumAsByte< enum ETickingGroup > TickGroup Defines the minimum tick group for this tick function.
Public variable float TickInterval The frequency in seconds at which this tick function will be executed.

Constructors

  Type Name Description
Public function   Default constructor, intitalizes to reasonable defaults

Destructors

  Type Name Description
Public function Virtual   Destructor, unregisters the tick function

Functions

  Type 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 Const TEnumAsByte< enum ETickingGroup > Gets the action tick group that this function will be required to end in.
Public function Const TEnumAsByte< enum ETickingGroup > Gets the action tick group that this function will be elligible to start in.
Public function Const FGraphEventRef 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 Const float  
Public function TArray< struct FTickPrerequisite > &  
Public function Const const TArray< struct FTickPrerequisite > &  
Public function Const bool Returns whether it is valid to access this tick function's completion handle
Public function Const bool Returns whether the tick function is currently enabled
Public function Const bool See if the tick function is currently registered
Public function void Adds the tick function to the primary 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 Removes the tick function from the primary list of tick functions.
Public function void

UpdateTickIntervalAndCoolDown ( float NewTickInterval
)

 Update tick interval in the system and overwrite the current cooldown if any.

Enums

  Type Name Description
Private enum ETickState    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page