@megavr/ecsy-babylon/src/components/Input.ts

babylon.js ecsy binding and helpers

import { Entity } from "ecsy";
import { SceneComponent } from "./types/index";

export enum InputTypes {
  Keyboard = "Keyboard"
}
/**
 * @example Keyboard
 * ```
 * entity.addComponent(Input, { onKey: onKey });
 * function onKey(key, down, up) {
 *   if (down) console.log(key + " is pressing.");
 * }
 * ```
 */
export class Input implements SceneComponent {
  scene?: Entity;
  /** @default "Keyboard" */
  type?: InputTypes = InputTypes.Keyboard;
  /** 
   * Return key value when detect keydown or keyup behaviuor. 
   * @memberof Keyboard
   */
  onKey?: Input.KeyDownUpInput;
}

namespace Input {
  export interface KeyDownUpInput {
    (key: string, down: boolean, up: boolean): void;
  }
}