onMouseWheel
Event
Client Only
Online and Offline
Not Cancellable
Available since Client 1.0.0
function(Event event, int mouse, Vec2 deltaCoordinates, bool flipped)
The onMouseWheel event is invoked when the mouse wheel is scrolled.
Parameters
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. |
Attributes
const | This event cannot be cancelled. |
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.
Examples
There aren't any examples for this event.
Compatibility
There isn't any compatibility information for this event.
Related
Client Related
OnMouseConnected
OnMouseDisconnected
OnMouseDown
OnMouseLeave
OnMouseMove
OnMouseUp
OnMouseWheel