pyux.start_timer

Starts a periodic timer that triggers timer events. The timer must have been setup by set_timer_handler, otherwise a lua error is raised.

pyux.start_timer(seconds, timer)

Parameters

	Type	Description
seconds	number	Timer interval in seconds. Must be greater than 0.
timer	timer_token	Identifier of the timer that was returned by set_timer_handler

Note:

Starts a timer that periodically invokes the registered timer handler. Note: the timer can only be called when the plugin code is not actively running.

The timer runs until it is stopped by pyux.stop_timer.

Successive timer events may coalesce if the timer period is very short.

For backwards compatibility (deprecated): if no timer_token is passed, any one registered timer is started.

Version requirements

This function is available in V26 and above.

See also

pyux, set_timer_handler, stop_timer