new Mouse(game)
Phaser.Mouse 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 released when not over the game.
Parameters:
| Name | Type | Description |
|---|---|---|
game |
Phaser.Game | A reference to the currently running game. |
- Source:
Members
-
<static, constant> LEFT_BUTTON :number
-
Type:
- number
- Source:
-
<static, constant> MIDDLE_BUTTON :number
-
Type:
- number
- Source:
-
<static, constant> NO_BUTTON :number
-
Type:
- number
- Source:
-
<static, constant> RIGHT_BUTTON :number
-
Type:
- number
- Source:
-
<static, constant> WHEEL_DOWN :number
-
Type:
- number
- Source:
-
<static, constant> WHEEL_UP :number
-
Type:
- number
- Source:
-
button
-
- Source:
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.
-
callbackContext
-
- Source:
Properties:
Name Type Description callbackContextObject The context under which callbacks are called.
-
capture
-
- Source:
Properties:
Name Type Description captureboolean If true the DOM mouse events will have event.preventDefault applied to them, if false they will propogate fully.
-
disabled
-
- Default Value:
- false
- Source:
Properties:
Name Type Description disabledboolean You can disable all Input by setting disabled = true. While set all new input related events will be ignored.
-
event
-
- Default Value:
- null
- Source:
Properties:
Name Type Description eventMouseEvent The browser mouse DOM event. Will be set to null if no mouse event has ever been received.
-
game
-
- Source:
Properties:
Name Type Description gamePhaser.Game A reference to the currently running game.
-
locked
-
- Default Value:
- false
- Source:
Properties:
Name Type Description lockedboolean If the mouse has been Pointer Locked successfully this will be set to true.
-
mouseDownCallback
-
- Source:
Properties:
Name Type Description mouseDownCallbackfunction A callback that can be fired when the mouse is pressed down.
-
mouseMoveCallback
-
- Source:
Properties:
Name Type Description mouseMoveCallbackfunction A callback that can be fired when the mouse is moved while pressed down.
-
mouseOutCallback
-
- Source:
Properties:
Name Type Description mouseOutCallbackfunction A callback that can be fired when the mouse is no longer over the game canvas.
-
mouseOverCallback
-
- Source:
Properties:
Name Type Description mouseOverCallbackfunction A callback that can be fired when the mouse enters the game canvas (usually after a mouseout).
-
mouseUpCallback
-
- Source:
Properties:
Name Type Description mouseUpCallbackfunction A callback that can be fired when the mouse is released from a pressed down state.
-
mouseWheelCallback
-
- Source:
Properties:
Name Type Description mouseWheelCallbackfunction A callback that can be fired when the mousewheel is used.
-
pointerLock
-
- Source:
Properties:
Name Type Description pointerLockPhaser.Signal This event is dispatched when the browser enters or leaves pointer lock state.
-
stopOnGameOut
-
- Default Value:
- false
- Source:
Properties:
Name Type Description stopOnGameOutboolean If true Pointer.stop will be called if the mouse leaves the game canvas.
-
wheelDelta
-
- Source:
Properties:
Name Type Description wheelDeltanumber The direction of the mousewheel usage 1 for up -1 for down
Methods
-
onMouseDown(event)
-
The internal method that handles the mouse down event from the browser.
Parameters:
Name Type Description eventMouseEvent The native event from the browser. This gets stored in Mouse.event.
- Source:
-
onMouseMove(event)
-
The internal method that handles the mouse move event from the browser.
Parameters:
Name Type Description eventMouseEvent The native event from the browser. This gets stored in Mouse.event.
- Source:
-
onMouseOut(event)
-
The internal method that handles the mouse out event from the browser.
Parameters:
Name Type Description eventMouseEvent The native event from the browser. This gets stored in Mouse.event.
- Source:
-
onMouseOver(event)
-
The internal method that handles the mouse over event from the browser.
Parameters:
Name Type Description eventMouseEvent The native event from the browser. This gets stored in Mouse.event.
- Source:
-
onMouseUp(event)
-
The internal method that handles the mouse up event from the browser.
Parameters:
Name Type Description eventMouseEvent The native event from the browser. This gets stored in Mouse.event.
- Source:
-
onMouseUpGlobal(event)
-
The internal method that handles the mouse up event from the window.
Parameters:
Name Type Description eventMouseEvent The native event from the browser. This gets stored in Mouse.event.
- Source:
-
onMouseWheel(event)
-
The internal method that handles the mouse wheel event from the browser.
Parameters:
Name Type Description eventMouseEvent The native event from the browser. This gets stored in Mouse.event.
- Source:
-
pointerLockChange(event)
-
Internal pointerLockChange handler.
Parameters:
Name Type Description eventpointerlockchange The native event from the browser. This gets stored in Mouse.event.
- Source:
-
releasePointerLock()
-
Internal release pointer lock handler.
- Source:
-
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:
-
start()
-
Starts the event listeners running.
- Source:
-
stop()
-
Stop the event listeners.
- Source: