Class: Mouse

Members

<static, constant> LEFT_BUTTON :number

Type:

• number

Source:

• input/Mouse.js, line 83

<static, constant> MIDDLE_BUTTON :number

Type:

• number

Source:

• input/Mouse.js, line 89

<static, constant> NO_BUTTON :number

Type:

• number

Source:

• input/Mouse.js, line 78

<static, constant> RIGHT_BUTTON :number

Type:

• number

Source:

• input/Mouse.js, line 95

button

Properties:

Name	Type	Description
button-	number	The type of click, either: Phaser.Mouse.NO_BUTTON, Phaser.Mouse.LEFT_BUTTON, Phaser.Mouse.MIDDLE_BUTTON or Phaser.Mouse.RIGHT_BUTTON.

Source:

• input/Mouse.js, line 49

callbackContext

Properties:

Name	Type	Description
callbackContext	Object	Description.

Source:

• input/Mouse.js, line 25

disabled

You can disable all Input by setting disabled = true. While set all new input related events will be ignored.

Properties:

Name	Type	Description
disabled	boolean

Default Value:

• false

Source:

• input/Mouse.js, line 56

game

Properties:

Name	Type	Description
game	Phaser.Game	Local reference to game.

Source:

• input/Mouse.js, line 20

locked

If the mouse has been Pointer Locked successfully this will be set to true.

Properties:

Name	Type	Description
locked	boolean

Default Value:

• false

Source:

• input/Mouse.js, line 63

mouseDownCallback

Properties:

Name	Type	Description
mouseDownCallback	function	Description.

Default Value:

• null

Source:

• input/Mouse.js, line 31

mouseMoveCallback

Properties:

Name	Type	Description
mouseMoveCallback	function	Description.

Default Value:

• null

Source:

• input/Mouse.js, line 37

mouseUpCallback

Properties:

Name	Type	Description
mouseUpCallback	function	Description.

Default Value:

• null

Source:

• input/Mouse.js, line 43

pointerLock

This event is dispatched when the browser enters or leaves pointer lock state.

Properties:

Name	Type	Description
pointerLock	Phaser.Signal

Source:

• input/Mouse.js, line 70

Methods

onMouseDown(event)

The internal method that handles the mouse down event from the browser.

Parameters:

Name	Type	Description
event	MouseEvent

Source:

• input/Mouse.js, line 131

onMouseMove(event)

The internal method that handles the mouse move event from the browser.

Parameters:

Name	Type	Description
event	MouseEvent

Source:

• input/Mouse.js, line 169

onMouseUp(event)

The internal method that handles the mouse up event from the browser.

Parameters:

Name	Type	Description
event	MouseEvent

Source:

• input/Mouse.js, line 194

pointerLockChange(event)

Internal pointerLockChange handler.

Parameters:

Name	Type	Description
event	MouseEvent

Source:

• input/Mouse.js, line 250

releasePointerLock()

Internal release pointer lock handler.

Source:

• input/Mouse.js, line 274

requestPointerLock()

If the browser supports it you can request that the pointer be locked to the browser window. This is classically known as 'FPS controls', where the pointer can't leave the browser until the user presses an exit key. If the browser successfully enters a locked state the event Phaser.Mouse.pointerLock will be dispatched and the first parameter will be 'true'.

Source:

• input/Mouse.js, line 221

start()

Starts the event listeners running.

Source:

• input/Mouse.js, line 99

stop()

Stop the event listeners.

Source:

• input/Mouse.js, line 290