InputMap
Defined in: input/inputMap.ts:202
A live set of named actions, as defineInputMap answers it. Query it by name from a system; the map recomputes itself once per frame, so every read within a frame sees the same values.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new InputMap(
actions):InputMap
Defined in: input/inputMap.ts:207
Parameters
Section titled “Parameters”actions
Section titled “actions”Record<string, ActionDef>
Returns
Section titled “Returns”InputMap
Methods
Section titled “Methods”actions()
Section titled “actions()”actions():
string[]
Defined in: input/inputMap.ts:256
Returns
Section titled “Returns”string[]
axis2d()
Section titled “axis2d()”axis2d(
name):Vec2
Defined in: input/inputMap.ts:252
2D value (axis2d); scalar actions return {value, 0}. A fresh object each call.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”cancelListen()
Section titled “cancelListen()”cancelListen():
void
Defined in: input/inputMap.ts:315
Cancel a pending listenForBinding (resolves it with null).
Returns
Section titled “Returns”void
down()
Section titled “down()”down(
name):boolean
Defined in: input/inputMap.ts:246
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean
getBindings()
Section titled “getBindings()”getBindings(
name):Binding[]
Defined in: input/inputMap.ts:259
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Binding[]
isListening()
Section titled “isListening()”isListening():
boolean
Defined in: input/inputMap.ts:319
Returns
Section titled “Returns”boolean
listenForBinding()
Section titled “listenForBinding()”listenForBinding(
opts?):Promise<Binding|null>
Defined in: input/inputMap.ts:304
Resolve with the next physical input the user presses (or null if cancelled / superseded by another listen). Drives a rebind UI — the evaluation system feeds it each frame, so the map must be installed and the app running.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<Binding | null>
load()
Section titled “load()”load(
key):boolean
Defined in: input/inputMap.ts:293
Apply bindings previously saved under key; returns true if found.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean
loadJSON()
Section titled “loadJSON()”loadJSON(
data):void
Defined in: input/inputMap.ts:283
Override bindings for actions that EXIST in this map (unknown names ignored, so stale saved data for a removed action never resurrects it).
Parameters
Section titled “Parameters”Record<string, Binding[]>
Returns
Section titled “Returns”void
pressed()
Section titled “pressed()”pressed(
name):boolean
Defined in: input/inputMap.ts:247
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean
rebind()
Section titled “rebind()”rebind(
name,opts?):Promise<Binding|null>
Defined in: input/inputMap.ts:309
Capture the next input and (re)bind it to name (replaces, or appends when append).
Parameters
Section titled “Parameters”string
ListenOptions & object
Returns
Section titled “Returns”Promise<Binding | null>
released()
Section titled “released()”released(
name):boolean
Defined in: input/inputMap.ts:248
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean
save()
Section titled “save()”save(
key):void
Defined in: input/inputMap.ts:291
Save current bindings under key.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
setBindings()
Section titled “setBindings()”setBindings(
name,bindings):void
Defined in: input/inputMap.ts:261
Replace an action’s bindings (no-op for an unknown action).
Parameters
Section titled “Parameters”string
bindings
Section titled “bindings”Binding[]
Returns
Section titled “Returns”void
toAsset()
Section titled “toAsset()”toAsset():
InputMapAsset
Defined in: input/inputMap.ts:274
Serialize the FULL map (action types + bindings) — an .inputmap asset’s
content. (vs toJSON, which is bindings-only for rebind persistence.)
Returns
Section titled “Returns”toJSON()
Section titled “toJSON()”toJSON():
Record<string,Binding[]>
Defined in: input/inputMap.ts:266
Serialize current bindings (persist via Storage).
Returns
Section titled “Returns”Record<string, Binding[]>
value()
Section titled “value()”value(
name):number
Defined in: input/inputMap.ts:250
Scalar value: button [0,1], axis [-1,1], axis2d the magnitude [0,1].
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”number