mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-12-27 10:30:30 +00:00
Code Issues Releases Wiki Activity
ae71eb3cae
CC-Tweaked/doc/events/mouse_click.md
Jonathan Coates 52b78f92cd
Use standard Markdown link syntax for references 
References are now written using normal links: You now use [`print`] or
[print a string][`print`]) instead of @{print} or @{print|print a
string}.
2023-08-24 11:23:33 +01:00

1.1 KiB
Raw Blame History

module: [kind=event] mouse_click

This event is fired when the terminal is clicked with a mouse. This event is only fired on advanced computers (including advanced turtles and pocket computers).

Return values

  1. [string]: The event name.
  2. [number]: The mouse button that was clicked.
  3. [number]: The X-coordinate of the click.
  4. [number]: The Y-coordinate of the click.

Mouse buttons

Several mouse events ([mouse_click], [mouse_up], [mouse_scroll]) contain a "mouse button" code. This takes a numerical value depending on which button on your mouse was last pressed when this event occurred.

Button Code Mouse Button
1 Left button
2 Right button
3 Middle button

Example

Print the button and the coordinates whenever the mouse is clicked.

while true do
  local event, button, x, y = os.pullEvent("mouse_click")
  print(("The mouse button %s was pressed at %d, %d"):format(button, x, y))
end