1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-11-15 14:24:55 +00:00
CC-Tweaked/doc/events/mouse_drag.md
SquidDev 9ae0f4a993 Add some initial documentation for events
Credit to @BradyFromDiscord for writing these. See #640 and #565.

Co-authored-by: Brady <bradyakent@gmail.com
2021-01-14 18:37:20 +00:00

661 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