Class: Input

Members

<static, constant> MOUSE_OVERRIDES_TOUCH :number

Type:

• number

Source:

• input/Input.js, line 40

<static, constant> MOUSE_TOUCH_COMBINE :number

Type:

• number

Source:

• input/Input.js, line 52

<static, constant> TOUCH_OVERRIDES_MOUSE :number

Type:

• number

Source:

• input/Input.js, line 46

activePointer

The most recently active Pointer object. When you've limited max pointers to 1 this will accurately be either the first finger touched or mouse.

Properties:

Name	Type	Description
activePointer	Phaser.Pointer

Default Value:

• null

Source:

• input/Input.js, line 272

circle

A Circle object centered on the x/y screen coordinates of the Input. Default size of 44px (Apples recommended "finger tip" size) but can be changed to anything.

Properties:

Name	Type	Description
circle	Phaser.Circle

Source:

• input/Input.js, line 123

currentPointers

The current number of active Pointers.

Properties:

Name	Type	Description
currentPointers	number

Default Value:

• 0

Source:

• input/Input.js, line 145

disabled

You can disable all Input by setting Input.disabled: true. While set all new input related events will be ignored. If you need to disable just one type of input, for example mouse, use Input.mouse.disabled: true instead

Properties:

Name	Type	Description
disabled	boolean

Default Value:

• false

Source:

• input/Input.js, line 98

doubleTapRate

The number of milliseconds between taps of the same Pointer for it to be considered a double tap / click

Properties:

Name	Type	Description
doubleTapRate	number

Default Value:

• 300

Source:

• input/Input.js, line 159

game

Properties:

Name	Type	Description
game	Phaser.Game	A reference to the currently running game.

Source:

• input/Input.js, line 20

hitCanvas

Properties:

Name	Type	Description
hitCanvas	HTMLCanvasElement	The canvas to which single pixels are drawn in order to perform pixel-perfect hit detection.

Default Value:

• null

Source:

• input/Input.js, line 26

hitContext

Properties:

Name	Type	Description
hitContext	CanvasRenderingContext2D	The context of the pixel perfect hit canvas.

Default Value:

• null

Source:

• input/Input.js, line 32

holdRate

The number of milliseconds that the Pointer has to be pressed down for it to fire a onHold event

Properties:

Name	Type	Description
holdRate	number

Default Value:

• 2000

Source:

• input/Input.js, line 166

interactiveItems

A linked list of interactive objects, the InputHandler components (belonging to Sprites) register themselves with this.

Properties:

Name	Type	Description
interactiveItems	Phaser.LinkedList

Source:

• input/Input.js, line 341

justPressedRate

The number of milliseconds below which the Pointer is considered justPressed

Properties:

Name	Type	Description
justPressedRate	number

Default Value:

• 200

Source:

• input/Input.js, line 173

justReleasedRate

The number of milliseconds below which the Pointer is considered justReleased

Properties:

Name	Type	Description
justReleasedRate	number

Default Value:

• 200

Source:

• input/Input.js, line 180

keyboard

The Keyboard Input manager.

Properties:

Name	Type	Description
keyboard	Phaser.Keyboard	The Keyboard Input manager.

Default Value:

• null

Source:

• input/Input.js, line 293

maxPointers

The maximum number of Pointers allowed to be active at any one time. For lots of games it's useful to set this to 1.

Properties:

Name	Type	Description
maxPointers	number

Default Value:

• 10

Source:

• input/Input.js, line 138

mouse

The Mouse Input manager.

Properties:

Name	Type	Description
mouse	Phaser.Mouse	The Mouse Input manager.

Default Value:

• null

Source:

• input/Input.js, line 286

mousePointer

The mouse has its own unique Phaser.Pointer object which you can use if making a desktop specific game.

Properties:

Name	Type	Description
mousePointer	Pointer

Default Value:

• null

Source:

• input/Input.js, line 279

mspointer

The MSPointer Input manager.

Properties:

Name	Type	Description
mspointer	Phaser.MSPointer	The MSPointer Input manager.

Default Value:

• null

Source:

• input/Input.js, line 307

multiInputOverride

Controls the expected behaviour when using a mouse and touch together on a multi-input device.

Properties:

Name	Type	Description
multiInputOverride	Description

Source:

• input/Input.js, line 104

onDown

A Signal that is dispatched each time a pointer is pressed down.

