mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-12-14 20:20:30 +00:00
Code Issues Releases Wiki Activity
d6751b8e3d
CC-Tweaked/doc/events/mouse_click.md
Jonathan Coates 895bc7721a
License CC:T according to the REUSE specification (#1351) 
This adds SPDX license headers to all source code files, following the
REUSE[1] specification. This does not include any asset files (such as
generated JSON files, or textures). While REUSE does support doing so
with ".license" files, for now we define these licences using the
.reuse/dep5 file.

[1]: https://reuse.software/
2023-03-15 21:52:13 +00: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