phaser - v4.0.0-rc.4
    Preparing search index...

    Class 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.

    Index

    Constructors

    constructor

    Properties

    enabled isTop locked manager onMouseDown onMouseDownWindow onMouseMove onMouseOut onMouseOver onMouseUp onMouseUpWindow onMouseWheel pointerLockChange preventDefaultDown preventDefaultMove preventDefaultUp preventDefaultWheel target

    Methods

    destroy disableContextMenu releasePointerLock requestPointerLock startListeners stopListeners

    Constructors

    Properties

    enabled: boolean

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

    isTop: boolean

    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.

    locked: boolean

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

    manager: InputManager

    A reference to the Input Manager.

    onMouseDown: Function

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

    onMouseDownWindow: Function

    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.

    onMouseMove: Function

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

    onMouseOut: Function

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

    onMouseOver: Function

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

    onMouseUp: Function

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

    onMouseUpWindow: Function

    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.

    onMouseWheel: Function

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

    pointerLockChange: Function

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

    preventDefaultDown: boolean

    If true the DOM mousedown event will have preventDefault set.

    preventDefaultMove: boolean

    If true the DOM mousemove event will have preventDefault set.

    preventDefaultUp: boolean

    If true the DOM mouseup event will have preventDefault set.

    preventDefaultWheel: boolean

    If true the DOM wheel event will have preventDefault set.

    target: any

    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.

    Methods

    • Attempts to disable the context menu from appearing if you right-click on the game canvas, or specified input target.

      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 context menu keeps getting in the way.

      Returns this

    • 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.

      Returns void

    • 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.

      Returns void

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

      Returns void

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

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods