UKismetSystemLibrary::K2_SetTimer

Set a timer to execute delegate.

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Kismet/KismetSystemLibrary.h

Include

#include "Kismet/KismetSystemLibrary.h"

Source

/Engine/Source/Runtime/Engine/Private/KismetSystemLibrary.cpp

Syntax

static FTimerHandle K2_SetTimer
(
    UObject * Object,
    FString FunctionName,
    float Time,
    bool bLooping,
    float InitialStartDelay,
    float InitialStartDelayVariance
)

Remarks

Set a timer to execute delegate. Setting an existing timer will reset that timer with updated parameters.

Returns

The timer handle to pass to other timer functions to manipulate this timer.

Parameters

Parameter

Description

Object

Object that implements the delegate function. Defaults to self (this blueprint)

FunctionName

Delegate function name. Can be a K2 function or a Custom Event.

Time

How long to wait before executing the delegate, in seconds. Setting a timer to <= 0 seconds will clear it if it is set.

bLooping

true to keep executing the delegate every Time seconds, false to execute delegate only once.

InitialStartDelay

Initial delay passed to the timer manager to allow some variance in when the timer starts, in seconds.

InitialStartDelayVariance

Use this to add some variance to when the timer starts in lieu of doing a random range on the InitialStartDelay input, in seconds.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss