mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-12-26 10:00:36 +00:00
Code Issues Releases Wiki Activity
d562a051c7
CC-Tweaked/doc/events/mouse_scroll.md
Jonathan Coates 52b78f92cd
Use standard Markdown link syntax for references 
References are now written using normal links: You now use [`print`] or
[print a string][`print`]) instead of @{print} or @{print|print a
string}.
2023-08-24 11:23:33 +01:00

712 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