Interface MouseButtonOptions

Optional configuration for Mouse.OnButton and Mouse.OnDown.

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

Properties

block? wildcard? deviceId?

Properties

Optionalblock

block?: boolean

If true (default), suppresses the button-down and its paired button-up from reaching other applications. Set to false to observe without blocking. Forced false when deviceId is set.

Optionalwildcard

wildcard?: boolean

If true, triggers even when extra modifier keys are held. Defaults to false (exact modifier match).

OptionaldeviceId

deviceId?: string

Limit this binding to a specific physical mouse device. Obtain the device path from Mouse.OnRawEvent's event.device_id. Device-filtered bindings are always non-blocking.

Settings

Member Visibility

On This Page

Properties