Class: Touch

Members

callbackContext :Object

The context under which callbacks are called.

Source - input/Touch.js, line 31

enabled :boolean

Touch events will only be processed if enabled.

Default Value:

• true

Source - 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 - input/Touch.js, line 73

game :Phaser.Game

A reference to the currently running game.

Source - input/Touch.js, line 19

preventDefault :boolean

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

Default Value:

• true

Source - input/Touch.js, line 67

touchCancelCallback :function

A callback that can be fired on a touchCancel event.

Source - input/Touch.js, line 61

touchEndCallback :function

A callback that can be fired on a touchEnd event.

Source - input/Touch.js, line 46

touchEnterCallback :function

A callback that can be fired on a touchEnter event.

Source - input/Touch.js, line 51

touchLeaveCallback :function

A callback that can be fired on a touchLeave event.

Source - input/Touch.js, line 56

touchMoveCallback :function

A callback that can be fired on a touchMove event.

Source - input/Touch.js, line 41

touchStartCallback :function

A callback that can be fired on a touchStart event.

Source - input/Touch.js, line 36

Methods

consumeTouchMove()

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

Source - 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 - 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 - 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 - 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 - 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 - 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 - input/Touch.js, line 189

start()

Starts the event listeners running.

Source - input/Touch.js, line 121

stop()

Stop the event listeners.

Source - input/Touch.js, line 361