Function Reference


Perform a mouse click operation.

MouseClick ( "button" [, x, y [, clicks = 1 [, speed = 10]]] )


button The button to click: "left", "right", "middle", "main", "menu", "primary", "secondary".
x, y [optional] The x/y coordinates to move the mouse to. If no x and y coords are given, the current position is used (default).
clicks [optional] The number of times to click the mouse. Default is 1.
speed [optional] the speed to move the mouse in the range 1 (fastest) to 100 (slowest). A speed of 0 will move the mouse instantly. Default speed is 10.

Return Value

Success: 1.
Failure: 0, the button is not in the list or invalid parameter as x without y.


If the button is an empty string, the left button will be clicked.
If x or y equal to the Default keyword no move occurs in the corresponding coordinate.

If the user has swapped the left and right mouse buttons in the control panel, then the behaviour of the buttons is different. "Left" and "right" always click those buttons, whether the buttons are swapped or not. The "primary" or "main" button will be the main click, whether or not the buttons are swapped. The "secondary" or "menu" buttons will usually bring up the context menu, whether the buttons are swapped or not.

Button Normal Swapped
"" Left Left
"left" Left Left
"middle" Middle Middle
"right" Right Right
"primary" Left Right
"main" Left Right
"secondary" Right Left
"menu" Right Left


ControlClick(), MouseClickDelay (Option), MouseClickDrag(), MouseCoordMode (Option), MouseDown(), MouseGetPos(), MouseMove(), MouseUp(), MouseWheel()


; Double click at the current mouse position.

; Double click at the x, y position of 0, 500.
MouseClick("left", 0, 500, 2)

; Double click at the x, y position of 0, 500. This is a better approach as it takes into account left/right handed users.
MouseClick("primary", 0, 500, 2)