Document: pointerlockerror event

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Want more browser support for this feature? Tell us why.

The pointerlockerror event is fired when locking the pointer failed (for technical reasons or because the permission was denied).

This event is not cancelable and does not bubble.

Syntax

Use the event name in addEventListener():

js
addEventListener("pointerlockerror", (event) => { })

Alternatively, assign to the event handler property of the interface:

js
onpointerlockerror = (event) => { }

Event type

A generic Event.

Examples

Using addEventListener():

js
const para = document.querySelector("p");

document.addEventListener("pointerlockerror", (event) => {
  console.log("Error locking pointer");
});

Using the onpointerlockerror event handler property (but note that this replaces other event listeners added using onpointerlockerror, if any):

js
document.onpointerlockerror = (event) => {
  console.log("Error locking pointer");
};

Specifications

Specification
Pointer Lock 2.0
# pointerlockchange-and-pointerlockerror-events
Pointer Lock 2.0
# dom-document-onpointerlockerror

Browser compatibility

See also