Atlas Engine
API Referenceatlasatlas/input

InputAction

Named button or axis mapping. Register it before querying it.

Module: atlas/input

Named button or axis mapping. Register it before querying it.

Declaration

export class InputAction { ... }

Properties

triggers

triggers: Trigger[];

axisTriggers

axisTriggers: AxisTrigger[];

name

name: string;

isAxis

isAxis: boolean;

isAxisSingle

isAxisSingle: boolean;

normalized

Whether to normalize the two-dimensional action value.

normalized: boolean;

invertY

Whether to invert the action Y axis.

invertY: boolean;

Methods

createButtonAction

Creates a named digital action from button bindings; register the returned action before polling it.

static createButtonAction(
            name: string,
            triggers: Trigger[],
        ): InputAction;

createAxisAction

Creates a named axis action from axis bindings; register the returned action before polling it.

static createAxisAction(
            name: string,
            axisTriggers: AxisTrigger[],
        ): InputAction;

createSingleAxisAction

Creates a single axis using positive and negative button bindings.

static createSingleAxisAction(
            name: string,
            positiveTrigger: Trigger,
            negativeTrigger: Trigger,
        ): InputAction;

Examples

import { Input, InputAction, Key, Trigger } from "atlas/input";
Input.addAction(InputAction.createButtonAction("jump", [Trigger.fromKey(Key.Space)]));

On this page