This function is used to stop the automatic internal handling of events event.

Note

Not every event can be cancelled, so make sure the event is cancellable according to the documentation.

Client Syntax

​bool cancelEvent ( )

Returns

• bool: result

Always returns true.

Server Syntax

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

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

• cancel (default: true): True to cancel, false to uncancel.
• reason (default: ""): The reason for cancelling the event.

Returns

• bool: result

Always returns true.

Code Examples

Example 1 Example 2

client

This example prevents any damage to a player clientside by making cancelEvent an event handler for the onClientPlayerDamage event.

function onClientPlayerDamage()
  cancelEvent()
end
addEventHandler("onClientPlayerDamage", root, onClientPlayerDamage)

server

This example stops the player from entering a vehicle.

function onVehicleStartEnter()
    cancelEvent()
end
addEventHandler("onVehicleStartEnter", root, onVehicleStartEnter)

See Also

Event Functions

• addEvent
• addEventHandler
• cancelEvent
• cancelLatentEvent
• getCancelReason
• getEventHandlers
• getLatentEventHandles
• getLatentEventStatus
• removeEventHandler
• triggerClientEvent
• triggerEvent
• triggerLatentClientEvent
• triggerLatentServerEvent
• triggerServerEvent
• wasEventCancelled

Reference

• Scripting Functions