API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

C

classVectorAction

@codexo/exojs / input / stable

A named two-dimensional input, fed by a stick, by four direction buttons, or by several such bindings at once. Each alternative binding is evaluated as a whole vector and the longest one wins, so x never comes from the keyboard while y comes from the pad. The result is clamped to unit length rather than normalized: a digital diagonal is no faster than a cardinal direction, while analog input below full deflection keeps its magnitude.

6
props
1
methods
0
events
Import
import { VectorAction } from '@codexo/exojs'

A named two-dimensional input, fed by a stick, by four direction buttons, or by several such bindings at once.

Each alternative binding is evaluated as a whole vector and the longest one wins, so x never comes from the keyboard while y comes from the pad. The result is clamped to unit length rather than normalized: a digital diagonal is no faster than a cardinal direction, while analog input below full deflection keeps its magnitude.

Constructors1
new(binding: OneOrManyA single value or a list of alternatives. Actions accept one binding directly and several as an array - there are no variadic constructors, so the options obje…<VectorBindingA two-dimensional binding with at least one source.>, options: ActionOptionsOptions shared by every action.): VectorAction
Methods1
serialize(): SerializedActionBindingOne 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…
This action's effective binding in persistable form.
Properties6
kind: "vector"
Which action kind this is - the discriminant a serialized binding is validated against.
value: VectorConcrete mutable 2D vector with full AbstractVector arithmetic and Collidable collision support (treated as a point collider). `Vector.temp` provides a shared…
Current vector. The same instance every frame - copy it if you need to retain a value.
active: boolean
true while the vector's length exceeds the action's threshold.
binding: Binding
The binding currently in effect: the default, or whatever last replaced it.
channels: readonly number[]
Absolute channel indices this action reads right now. Reflects the effective binding and the owning map's gamepad slot, and is what an InputScope claims on this action's behalf. The array is replaced, not mutated, on every rebind - do not retain it across one.
defaultBinding: Binding
The binding this action was constructed with - what a null rebind restores.
Source
src/input/actions/VectorAction.ts