Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

---

This function is used to stop the automatic internal handling of events, for example this can be used to prevent an item being given to a player when they walk over a pickup, by canceling the onPickupUse event.

Syntax

bool cancelEvent ( )

Returns

• bool: value

Always returns true .

Code Examples

Example 1 Example 2

client

This example prevents any damage to a player clientside by makingcancelEventan event handler for theonClientPlayerDamageevent.

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