getCancelReason

Devolve o motivo passado ao cancelEvent.

Sintaxe

string getCancelReason ( )

Retorno

O motivo passado a cancelEvent para o evento em execução. Quando não há motivo — o evento não foi cancelado, foi cancelado sem motivo ou nenhum evento está rodando —, o servidor devolve uma string vazia e o cliente devolve false.

O motivo pertence ao evento em execução: depois que triggerEvent retorna, ele some. Leia-o num manipulador que rode depois daquele que cancelou, como um de prioridade baixa.

Exemplo

addEventHandler("onLojaComprar", root, function(item)
    if wasEventCancelled() then
        outputDebugString("compra recusada: " .. getCancelReason(), 2)
    end
end, true, "low")   -- prioridade baixa: roda depois dos manipuladores que podem cancelar

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.
• 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.