Engine API Reference - v2.7.2
    Preparing search index...

    Class Mouse

    Manages mouse input by tracking button states and dispatching events. Extends EventHandler to fire mousedown, mouseup, mousemove and mousewheel events (see MouseEvent).

    Allows the state of mouse buttons to be queried to check if they are currently pressed or were pressed/released since the last update. Provides methods to enable/disable pointer lock for raw mouse movement input and control over the context menu. The Mouse instance must be attached to a DOM element before it can detect mouse events.

    Your application's Mouse instance is managed and accessible via AppBase#mouse.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    attach detach disableContextMenu disablePointerLock enableContextMenu enablePointerLock fire hasEvent isPressed off on once update wasPressed wasReleased isPointerLocked

    Events

    EVENT_MOUSEDOWN EVENT_MOUSEMOVE EVENT_MOUSEUP EVENT_MOUSEWHEEL

    Constructors

    Methods

    • Disable the context menu usually activated with right-click.

      Returns void

    • Enable the context menu usually activated with right-click. This option is active by default.

      Returns void

    • Request that the browser hides the mouse cursor and locks the mouse to the element. Allowing raw access to mouse movement input without risking the mouse exiting the element. Notes:

      • In some browsers this will only work when the browser is running in fullscreen mode. See Fullscreen API for more details.
      • Enabling pointer lock can only be initiated by a user action e.g. in the event handler for a mouse or keyboard input.

      Parameters

      • Optionalsuccess: LockMouseCallback

        Function called if the request for mouse lock is successful.

      • Optionalerror: LockMouseCallback

        Function called if the request for mouse lock is unsuccessful.

      Returns void

    • Fire an event, all additional arguments are passed on to the event listener.

      Parameters

      • name: string

        Name of event to fire.

      • Optionalarg1: any

        First argument that is passed to the event handler.

      • Optionalarg2: any

        Second argument that is passed to the event handler.

      • Optionalarg3: any

        Third argument that is passed to the event handler.

      • Optionalarg4: any

        Fourth argument that is passed to the event handler.

      • Optionalarg5: any

        Fifth argument that is passed to the event handler.

      • Optionalarg6: any

        Sixth argument that is passed to the event handler.

      • Optionalarg7: any

        Seventh argument that is passed to the event handler.

      • Optionalarg8: any

        Eighth argument that is passed to the event handler.

      Returns EventHandler

      Self for chaining.

      obj.fire('test', 'This is the message');

    • Test if there are any handlers bound to an event name.

      Parameters

      • name: string

        The name of the event to test.

      Returns boolean

      True if the object has handlers bound to the specified event name.

      obj.on('test', () => {}); // bind an event to 'test'
      obj.hasEvent('test'); // returns true
      obj.hasEvent('hello'); // returns false

    • Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

      Parameters

      • Optionalname: string

        Name of the event to unbind.

      • Optionalcallback: HandleEventCallback

        Function to be unbound.

      • Optionalscope: any

        Scope that was used as the this when the event is fired.

      Returns EventHandler

      Self for chaining.

      const handler = () => {};
      obj.on('test', handler);

      obj.off(); // Removes all events
      obj.off('test'); // Removes all events called 'test'
      obj.off('test', handler); // Removes all handler functions, called 'test'
      obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this

    • Attach an event handler to an event.

      Parameters

      • name: string

        Name of the event to bind the callback to.

      • callback: HandleEventCallback

        Function that is called when event is fired. Note the callback is limited to 8 arguments.

      • Optionalscope: any = ...

        Object to use as 'this' when the event is fired, defaults to current this.

      Returns EventHandle

      Can be used for removing event in the future.

      obj.on('test', (a, b) => {
          console.log(a + b);
      });
      obj.fire('test', 1, 2); // prints 3 to the console

      const evt = obj.on('test', (a, b) => {
          console.log(a + b);
      });
      // some time later
      evt.off();

    • Attach an event handler to an event. This handler will be removed after being fired once.

      Parameters

      • name: string

        Name of the event to bind the callback to.

      • callback: HandleEventCallback

        Function that is called when event is fired. Note the callback is limited to 8 arguments.

      • Optionalscope: any = ...

        Object to use as 'this' when the event is fired, defaults to current this.

      Returns EventHandle

      • can be used for removing event in the future.
      obj.once('test', (a, b) => {
          console.log(a + b);
      });
      obj.fire('test', 1, 2); // prints 3 to the console
      obj.fire('test', 1, 2); // not going to get handled

    Events

    EVENT_MOUSEDOWN: string = 'mousedown'

    Fired when a mouse button is pressed. The handler is passed a MouseEvent.

    app.mouse.on('mousedown', (e) => {
        console.log(`The ${e.button} button was pressed at position: ${e.x}, ${e.y}`);
    });
    EVENT_MOUSEMOVE: string = 'mousemove'

    Fired when the mouse is moved. The handler is passed a MouseEvent.

    app.mouse.on('mousemove', (e) => {
        console.log(`Current mouse position is: ${e.x}, ${e.y}`);
    });
    EVENT_MOUSEUP: string = 'mouseup'

    Fired when a mouse button is released. The handler is passed a MouseEvent.

    app.mouse.on('mouseup', (e) => {
        console.log(`The ${e.button} button was released at position: ${e.x}, ${e.y}`);
    });
    EVENT_MOUSEWHEEL: string = 'mousewheel'

    Fired when a mouse wheel is moved. The handler is passed a MouseEvent.

    app.mouse.on('mousewheel', (e) => {
        console.log(`The mouse wheel was moved by ${e.wheelDelta}`);
    });

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Events