OnMouseWheel: Difference between revisions

Latest revision as of 20:28, 19 November 2022

Event Client Only Online and Offline Not Cancellable

Available since Client 1.0.0

onMouseWheel(Event event, int mouse, Vec2 deltaCoordinates, bool flipped)

The onMouseWheel event is invoked when the mouse wheel is scrolled.

1)	Event	event	The event object for this event.
2)	int	mouse	The ID of the mouse.
3)	Vec2	deltaCoordinates	The 2D delta coordinates for the mouse wheel scroll(s).
4)	bool	flipped	Whether the coordinates are flipped.

const	This event cannot be cancelled.

The deltaCoordinates are relative to the scroll direction. For example, the Y coordinate will show a positive or negative number indicating the vertical scroll speed. If flipped is false, scrolling up will be positive, and down will be negative.

There aren't any examples for this event.

There isn't any compatibility information for this event.

@@ Line 1: / Line 1: @@
-{{ScriptItem
+{{ScriptItem2
-|endpoint = client
+|name = onMouseWheel
+|side = client
 |type = event
-|name = onMouseWheel
+|games = iii vc sa iv
-|usage = the mouse wheel is scrolled
+|desc = the mouse wheel is scrolled
-|callbackParameters = Event event, int mouse, Vec2 deltaCoordinates, bool flipped
+|arg1 = int mouse The ID of the mouse.
-|parameter1 = int mouse The ID of the mouse.
+|arg2 = Vec2 deltaCoordinates The 2D delta coordinates for the mouse wheel scroll(s).
-|parameter2 = Vec2 deltaCoordinates The 2D delta coordinates for the mouse wheel scroll(s).
+|arg3 = bool flipped Whether the coordinates are flipped.
-|parameter3 = bool flipped Whether the coordinates are flipped.
+|note = The deltaCoordinates are relative to the scroll direction. For example, the Y coordinate will show a positive or negative number indicating the vertical scroll speed. If flipped is false, scrolling up will be positive, and down will be negative.
-|cancellable = false
+|cancel = false
-|notes = The deltaCoordinates are relative to the scroll direction. For example, the Y coordinate will show a positive or negative number indicating the vertical scroll speed. If flipped is false, scrolling up will be positive, and down will be negative.
 }}