Navigation
API > API/Runtime > API/Runtime/Engine
Inheritance Hierarchy
- FNoncopyable
- FTimerManager
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Public/TimerManager.h |
| Include | #include "TimerManager.h" |
Syntax
class FTimerManager : public FNoncopyable
Remarks
Class to globally manage timers.
Constructors
| Type | Name | Description | |
|---|---|---|---|
FTimerManager
(
UGameInstance* GameInstance |
Timer API |
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | ClearAllTimersForObject
(
void const* Object |
Clears all timers that are bound to functions on the given object. | |
| void | ClearTimer
(
FTimerHandle& InHandle |
Clears a previously set timer, identical to calling SetTimer() with a <= 0.f rate. | |
| FTimerData * | FindTimer
(
FTimerHandle const& InHandle |
||
| FTimerData const * | FindTimer
(
FTimerHandle const& InHandle |
These should be private, but need to be protected so IMPLEMENT_GET_PROTECTED_FUNC works for testing. | |
| FTimerHandle | GenerateHandle
(
int32 Index |
This should be private, but needs to be public for testing. | |
| TStatId | GetStatId () |
||
| float | GetTimerElapsed
(
FTimerHandle InHandle |
Gets the current elapsed time for the specified timer. | |
| float | GetTimerRate
(
FTimerHandle InHandle |
Gets the current rate (time between activations) for the specified timer. | |
| float | GetTimerRemaining
(
FTimerHandle InHandle |
Gets the time remaining before the specified timer is called | |
| bool | |||
| bool | IsTimerActive
(
FTimerHandle InHandle |
Returns true if the specified timer exists and is not paused | |
| bool | IsTimerPaused
(
FTimerHandle InHandle |
Returns true if the specified timer exists and is paused | |
| bool | IsTimerPending
(
FTimerHandle InHandle |
Returns true if the specified timer exists and is pending | |
| FTimerHandle | K2_FindDynamicTimerHandle
(
FTimerDynamicDelegate InDynamicDelegate |
Finds a handle to a timer bound to a particular dynamic delegate. | |
| void | ListTimers () |
Debug command to output info on all timers currently set to the log. | |
| void | OnCrash () |
Called from crash handler to provide more debug information. | |
| void | PauseTimer
(
FTimerHandle InHandle |
Pauses a previously set timer. | |
| void | SetTimer
(
FTimerHandle& InOutHandle, |
||
| void | SetTimer
(
FTimerHandle& InOutHandle, |
Version that takes any generic delegate. | |
| void | SetTimer
(
FTimerHandle& InOutHandle, |
Version that takes a dynamic delegate (e.g. for UFunctions). | |
| void | SetTimer
(
FTimerHandle& InOutHandle, |
Version that takes a TFunction | |
| void | SetTimer
(
FTimerHandle& InOutHandle, |
Sets a timer to call the given native function at a set interval. | |
| void | SetTimer
(
FTimerHandle& InOutHandle, |
||
| FTimerHandle | SetTimerForNextTick
(
UserClass* inObj, |
Sets a timer to call the given native function on the next tick. | |
| FTimerHandle | SetTimerForNextTick
(
FTimerDelegate const& InDelegate |
Version that takes any generic delegate. | |
| FTimerHandle | SetTimerForNextTick
(
FTimerDynamicDelegate const& InDynDelegate |
Version that takes a dynamic delegate (e.g. for UFunctions). | |
| FTimerHandle | SetTimerForNextTick
(
TFunction< void(void)>&& Callback |
Version that takes a TFunction | |
| FTimerHandle | SetTimerForNextTick
(
UserClass* inObj, |
||
| void | Tick
(
float DeltaTime |
||
| bool | TimerExists
(
FTimerHandle InHandle |
Returns true if the specified timer exists | |
| void | UnPauseTimer
(
FTimerHandle InHandle |
Unpauses a previously set timer |
Constants
| Name | Description |
|---|---|
| LastAssignedSerialNumber | The last serial number we assigned from this timer manager |