setTimer

Agenda uma função para executar depois de um intervalo.

Sintaxe

timer setTimer ( function funcao, number intervalo [, number vezes = 1, ... ] )

Parâmetros

Nome	Tipo	Padrão	Descrição
funcao	function	—	Função a executar.
intervalo	number	—	Intervalo em milissegundos.
vezes	number	1	Quantas vezes executar. 0 repete para sempre. Obrigatório no cliente, como no MTA — omiti-lo faz a chamada falhar.
...	any	—	Argumentos extras repassados à função a cada execução.

Retorno

O handle timer, ou false em caso de erro.

Nota

No servidor o intervalo mínimo é 50 ms. Valores menores são elevados para 50 automaticamente, exceto 0, que é mantido. O cliente não tem mínimo.

No cliente, como no MTA, os argumentos extras são copiados quando o timer é criado e de novo a cada execução: tabelas são copiadas sem a metatable, e funções e corrotinas viram nil. Enquanto a função executa, o global sourceTimer guarda o timer que a disparou. O servidor repassa os próprios valores.

Exemplo

-- uma vez, depois de 5 segundos
setTimer(function()
    outputDebugString("passaram 5 segundos")
end, 5000, 1)

-- a cada 2 segundos, para sempre
setTimer(function()
    outputDebugString("tick")
end, 2000, 0)

-- repassando argumentos
setTimer(function(nome, pontos)
    outputDebugString(nome .. " tem " .. pontos)
end, 1000, 3, "Gabriel", 10)

Veja também

• 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.
• setTimerPaused — Pausa ou retoma um timer.
• isTimerPaused — Verifica se um timer está pausado.
• getTimers — Lista os timers do resource.