UKismetSystemLibrary::K2_IsTimerPausedHandle
#include "Kismet/KismetSystemLibrary.h"
Access: public
Specifiers: staticUFUNCTIONBlueprintPure
Description
Returns true only if a timer exists for the given handle and is currently paused via Pause Timer by Handle.
Caveats & Gotchas
- • Returns false for a cleared, never-set, or invalid handle — it does not distinguish 'never paused' from 'doesn't exist', so pair it with Does Timer Exist by Handle if that distinction matters.
- • A timer that finished its last (non-looping) iteration and was never paused also returns false here, not true.
Signature
static bool K2_IsTimerPausedHandle(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 check. | — |
Return Type
bool Example
Toggle a pause/resume button label (Blueprint) Blueprint
Widget graph: on tick or on open, branch on 'Is Timer Paused by Handle' for RoundTimerHandle to set the pause button's text to 'Resume' or 'Pause' accordingly.Tags
Version History
Introduced in: 4.24
| Version | Status | Notes |
|---|---|---|
| 5.6 | stable | — |
Feedback
Was this helpful?