These archived docs are for Phaser 2.2.2 Phaser 3 docs can be found on newdocs.phaser.io.
Phaser CE docs can be found on the Phaser CE Documentation site.

Constructor

Phaser. Touch

new Touch(game)

Phaser.Touch handles touch events with your game. Note: Android 2.x only supports 1 touch event at once, no multi-touch.

Parameters
Name Type Description
game Phaser.Game

A reference to the currently running game.

Source code: input/Touch.js, line 14

Public Properties

callbackContext : Object

The context under which callbacks are called.

Source code: input/Touch.js, line 31

enabled : boolean

Touch events will only be processed if enabled.

Default Value
  • true
Source code: input/Touch.js, line 26

event :TouchEvent

The browser touch DOM event. Will be set to null if no touch event has ever been received.

Default Value
  • null
Source code: input/Touch.js, line 73

game : Phaser.Game

A reference to the currently running game.

Source code: input/Touch.js, line 19

preventDefault : boolean

If true the TouchEvent will have prevent.default called on it.

Default Value
  • true
Source code: input/Touch.js, line 67

touchCancelCallback : Function

A callback that can be fired on a touchCancel event.

Source code: input/Touch.js, line 61

touchEndCallback : Function

A callback that can be fired on a touchEnd event.

Source code: input/Touch.js, line 46

touchEnterCallback : Function

A callback that can be fired on a touchEnter event.

Source code: input/Touch.js, line 51

touchLeaveCallback : Function

A callback that can be fired on a touchLeave event.

Source code: input/Touch.js, line 56

touchMoveCallback : Function

A callback that can be fired on a touchMove event.

Source code: input/Touch.js, line 41

touchStartCallback : Function

A callback that can be fired on a touchStart event.

Source code: input/Touch.js, line 36

Public Methods

consumeTouchMove()

Consumes all touchmove events on the document (only enable this if you know you need it!).

Source code: input/Touch.js, line 175

onTouchCancel(event)

Touch cancel - touches that were disrupted (perhaps by moving into a plugin or browser chrome). Occurs for example on iOS when you put down 4 fingers and the app selector UI appears.

Parameters
Name Type Description
event TouchEvent

The native event from the browser. This gets stored in Touch.event.

Source code: input/Touch.js, line 223

onTouchEnd(event)

The handler for the touchend events.

Parameters
Name Type Description
event TouchEvent

The native event from the browser. This gets stored in Touch.event.

Source code: input/Touch.js, line 332

onTouchEnter(event)

For touch enter and leave its a list of the touch points that have entered or left the target. Doesn't appear to be supported by most browsers on a canvas element yet.

Parameters
Name Type Description
event TouchEvent

The native event from the browser. This gets stored in Touch.event.

Source code: input/Touch.js, line 257

onTouchLeave(event)

For touch enter and leave its a list of the touch points that have entered or left the target. Doesn't appear to be supported by most browsers on a canvas element yet.

Parameters
Name Type Description
event TouchEvent

The native event from the browser. This gets stored in Touch.event.

Source code: input/Touch.js, line 284

onTouchMove(event)

The handler for the touchmove events.

Parameters
Name Type Description
event TouchEvent

The native event from the browser. This gets stored in Touch.event.

Source code: input/Touch.js, line 306

onTouchStart(event)

The internal method that handles the touchstart event from the browser.

Parameters
Name Type Description
event TouchEvent

The native event from the browser. This gets stored in Touch.event.

Source code: input/Touch.js, line 189

start()

Starts the event listeners running.

Source code: input/Touch.js, line 121

stop()

Stop the event listeners.

Source code: input/Touch.js, line 361