Event Cancelation

Canceling Events

To cancel an event, use the CANCEL_EVENT native from within an event handler. This does not stop other event handlers from running.

Example

Lua

AddEventHandler("eventName", function(eventParam1, eventParam2)
    -- Cancelling this event!
    CancelEvent()
end)

EventHandlers["eventName"] += new Action<string, bool>(TargetFunction);

private void TargetFunction(string param1, bool param2)
{
    // Canceling this event!
    CancelEvent();
}

on('eventName', (eventParam1, eventParam2) => {
    // Canceling this event!
    CancelEvent();
});

Checking for event cancelation

To check if the last event you triggered was canceled, use the WAS_EVENT_CANCELED native. This only works for local events.

Example

Lua

TriggerEvent("eventName", eventParam1, eventParam2)

if WasEventCanceled() then
    -- Code that runs if the event was canceled.
end

In Lua, the TriggerEvent() function returns true if the event was canceled, allowing you to also use the following syntax:

Lua

if TriggerEvent("eventName", eventParam1, eventParam2) then
    -- Code that runs if the event was canceled.
end

TriggerEvent("eventName", eventParam1, eventParam2);

if (WasEventCanceled())
{
    // Code that runs if the event was canceled. 
}

emit("eventName", eventParam1, eventParam2);

if (WasEventCanceled()) {
    // Code that runs if the event was canceled. 
}

Last modified August 11, 2024: Add guide for event cancellation (#271) (7a23fbb)