1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-11-06 18:16:23 +00:00
CC-Tweaked/doc/events/mouse_up.md
Jonathan Coates 440fca6535
Relicense a couple of more files
We've got in touch with Brady, so can now do the last of the docs \o/!

Also pick up a couple of stragglers that I'd missed from before.
2023-10-11 08:00:07 +01:00

712 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