mouse
mouse - Mouse#
Pointer buttons and view control. All output is virtual-HID device input; aim moves in clamped steps and never teleports.
mouse.move#
mouse.move(dx, dy)
Relative pointer move in pixels, converted to HID counts with +/-1 count of per-call noise. No-op when the virtual HID mouse is not connected.
| Parameter | Type | Default | Description |
|---|---|---|---|
dx | number | (required) | Horizontal delta in pixels. |
dy | number | (required) | Vertical delta in pixels. |
mouse.aim#
mouse.aim(x, y, z)
Aim toward a world point in clamped steps: one clamped 20-30 deg step with 0.3-0.9 deg randomized endpoint error, last call per tick wins. Converges over several ticks. No-op without the HID mouse. Prefer util.lead_world + this over writing your own smoothing.
| Parameter | Type | Default | Description |
|---|---|---|---|
x | number | (required) | World X coordinate. |
y | number | (required) | World Y coordinate. |
z | number | (required) | World Z coordinate. |
mouse.direction#
mouse.direction() → { x, y, z }
Current local view direction (unit vector). Zeros when unknown.
mouse.face#
mouse.face(x, y, z)
Turn toward an absolute direction vector (same clamped-step model as mouse.aim).
| Parameter | Type | Default | Description |
|---|---|---|---|
x | number | (required) | World X coordinate. |
y | number | (required) | World Y coordinate. |
z | number | (required) | World Z coordinate. |
mouse.click#
mouse.click([button])
Tap a mouse button (randomized 2-5 tick assert so the game sees the pulse).
| Parameter | Type | Default | Description |
|---|---|---|---|
button | string | 'left' | 'left' |
mouse.down#
mouse.down([button])
Hold a mouse button for this frame - call every tick to keep it held.
| Parameter | Type | Default | Description |
|---|---|---|---|
button | string | 'left' | Button name, same values as mouse.click. |
mouse.up#
mouse.up([button])
Release a mouse button immediately (also clears pending taps and blocks).
| Parameter | Type | Default | Description |
|---|---|---|---|
button | string | 'left' | Button name, same values as mouse.click. |
mouse.held#
mouse.held([button]) → boolean
True while the real button is physically held.
| Parameter | Type | Default | Description |
|---|---|---|---|
button | string | 'left' | Button name, same values as mouse.click. |
Last updated 2026-10-03