cancellableEvent.preventDefault: Difference between revisions

Latest revision as of 20:36, 19 November 2022

Method Server and Client Online and Offline

Available since Server 1.0.0, Client 1.0.0

void cancellableEvent.preventDefault(void)

The cancellableEvent.preventDefault method is used to prevent the default action for the current event which is triggering.

Parameters

void	This method doesn't take any parameters.

Return

void	This method doesn't return a value.

Types

Shared CancellableEvent

Notes

See also: event.isDefaultPrevented.

Examples

Example 1 - JavaScript - Client-Side:

addEventHandler('onPedInflictDamage', function(event, ped, responsibleEntity, weapon, loss, pedPiece)
{
    // Prevent the ped from being damaged.
    event.preventDefault();
});

Compatibility

There isn't any compatibility information for this method.

@@ Line 1: / Line 1: @@
-{{ScriptItem
+{{ScriptItem2
-|endpoint = shared
+|name = preventDefault
+|side = shared
 |type = method
-|class = Event
+|class = CancellableEvent
-|name = preventDefault
+|games = iii vc sa iv
-|parameters = void
+|desc = prevent the default action for the current event which is triggering
-|return1 = void
+|return = void
-|returnFail1 = void
+|freturn = void
-|usage = prevent the default action for the event trigger occurrence
+|note = See also: [[event.isDefaultPrevented|event.isDefaultPrevented]]
-|notes = See also: [[event.isDefaultPrevented|event.isDefaultPrevented]]
+|exampleJSCS = addEventHandler('onPedInflictDamage', function(event, ped, responsibleEntity, weapon, loss, pedPiece)
+{
+	// Prevent the ped from being damaged.
+	event.preventDefault();
+});
 }}