Class ScriptedProvider

Programmatic InputProvider — actions are driven by direct method calls instead of real keyboard / touch / gamepad events.

Used by the multi-instance test harness so scenarios can simulate inputs without a DOM. Add to any InputManager via inputManager.addProvider(scripted) — the whole pipeline (action map, InputBuffer, combo detector, BaseScene.actions) works exactly as it does for real input.

Two modes:

set(action, true|false) — sticky: stays in that state until changed
pulse(action, frames) — held down for the next N polled frames
apply(state) — bulk set from a { action: boolean } map
clear() — release everything

Example

const scripted = new ScriptedProvider();
inputManager.addProvider(scripted);
scripted.set('jump', true);
scripted.pulse('attack', 3);

Implements

InputProvider

Index

Constructors

constructor

Methods

apply clear consumeAction destroy isActionDown pulse set update

Constructors

constructor

new ScriptedProvider(): ScriptedProvider
Returns ScriptedProvider

Methods

apply

apply(state: Record<string, boolean>): void
Apply a flat snapshot of action states (true/false). Unlisted actions are unchanged.
Parameters
- state: Record<string, boolean>
Returns void
- Defined in packages/clik-engine/src/input/providers/ScriptedProvider.ts:56

clear

clear(): void
Release every action and cancel any in-flight pulses.

Returns void
- Defined in packages/clik-engine/src/input/providers/ScriptedProvider.ts:50

consumeAction

consumeAction(_action: string): boolean
Check if provider detected a one-shot gesture for this action (e.g. swipe)
Parameters
- _action: string
Returns boolean
Implementation of InputProvider.consumeAction
- Defined in packages/clik-engine/src/input/providers/ScriptedProvider.ts:82

destroy

destroy(): void
Clean up all listeners

Returns void
Implementation of InputProvider.destroy
- Defined in packages/clik-engine/src/input/providers/ScriptedProvider.ts:86

isActionDown

isActionDown(action: string): boolean
Check if an action is currently down via this provider
Parameters
- action: string
Returns boolean
Implementation of InputProvider.isActionDown
- Defined in packages/clik-engine/src/input/providers/ScriptedProvider.ts:76

pulse

pulse(action: string, frames?: number): void
Hold an action down for the next frames polls (default 1).
Parameters
- action: string
- frames: number = 1
Returns void
- Defined in packages/clik-engine/src/input/providers/ScriptedProvider.ts:43

set

set(action: string, pressed: boolean): void
Set an action's held state. Pass true to press, false to release.
Parameters
- action: string
- pressed: boolean
Returns void
- Defined in packages/clik-engine/src/input/providers/ScriptedProvider.ts:34

update

update(): void
Poll the provider and update action states

Returns void
Implementation of InputProvider.update
- Defined in packages/clik-engine/src/input/providers/ScriptedProvider.ts:62

Class ScriptedProvider

Example

Implements

Index

Constructors

Methods

Constructors

constructor

Returns ScriptedProvider

Methods

apply

Parameters

Returns void

clear

Returns void

consumeAction

Parameters

Returns boolean

destroy

Returns void

isActionDown

Parameters

Returns boolean

pulse

Parameters

Returns void

set

Parameters

Returns void

update

Returns void

Settings

On This Page