RealDocs

UKismetSystemLibrary::K2_ClearTimer

function Engine Blueprint Since 4.0
#include "Kismet/KismetSystemLibrary.h"
Access: public Specifiers: staticUFUNCTIONBlueprintCallable

Description

Stops a timer previously set with Set Timer by Function Name, identified by the same object and function name pair rather than a handle.

Caveats & Gotchas

  • • If the same Object/FunctionName pair was ever used for more than one timer (e.g. re-set with different parameters), this clears whichever single timer entry the timer manager currently associates with that pair — it cannot target one of several concurrent timers independently the way a handle-based clear can.
  • • Safe to call on a function name that has no active timer; it is a silent no-op rather than an error.

Signature

static void K2_ClearTimer(UObject* Object, FString FunctionName);

Parameters

Name Type Description Default
Object UObject* Object that implements the target function. Defaults to self (the blueprint the node is placed in). —
FunctionName FString Name of the function whose timer should be cleared, matched by string against the object's function table. —

Return Type

void

Example

Cancel a repeating tick on state exit (Blueprint) Blueprint
Event graph: on ending a damage-over-time state, call 'Clear Timer by Function Name' with Object = self, FunctionName = 'ApplyDotTick' to stop further ticks without needing to have stored a handle.

Version History

Introduced in: 4.0

Version Status Notes
5.6 stable —

Feedback

Was this helpful?

Suggest an edit

Select a field above to begin editing.