RealDocs

UKismetSystemLibrary::K2_InvalidateTimerHandle

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

Description

Resets a timer handle variable to its invalid default state and returns it for convenience. Does not clear or otherwise affect any timer the handle previously referenced.

Caveats & Gotchas

  • This only clears the local FTimerHandle variable — the underlying timer, if still set, keeps running in the timer manager. Call Clear Timer by Handle (or Clear and Invalidate Timer by Handle) first if you actually want to stop it.
  • Because Handle is passed by reference, this must be wired directly to a variable pin; you cannot invalidate the return value of another node in the same call.

Signature

static FTimerHandle K2_InvalidateTimerHandle(UPARAM(ref) FTimerHandle& Handle);

Parameters

Name Type Description Default
Handle FTimerHandle& The timer handle variable to invalidate, passed by reference so the caller's variable is reset in place.

Return Type

FTimerHandle

Example

Reset a handle variable after manual cleanup (Blueprint) Blueprint
Event graph: after calling 'Clear Timer by Handle' on MyTimerHandle, follow up with 'Invalidate Timer Handle' on the same variable so 'Is Valid Timer Handle' correctly reports false afterward; or use 'Clear and Invalidate Timer by Handle' to do both in one 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.