CancelEvent

This function is used to stop the automatic internal handling of events, for exmaple this can be used to prevent an item being given to a player when they walk over a pickup, by canceling the onPickupPickup event. cancelEvent is not compatible with all events. cancelEvent does not stop further event handlers from being called, as the order of event handlers being called is undefined in many cases. Instead, you can see if the currently active event has been canceled using wasEventCanceled.

The use of cancelEvent outside of an event handler has no effect.

See individual event pages for information on the effect of canceling them, if any.

Syntax

bool cancelEvent ()   

Returns

Always returns true.

Example

This example stops the player huntedPlayer from entering a vehicle:

-- call 'stopVehicleEntry' whenever hunterPlayer is about to enter a vehicle:
addEventHandler ( "onVehicleStartEnter", huntedPlayer, "stopVehicleEntry" )
function stopVehicleEntry ( theplayer, seat, jacked )
   cancelEvent () -- stop the event from occuring
end

See Also

• addEvent
• addEventHandler
• cancelEvent
• cancelLatentEvent
• getEventHandlers
• getLatentEventHandles
• getLatentEventStatus
• removeEventHandler
• triggerEvent
• wasEventCancelled