pyux.stop_timer

Stops a periodic timer. The timer must have been set up by set_timer_handler, otherwise a lua error is raised.

pyux.stop_timer(timer)

Parameters

	Type	Description
timer	timer_token	Identifier of the timer that was returned by set_timer_handler

Note:

After this call, no more timer events will be dispatched to the timer handler until the timer is potentially restarted.

For backwards compatibility (deprecated): if nil is passed instead of timer_token, any one registered timer is stopped.

Version requirements

This function is available in V26 and above.

See also

pyux, set_timer_handler, start_timer, stop_animation