Interface MouseButtonOptions

Optional configuration for Mouse.OnButton, Mouse.OnDown, and Mouse.OnUp.

interface MouseButtonOptions {
    block?: boolean;
    wildcard?: boolean;
    deviceId?: string;
}

Properties

block? wildcard? deviceId?

Properties

Optionalblock

block?: boolean

If true, the matching mouse event is suppressed from reaching other applications. Defaults to true for Mouse.OnButton and Mouse.OnDown; defaults to false for Mouse.OnUp. Forced to false when deviceId is set.

Optionalwildcard

wildcard?: boolean

If true, the binding triggers even when extra modifier keys are held. Defaults to false.

OptionaldeviceId

deviceId?: string

Device path string to limit the binding to a specific physical mouse. Device-filtered bindings are always non-blocking.

Settings

Member Visibility

On This Page

Properties