Properties:

Name	Type	Description
onDown	Phaser.Signal

Default Value:

• null

Source:

• input/Input.js, line 314

onHold

A Signal that is dispatched each time a pointer is held down.

Properties:

Name	Type	Description
onHold	Phaser.Signal

Default Value:

• null

Source:

• input/Input.js, line 335

onTap

A Signal that is dispatched each time a pointer is tapped.

Properties:

Name	Type	Description
onTap	Phaser.Signal

Default Value:

• null

Source:

• input/Input.js, line 328

onUp

A Signal that is dispatched each time a pointer is released.

Properties:

Name	Type	Description
onUp	Phaser.Signal

Default Value:

• null

Source:

• input/Input.js, line 321

pointer1

A Pointer object

Properties:

Name	Type	Description
pointer1	Phaser.Pointer

Source:

• input/Input.js, line 210

pointer2

A Pointer object

Properties:

Name	Type	Description
pointer2	Phaser.Pointer

Source:

• input/Input.js, line 216

pointer3

A Pointer object

Properties:

Name	Type	Description
pointer3	Phaser.Pointer

Source:

• input/Input.js, line 222

pointer4

A Pointer object

Properties:

Name	Type	Description
pointer4	Phaser.Pointer

Source:

• input/Input.js, line 228

pointer5

A Pointer object

Properties:

Name	Type	Description
pointer5	Phaser.Pointer

Source:

• input/Input.js, line 234

pointer6

A Pointer object

Properties:

Name	Type	Description
pointer6	Phaser.Pointer

Source:

• input/Input.js, line 240

pointer7

A Pointer object

Properties:

Name	Type	Description
pointer7	Phaser.Pointer

Source:

• input/Input.js, line 246

pointer8

A Pointer object

Properties:

Name	Type	Description
pointer8	Phaser.Pointer

Source:

• input/Input.js, line 252

pointer9

A Pointer object

Properties:

Name	Type	Description
pointer9	Phaser.Pointer

Source:

• input/Input.js, line 258

pointer10

A Pointer object.

Properties:

Name	Type	Description
pointer10	Phaser.Pointer

Source:

• input/Input.js, line 264

<readonly> pollLocked

Properties:

Name	Type	Description
pollLocked	boolean	True if the Input is currently poll rate locked.

Source:

• input/Input.js, line 722

pollRate

How often should the input pointers be checked for updates? A value of 0 means every single frame (60fps), a value of 1 means every other frame (30fps) and so on.

Properties:

Name	Type	Description
pollRate	number

Default Value:

• 0

Source:

• input/Input.js, line 62

position

Properties:

Name	Type	Description
position	Phaser.Point	A point object representing the current position of the Pointer.

Default Value:

• null

Source:

• input/Input.js, line 110

recordLimit

The total number of entries that can be recorded into the Pointer objects tracking history. If the Pointer is tracking one event every 100ms, then a trackLimit of 100 would store the last 10 seconds worth of history.

Properties:

Name	Type	Description
recordLimit	number

Default Value:

• 100

Source:

• input/Input.js, line 204

recordPointerHistory

Sets if the Pointer objects should record a history of x/y coordinates they have passed through. The history is cleared each time the Pointer is pressed down. The history is updated at the rate specified in Input.pollRate

Properties:

Name	Type	Description
recordPointerHistory	boolean

Default Value:

• false

Source:

• input/Input.js, line 189

recordRate

The rate in milliseconds at which the Pointer objects should update their tracking history

Properties:

Name	Type	Description
recordRate	number

Default Value:

• 100

Source:

• input/Input.js, line 196

scale

The scale by which all input coordinates are multiplied, calculated by the StageScaleMode. In an un-scaled game the values will be x: 1 and y: 1.

Properties:

Name	Type	Description
scale	Phaser.Point

Source:

• input/Input.js, line 130

speed

A point object representing the speed of the Pointer. Only really useful in single Pointer games, otherwise see the Pointer objects directly.

Properties:

Name	Type	Description
speed	Phaser.Point

Source:

• input/Input.js, line 116

tapRate

The number of milliseconds that the Pointer has to be pressed down and then released to be considered a tap or clicke

Properties:

Name	Type	Description
tapRate	number

Default Value:

• 200

Source:

• input/Input.js, line 152

<readonly> totalActivePointers

The total number of active Pointers

