mousescroll

Simulates mouse wheel scrolling.

Syntax

mousescroll(delta: number) -> ()

Parameters

ParameterTypeDescription
deltanumberSigned wheel delta; positive scrolls up and negative scrolls down

Returns

This function does not return a value.

Description

mousescroll sends a mouse-wheel event at the current cursor position.

Example

-- Scroll up
mousescroll(120)

-- Scroll down
mousescroll(-120)

-- Three wheel steps up
mousescroll(120 * 3)