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
-
- Source:
Properties:
Name Type Description callbackContextObject The context under which callbacks are called.
-
disabled
-
- Source:
Properties:
Name Type Description disabledboolean You can disable all Touch events by setting disabled = true. While set all new touch events will be ignored.
-
event
-
- Default Value:
- null
- Source:
Properties:
Name Type Description eventTouchEvent The browser touch DOM event. Will be set to null if no touch event has ever been received.
-
game
-
- Source:
Properties:
Name Type Description gamePhaser.Game A reference to the currently running game.
-
preventDefault
-
- Default Value:
- true
- Source:
Properties:
Name Type Description preventDefaultboolean If true the TouchEvent will have prevent.default called on it.
-
touchCancelCallback
-
- Source:
Properties:
Name Type Description touchCancelCallbackfunction A callback that can be fired on a touchCancel event.
-
touchEndCallback
-
- Source:
Properties:
Name Type Description touchEndCallbackfunction A callback that can be fired on a touchEnd event.
-
touchEnterCallback
-
- Source:
Properties:
Name Type Description touchEnterCallbackfunction A callback that can be fired on a touchEnter event.
-
touchLeaveCallback
-
- Source:
Properties:
Name Type Description touchLeaveCallbackfunction A callback that can be fired on a touchLeave event.
-
touchMoveCallback
-
- Source:
Properties:
Name Type Description touchMoveCallbackfunction A callback that can be fired on a touchMove event.
-
touchStartCallback
-
- Source:
Properties:
Name Type Description touchStartCallbackfunction A callback that can be fired on a touchStart event.
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 eventTouchEvent 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 eventTouchEvent 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 eventTouchEvent 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 eventTouchEvent 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 eventTouchEvent 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 eventTouchEvent 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: