Mouse drag (event) - Revision history

SGunner2014: Fixed the second example as it would just clear the screen whilst the background colour was set to red. tl;dr: I moved the term.setBackgroundColor(colors.black) to the start of example two.

2014-11-11T09:06:10Z

Fixed the second example as it would just clear the screen whilst the background colour was set to red. tl;dr: I moved the term.setBackgroundColor(colors.black) to the start of example two.

Oeed: Removed NeedsWork tag, added short desciption

2014-03-25T04:26:39Z

Removed NeedsWork tag, added short desciption

Eric: Missing braces

2013-01-20T13:25:54Z

Missing braces

TheOriginalBIT: Added a graphical code example

2013-01-18T17:23:20Z

Added a graphical code example

AfterLifeLochie: Updated error with only listing two event parameters, and not three.

2012-12-27T11:22:47Z

Updated error with only listing two event parameters, and not three.

91.156.36.126 at 03:12, 1 December 2012

2012-12-01T03:12:28Z

91.156.36.126 at 03:11, 1 December 2012

2012-12-01T03:11:46Z

AfterLifeLochie: Added example, this time I won't forget to filter. ;P

2012-12-01T00:32:45Z

Added example, this time I won't forget to filter. ;P

AfterLifeLochie: Created event page

2012-11-30T12:00:41Z

Created event page

New page

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

{{Event
|name=mouse_drag
|desc=Fired when the mouse is dragged (implies that a [[mouse_click_(event)|mouse_click]] event has already occurred).
|return1=The new X-coordinate of the mouse (in screen-characters).
|return2=The new Y-coordinate of the mouse (in screen-characters).
}}

@@ Line 25: / Line 25: @@
   y = 5
   while true do
     [[term.setBackgroundColor]]( colors.black )
     [[paintutils.drawPixel]]( x, y, colors.red )

← Older revision		Revision as of 04:26, 25 March 2014
Line 1:		Line 1:
−	~~{{NeedsWork\|A demonstration on the use and handling of this~~ event ~~would be beneficial~~. ''[[~~User:AfterLifeLochie~~\|~~AfterLifeLochie~~]] ~~16:00~~, ~~30 November 2012 (MSK)''}}~~	+	The mouse_drag event occurs every time the mouse is moved until the user releases the mouse button. It will always occur after a [[mouse_click_(event)\|mouse_click]] event. The event will only be fired when the mouse moves to another character position, dragging within the same character will have no effect.

	{{Event		{{Event

@@ Line 37: / Line 37: @@
   end
 |output=
 }}

@@ Line 5: / Line 5: @@
 |desc=Fired when the mouse is dragged (implies that a [[mouse_click_(event)|mouse_click]] event has already occurred).
 |return1=The mouse button that was clicked.
-|return2=The X-coordinate of the click (in screen-characters).
+|return2=The X-coordinate of the mouse (in screen-characters).
-|return3=The Y-coordinate of the click (in screen-characters).
+|return3=The Y-coordinate of the mouse (in screen-characters).
 |examples=
 {{Example
@@ Line 13: / Line 13: @@
   while true do
     _, button, xPos, yPos = os.pullEvent("[[mouse_drag_(event)|mouse_drag]]")
-    [[print]]("mouse_drag => " .. tostring(button) .. ": " ..
+    [[print]]("mouse_drag => " .. [[tostring]](button) .. ": " ..
       "X: " .. [[tostring]](xPos) .. ", " ..
       "Y: " .. [[tostring]](yPos))
@@ Line 19: / Line 19: @@
 |output=The X and Y position of the mouse during the drag.
 }}
 }}

@@ Line 4: / Line 4: @@
 |name=mouse_drag
 |desc=Fired when the mouse is dragged (implies that a [[mouse_click_(event)|mouse_click]] event has already occurred).
-|return1=The new X-coordinate of the mouse (in screen-characters).
+|return1=The mouse button that was clicked.
-|return2=The new Y-coordinate of the mouse (in screen-characters).
+|return2=The X-coordinate of the click (in screen-characters).
 |examples=
 {{Example
@@ Line 12: / Line 13: @@
   while true do
     _, button, xPos, yPos = os.pullEvent("[[mouse_drag_(event)|mouse_drag]]")
-    [[print]]("mouse_drag: X: " .. [[tostring]](xPos) .. ", " ..
+    [[print]]("mouse_drag => " .. tostring(button) .. ": " ..
       "Y: " .. [[tostring]](yPos))
   end
 |output=The X and Y position of the mouse during the drag.
 }}
 }}