SWidget::RegisterActiveTimer

Navigation

API > API/Runtime > API/Runtime/SlateCore > API/Runtime/SlateCore/SWidget

Description

Registers an "active timer" delegate that will execute at some regular interval. TickFunction will not be called until the specified interval has elapsed once. A widget can register as many delegates as it needs. Be careful when registering to avoid duplicate active timers.

An active timer can be UnRegistered in one of three ways:

Call UnRegisterActiveTimer using the active timer handle that is returned here.

Have your delegate return EActiveTimerReturnType::Stop.

Destroying the widgetActive Timers

Slate may go to sleep when there is no user interaction for some time to save power. However, some UI elements may need to "drive" the UI even when the user is not providing any input (ie, animations, viewport rendering, async polling, etc). A widget notifies Slate of this by registering an "Active Timer" that is executed at a specified frequency to drive the UI. In this way, slate can go to sleep when there is no input and no active timer needs to fire. When any active timer needs to fire, all of Slate will do a Tick and Paint pass.

TSharedRef < FActiveTimerHandle > RegisterActiveTimer  
(  
    float TickPeriod,  
    FWidgetActiveTimerDelegate TickFunction  
)  
Copy full snippet

TSharedRef < FActiveTimerHandle > RegisterActiveTimer (     float TickPeriod,     FWidgetActiveTimerDelegate TickFunction )