Document: pointerlockerror event

{{APIRef("Pointer Lock API")}}

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 methods like {{domxref("EventTarget.addEventListener", "addEventListener()")}}, or set an event handler property.

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

onpointerlockerror = (event) => { }

Event type

A generic {{domxref("Event")}}.

Examples

Using addEventListener():

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

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

Using the onpointerlockerror event handler property:

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

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• Using Pointer Lock API