Phaser API Documentation

  Version: 
<readonly> locked: boolean

Description:

Is this pointer Pointer Locked?

Only a mouse pointer can be locked and it only becomes locked when requested via the browsers Pointer Lock API.

You can request this by calling the this.input.mouse.requestPointerLock() method from a pointerdown or pointerup event handler.

Type:
boolean
Since: 3.19.0
Source: src/input/Pointer.js (Line 448)