InspectorDriveInput
Defined in: Inspector.ts:445
Synthetic input for a drive. The setters write input state and return; the three that hold a key across frames issue those frames and are awaited.
Methods
Section titled “Methods”clearAll()
Section titled “clearAll()”clearAll():
void
Defined in: Inspector.ts:457
Releases every synthetic key, pointer and pad input at once.
Returns
Section titled “Returns”void
fireAction()
Section titled “fireAction()”fireAction(
name,frames?):Promise<void>
Defined in: Inspector.ts:474
Fires name once per frame for frames frames. Each frame is a fresh
one-frame pulse, so isJustPressed reads true on every one of them.
Parameters
Section titled “Parameters”string
frames?
Section titled “frames?”number
Returns
Section titled “Returns”Promise<void>
gamepadAxis()
Section titled “gamepadAxis()”gamepadAxis(
side,value):void
Defined in: Inspector.ts:455
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
gamepadButton()
Section titled “gamepadButton()”gamepadButton(
code,pressed):void
Defined in: Inspector.ts:454
Parameters
Section titled “Parameters”string
pressed
Section titled “pressed”boolean
Returns
Section titled “Returns”void
hold()
Section titled “hold()”hold(
code,frames):Promise<void>
Defined in: Inspector.ts:469
Parameters
Section titled “Parameters”string
frames
Section titled “frames”number
Returns
Section titled “Returns”Promise<void>
keyDown()
Section titled “keyDown()”keyDown(
code):void
Defined in: Inspector.ts:446
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
keyUp()
Section titled “keyUp()”keyUp(
code):void
Defined in: Inspector.ts:447
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
mouseDown()
Section titled “mouseDown()”mouseDown(
button?):void
Defined in: Inspector.ts:449
Parameters
Section titled “Parameters”button?
Section titled “button?”0 | 1 | 2
Returns
Section titled “Returns”void
mouseMove()
Section titled “mouseMove()”mouseMove(
x,y):void
Defined in: Inspector.ts:448
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”void
mouseUp()
Section titled “mouseUp()”mouseUp(
button?):void
Defined in: Inspector.ts:450
Parameters
Section titled “Parameters”button?
Section titled “button?”0 | 1 | 2
Returns
Section titled “Returns”void
pointerDown()
Section titled “pointerDown()”pointerDown(
button?,opts?):void
Defined in: Inspector.ts:452
Parameters
Section titled “Parameters”button?
Section titled “button?”0 | 1 | 2
Returns
Section titled “Returns”void
pointerMove()
Section titled “pointerMove()”pointerMove(
x,y,opts?):void
Defined in: Inspector.ts:451
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”void
pointerUp()
Section titled “pointerUp()”pointerUp(
button?,opts?):void
Defined in: Inspector.ts:453
Parameters
Section titled “Parameters”button?
Section titled “button?”0 | 1 | 2
number
Returns
Section titled “Returns”void
tap(
code,frames?):Promise<void>
Defined in: Inspector.ts:468
Holds code for one frame unless told otherwise, then releases it.
Parameters
Section titled “Parameters”string
frames?
Section titled “frames?”number
Returns
Section titled “Returns”Promise<void>
whileHolding()
Section titled “whileHolding()”whileHolding<
T>(codes,fn):Promise<T>
Defined in: Inspector.ts:466
Holds codes for the duration of fn, then restores what was held
before — including when fn throws — and resolves with whatever fn
returned. A code already down on entry is left alone at both ends, so
nested holds compose by lexical scope: an inner call that repeats one of
the outer call’s codes does not drop it, and neither does a code a plain
keyDown is holding.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”readonly string[]
() => Promise<T>
Returns
Section titled “Returns”Promise<T>