1681-engine / index / Actions

Class: Actions<A>

Defined in: src/input/Actions.ts:50

Type Parameters

Type Parameter
A extends string

Constructors

Constructor

new Actions<A>(
   keyboard, 
   bindings, 
   options?
): Actions<A>;

Defined in: src/input/Actions.ts:69

Parameters

Parameter	Type
keyboard	Keyboard | null
bindings	Bindings<A>
options	ActionsOptions

Returns

Actions<A>

Accessors

replaying

Get Signature

get replaying(): boolean;

Defined in: src/input/Actions.ts:137

Whether a replay is driving the actions now.

Returns

boolean

Methods

axis()

axis(negative, positive): number;

Defined in: src/input/Actions.ts:178

value(positive) - value(negative), in −1…1.

Parameters

Parameter	Type
negative	A
positive	A

Returns

number

---

bind()

bind(action, inputs): void;

Defined in: src/input/Actions.ts:81

Replaces one action's bindings (a player's rebinding).

Parameters

Parameter	Type
action	A
inputs	readonly string[]

Returns

void

---

bindingsOf()

bindingsOf(action): readonly string[];

Defined in: src/input/Actions.ts:85

Parameters

Parameter	Type
action	A

Returns

readonly string[]

---

down()

down(action): boolean;

Defined in: src/input/Actions.ts:158

Held this step.

Parameters

Parameter	Type
action	A

Returns

boolean

---

endStep()

endStep(): void;

Defined in: src/input/Actions.ts:191

Ends the step: the keyboard forgets its edges; virtual taps shorter than a step have now been seen.

Returns

void

---

flush()

flush(): void;

Defined in: src/input/Actions.ts:201

Drops every pending edge: what went down or up since the last step is forgotten, and what is held now counts as already held, so the next poll reports no pressed or released for it. For input that sat unread while something else had the keys (a pause menu over the level; SceneManager.pop calls it through Scene.useInput).

Returns

void

---

poll()

poll(): void;

Defined in: src/input/Actions.ts:111

Reads every device once; call at the start of each simulation step.

Returns

void

---

press()

press(name): void;

Defined in: src/input/Actions.ts:90

A touch UI's virtual button went down: touch:<name> bindings read it.

Parameters

Parameter	Type
name	string

Returns

void

---

pressed()

pressed(action): boolean;

Defined in: src/input/Actions.ts:168

Went down this step.

Parameters

Parameter	Type
action	A

Returns

boolean

---

release()

release(name): void;

Defined in: src/input/Actions.ts:95

Parameters

Parameter	Type
name	string

Returns

void

---

released()

released(action): boolean;

Defined in: src/input/Actions.ts:173

Came up this step.

Parameters

Parameter	Type
action	A

Returns

boolean

---

replay()

replay(source): void;

Defined in: src/input/Actions.ts:132

Takes each step's values from source instead of the devices (an InputPlayer), until it returns null; then the devices answer again. Pass null to stop at once.

Parameters

Parameter	Type
source	(() => ReadonlyMap<A, number> | null) | null

Returns

void

---

rumble()

rumble(options, padIndex?): Promise<boolean>;

Defined in: src/input/Actions.ts:103

Rumbles the gamepads the actions read: every connected one, or only padIndex among them. Resolves true when any played; a pad without rumble is skipped silently.

Parameters

Parameter	Type
options	RumbleOptions
padIndex?	number

Returns

Promise<boolean>

---

tap()

tap(tap): () => void;

Defined in: src/input/Actions.ts:142

Calls tap with every step's values right after poll (an InputRecorder); returns the stop.

Parameters

Parameter	Type
tap	(values) => void

Returns

() => void

---

value()

value(action): number;

Defined in: src/input/Actions.ts:163

How far it is held (0–1): 1 for a key, the trigger or stick amount for analog input.

Parameters

Parameter	Type
action	A

Returns

number

---

vector()

vector(
   left, 
   right, 
   up, 
   down
): [number, number];

Defined in: src/input/Actions.ts:183

A 2D direction from four actions, never longer than 1 (a diagonal is not faster).

Parameters

Parameter	Type
left	A
right	A
up	A
down	A

Returns

[number, number]