addEventHandler

Registra uma função para rodar quando um evento dispara.

Sintaxe

bool addEventHandler ( string nomeDoEvento, element anexadoA, function manipulador [, bool propagar = true, string prioridade = "normal" ] )

Parâmetros

Nome	Tipo	Padrão	Descrição
nomeDoEvento	string	—	Evento a escutar.
anexadoA	element	—	Ponto da árvore de elementos a escutar.
manipulador	function	—	Função a chamar.
propagar	bool	true	Com false, o manipulador só roda quando anexadoA é o próprio source do evento — eventos vindos dos ancestrais ou dos filhos dele são ignorados.
prioridade	string	"normal"	"low", "normal" ou "high", em maiúsculas ou minúsculas, opcionalmente seguido de um modificador como "high+5" ou "low-1.5". Entre manipuladores no mesmo ponto da árvore, a prioridade mais alta roda primeiro, e o modificador desempata.

Retorno

true se o manipulador foi registrado. Devolve false quando o nome está vazio, quando anexadoA não é um elemento, quando manipulador não é uma função, quando prioridade não é um nível válido ou quando essa mesma função já está presa àquele elemento para aquele evento ('<nome>' with this function is already handled). Todos esses casos registram um aviso.

Os argumentos do evento chegam como parâmetros da sua função, na ordem em que foram passados a triggerEvent.

O evento precisa existir

Um nome que não é nem um evento nativo deste lado nem um criado com addEvent é recusado, em vez de registrar um manipulador que nunca poderia disparar. No servidor a chamada devolve false com o aviso unknown event '<nome>', o que transforma um erro de digitação em uma reclamação imediata. No cliente ela devolve false em silêncio, como também faz com um nome de mais de 100 caracteres — confira o retorno se um manipulador parece nunca rodar.

Registre os seus próprios eventos com addEvent antes de prender manipuladores a eles.

addEventHandler("onPlayerChat", root, function(mensagem)
    outputDebugString(getPlayerName(source) .. ": " .. mensagem)
end)

Todos os manipuladores de um resource são removidos quando ele para — não é preciso limpar nada no onResourceStop. Os manipuladores pertencem ao resource que os registrou: dois resources podem prender, cada um, o seu próprio manipulador no mesmo evento e no mesmo elemento, e a checagem de duplicata acima só olha os seus.

Veja também

• addEvent — Cria um evento novo, para que ele possa ser disparado com triggerEvent.
• removeEventHandler — Desfaz um addEventHandler.
• getEventHandlers — Lista os manipuladores que o seu resource anexou a um elemento.
• triggerEvent — Dispara um evento no lado que o chama.
• cancelEvent — Cancela o evento em execução.
• wasEventCancelled — Diz se um evento foi cancelado — o que está rodando, no servidor; o último que terminou, no cliente.
• getCancelReason — Devolve o motivo passado ao cancelEvent.