1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2025-10-22 17:37:38 +00:00
Files
CC-Tweaked/doc/events/mouse_scroll.md
Jonathan Coates 70a24d371d Update build.gradle to more closely match CC:T's
- Adds cct-javadoc fun and renables checkstyle (yay?)
 - Fixes a few javadoc and formatting issues
 - Cherry pick the docs so illuaminate doesn't complain
2021-11-27 09:32:25 +00:00

600 B

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