RealDocs

UKismetSystemLibrary::K2_ClearTimerDelegate

function Engine Blueprint Deprecated Since 4.0
Deprecated: Use Clear Timer by Handle
#include "Kismet/KismetSystemLibrary.h"
Access: public Specifiers: staticUFUNCTIONBlueprintCallable

Description

Clears a timer previously set for the given delegate, stopping it from firing again. Superseded by clearing via FTimerHandle, which is more reliable.

Caveats & Gotchas

  • Marked deprecated in favor of 'Clear Timer by Handle' — clearing by delegate can misbehave if multiple timers were set against equivalent-looking delegates, since matching is done by delegate identity rather than a unique handle.
  • Calling this on a delegate with no active timer is a harmless no-op rather than an error.
  • New projects should capture the FTimerHandle from K2_SetTimerDelegate and use the handle-based clear function instead of this one.

Signature

static void K2_ClearTimerDelegate(UPARAM(DisplayName="Event") FTimerDynamicDelegate Delegate);

Parameters

Name Type Description Default
Delegate FTimerDynamicDelegate The event whose bound timer should be cleared.

Return Type

void

Example

Clear a timer by its bound event (Blueprint) Blueprint
Event graph: Clear Timer by Event node with the same Custom Event reference passed to the earlier Set Timer by Event node.

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.