API reference
Every public class, method, and event in @codexo/exojs. Generated from source.
typeSerializedActionBinding
One action's binding in its persistable form - the shape a BindingProfile stores and a save file round-trips. Chord and sequence bindings are stored NORMALIZED (alternatives of channel groups, and steps of those) rather than as the `'Control+S|Meta+S'` shorthand a developer may have written the default with: the shorthand resolves only `Keyboard` names, so a player who rebinds a chord onto a gamepad button could not be expressed in it. `kind` is validated against the live action when a profile is applied. A stored binding whose kind no longer matches is rejected rather than partially applied - an action that changed from a button into an axis between builds is a developer-side break, not something to guess at.
import { SerializedActionBinding } from '@codexo/exojs'One action's binding in its persistable form - the shape a BindingProfile stores and a save file round-trips.
Chord and sequence bindings are stored NORMALIZED (alternatives of channel groups, and steps of those) rather than as the `'Control+S|Meta+S'` shorthand a developer may have written the default with: the shorthand resolves only `Keyboard` names, so a player who rebinds a chord onto a gamepad button could not be expressed in it.
`kind` is validated against the live action when a profile is applied. A stored binding whose kind no longer matches is rejected rather than partially applied - an action that changed from a button into an axis between builds is a developer-side break, not something to guess at.
{ binding: ReadonlyArray<ReadonlyArray<readonly InputTokenStable, persistable identifier for one input control. A token is lowercase ASCII, uses `.` as the namespace separator and `-` inside a name: `keyboard.space`,…[]>>; kind: "sequence" } | { binding: ReadonlyArray<readonly InputTokenStable, persistable identifier for one input control. A token is lowercase ASCII, uses `.` as the namespace separator and `-` inside a name: `keyboard.space`,…[]>; kind: "chord" } | { binding: readonly InputTokenStable, persistable identifier for one input control. A token is lowercase ASCII, uses `.` as the namespace separator and `-` inside a name: `keyboard.space`,…[]; kind: "button" } | { binding: readonly SerializedAxisEntryOne alternative of a serialized AxisAction binding.[]; kind: "axis" } | { binding: readonly SerializedVectorEntryOne alternative of a serialized VectorAction binding.[]; kind: "vector" }