Mouse#onMouseDown()

onMouseDown(event) The internal method that handles the mouse down event from the browser. Parameters Name Type Description event MouseEvent The native event from the browser. This gets stored in Mouse.event. Source code: input/Mouse.js (Line 296)

Mouse#mouseWheelCallback

mouseWheelCallback : Function A callback that can be fired when the mousewheel is used. Source code: input/Mouse.js (Line 62)

Mouse#mouseUpCallback

mouseUpCallback : Function A callback that can be fired when the mouse is released from a pressed down state. Source code: input/Mouse.js (Line 47)

Mouse#mouseOverCallback

mouseOverCallback : Function A callback that can be fired when the mouse enters the game canvas (usually after a mouseout). Source code: input/Mouse.js (Line 57)

Mouse#mouseOutCallback

mouseOutCallback : Function A callback that can be fired when the mouse is no longer over the game canvas. Source code: input/Mouse.js (Line 52)

Mouse#mouseDownCallback

mouseDownCallback : Function A callback that can be fired when the mouse is pressed down. Source code: input/Mouse.js (Line 42)

Mouse#Mouse

new Mouse(game) The Mouse class is responsible for handling all aspects of mouse interaction with the browser. It captures and processes mouse events that happen on the game canvas object.It also adds a single mouseup listener to window which is used to capture the mouse being releasedwhen not over the game. You should not normally access this class directly, but instead use a Phaser.Pointer objectwhich normalises all game input for you, including accurate button handling. Parameters Name Ty

Mouse#locked

locked : boolean If the mouse has been Pointer Locked successfully this will be set to true. Source code: input/Mouse.js (Line 95)

Mouse#game

game : Phaser.Game A reference to the currently running game. Source code: input/Mouse.js (Line 26)

Mouse#event

event :MouseEvent | null The browser mouse DOM event. Will be null if no mouse event has ever been received.Access this property only inside a Mouse event handler and do not keep references to it. Type MouseEvent | null Source code: input/Mouse.js (Line 115)