UKismetSystemLibrary::K2_ClearAndInvalidateTimerHandle
#include "Kismet/KismetSystemLibrary.h"
Access: public
Specifiers: staticUFUNCTIONBlueprintCallable
Description
Stops a set timer identified by its handle and resets the handle variable to invalid in one step. This is the recommended replacement for Clear Timer by Handle.
Caveats & Gotchas
- • Because Handle is passed by reference, it must be wired to an actual variable pin — you cannot feed it the output of another node directly.
- • Safe to call on an already-cleared, never-set, or invalid handle; it simply leaves the (already invalid) handle unchanged rather than erroring.
Signature
static void K2_ClearAndInvalidateTimerHandle(const UObject* WorldContextObject, UPARAM(ref) 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 reference so the caller's variable is reset to invalid in the same call. | — |
Return Type
void Example
Stop and reset a stored timer handle (Blueprint) Blueprint
Event graph: on EndPlay or state exit, call 'Clear and Invalidate Timer by Handle' with the actor's MyTimerHandle variable so both the running timer stops and Is Valid Timer Handle immediately reports false.Tags
Version History
Introduced in: 4.24
| Version | Status | Notes |
|---|---|---|
| 5.6 | stable | — |
Feedback
Was this helpful?