UKismetSystemLibrary::K2_PauseTimerHandle

function Engine Blueprint Since 4.24

#include "Kismet/KismetSystemLibrary.h"

Access: public Specifiers: staticUFUNCTIONBlueprintCallable

Description

Pauses a running timer at its current elapsed time without clearing it, so it can later be resumed from where it left off.

Caveats & Gotchas

• A paused timer still exists in the timer manager (Does Timer Exist by Handle stays true) — use Clear and Invalidate Timer by Handle instead if you actually want to remove it.
• Calling this on a timer that is already paused, or on an invalid/nonexistent handle, is a silent no-op.

Signature

static void K2_PauseTimerHandle(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 pause.	—

Return Type

void

Example

Pause a countdown while a menu is open (Blueprint) Blueprint

Event graph: on OpenPauseMenu, call 'Pause Timer by Handle' with the stored RoundTimerHandle; on ClosePauseMenu, call 'Unpause Timer by Handle' with the same handle to resume from the exact elapsed time.

Version History

Introduced in: 4.24

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?