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](code 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.

Constructor

new InputPlugin(scene)

Parameters

name	type	optional	description
scene	Phaser.Scene	No	A reference to the Scene that this Input Plugin is responsible for.

Scope: static

Extends

Phaser.Events.EventEmitter

Source: src/input/InputPlugin.js#L29
Since: 3.0.0

Public Members

activePointer

activePointer: Phaser.Input.Pointer

Description:

The current active input Pointer.

Source: src/input/InputPlugin.js#L3271
Since: 3.0.0

cameras

cameras: Phaser.Cameras.Scene2D.CameraManager

Description:

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

Source: src/input/InputPlugin.js#L149
Since: 3.0.0

displayList

displayList: Phaser.GameObjects.DisplayList

Description:

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

Source: src/input/InputPlugin.js#L140
Since: 3.0.0

dragDistanceThreshold

dragDistanceThreshold: number

Description:

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

Source: src/input/InputPlugin.js#L247
Since: 3.0.0

dragTimeThreshold

dragTimeThreshold: number

Description:

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 or setPollRate.

Source: src/input/InputPlugin.js#L257
Since: 3.0.0

enabled

enabled: boolean

Description:

If true this Input Plugin will process DOM input events.

Source: src/input/InputPlugin.js#L130
Since: 3.5.0

gamepad

gamepad: Phaser.Input.Gamepad.GamepadPlugin

Description:

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.

Source: src/input/gamepad/GamepadPlugin.js#L630
Since: 3.10.0

isOver

isOver: boolean

Description:

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

Source: src/input/InputPlugin.js#L3235
Since: 3.16.0

keyboard

keyboard: Phaser.Input.Keyboard.KeyboardPlugin

Description:

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.

Source: src/input/keyboard/KeyboardPlugin.js#L946
Since: 3.10.0

manager

manager: Phaser.Input.InputManager

Description:

A reference to the Game Input Manager.

Source: src/input/InputPlugin.js#L111
Since: 3.0.0

mouse

mouse: Phaser.Input.Mouse.MouseManager

Description:

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.

Source: src/input/InputPlugin.js#L161
Since: 3.0.0

mousePointer

mousePointer: Phaser.Input.Pointer

Description:

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.

Source: src/input/InputPlugin.js#L3252
Since: 3.10.0