Volt

mousescroll

Simulates mouse wheel scrolling.

Syntax

mousescroll(delta: number) -> void

Parameters

ParameterTypeDescription
deltanumberScroll amount (positive = up, negative = down)

Returns

This function does not return a value.

Description

mousescroll simulates scrolling the mouse wheel. Positive values scroll up, negative values scroll down.

Example

-- Scroll up
mousescroll(3)

-- Scroll down
mousescroll(-3)

-- Smooth scroll
for i = 1, 10 do
    mousescroll(1)
    task.wait(0.05)
end

On this page