Class: Touch

Phaser. Touch

The Touch class handles touch interactions with the game and the resulting Pointer objects.

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:

Members

callbackContext

Properties:
Name Type Description
callbackContext Object

The context under which callbacks are called.

Source:

disabled

Properties:
Name Type Description
disabled boolean

You can disable all Touch events by setting disabled = true. While set all new touch events will be ignored.

Source:

event

Properties:
Name Type Description
event TouchEvent

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

Default Value:
  • null
Source:

game

Properties:
Name Type Description
game Phaser.Game

A reference to the currently running game.

Source:

preventDefault

Properties:
Name Type Description
preventDefault boolean

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

Default Value:
  • true
Source:

touchCancelCallback

Properties:
Name Type Description
touchCancelCallback function

A callback that can be fired on a touchCancel event.

Source:

touchEndCallback

Properties:
Name Type Description
touchEndCallback function

A callback that can be fired on a touchEnd event.

Source:

touchEnterCallback

Properties:
Name Type Description
touchEnterCallback function

A callback that can be fired on a touchEnter event.

Source:

touchLeaveCallback

Properties:
Name Type Description
touchLeaveCallback function

A callback that can be fired on a touchLeave event.

Source:

touchMoveCallback

Properties:
Name Type Description
touchMoveCallback function

A callback that can be fired on a touchMove event.

Source:

touchStartCallback

Properties:
Name Type Description
touchStartCallback function

A callback that can be fired on a touchStart event.

Source:

Methods

consumeTouchMove()

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

Source:

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:

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:

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:

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:

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:

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:

start()

Starts the event listeners running.

Source:

stop()

Stop the event listeners.

Source:
Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev on Tue Apr 29 2014 14:51:37 GMT+0100 (BST) using the DocStrap template.