new Mouse(game)
Phaser - Mouse constructor.
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> RIGHT_BUTTON :number
-
Type:
- number
- Source:
-
callbackContext
-
- Source:
Properties:
Name Type Description callbackContextObject Description.
-
disabled
-
You can disable all Input by setting disabled = true. While set all new input related events will be ignored.
- Default Value:
- false
- Source:
Properties:
Name Type Description disabledboolean -
game
-
- Source:
Properties:
Name Type Description gamePhaser.Game Local reference to game.
-
locked
-
If the mouse has been Pointer Locked successfully this will be set to true.
- Default Value:
- false
- Source:
Properties:
Name Type Description lockedboolean -
mouseDownCallback
-
- Default Value:
- null
- Source:
Properties:
Name Type Description mouseDownCallbackDescription Description.
-
mouseMoveCallback
-
- Default Value:
- null
- Source:
Properties:
Name Type Description mouseMoveCallbackDescription Description.
-
mouseUpCallback
-
- Default Value:
- null
- Source:
Properties:
Name Type Description mouseUpCallbackDescription Description.
Methods
-
onMouseDown(event)
-
Description.
Parameters:
Name Type Description eventMouseEvent - Source:
-
onMouseMove(event)
-
Description
Parameters:
Name Type Description eventMouseEvent - Source:
-
onMouseUp(event)
-
Description.
Parameters:
Name Type Description eventMouseEvent - Source:
-
pointerLockChange(event)
-
Description.
Parameters:
Name Type Description eventMouseEvent - Source:
-
releasePointerLock()
-
Description.
- Source:
-
requestPointerLock()
-
Description.
- Source:
-
start()
-
Starts the event listeners running.
- Source:
-
stop()
-
Stop the event listeners.
- Source: