Mouse scroll (event)

From ComputerCraft Wiki
Revision as of 00:34, 1 December 2012 by AfterLifeLochie (Talk | contribs) (Added example.)

Jump to: navigation, search
This page needs some serious TLC, stat!
Please help us by cleaning it, fixing it up, or sparing it some love.
(Reason: A demonstration on the use and handling of this event would be beneficial. AfterLifeLochie 15:57, 30 November 2012 (MSK))


Grid Modem.png  Event mouse_scroll
Fired when a mousewheel is scrolled in the terminal
Returned Object 1 The direction of the mouse-scroll (-1 = up, 1 = down).
Returned Object 2 The X-coordinate of the scroll (in screen-characters).
Returned Object 3 The Y-coordinate of the scroll (in screen-characters).

Examples

Grid paper.png  Example
Print the direction and the co-ordinates of every mouse scroll we receive a mouse_scroll event for.
Code
while true do
  scrollDirection, xPos, yPos = os.pullEvent("mouse_scroll")
  print("mouse_scroll: " .. tostring(scrollDirection) .. ", " ..
    "X: " .. tostring(xPos) .. ", " ..
    "Y: " .. tostring(yPos))
end
Output The direction the mouse-wheel was scrolled in, followed by the X and Y position of the event.