Mouse capture. While captured, raw-input mouse records are added to the totals Input.PollMouse returns and are not passed to Fallout 76.
Start capturing mouse input
__SFCodeObj.call("Input.BeginMouseCapture"):BooleanNo arguments.
BooleanResets the totals and starts capture. Returns false when the game window subclass could not be installed; capture stays on and the next call retries the install.
Read and reset mouse totals
__SFCodeObj.call("Input.PollMouse"):StringNo arguments.
String (JSON)| Field | Type | Description |
|---|---|---|
dx | int | Horizontal motion in raw mouse units. |
dy | int | Vertical motion in raw mouse units. |
wheel | int | Wheel delta, 120 per notch. |
left | Boolean | Left button physically held. |
right | Boolean | Right button physically held. |
leftPressed | Boolean | Left button went down since the previous poll. |
rightPressed | Boolean | Right button went down since the previous poll. |
capturing | Boolean |
Sample result
{"dx":12,"dy":-3,"wheel":120,"left":false,"right":false,"leftPressed":false,"rightPressed":false,"capturing":true}Returns the motion and wheel totals since the previous poll and resets them. Relative motion only: records with absolute coordinates (tablets, remote desktop) add no motion. All values are zero and capturing is false while capture is off.
Stop capturing mouse input
__SFCodeObj.call("Input.EndMouseCapture"):BooleanNo arguments.
BooleanAlways true.