Kiln API / kiln / InputState

Class: InputState

The Input resource. Read it with res.get(Input): axis (x: right−left, y: up−down, length ≤ 1), down('jump'), pressed('jump'), released('jump'), value('fire'), and pointer.

pressed/released are true for exactly one fixed step when read in Fixed, and for exactly one frame when read elsewhere, however many fixed steps a frame runs.

Constructors

Constructor

new InputState(): InputState;

Returns

InputState

Properties

axis

readonly axis: object;

Move axis from left/right/up/down (or the left stick). Unit length at most.

x

x: number = 0;

y

y: number = 0;

---

pointer

readonly pointer: object;

Pointer in canvas pixels and normalized device coords (y up), plus deltas this frame.

x

x: number = 0;

y

y: number = 0;

ndcX

ndcX: number = 0;

ndcY

ndcY: number = 0;

dx

dx: number = 0;

dy

dy: number = 0;

wheel

wheel: number = 0;

down

down: boolean = false;

---

values

values: Map<string, number>;

---

downSet

downSet: Set<string>;

---

framePressed

framePressed: Set<string>;

---

frameReleased

frameReleased: Set<string>;

---

fixedPressed

fixedPressed: Set<string>;

---

fixedReleased

fixedReleased: Set<string>;

---

inFixed

inFixed: () => boolean;

Returns

boolean

Methods

down()

down(action): boolean;

True while the action is held.

Parameters

Parameter	Type
action	string

Returns

boolean

---

pressed()

pressed(action): boolean;

True on the step (in Fixed) or frame (elsewhere) the action went down.

Parameters

Parameter	Type
action	string

Returns

boolean

---

released()

released(action): boolean;

True on the step (in Fixed) or frame (elsewhere) the action went up.

Parameters

Parameter	Type
action	string

Returns

boolean

---

value()

value(action): number;

Analog value 0..1 (triggers, stick directions); 0 or 1 for keys.

Parameters

Parameter	Type
action	string

Returns

number

---

toJSON()

toJSON(): object;

Returns

object

axis

axis: object;

axis.x

x: number = 0;

axis.y

y: number = 0;

down

down: string[];