1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-06-22 21:23:21 +00:00
CC-Tweaked/doc/events/mouse_drag.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

767 B

module: [kind=event] mouse_drag see: mouse_click For when a mouse button is initially pressed.

This event is fired every time the mouse is moved while a mouse button is being held.

Return values

  1. @{string}: The event name.
  2. @{number}: The mouse button that is being pressed.
  3. @{number}: The X-coordinate of the mouse.
  4. @{number}: The Y-coordinate of the mouse.

Example

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

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