Mouse scroll (event) - Revision history

MKlegoman357: Expanded

2014-04-10T17:45:44Z

Expanded

TheCoryKid: cough Apparently, the Event template doesn't allow for more than three return values?

2013-05-04T08:31:34Z

*cough* Apparently, the Event template doesn't allow for more than three return values?

TheCoryKid: Removed the NeedsWork and fixed my own error.

2013-05-04T08:29:19Z

Removed the NeedsWork and fixed my own error.

TheCoryKid: The description and code example were both wrong. Fixed the return values, changed the example to reflect this, and added a second example.

2013-05-04T08:27:05Z

The description and code example were both wrong. Fixed the return values, changed the example to reflect this, and added a second example.

AfterLifeLochie: Added example.

2012-12-01T00:34:46Z

Added example.

AfterLifeLochie: Created event page.

2012-11-30T11:57:23Z

Created event page.

New page

{{NeedsWork|A demonstration on the use and handling of this event would be beneficial. ''[[User:AfterLifeLochie|AfterLifeLochie]] 15:57, 30 November 2012 (MSK)''}}

{{Event
|name=mouse_scroll
|desc=Fired when a mousewheel is scrolled in the terminal
|return1=The direction of the mouse-scroll (<var>-1</var> = up, <var>1</var> = down).
|return2=The X-coordinate of the scroll (in screen-characters).
|return3=The Y-coordinate of the scroll (in screen-characters).
}}

@@ Line 7: / Line 7: @@
 |examples=
 {{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=
   while true do
-    _, dir, x, y = os.pullEvent("[[mouse_scroll_(event)|mouse_scroll]]")
+    local event, scrollDirection, x, y = '''[[os.pullEvent]]("mouse_scroll")'''
-    [[print]]("mouse_scroll: " .. [[tostring]](dir) .. ", " ..
+    [[print]]("mouse_scroll: " .. [[tostring]](scrollDirection) .. ", " ..
       "X: " .. [[tostring]](x) .. ", " ..
       "Y: " .. [[tostring]](y))
@@ Line 18: / Line 18: @@
 }}
 {{Example
-|desc=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.
+|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=
+|code= local i = 0
- i = 0
   while true do
-     term.clear()
+     [[term.clear]]()
-     _, dir, x, y = os.pullEvent("[[mouse_scroll_(event)|mouse_scroll]]")
-     if dir == -1 then
+    local _, srollDirection, x, y = '''[[os.pullEvent]]("mouse_scroll")'''
         i = i + 1
-     elseif dir == 1 then
+     elseif scrollDirection == 1 then
         i = i - 1
      end
      term.setCursorPos(x, y)
-     term.write(i)
+    [[term.setCursorPos]](x, y)
   end
-|output=At the coordinates of the scroll, the counter value is printed.
+|output=At the coordinates of the scroll, the counter value <var>i</var> is printed.
 }}
 }}

@@ Line 2: / Line 2: @@
 |name=mouse_scroll
 |desc=Fired when a mousewheel is scrolled in the terminal
-|return1=The name of the event.
+|return1=The direction of the mouse-scroll (<var>-1</var> = up, <var>1</var> = down).
-|return2=The direction of the mouse-scroll (<var>-1</var> = up, <var>1</var> = down).
+|return2=The X-coordinate of the scroll (in screen-characters).
-|return3=The X-coordinate of the scroll (in screen-characters).
+|return3=The Y-coordinate of the scroll (in screen-characters).
-|return4=The Y-coordinate of the scroll (in screen-characters).
 |examples=
 {{Example

@@ Line 1: / Line 1: @@
 {{Event
 |name=mouse_scroll
@@ Line 25: / Line 23: @@
   i = 0
   while true do
-   term.clear()
+    term.clear()
-   _, dir, x, y = os.pullEvent("[[mouse_scroll_(event)|mouse_scroll]]")
+    _, dir, x, y = os.pullEvent("[[mouse_scroll_(event)|mouse_scroll]]")
-   if dir == -1 then
+    if dir == -1 then
-     i = i + 1
+       i = i + 1
-   elseif dir == 1 then
+    elseif dir == 1 then
-     i = i - 1
+       i = i - 1
-   end
+    end
-   term.setCursorPos(x, y)
+    term.setCursorPos(x, y)
-   term.write(i)
+    term.write(i)
 |output=At the coordinates of the scroll, the counter value is printed.
 }}
 }}

@@ Line 4: / Line 4: @@
 |name=mouse_scroll
 |desc=Fired when a mousewheel is scrolled in the terminal
-|return1=The direction of the mouse-scroll (<var>-1</var> = up, <var>1</var> = down).
+|return1=The name of the event.
-|return2=The X-coordinate of the scroll (in screen-characters).
+|return2=The direction of the mouse-scroll (<var>-1</var> = up, <var>1</var> = down).
-|return3=The Y-coordinate of the scroll (in screen-characters).
+|return3=The X-coordinate of the scroll (in screen-characters).
 |examples=
 {{Example
@@ Line 12: / Line 13: @@
 |code=
   while true do
-    scrollDirection, xPos, yPos = os.pullEvent("[[mouse_scroll_(event)|mouse_scroll]]")
+    _, dir, x, y = os.pullEvent("[[mouse_scroll_(event)|mouse_scroll]]")
-    [[print]]("mouse_scroll: " .. [[tostring]](scrollDirection) .. ", " ..
+    [[print]]("mouse_scroll: " .. [[tostring]](dir) .. ", " ..
-      "X: " .. [[tostring]](xPos) .. ", " ..
+      "X: " .. [[tostring]](x) .. ", " ..
-      "Y: " .. [[tostring]](yPos))
+      "Y: " .. [[tostring]](y))
   end
 |output=The direction the mouse-wheel was scrolled in, followed by the X and Y position of the event.
 }}
 }}