Difference between revisions of "Mouse Control"
From SolarStrike wiki
(→mousetSet(x,y)) |
|||
| Line 8: | Line 8: | ||
mouseSet(100, 200); -- This will move the mouse to (100,200) | mouseSet(100, 200); -- This will move the mouse to (100,200) | ||
</source> | </source> | ||
| + | |||
== mouseMove(x,y) == | == mouseMove(x,y) == | ||
Moves the mouse (x,y) pixels, where x and y are integers. Coordinates are relative. See mouseSet to specify absolute coordinates. | Moves the mouse (x,y) pixels, where x and y are integers. Coordinates are relative. See mouseSet to specify absolute coordinates. | ||
| + | |||
| + | |||
| + | '''Example''' | ||
| + | <source lang="lua"> | ||
| + | mouseMove(5, 10); -- This will move the mouse right 5 pixels and down 10 | ||
| + | </source> | ||
| Line 17: | Line 24: | ||
Clicks the left mouse button. | Clicks the left mouse button. | ||
| + | |||
| + | |||
| + | '''Example''' | ||
| + | <source lang="lua"> | ||
| + | mouseLClick(); -- The left mouse button will be clicked | ||
| + | </source> | ||
| Line 22: | Line 35: | ||
Clicks the middle (or wheel) mouse button. | Clicks the middle (or wheel) mouse button. | ||
| + | |||
| + | |||
| + | '''Example''' | ||
| + | <source lang="lua"> | ||
| + | mouseMClick(); -- The middle/wheel mouse button will be clicked | ||
| + | </source> | ||
| Line 27: | Line 46: | ||
Clicks the right mouse button. | Clicks the right mouse button. | ||
| + | |||
| + | |||
| + | '''Example''' | ||
| + | <source lang="lua"> | ||
| + | mouseRClick(); -- The right mouse button will be clicked | ||
| + | </source> | ||
| Line 32: | Line 57: | ||
Holds down the left mouse button until a left click or left release. Use mouseLRelease() to release. | Holds down the left mouse button until a left click or left release. Use mouseLRelease() to release. | ||
| + | |||
| + | |||
| + | '''Example''' | ||
| + | <source lang="lua"> | ||
| + | mouseLHold(); -- The left mouse button will be held down. Click or use mouseLRelease to release | ||
| + | </source> | ||
| Line 37: | Line 68: | ||
Holds down the middle/wheel mouse button until a middle/wheel click or middle/wheel button release. Use mouseMRelease() to release. | Holds down the middle/wheel mouse button until a middle/wheel click or middle/wheel button release. Use mouseMRelease() to release. | ||
| + | |||
| + | |||
| + | '''Example''' | ||
| + | <source lang="lua"> | ||
| + | mouseLHold(); -- The middle/wheel mouse button will be held down. Click or use mouseMRelease to release | ||
| + | </source> | ||
| Line 42: | Line 79: | ||
Holds down the right mouse button until a right click or right release. Use mouseRRelease() to release. | Holds down the right mouse button until a right click or right release. Use mouseRRelease() to release. | ||
| + | |||
| + | |||
| + | '''Example''' | ||
| + | <source lang="lua"> | ||
| + | mouseRHold(); -- The right mouse button will be held down. Click or use mouseRRelease to release | ||
| + | </source> | ||
| Line 47: | Line 90: | ||
Releases the left mouse button, if held down. | Releases the left mouse button, if held down. | ||
| + | |||
| + | |||
| + | '''Example''' | ||
| + | <source lang="lua"> | ||
| + | mouseLRelease(); -- The left mouse button is no longer being held | ||
| + | </source> | ||
| Line 52: | Line 101: | ||
Releases the middle/wheel mouse button, if held down. | Releases the middle/wheel mouse button, if held down. | ||
| + | |||
| + | |||
| + | '''Example''' | ||
| + | <source lang="lua"> | ||
| + | mouseRRelease(); -- The right mouse button is no longer being held | ||
| + | </source> | ||
| Line 57: | Line 112: | ||
Releases the right mouse button, if held down. | Releases the right mouse button, if held down. | ||
| + | |||
| + | |||
| + | '''Example''' | ||
| + | <source lang="lua"> | ||
| + | mouseRRelease(); -- The right mouse button is no longer being held | ||
| + | </source> | ||
| Line 62: | Line 123: | ||
Move the mouse wheel up or down by 'amount'. 'amount' can be either positive (up) or negative (down). An 'amount' of 100 is roughly one 'tick' of the wheel. | Move the mouse wheel up or down by 'amount'. 'amount' can be either positive (up) or negative (down). An 'amount' of 100 is roughly one 'tick' of the wheel. | ||
| + | |||
| + | |||
| + | '''Example''' | ||
| + | <source lang="lua"> | ||
| + | mouseWheelMove(100); -- The mouse wheel will be scrolled up 100 units. | ||
| + | </source> | ||
| Line 67: | Line 134: | ||
Retrieve the screen coordinates of the mouse. Returns two integers: x and y. | Retrieve the screen coordinates of the mouse. Returns two integers: x and y. | ||
| + | |||
| + | |||
| + | '''Example''' | ||
| + | <source lang="lua"> | ||
| + | x,y = mouseGetPos(); | ||
| + | printf("mouse_x: %d, mouse_y: %d", x, y); -- display the coordinates of the mouse | ||
| + | </source> | ||
| Line 72: | Line 146: | ||
Similar to keyboardSetDelay(), this function sets the delay (in miliseconds) between click and release for functions like mouseLClick() and mouseRClick(). | Similar to keyboardSetDelay(), this function sets the delay (in miliseconds) between click and release for functions like mouseLClick() and mouseRClick(). | ||
| + | |||
| + | |||
| + | '''Example''' | ||
| + | <source lang="lua"> | ||
| + | mouseSetDelay(100); -- The mouse delay is now 100ms | ||
| + | </source> | ||
Revision as of 10:29, 13 July 2008
Contents
mousetSet(x,y)
Sets the mouse's screen position to (x,y), where x and y are integers. Coordinates are absolute. See mouseMove() to specify relative coordinates.
Example
mouseSet(100, 200); -- This will move the mouse to (100,200)
mouseMove(x,y)
Moves the mouse (x,y) pixels, where x and y are integers. Coordinates are relative. See mouseSet to specify absolute coordinates.
Example
mouseMove(5, 10); -- This will move the mouse right 5 pixels and down 10
mouseLClick()
Clicks the left mouse button.
Example
mouseLClick(); -- The left mouse button will be clicked
mouseMClick()
Clicks the middle (or wheel) mouse button.
Example
mouseMClick(); -- The middle/wheel mouse button will be clicked
mouseRClick()
Clicks the right mouse button.
Example
mouseRClick(); -- The right mouse button will be clicked
mouseLHold()
Holds down the left mouse button until a left click or left release. Use mouseLRelease() to release.
Example
mouseLHold(); -- The left mouse button will be held down. Click or use mouseLRelease to release
mouseMHold()
Holds down the middle/wheel mouse button until a middle/wheel click or middle/wheel button release. Use mouseMRelease() to release.
Example
mouseLHold(); -- The middle/wheel mouse button will be held down. Click or use mouseMRelease to release
mouseRHold()
Holds down the right mouse button until a right click or right release. Use mouseRRelease() to release.
Example
mouseRHold(); -- The right mouse button will be held down. Click or use mouseRRelease to release
mouseLRelease()
Releases the left mouse button, if held down.
Example
mouseLRelease(); -- The left mouse button is no longer being held
mouseMRelease()
Releases the middle/wheel mouse button, if held down.
Example
mouseRRelease(); -- The right mouse button is no longer being held
mouseRRelease()
Releases the right mouse button, if held down.
Example
mouseRRelease(); -- The right mouse button is no longer being held
mouseWheelMove()
Move the mouse wheel up or down by 'amount'. 'amount' can be either positive (up) or negative (down). An 'amount' of 100 is roughly one 'tick' of the wheel.
Example
mouseWheelMove(100); -- The mouse wheel will be scrolled up 100 units.
x,y mouseGetPos()
Retrieve the screen coordinates of the mouse. Returns two integers: x and y.
Example
x,y = mouseGetPos();
printf("mouse_x: %d, mouse_y: %d", x, y); -- display the coordinates of the mouse
mouseSetDelay
Similar to keyboardSetDelay(), this function sets the delay (in miliseconds) between click and release for functions like mouseLClick() and mouseRClick().
Example
mouseSetDelay(100); -- The mouse delay is now 100ms