Properties:

Name	Type	Description
totalActivePointers	number	The total number of active Pointers.

Source:

• input/Input.js, line 749

<readonly> totalInactivePointers

The total number of inactive Pointers

Properties:

Name	Type	Description
totalInactivePointers	number	The total number of inactive Pointers.

Source:

• input/Input.js, line 735

touch

The Touch Input manager.

Properties:

Name	Type	Description
touch	Phaser.Touch	the Touch Input manager.

Default Value:

• null

Source:

• input/Input.js, line 300

worldX

The world X coordinate of the most recently active pointer.

Properties:

Name	Type	Description
worldX	number	The world X coordinate of the most recently active pointer.

Source:

• input/Input.js, line 775

worldY

The world Y coordinate of the most recently active pointer.

Properties:

Name	Type	Description
worldY	number	The world Y coordinate of the most recently active pointer.

Source:

• input/Input.js, line 788

x

The X coordinate of the most recently active pointer. This value takes game scaling into account automatically. See Pointer.screenX/clientX for source values.

Properties:

Name	Type	Description
x	number	The X coordinate of the most recently active pointer.

Source:

• input/Input.js, line 688

y

The Y coordinate of the most recently active pointer. This value takes game scaling into account automatically. See Pointer.screenY/clientY for source values.

Properties:

Name	Type	Description
y	number	The Y coordinate of the most recently active pointer.

Source:

• input/Input.js, line 705

Methods

addPointer() → {Phaser.Pointer}

Add a new Pointer object to the Input Manager. By default Input creates 3 pointer objects: mousePointer, pointer1 and pointer2. If you need more then use this to create a new one, up to a maximum of 10.

Source:

• input/Input.js, line 400

Returns:

A reference to the new Pointer object that was created.

Type

Phaser.Pointer

<protected> boot()

Starts the Input Manager running.

Source:

• input/Input.js, line 343

destroy()

Stops all of the Input Managers from running.

Source:

• input/Input.js, line 387

getPointer(state) → {Phaser.Pointer}

Get the next Pointer object whos active property matches the given state

Parameters:

Name	Type	Description
state	boolean	The state the Pointer should be in (false for inactive, true for active).

Source:

• input/Input.js, line 622

Returns:

A Pointer object or null if no Pointer object matches the requested state.

Type

Phaser.Pointer

getPointerFromIdentifier(identifier) → {Phaser.Pointer}

Get the Pointer object whos identified property matches the given identifier value.

Parameters:

Name	Type	Description
identifier	number	The Pointer.identifier value to search for.

Source:

• input/Input.js, line 655

Returns:

A Pointer object or null if no Pointer object matches the requested identifier.

Type

Phaser.Pointer

reset(hard)

Reset all of the Pointers and Input states

Parameters:

Name	Type	Description
hard	boolean	A soft reset (hard = false) won't reset any Signals that might be bound. A hard reset will.

Source:

• input/Input.js, line 465

resetSpeed(x, y)

Resets the speed and old position properties.

Parameters:

Name	Type	Description
x	number	Sets the oldPosition.x value.
y	number	Sets the oldPosition.y value.

Source:

• input/Input.js, line 511

startPointer(event) → {Phaser.Pointer}

Find the first free Pointer object and start it, passing in the event data. This is called automatically by Phaser.Touch and Phaser.MSPointer.

Parameters:

Name	Type	Description
event	Any	The event data from the Touch event.

Source:

• input/Input.js, line 524

Returns:

The Pointer object that was started or null if no Pointer object is available.

Type

Phaser.Pointer

stopPointer(event) → {Phaser.Pointer}

Stops the matching Pointer object, passing in the event data.

Parameters:

Name	Type	Description
event	Any	The event data from the Touch event.

Source:

• input/Input.js, line 591

Returns:

The Pointer object that was stopped or null if no Pointer object is available.

Type

Phaser.Pointer

<protected> update()

Updates the Input Manager. Called by the core Game loop.

Source:

• input/Input.js, line 431

updatePointer(event) → {Phaser.Pointer}

Updates the matching Pointer object, passing in the event data. This is called automatically and should not normally need to be invoked.

Parameters:

Name	Type	Description
event	Any	The event data from the Touch event.

Source:

• input/Input.js, line 560

Returns:

The Pointer object that was updated or null if no Pointer object is available.

Type

Phaser.Pointer