Difference between revisions of "Mouse click (event)"

From ComputerCraft Wiki
Jump to: navigation, search
(Clarified the output of return1)
(Advanced systems only.)
Line 1: Line 1:
 
{{Event
 
{{Event
 
|name=mouse_click
 
|name=mouse_click
|desc=Fired when the terminal is clicked.
+
|desc=Fired when the terminal of an advanced system is clicked. Unavailable to normal systems, as these lack mouse support (except via attached [[Advanced Monitor]]s, which grant access to the [[monitor_touch_(event)|monitor_touch event]]).
 
|return1=The mouse button that was clicked. Left Mouse Button is returned as the number 1, and Right Mouse Button is returned as the number 2
 
|return1=The mouse button that was clicked. Left Mouse Button is returned as the number 1, and Right Mouse Button is returned as the number 2
 
|return2=The X-coordinate of the click (in screen-characters).
 
|return2=The X-coordinate of the click (in screen-characters).

Revision as of 02:52, 13 August 2014


Grid Modem.png  Event mouse_click
Fired when the terminal of an advanced system is clicked. Unavailable to normal systems, as these lack mouse support (except via attached Advanced Monitors, which grant access to the monitor_touch event).
Returned Object 1 The mouse button that was clicked. Left Mouse Button is returned as the number 1, and Right Mouse Button is returned as the number 2
Returned Object 2 The X-coordinate of the click (in screen-characters).
Returned Object 3 The Y-coordinate of the click (in screen-characters).

Examples

Grid paper.png  Example
Print the button and the co-ordinates of every mouse click we receive a mouse_click event.
Code
while true do
  local event, button, xPos, yPos = os.pullEvent("mouse_click")
  print("Mouse button clicked: ", button, " => Click Position X: ", xPos, " => Click Position Y: ", yPos)
end
Output The button that was pressed, followed by the X and Y position of the event.