UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
FActorComponentTickFunction Struct Reference

#include <EngineBaseTypes.h>

+ Inheritance diagram for FActorComponentTickFunction:

Public Member Functions

virtual ENGINE_API void ExecuteTick (float DeltaTime, ELevelTick TickType, ENamedThreads::Type CurrentThread, const FGraphEventRef &MyCompletionGraphEvent) override
 
virtual ENGINE_API FString DiagnosticMessage () override
 
virtual ENGINE_API FName DiagnosticContext (bool bDetailed) override
 
- Public Member Functions inherited from FTickFunction
 UPROPERTY (EditDefaultsOnly, Category="Tick", meta=(DisplayName="Tick Interval (secs)")) float TickInterval
 
ENGINE_API FTickFunction ()
 
virtual ENGINE_API ~FTickFunction ()
 
ENGINE_API void RegisterTickFunction (class ULevel *Level)
 
ENGINE_API void UnRegisterTickFunction ()
 
bool IsTickFunctionRegistered () const
 
ENGINE_API void SetTickFunctionEnable (bool bInEnabled)
 
bool IsTickFunctionEnabled () const
 
ENGINE_API void UpdateTickIntervalAndCoolDown (float NewTickInterval)
 
ENGINE_API bool IsCompletionHandleValid () const
 
ENGINE_API FGraphEventRef GetCompletionHandle () const
 
virtual ENGINE_API bool CanDispatchManually () const
 
virtual ENGINE_API bool DispatchManually ()
 
TEnumAsByte< enum ETickingGroup > GetActualTickGroup () const
 
TEnumAsByte< enum ETickingGroup > GetActualEndTickGroup () const
 
ENGINE_API void AddPrerequisite (UObject *TargetObject, struct FTickFunction &TargetTickFunction)
 
ENGINE_API void RemovePrerequisite (UObject *TargetObject, struct FTickFunction &TargetTickFunction)
 
ENGINE_API void SetPriorityIncludingPrerequisites (bool bInHighPriority)
 
TArray< struct FTickPrerequisite > & GetPrerequisites ()
 
const TArray< struct FTickPrerequisite > & GetPrerequisites () const
 
float GetLastTickGameTime () const
 
ENGINE_API void ExecuteNestedTick (float DeltaTime, ELevelTick TickType, ENamedThreads::Type CurrentThread, const FGraphEventRef &MyCompletionGraphEvent)
 
ENGINE_API float CalculateDeltaTime (float DeltaTime, const class UWorld *TickingWorld)
 
ENGINE_API void LogTickFunction (ENamedThreads::Type CurrentThread, bool bLogPrerequisites, int32 Indent=0)
 
ENGINE_API void ShowPrerequistes (int32 Indent=1)
 
ENGINE_API void ClearTaskInformation ()
 
virtual void virtual FString return TEXT ("DiagnosticMessage() not implemented")
 
virtual void ForEachNestedTick (TFunctionRef< void(FTickFunction &)> InFunc) const
 
FTickFunction & operator= (const FTickFunction &)=delete
 

Static Public Member Functions

template<typename ExecuteTickLambda >
static void ExecuteTickHelper (UActorComponent *Target, bool bTickInEditor, float DeltaTime, ELevelTick TickType, const ExecuteTickLambda &ExecuteTickFunc)
 

Public Attributes

class UActorComponent * Target
 
- Public Attributes inherited from FTickFunction
TEnumAsByte< enum ETickingGroup > TickGroup
 
TEnumAsByte< enum ETickingGroup > EndTickGroup
 
uint8 bTickEvenWhenPaused:1
 
uint8 bCanEverTick:1
 
uint8 bStartWithTickEnabled:1
 
uint8 bAllowTickOnDedicatedServer:1
 
uint8 bAllowTickBatching:1
 
uint8 bHighPriority:1
 
uint8 bRunOnAnyThread:1
 
uint8 bRunTransactionally:1
 
uint8 bDispatchManually: 1
 

Detailed Description

Tick function that calls UActorComponent::ConditionalTick

Member Function Documentation

◆ DiagnosticContext()

FName FActorComponentTickFunction::DiagnosticContext ( bool  bDetailed)
overridevirtual

Function to give a 'context' for this tick, used for grouped active tick reporting

Reimplemented from FTickFunction.

◆ DiagnosticMessage()

FString FActorComponentTickFunction::DiagnosticMessage ( )
overridevirtual

Abstract function to describe this tick. Used to print messages about illegal cycles in the dependency graph

Reimplemented from FTickFunction.

◆ ExecuteTick()

void FActorComponentTickFunction::ExecuteTick ( float  DeltaTime,
ELevelTick  TickType,
ENamedThreads::Type  CurrentThread,
const FGraphEventRef &  MyCompletionGraphEvent 
)
overridevirtual

Abstract function actually execute the tick.

Parameters
DeltaTime- frame time to advance, in seconds
TickType- kind of tick for this frame
CurrentThread- thread we are executing on, useful to pass along as new tasks are created
MyCompletionGraphEvent- completion event for this task. Useful for holding the completetion of this task until certain child tasks are complete.

Reimplemented from FTickFunction.

◆ ExecuteTickHelper()

template<typename ExecuteTickLambda >
void FActorComponentTickFunction::ExecuteTickHelper ( UActorComponent *  Target,
bool  bTickInEditor,
float  DeltaTime,
ELevelTick  TickType,
const ExecuteTickLambda &  ExecuteTickFunc 
)
static

Conditionally calls ExecuteTickFunc if registered and a bunch of other criteria are met

Parameters
Target- the actor component we are ticking
bTickInEditor- whether the target wants to tick in the editor
DeltaTime- The time since the last tick.
TickType- Type of tick that we are running
ExecuteTickFunc- the lambda that ultimately calls tick on the actor component

Helper function for executing component tick functions using the same conditions as FActorTickFunction

Member Data Documentation

◆ Target

class UActorComponent* FActorComponentTickFunction::Target

AActor component that is the target of this tick

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