Class Mouse

constructor

• new Mouse(button: 0 | 1 | 4 | 2 | 3, descriptor: string, game: Game, scene: Scene, mouseInput: MouseInput, mouseDown?: (e: MouseEvent) => any, mouseUp?: (e: MouseEvent) => any, mouseMove?: (e: MouseEvent) => any): Mouse

• description

  Creates a Mouse instance

  since

  2.0.0

  Parameters

  • button: 0 | 1 | 4 | 2 | 3

    Mouse button

  • descriptor: string

    Mouse descriptor

  • game: Game

    Game instance

  • scene: Scene

    Scene instance

  • mouseInput: MouseInput

    MouseInput that the Mouse is attached to

  • Optional mouseDown: (e: MouseEvent) => any

    • • (e: MouseEvent): any

      • Parameters

        • e: MouseEvent

        Returns any

  • Optional mouseUp: (e: MouseEvent) => any

    • • (e: MouseEvent): any

      • Parameters

        • e: MouseEvent

        Returns any

  • Optional mouseMove: (e: MouseEvent) => any

    • • (e: MouseEvent): any

      • Parameters

        • e: MouseEvent

        Returns any

  Returns Mouse