Class Mouse

A Mouse Device, bound to a DOM Element.

Hierarchy (View Summary)

EventHandler
- Mouse

Constructors

constructor

new Mouse(element?: Element): Mouse
Create a new Mouse instance.
Parameters
- Optionalelement: Element
  The Element that the mouse events are attached to.
Returns Mouse

Methods

attach

attach(element: Element): void
Attach mouse events to an Element.
Parameters
- element: Element
  The DOM element to attach the mouse to.
Returns void

detach

detach(): void
Remove mouse events from the element that it is attached to.

Returns void

disableContextMenu

disableContextMenu(): void
Disable the context menu usually activated with right-click.

Returns void

disablePointerLock

disablePointerLock(success?: LockMouseCallback): void
Return control of the mouse cursor to the user.
Parameters
- Optionalsuccess: LockMouseCallback
  Function called when the mouse lock is disabled.
Returns void

enableContextMenu

enableContextMenu(): void
Enable the context menu usually activated with right-click. This option is active by default.

Returns void

enablePointerLock

enablePointerLock(success?: LockMouseCallback, error?: LockMouseCallback): 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

fire(
    name: string,
    arg1?: any,
    arg2?: any,
    arg3?: any,
    arg4?: any,
    arg5?: any,
    arg6?: any,
    arg7?: any,
    arg8?: any,
): EventHandler
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.
Example
```
obj.fire('test', 'This is the message');
```

hasEvent

hasEvent(name: string): boolean
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.
Example
```
obj.on('test', () => {}); // bind an event to 'test'
obj.hasEvent('test'); // returns true
obj.hasEvent('hello'); // returns false
```

isPressed

isPressed(button: number): boolean
Returns true if the mouse button is currently pressed.
Parameters
- button: number
  The mouse button to test. Can be:
  
  MOUSEBUTTON_LEFT
  
  MOUSEBUTTON_MIDDLE
  
  MOUSEBUTTON_RIGHT
Returns boolean
True if the mouse button is current pressed.

off

off(name?: string, callback?: HandleEventCallback, scope?: any): EventHandler
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.
Example
```
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
```

on

on(name: string, callback: HandleEventCallback, scope?: any): EventHandle
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.
Example
```
obj.on('test', (a, b) => {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
```
Example
```
const evt = obj.on('test', (a, b) => {
    console.log(a + b);
});
// some time later
evt.off();
```

once

once(name: string, callback: HandleEventCallback, scope?: any): EventHandle
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.
Example
```
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
```

update

update(): void
Update method, should be called once per frame.

Returns void

wasPressed

wasPressed(button: number): boolean
Returns true if the mouse button was pressed this frame (since the last call to update).
Parameters
- button: number
  The mouse button to test. Can be:
  
  MOUSEBUTTON_LEFT
  
  MOUSEBUTTON_MIDDLE
  
  MOUSEBUTTON_RIGHT
Returns boolean
True if the mouse button was pressed since the last update.

wasReleased

wasReleased(button: number): boolean
Returns true if the mouse button was released this frame (since the last call to update).
Parameters
- button: number
  The mouse button to test. Can be:
  
  MOUSEBUTTON_LEFT
  
  MOUSEBUTTON_MIDDLE
  
  MOUSEBUTTON_RIGHT
Returns boolean
True if the mouse button was released since the last update.

`Static`isPointerLocked

isPointerLocked(): boolean
Check if the mouse pointer has been locked, using Mouse#enablePointerLock.

Returns boolean
True if locked.

Events

`Static`EVENT_MOUSEDOWN

EVENT_MOUSEDOWN: string = EVENT_MOUSEDOWN

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

Example

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

`Static`EVENT_MOUSEMOVE

EVENT_MOUSEMOVE: string = EVENT_MOUSEMOVE

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

Example

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

`Static`EVENT_MOUSEUP

EVENT_MOUSEUP: string = EVENT_MOUSEUP

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

Example

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

`Static`EVENT_MOUSEWHEEL

EVENT_MOUSEWHEEL: string = EVENT_MOUSEWHEEL

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

Example

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

Class Mouse

Hierarchy (View Summary)

Index

Constructors

Methods

Events

Constructors

constructor

Parameters

Returns Mouse

Methods

attach

Parameters

Returns void

detach

Returns void

disableContextMenu

Returns void

disablePointerLock

Parameters

Returns void

enableContextMenu

Returns void

enablePointerLock

Parameters

Returns void

fire

Parameters

Returns EventHandler

Example

hasEvent

Parameters

Returns boolean

Example

isPressed

Parameters

Returns boolean

off

Parameters

Returns EventHandler

Example

on

Parameters

Returns EventHandle

Example

Example

once

Parameters

Returns EventHandle

Example

update

Returns void

wasPressed

Parameters

Returns boolean

wasReleased

Parameters

Returns boolean

StaticisPointerLocked

Returns boolean

Events

StaticEVENT_MOUSEDOWN

Example

StaticEVENT_MOUSEMOVE

Example

StaticEVENT_MOUSEUP

Example

StaticEVENT_MOUSEWHEEL

Example

Settings

On This Page

`Static`isPointerLocked

`Static`EVENT_MOUSEDOWN

`Static`EVENT_MOUSEMOVE

`Static`EVENT_MOUSEUP

`Static`EVENT_MOUSEWHEEL