RealDocs

UKismetSystemLibrary::K2_ClearTimerHandle

function Engine Blueprint Deprecated Since 4.24
Deprecated: Use Clear and Invalidate Timer by Handle. Note: you no longer need to reset your handle yourself after switching to the new function.
#include "Kismet/KismetSystemLibrary.h"
Access: public Specifiers: staticUFUNCTIONBlueprintCallable

Description

Stops a set timer identified by its handle. This is the deprecated 'by Handle' node that predates the invalidating version.

Caveats & Gotchas

  • • Deprecated in favor of Clear and Invalidate Timer by Handle — because Handle is passed by value here, the caller's own handle variable still reports as valid afterward and must be invalidated separately.
  • • Safe to call on an already-cleared or never-set handle; it is a silent no-op rather than an error.

Signature

static void K2_ClearTimerHandle(const UObject* WorldContextObject, FTimerHandle Handle);

Parameters

Name Type Description Default
WorldContextObject const UObject* Supplied automatically by the Blueprint compiler to resolve the owning world's timer manager; hidden from the node's visible pins. —
Handle FTimerHandle The handle of the timer to clear. Passed by value, so the caller's own handle variable is left untouched. —

Return Type

void

Example

Stop a stored timer (Blueprint) Blueprint
Event graph: call 'Clear Timer by Handle' with the stored MyTimerHandle when a state ends; prefer 'Clear and Invalidate Timer by Handle' in new graphs so the variable is reset in the same call.

Version History

Introduced in: 4.24

Version Status Notes
5.6 stable —

Feedback

Was this helpful?

Suggest an edit

Select a field above to begin editing.