Class Key

constructor

• new Key(keyCode: number, descriptor: string, game: Game, scene: Scene, keyboardInput: KeyboardInput, keyDown?: (e: KeyboardEvent) => any, keyUp?: (e: KeyboardEvent) => any, keyJustPressed?: (e: KeyboardEvent) => any, keyState?: (e: KeyboardEvent, state: boolean) => any): Key

• description

  Creates a Key instance

  since

  2.0.0

  Parameters

  • keyCode: number

    The Key keyCode

  • descriptor: string

    The Key descriptor, used to set the value to KeyboardInput.keys

  • game: Game

    Game instance

  • scene: Scene

    Scene instance

  • keyboardInput: KeyboardInput

  • Optional keyDown: (e: KeyboardEvent) => any

    • • (e: KeyboardEvent): any

      • Parameters

        • e: KeyboardEvent

        Returns any

  • Optional keyUp: (e: KeyboardEvent) => any

    • • (e: KeyboardEvent): any

      • Parameters

        • e: KeyboardEvent

        Returns any

  • Optional keyJustPressed: (e: KeyboardEvent) => any

    • • (e: KeyboardEvent): any

      • Parameters

        • e: KeyboardEvent

        Returns any

  • Optional keyState: (e: KeyboardEvent, state: boolean) => any

    • • (e: KeyboardEvent, state: boolean): any

      • Parameters

        • e: KeyboardEvent

        • state: boolean

        Returns any

  Returns Key