Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

> Unreal Engine API Reference > Runtime > Engine > Engine > FTickFunction

Light Theme

Dark Theme

FTickFunction

Abstract Base class for all tick functions.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FTickFunction

	FActorComponentTickFunction
	FActorTickFunction
	FCharacterMovementComponentPostPhysicsTickFunction
	FCharacterMovementComponentPrePhysicsTickFunction
	FEndPhysicsTickFunction
	FMassProcessingPhase
	FNiagaraWorldManagerTickFunction
	FParticleSystemWorldManagerTickFunction
	FSkeletalMeshComponentClothTickFunction
	FSkeletalMeshComponentEndPhysicsTickFunction
	FSkinWeightProfileManagerTickFunction
	FStartPhysicsTickFunction
	FTickAnimationSharingFunction

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

		Name	Description
	uint8: 1	bAllowTickOnDedicatedServer	If we allow this tick to run on a dedicated server
	uint8: 1	bCanEverTick	If false, this tick function will never be registered and will never tick.
	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.
	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"
	uint8: 1	bStartWithTickEnabled	If true, this tick function will start enabled, but can be disabled later on.
	uint8: 1	bTickEvenWhenPaused	Bool indicating that this function should execute even if the game is paused.
	TEnumAsByte< en...	EndTickGroup	Defines the tick group that this tick function must finish in.
	TEnumAsByte< en...	TickGroup	Defines the minimum tick group for this tick function.
	float	TickInterval	The frequency in seconds at which this tick function will be executed.

Constructors

	Name	Description
	FTickFunction()	Default constructor, intitalizes to reasonable defaults

Destructors

	Name	Description
	~FTickFunction()	Destructor, unregisters the tick function

Functions

		Name	Description
	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
	TEnumAsByte<...	GetActualEndTickGroup()	Gets the action tick group that this function will be required to end in.
	TEnumAsByte<...	GetActualTickGroup()	Gets the action tick group that this function will be elligible to start in.
	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.
	float	GetLastTickGameTime()
	TArray< stru...	GetPrerequisites()
	const TArray...	GetPrerequisites()
	bool	IsCompletionHandleValid()	Returns whether it is valid to access this tick function's completion handle
	bool	IsTickFunctionEnabled()	Returns whether the tick function is currently enabled
	bool	IsTickFunctionRegistered()	See if the tick function is currently registered
	void	RegisterTickFunction ( ULevel* Level )	Adds the tick function to the master list of tick functions.
	void	RemovePrerequisite ( UObject* TargetObject, FTickFunction& TargetTickFunction )	Removes a prerequisite that was previously added.
	void	SetPriorityIncludingPrerequisites ( bool bInHighPriority )	Sets this function to hipri and all prerequisites recursively
	void	SetTickFunctionEnable ( bool bInEnabled )	Enables or disables this tick function.
	void	UnRegisterTickFunction()	Removes the tick function from the master list of tick functions.
	void	UpdateTickIntervalAndCoolDown ( float NewTickInterval )	Update tick interval in the system and overwrite the current cooldown if any.

Enums

	Name	Description
	ETickState