mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-11-16 23:04:53 +00:00
Code Issues Releases Wiki Activity
bc03090ca4
CC-Tweaked/doc/events/mouse_scroll.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

704 B
Raw Blame History

module: [kind=event] mouse_scroll

This event is fired when a mouse wheel is scrolled in the terminal.

Return values

  1. [string]: The event name.
  2. [number]: The direction of the scroll. (-1 = up, 1 = down)
  3. [number]: The X-coordinate of the mouse when scrolling.
  4. [number]: The Y-coordinate of the mouse when scrolling.

Example

Prints the direction of each scroll, and the position of the mouse at the time.

while true do
  local event, dir, x, y = os.pullEvent("mouse_scroll")
  print(("The mouse was scrolled in direction %s at %d, %d"):format(dir, x, y))
end