Class: Mouse

Mouse()

Manages mouse input, tracking position, which buttons are down, and which were just pressed.

Constructor

new Mouse()

Source:

Classes

Mouse

Members

x :number

The last known client x-coordinate of the mouse.
Type:
  • number
Source:

y :number

The last known client y-coordinate of the mouse.
Type:
  • number
Source:

Methods

mouseDown(button) → {boolean}

Checks if a specific mouse button is currently held down.
Parameters:
Name Type Description
button number The button to check (1=left, 2=right, 3=middle).
Source:
Returns:
Type
boolean

mouseHit(button) → {boolean}

Checks if a specific mouse button was just pressed in the current frame. This state is cleared at the end of the frame.
Parameters:
Name Type Description
button number The button to check (1=left, 2=right, 3=middle).
Source:
Returns:
Type
boolean