Phaser API Documentation

  Version: 
Filter
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . Input . Mouse . MouseManager

This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . Input . Mouse . MouseManager

The Mouse Manager is a helper class that belongs to the Input Manager.

Its role is to listen for native DOM Mouse Events and then pass them onto the Input Manager for further processing.

You do not need to create this class directly, the Input Manager will create an instance of it automatically.

Constructor:

new MouseManager(inputManager)

Parameters:

name type description
inputManager Phaser.Input.InputManager

A reference to the Input Manager.

Since: 3.0.0

Members

enabled: boolean
Focus
Focus

Description:

A boolean that controls if the Mouse Manager is enabled or not. Can be toggled on the fly.

Type:
boolean
Default: false
Since: 3.0.0
Focus
Focus
<readonly> isTop: boolean
Focus
Focus

Description:

Are the event listeners hooked into window.top or window?

This is set during the boot sequence. If the browser does not have access to window.top, such as in cross-origin iframe environments, this property gets set to false and the events are hooked into window instead.

Type:
boolean
Since: 3.50.0
Focus
Focus
locked: boolean
Focus
Focus

Description:

If the mouse has been pointer locked successfully this will be set to true.

Type:
boolean
Default: false
Since: 3.0.0
Focus
Focus

Description:

A reference to the Input Manager.

Type:
Since: 3.0.0
Focus
Focus
onMouseDown: function
Focus
Focus

Description:

The Mouse Down Event handler. This function is sent the native DOM MouseEvent. Initially empty and bound in the startListeners method.

Type:
function
Since: 3.10.0
Focus
Focus
onMouseDownWindow: function
Focus
Focus

Description:

The Mouse Down Event handler specifically for events on the Window. This function is sent the native DOM MouseEvent. Initially empty and bound in the startListeners method.

Type:
function
Since: 3.17.0
Focus
Focus
onMouseMove: function
Focus
Focus

Description:

The Mouse Move Event handler. This function is sent the native DOM MouseEvent. Initially empty and bound in the startListeners method.

Type:
function
Since: 3.10.0
Focus
Focus
onMouseOut: function
Focus
Focus

Description:

The Mouse Out Event handler. This function is sent the native DOM MouseEvent. Initially empty and bound in the startListeners method.

Type:
function
Since: 3.16.0
Focus
Focus
onMouseOver: function
Focus
Focus

Description:

The Mouse Over Event handler. This function is sent the native DOM MouseEvent. Initially empty and bound in the startListeners method.

Type:
function
Since: 3.16.0
Focus
Focus
onMouseUp: function
Focus
Focus

Description:

The Mouse Up Event handler. This function is sent the native DOM MouseEvent. Initially empty and bound in the startListeners method.

Type:
function
Since: 3.10.0
Focus
Focus
onMouseUpWindow: function
Focus
Focus

Description:

The Mouse Up Event handler specifically for events on the Window. This function is sent the native DOM MouseEvent. Initially empty and bound in the startListeners method.

Type:
function
Since: 3.17.0
Focus
Focus
onMouseWheel: function
Focus
Focus

Description:

The Mouse Wheel Event handler. This function is sent the native DOM MouseEvent. Initially empty and bound in the startListeners method.

Type:
function
Since: 3.18.0
Focus
Focus
pointerLockChange: function
Focus
Focus

Description:

Internal pointerLockChange handler. This function is sent the native DOM MouseEvent. Initially empty and bound in the startListeners method.

Type:
function
Since: 3.0.0
Focus
Focus
preventDefaultDown: boolean
Focus
Focus

Description:

If true the DOM mousedown event will have preventDefault set.

Type:
boolean
Default: true
Since: 3.50.0
Focus
Focus
preventDefaultMove: boolean
Focus
Focus

Description:

If true the DOM mousemove event will have preventDefault set.

Type:
boolean
Default: true
Since: 3.50.0
Focus
Focus
preventDefaultUp: boolean
Focus
Focus

Description:

If true the DOM mouseup event will have preventDefault set.

Type:
boolean
Default: true
Since: 3.50.0
Focus
Focus
preventDefaultWheel: boolean
Focus
Focus

Description:

If true the DOM wheel event will have preventDefault set.

Type:
boolean
Default: true
Since: 3.50.0
Focus
Focus
target: any
Focus
Focus

Description:

The Mouse target, as defined in the Game Config. Typically the canvas to which the game is rendering, but can be any interactive DOM element.

Type:
any
Since: 3.0.0
Focus
Focus

Methods

<private> boot()
Focus
Focus

Description:

The Touch Manager boot process.

Examples:
Since: 3.0.0
Focus
Focus
destroy()
Focus
Focus

Description:

Destroys this Mouse Manager instance.

Examples:
Since: 3.0.0
Focus
Focus
disableContextMenu()
Focus
Focus

Description:

Attempts to disable the context menu from appearing if you right-click on the browser.

Works by listening for the contextmenu event and prevent defaulting it.

Use this if you need to enable right-button mouse support in your game, and the browser menu keeps getting in the way.

Returns:
Description:

This Mouse Manager instance.

Examples:
Since: 3.0.0
Focus
Focus
releasePointerLock()
Focus
Focus

Description:

If the browser supports pointer lock, this will request that the pointer lock is released. If the browser successfully enters a locked state, a 'POINTER_LOCK_CHANGE_EVENT' will be dispatched - from the game's input manager - with an isPointerLocked property.

Examples:
Since: 3.0.0
Focus
Focus
requestPointerLock()
Focus
Focus

Description:

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, a POINTER_LOCK_CHANGE_EVENT will be dispatched, from the games Input Manager, with an isPointerLocked property.

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.

Examples:
Since: 3.0.0
Focus
Focus
startListeners()
Focus
Focus

Description:

Starts the Mouse Event listeners running. This is called automatically and does not need to be manually invoked.

Examples:
Since: 3.0.0
Focus
Focus
stopListeners()
Focus
Focus

Description:

Stops the Mouse Event listeners. This is called automatically and does not need to be manually invoked.

Examples:
Since: 3.0.0
Focus
Focus