# cancelEvent (Compartilhado)

> Marca o evento que está rodando como cancelado. O que o cancelamento impede depende do evento.

- **Plataforma**: MY Multiplayer (MYMP)
- **Tipo**: Função Lua
- **Lado**: Compartilhado
- **Categoria**: Eventos
- **URL**: https://wiki.mymp.gg/pt/cancelEvent

## Sintaxe

```lua
bool cancelEvent([bool cancel = true, string reason = ""])
```

## Parâmetros

| Nome | Tipo | Descrição |
| --- | --- | --- |
| `cancel` | `bool` | `true` cancela, `false` desfaz um cancelamento feito por um handler anterior. *(padrão: `true`)* |
| `reason` | `string` | Motivo, lido depois com `getCancelReason`. *(padrão: `""`)* |

## Retorno

`true` se marcou, `false` se não foi chamado dentro de um handler.

Quem disparou o evento vê o resultado: `triggerEvent` devolve `false` para um evento cancelado.

## Exemplo

```lua
local banned = { ["c3f1a2"] = true }

addEventHandler("onPlayerQueue", root, function(accountId)
    if banned[accountId] then
        cancelEvent(true, "banned")
    end
end)
```

### Atenção

Os handlers seguintes do mesmo evento ainda são chamados.

## Veja também

- [wasEventCancelled (Compartilhado)](https://wiki.mymp.gg/pt/wasEventCancelled.md): Diz se o último evento que terminou de rodar neste lado foi cancelado.
- [getCancelReason (Compartilhado)](https://wiki.mymp.gg/pt/getCancelReason.md): Dá o motivo passado a cancelEvent no último evento que terminou de rodar neste lado.
- [triggerEvent (Compartilhado)](https://wiki.mymp.gg/pt/triggerEvent.md): Dispara um evento neste lado, em source. Os handlers do próprio elemento e os de seus ancestrais que propagam são chamados na hora, antes de a função retornar.
