setTimerPaused

Pausa ou retoma um timer.

Sintaxe

bool setTimerPaused ( timer oTimer, bool pausado )

Ao pausar, o tempo que faltava é guardado; ao retomar, a contagem recomeça a partir dele. Pausar um timer já pausado não faz nada e ainda assim devolve true.

Retorno

true em caso de sucesso. No servidor um handle inválido, ou um pausado que não seja booleano, devolve false com um aviso; no cliente os dois casos levantam um erro (Bad argument @ 'setTimerPaused' [...]) que interrompe o código chamador.

Exemplo

setTimerPaused(meuTimer, true)    -- pausa
setTimerPaused(meuTimer, false)   -- retoma de onde parou

Veja também

• setTimer — Agenda uma função para executar depois de um intervalo.
• killTimer — Cancela e remove um timer.
• isTimer — Verifica se um handle ainda aponta para um timer ativo.
• getTimerDetails — Devolve o estado atual de um timer.
• resetTimer — Reinicia a contagem a partir de agora.
• isTimerPaused — Verifica se um timer está pausado.
• getTimers — Lista os timers do resource.