Kiln API / kiln / InputController

Interface: InputController

What app.input exposes. Implemented by the input plugin.

Methods

script()

script(events): InputController;

Queues scripted input, relative to the current frame.

Parameters

Parameter	Type
events	readonly ScriptEvent[]

Returns

InputController

---

press()

press(action): InputController;

Holds an action down from the next frame on.

Parameters

Parameter	Type
action	string

Returns

InputController

---

release()

release(action): InputController;

Parameters

Parameter	Type
action	string

Returns

InputController

---

tap()

tap(action): InputController;

Presses on the next frame and releases the frame after.

Parameters

Parameter	Type
action	string

Returns

InputController

---

setAxis()

setAxis(x, y): InputController;

Parameters

Parameter	Type
x	number
y	number

Returns

InputController

---

clearAxis()

clearAxis(): InputController;

Returns

InputController

---

reset()

reset(): InputController;

Drops scripted state and pending events.

Returns

InputController

---

record()

record(): object;

Starts recording what the game sees as a script: action values (press/release), the move axis when a stick or script drives it, and the pointer. stop() returns it (peek() copies it so far); script() replays it.

Returns

object

stop()

stop(): ScriptEvent[];

Returns

ScriptEvent[]

peek()

peek(): ScriptEvent[];

Returns

ScriptEvent[]