Difference between revisions of "Mouse scroll (event)"

From ComputerCraft Wiki
Jump to: navigation, search
(Added example.)
m (Expanded)
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
−
{{NeedsWork|A demonstration on the use and handling of this event would be beneficial. ''[[User:AfterLifeLochie|AfterLifeLochie]] 15:57, 30 November 2012 (MSK)''}}
 
−
 
 
{{Event
 
{{Event
 
|name=mouse_scroll
 
|name=mouse_scroll
Line 9: Line 7:
 
|examples=
 
|examples=
 
{{Example
 
{{Example
−
|desc=Print the direction and the co-ordinates of every mouse scroll we receive a ''mouse_scroll'' event for.
+
|desc=Prints the direction and the co-ordinates of every mouse scroll we receive a ''mouse_scroll'' event for.
 
|code=
 
|code=
 
  while true do
 
  while true do
−
   scrollDirection, xPos, yPos = os.pullEvent("[[mouse_scroll_(event)|mouse_scroll]]")
+
   local event, scrollDirection, x, y = '''[[os.pullEvent]]("mouse_scroll")'''
 
   [[print]]("mouse_scroll: " .. [[tostring]](scrollDirection) .. ", " ..
 
   [[print]]("mouse_scroll: " .. [[tostring]](scrollDirection) .. ", " ..
−
     "X: " .. [[tostring]](xPos) .. ", " ..
+
     "X: " .. [[tostring]](x) .. ", " ..
−
     "Y: " .. [[tostring]](yPos))
+
     "Y: " .. [[tostring]](y))
 
  end
 
  end
 
|output=The direction the mouse-wheel was scrolled in, followed by the X and Y position of the event.
 
|output=The direction the mouse-wheel was scrolled in, followed by the X and Y position of the event.
 +
}}
 +
{{Example
 +
|desc=A variable <var>i</var> keeps track of the relative value of the scroll: every time a mouse-scroll occurs, the code checks the direction, incrementing the variable by one for every scroll up and decrementing the variable by one for every scroll down.
 +
|code= local i = 0
 +
 +
while true do
 +
    [[term.clear]]()
 +
   
 +
    local _, srollDirection, x, y = '''[[os.pullEvent]]("mouse_scroll")'''
 +
   
 +
    if scrollDirection == -1 then
 +
      i = i + 1
 +
    elseif scrollDirection == 1 then
 +
      i = i - 1
 +
    end
 +
   
 +
    [[term.setCursorPos]](x, y)
 +
    [[term.write]](i)
 +
end
 +
|output=At the coordinates of the scroll, the counter value <var>i</var> is printed.
 
}}
 
}}
 
}}
 
}}

Latest revision as of 17:45, 10 April 2014


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
Prints the direction and the co-ordinates of every mouse scroll we receive a mouse_scroll event for.
Code 
while true do
  local event, scrollDirection, x, y = os.pullEvent("mouse_scroll")
  print("mouse_scroll: " .. tostring(scrollDirection) .. ", " ..
    "X: " .. tostring(x) .. ", " ..
    "Y: " .. tostring(y))
end
Output The direction the mouse-wheel was scrolled in, followed by the X and Y position of the event.



Grid paper.png  Example
A variable i keeps track of the relative value of the scroll: every time a mouse-scroll occurs, the code checks the direction, incrementing the variable by one for every scroll up and decrementing the variable by one for every scroll down.
Code 
local i = 0

while true do
   term.clear()
   
   local _, srollDirection, x, y = os.pullEvent("mouse_scroll")
   
   if scrollDirection == -1 then
      i = i + 1
   elseif scrollDirection == 1 then
      i = i - 1
   end
   
   term.setCursorPos(x, y)
   term.write(i)
end
Output At the coordinates of the scroll, the counter value i is printed.
Retrieved from "https://www.computercraft.info/wiki/index.php?title=Mouse_scroll_(event)&oldid=6432"