Document: pointerlockchange 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 pointerlockchange event is fired when the pointer is locked/unlocked.
The event handler can use Document.pointerLockElement to determine whether the pointer is locked, and if so, to which element it is locked.
This event is not cancelable and does not bubble.
Syntax
Use the event name in addEventListener():
js
addEventListener("pointerlockchange", (event) => { })
Alternatively, assign to the event handler property of the interface:
js
onpointerlockchange = (event) => { }
Event type
A generic Event.
Examples
Using addEventListener():
js
document.addEventListener("pointerlockchange", (event) => {
if (document.pointerLockElement)
console.log("The pointer is locked to: ", document.pointerLockElement);
else {
console.log("The pointer is not locked");
}
});
Using the onpointerlockchange event handler property (but note that this replaces other event listeners added using onpointerlockchange, if any):
js
document.onpointerlockchange = (event) => {
if (document.pointerLockElement)
console.log("The pointer is locked to: ", document.pointerLockElement);
else {
console.log("The pointer is not locked");
}
};
Specifications
| Specification |
|---|
| Pointer Lock 2.0> # pointerlockchange-and-pointerlockerror-events> |
| Pointer Lock 2.0> # dom-document-onpointerlockchange> |