Updated JSDocs. Fix #5268

This commit is contained in:
Richard Davey 2020-09-11 11:08:43 +01:00
parent 0d57de02ee
commit 57657ce76c

View file

@ -280,6 +280,12 @@ var MouseManager = new Class({
* It is important to note that pointer lock can only be enabled after an 'engagement gesture',
* see: https://w3c.github.io/pointerlock/#dfn-engagement-gesture.
*
* Note for Firefox: There is a bug in certain Firefox releases that cause native DOM events like
* `mousemove` to fire continuously when in pointer lock mode. You can get around this by setting
* `this.preventDefaultMove` to `false` in this class. You may also need to do the same for
* `preventDefaultDown` and/or `preventDefaultUp`. Please test combinations of these if you encounter
* the error.
*
* @method Phaser.Input.Mouse.MouseManager#requestPointerLock
* @since 3.0.0
*/