This object allows you to simulate mouse actions.

Constructor function.

var myObject = new Mouse();

Returns the current position of the cursor.

myObject.position();

• (Point) the current position of the cursor

Moves the mouse cursor.

myObject.move(position);

1. position - (Point) the position where to move the mouse cursor

• (Mouse) this Mouse

Returns true if button is pressed.

myObject.isButtonPressed(button);

1. button - (Button) the button to check

• (boolean) true if button is pressed

Presses a mouse button or the left button if no button is specified.

myObject.press(button);

myObject.press();

1. button - (Button) the button to press

• (Mouse) this Mouse

• (PressButtonError) unable to press the button

Releases a mouse button or the left button if no button is specified.

myObject.release(button);

myObject.release();

1. button - (Button) the button to release

• (Mouse) this Mouse

• (ReleaseButtonError) unable to release the button

Presses and releases a mouse button or the left button if no button is specified.

myObject.click(button);

myObject.click();

1. button - (Button) the button to press and release

• (Mouse) this Mouse

• (ClickError) unable to press and release the button

Emulates a mouse wheel movement.

myObject.wheel(intensity);

myObject.wheel();

1. intensity - (integer) the wheel movement intensity, positive is forward, negative is backward (default: 1)

• (Mouse) this Mouse

• (WheelError) unable to emulate a mouse wheel

Mouse buttons.

1. LeftButton: left button
2. MiddleButton: middle button
3. RightButton: right button