Class InputPlugin

The Input Plugin belongs to a Scene and handles all input related events and operations for it.

You can access it from within a Scene using this.input.

It emits events directly. For example, you can do:

this.input.on('pointerdown', callback, context);

To listen for a pointer down event anywhere on the game canvas.

Game Objects can be enabled for input by calling their setInteractive method. After which they will directly emit input events:

var sprite = this.add.sprite(x, y, texture);
sprite.setInteractive();
sprite.on('pointerdown', callback, context);

There are lots of game configuration options available relating to input. See the [Input Config object]Phaser.Types.Core.InputConfig for more details, including how to deal with Phaser listening for input events outside of the canvas, how to set a default number of pointers, input capture settings and more.

Please also see the Input examples and tutorials for further information.

Incorrect input coordinates with Angular

If you are using Phaser within Angular, and use nglf or the router, to make the component in which the Phaser game resides change state (i.e. appear or disappear) then you'll need to notify the Scale Manager about this, as Angular will mess with the DOM in a way in which Phaser can't detect directly. Call this.scale.updateBounds() as part of your game init in order to refresh the canvas DOM bounds values, which Phaser uses for input point position calculations.

Hierarchy (View Summary)

EventEmitter
- InputPlugin

Index

Constructors

constructor

Constructors

constructor

new InputPlugin(scene: Scene): InputPlugin
Parameters
- scene: Scene
  A reference to the Scene that this Input Plugin is responsible for.
Returns InputPlugin
Overrides EventEmitter.constructor
- Defined in types/phaser.d.ts:62630

Properties

`Readonly`activePointer

activePointer: Pointer

The current active input Pointer.

cameras

cameras: CameraManager

A reference to the Scene Cameras Manager. This property is set during the boot method.

displayList

displayList: DisplayList

A reference to the Scene Display List. This property is set during the boot method.

dragDistanceThreshold

dragDistanceThreshold: number

The distance, in pixels, a pointer has to move while being held down, before it thinks it is being dragged.

dragTimeThreshold

dragTimeThreshold: number

The amount of time, in ms, a pointer has to be held down before it thinks it is dragging.

The default polling rate is to poll only on move so once the time threshold is reached the drag event will not start until you move the mouse. If you want it to start immediately when the time threshold is reached, you must increase the polling rate by calling [setPollAlways]Phaser.Input.InputPlugin#setPollAlways or [setPollRate]Phaser.Input.InputPlugin#setPollRate.

enabled

enabled: boolean

If true this Input Plugin will process DOM input events.

gamepad

gamepad: GamepadPlugin

An instance of the Gamepad Plugin class, if enabled via the input.gamepad Scene or Game Config property. Use this to create access Gamepads connected to the browser and respond to gamepad buttons.

`Readonly`isOver

isOver: boolean

Are any mouse or touch pointers currently over the game canvas?

keyboard

keyboard: KeyboardPlugin

An instance of the Keyboard Plugin class, if enabled via the input.keyboard Scene or Game Config property. Use this to create Key objects and listen for keyboard specific events.

manager

manager: InputManager

A reference to the Game Input Manager.

mouse

mouse: MouseManager

A reference to the Mouse Manager.

This property is only set if Mouse support has been enabled in your Game Configuration file.

If you just wish to get access to the mouse pointer, use the mousePointer property instead.

`Readonly`mousePointer

mousePointer: Pointer

The mouse has its own unique Pointer object, which you can reference directly if making a desktop specific game. If you are supporting both desktop and touch devices then do not use this property, instead use activePointer which will always map to the most recently interacted pointer.