mousescroll Synchronous

Submit a mouse-wheel scroll amount to the input bridge. Use it to submit a wheel movement to a focused local interface. The receiving control decides how that movement changes its scroll position.

Syntax

Luau

mousescroll(amount: number) -> ()

Parameters

Function parameters
Parameter	Type	Description
`amount`	`number`	Signed scroll amount.

Returns

()

This function returns no values.

Example

Luau

-- Place the pointer over a scrollable area in your own test UI.
task.wait(3)
if isrbxactive() then
    mousescroll(1)
end