Class: Mouse

Members

<static, readonly> Button :Number

Mouse buttons.

Type:

• Number

Properties:

Name	Type	Default	Description
NONE	Number	0	No button.
LEFT	Number	1	Left mouse button.
RIGHT	Number	2	Right mouse button.
MIDDLE	Number	3	Middle mouse button.
EXTRA1	Number	4	First extra mouse button.
EXTRA2	Number	5	Second extra mouse button.

Source:

• mouse.js, line 71

<static> numberOfButtons

Number of buttons available in the mouse.

Source:

• mouse.js, line 45

<static> x

Horizontal position of the mouse, in points, within the window.

Source:

• mouse.js, line 35

<static> y

Vertical position of the mouse, in points, within the window.

Source:

• mouse.js, line 40

Methods

<static> isButtonpressed(button) → {Boolean}

Get whether a button is pressed.

Parameters:

Name	Type	Description
button	Input.Mouse.Button	Button.

Source:

• mouse.js, line 62

Returns:

true when pressed, false otherwise.

Type

Boolean

<static> setPosition(x, y)

Set position of the mouse cursor.

Parameters:

Name	Type	Description
x	Number	Horizontal position.
y	Number	Vertical position.

Source:

• mouse.js, line 53