FActiveTimerHandle Class Reference

#include <ActiveTimerHandle.h>

Public Member Functions
	FActiveTimerHandle (float InExecutionPeriod, FWidgetActiveTimerDelegate InTimerFunction, double InNextExecutionTime)
bool	IsPendingExecution () const
bool	UpdateExecutionPendingState (double CurrentTime)
EActiveTimerReturnType	ExecuteIfPending (double CurrentTime, float DeltaTime)

Detailed Description

Stores info about an active timer delegate for a widget.

Constructor & Destructor Documentation

FActiveTimerHandle()

FActiveTimerHandle::FActiveTimerHandle	(	float	InExecutionPeriod,
		FWidgetActiveTimerDelegate	InTimerFunction,
		double	InNextExecutionTime
	)

Public ctor that initializes a new active timer handle. Not intended to be called by user code.

Member Function Documentation

ExecuteIfPending()

EActiveTimerReturnType FActiveTimerHandle::ExecuteIfPending	(	double	CurrentTime,
		float	DeltaTime
	)

Execute the bound delegate if the active timer is bPendingExecution.

Returns

EActiveTimerReturnType::Stop if the handle should be auto-unregistered (either the TimerFunction indicated this or the TimerFunction is unbound).

IsPendingExecution()

bool FActiveTimerHandle::IsPendingExecution

(

)

const

Returns

True if the active timer is pending execution

UpdateExecutionPendingState()

bool FActiveTimerHandle::UpdateExecutionPendingState

(

double

CurrentTime

)

Updates the pending state of the active timer based on the current time

Returns

True if the active timer is pending execution

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/SlateCore/Private/Application/ActiveTimerHandle.h
• Engine/Source/Runtime/SlateCore/Private/Application/ActiveTimerHandle.cpp