cancelEvent

Cancela o evento em execução.

Sintaxe

bool cancelEvent ( [ bool cancelar = true, string motivo = "" ] )

Parâmetros

Nome	Tipo	Padrão	Descrição
cancelar	bool	true	No servidor, false não faz nada — não desfaz um cancelamento já feito. O cliente ignora este argumento: lá, cancelEvent(false) também cancela.
motivo	string	""	Texto recuperável com getCancelReason. No cliente, só é aceito quando é uma string.

Retorno

Sempre true.

Cancelar não interrompe os demais manipuladores: todos ainda rodam, e cada um pode consultar wasEventCancelled. O que muda é o valor devolvido por triggerEvent e, nos eventos internos que aceitam cancelamento, a ação que o servidor faria em seguida.

Exemplo

addEventHandler("onPlayerChat", root, function(mensagem)
    if mensagem:find("palavrão") then
        cancelEvent(true, "linguagem imprópria")
    end
end)

Veja também

• addEvent — Cria um evento novo, para que ele possa ser disparado com triggerEvent.
• addEventHandler — Registra uma função para rodar quando um evento dispara.
• 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.
• 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.