1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-12-12 11:10:29 +00:00
CC-Tweaked/doc/events/mouse_up.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

647 B

module: [kind=event] mouse_up

This event is fired when a mouse button is released or a held mouse leaves the computer's terminal.

Return values

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

Example

Prints the coordinates and button number whenever the mouse is released.

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