playcanvas/build/playcanvas/src/platform/input/constants.d.ts

PlayCanvas WebGL game engine

export const ACTION_MOUSE: "mouse";
export const ACTION_KEYBOARD: "keyboard";
export const ACTION_GAMEPAD: "gamepad";
export const AXIS_MOUSE_X: "mousex";
export const AXIS_MOUSE_Y: "mousey";
export const AXIS_PAD_L_X: "padlx";
export const AXIS_PAD_L_Y: "padly";
export const AXIS_PAD_R_X: "padrx";
export const AXIS_PAD_R_Y: "padry";
export const AXIS_KEY: "key";
/**
 * @type {number}
 * @category Input
 */
export const KEY_BACKSPACE: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_TAB: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_RETURN: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_ENTER: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_SHIFT: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_CONTROL: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_ALT: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_PAUSE: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_CAPS_LOCK: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_ESCAPE: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_SPACE: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_PAGE_UP: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_PAGE_DOWN: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_END: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_HOME: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_LEFT: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_UP: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_RIGHT: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_DOWN: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_PRINT_SCREEN: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_INSERT: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_DELETE: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_0: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_1: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_2: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_3: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_4: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_5: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_6: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_7: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_8: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_9: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_SEMICOLON: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_EQUAL: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_A: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_B: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_C: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_D: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_E: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_F: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_G: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_H: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_I: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_J: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_K: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_L: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_M: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_N: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_O: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_P: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_Q: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_R: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_S: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_T: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_U: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_V: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_W: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_X: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_Y: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_Z: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_WINDOWS: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_CONTEXT_MENU: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_NUMPAD_0: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_NUMPAD_1: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_NUMPAD_2: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_NUMPAD_3: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_NUMPAD_4: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_NUMPAD_5: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_NUMPAD_6: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_NUMPAD_7: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_NUMPAD_8: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_NUMPAD_9: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_MULTIPLY: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_ADD: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_SEPARATOR: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_SUBTRACT: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_DECIMAL: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_DIVIDE: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_F1: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_F2: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_F3: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_F4: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_F5: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_F6: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_F7: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_F8: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_F9: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_F10: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_F11: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_F12: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_COMMA: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_PERIOD: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_SLASH: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_OPEN_BRACKET: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_BACK_SLASH: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_CLOSE_BRACKET: number;
/**
 * @type {number}
 * @category Input
 */
export const KEY_META: number;
/**
 * No mouse buttons pressed.
 *
 * @category Input
 */
export const MOUSEBUTTON_NONE: -1;
/**
 * The left mouse button.
 *
 * @category Input
 */
export const MOUSEBUTTON_LEFT: 0;
/**
 * The middle mouse button.
 *
 * @category Input
 */
export const MOUSEBUTTON_MIDDLE: 1;
/**
 * The right mouse button.
 *
 * @category Input
 */
export const MOUSEBUTTON_RIGHT: 2;
/**
 * Index for pad 1.
 *
 * @category Input
 */
export const PAD_1: 0;
/**
 * Index for pad 2.
 *
 * @category Input
 */
export const PAD_2: 1;
/**
 * Index for pad 3.
 *
 * @category Input
 */
export const PAD_3: 2;
/**
 * Index for pad 4.
 *
 * @category Input
 */
export const PAD_4: 3;
/**
 * The first face button, from bottom going clockwise.
 *
 * @category Input
 */
export const PAD_FACE_1: 0;
/**
 * The second face button, from bottom going clockwise.
 *
 * @category Input
 */
export const PAD_FACE_2: 1;
/**
 * The third face button, from bottom going clockwise.
 *
 * @category Input
 */
export const PAD_FACE_3: 2;
/**
 * The fourth face button, from bottom going clockwise.
 *
 * @category Input
 */
export const PAD_FACE_4: 3;
/**
 * The first shoulder button on the left.
 *
 * @category Input
 */
export const PAD_L_SHOULDER_1: 4;
/**
 * The first shoulder button on the right.
 *
 * @category Input
 */
export const PAD_R_SHOULDER_1: 5;
/**
 * The second shoulder button on the left.
 *
 * @category Input
 */
export const PAD_L_SHOULDER_2: 6;
/**
 * The second shoulder button on the right.
 *
 * @category Input
 */
export const PAD_R_SHOULDER_2: 7;
/**
 * The select button.
 *
 * @category Input
 */
export const PAD_SELECT: 8;
/**
 * The start button.
 *
 * @category Input
 */
export const PAD_START: 9;
/**
 * The button when depressing the left analogue stick.
 *
 * @category Input
 */
export const PAD_L_STICK_BUTTON: 10;
/**
 * The button when depressing the right analogue stick.
 *
 * @category Input
 */
export const PAD_R_STICK_BUTTON: 11;
/**
 * Direction pad up.
 *
 * @category Input
 */
export const PAD_UP: 12;
/**
 * Direction pad down.
 *
 * @category Input
 */
export const PAD_DOWN: 13;
/**
 * Direction pad left.
 *
 * @category Input
 */
export const PAD_LEFT: 14;
/**
 * Direction pad right.
 *
 * @category Input
 */
export const PAD_RIGHT: 15;
/**
 * Vendor specific button.
 *
 * @category Input
 */
export const PAD_VENDOR: 16;
/**
 * Horizontal axis on the left analogue stick.
 *
 * @category Input
 */
export const PAD_L_STICK_X: 0;
/**
 * Vertical axis on the left analogue stick.
 *
 * @category Input
 */
export const PAD_L_STICK_Y: 1;
/**
 * Horizontal axis on the right analogue stick.
 *
 * @category Input
 */
export const PAD_R_STICK_X: 2;
/**
 * Vertical axis on the right analogue stick.
 *
 * @category Input
 */
export const PAD_R_STICK_Y: 3;
/**
 * Horizontal axis on the touchpad of a XR pad.
 *
 * @category Input
 */
export const XRPAD_TOUCHPAD_X: 0;
/**
 * Vertical axis on the thouchpad of a XR pad.
 *
 * @category Input
 */
export const XRPAD_TOUCHPAD_Y: 1;
/**
 * Horizontal axis on the stick of a XR pad.
 *
 * @category Input
 */
export const XRPAD_STICK_X: 2;
/**
 * Vertical axis on the stick of a XR pad.
 *
 * @category Input
 */
export const XRPAD_STICK_Y: 3;
/**
 * The button when pressing the XR pad's touchpad.
 *
 * @category Input
 */
export const XRPAD_TOUCHPAD_BUTTON: 2;
/**
 * The trigger button from XR pad.
 *
 * @category Input
 */
export const XRPAD_TRIGGER: 0;
/**
 * The squeeze button from XR pad.
 *
 * @category Input
 */
export const XRPAD_SQUEEZE: 1;
/**
 * The button when pressing the XR pad's stick.
 *
 * @category Input
 */
export const XRPAD_STICK_BUTTON: 3;
/**
 * The A button from XR pad.
 *
 * @category Input
 */
export const XRPAD_A: 4;
/**
 * The B button from XR pad.
 *
 * @category Input
 */
export const XRPAD_B: 5;