phaser/resources/docgen/output/Phaser.Touch.json

{"class":{"name":"Phaser.Touch","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null}],"help":"Phaser.Touch handles touch events with your game. Note: Android 2.x only supports 1 touch event at once, no multi-touch."},"consts":[],"methods":{"public":[{"name":"consumeTouchMove","static":false,"returns":null,"help":"Consumes all touchmove events on the document (only enable this if you know you need it!).","line":178,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"onTouchCancel","static":false,"returns":null,"help":"Touch cancel - touches that were disrupted (perhaps by moving into a plugin or browser chrome).\\nOccurs for example on iOS when you put down 4 fingers and the app selector UI appears.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["TouchEvent"],"help":"The native event from the browser. This gets stored in Touch.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onTouchEnd","static":false,"returns":null,"help":"The handler for the touchend events.","line":336,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["TouchEvent"],"help":"The native event from the browser. This gets stored in Touch.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onTouchEnter","static":false,"returns":null,"help":"For touch enter and leave its a list of the touch points that have entered or left the target.\\nDoesn't appear to be supported by most browsers on a canvas element yet.","line":262,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["TouchEvent"],"help":"The native event from the browser. This gets stored in Touch.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onTouchLeave","static":false,"returns":null,"help":"For touch enter and leave its a list of the touch points that have entered or left the target.\\nDoesn't appear to be supported by most browsers on a canvas element yet.","line":289,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["TouchEvent"],"help":"The native event from the browser. This gets stored in Touch.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onTouchMove","static":false,"returns":null,"help":"The handler for the touchmove events.","line":310,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["TouchEvent"],"help":"The native event from the browser. This gets stored in Touch.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onTouchStart","static":false,"returns":null,"help":"The internal method that handles the touchstart event from the browser.","line":193,"public":true,"protected":false,"private":false,"parameters":[{"name":"event","type":["TouchEvent"],"help":"The native event from the browser. This gets stored in Touch.event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"start","static":false,"returns":null,"help":"Starts the event listeners running.","line":124,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"stop","static":false,"returns":null,"help":"Stop the event listeners.","line":364,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"callbackContext","type":["object"],"help":"","inlineHelp":"The context under which callbacks are called.","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"disabled","type":["boolean"],"help":"","inlineHelp":"You can disable all Touch events by setting disabled = true. While set all new touch events will be ignored.","line":25,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"event","type":["TouchEvent"],"help":"","inlineHelp":"The browser touch DOM event. Will be set to null if no touch event has ever been received.","line":72,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running game.","line":19,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"preventDefault","type":["boolean"],"help":"","inlineHelp":"If true the TouchEvent will have prevent.default called on it.","line":66,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"touchCancelCallback","type":["function"],"help":"","inlineHelp":"A callback that can be fired on a touchCancel event.","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"touchEndCallback","type":["function"],"help":"","inlineHelp":"A callback that can be fired on a touchEnd event.","line":45,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"touchEnterCallback","type":["function"],"help":"","inlineHelp":"A callback that can be fired on a touchEnter event.","line":50,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"touchLeaveCallback","type":["function"],"help":"","inlineHelp":"A callback that can be fired on a touchLeave event.","line":55,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"touchMoveCallback","type":["function"],"help":"","inlineHelp":"A callback that can be fired on a touchMove event.","line":40,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"touchStartCallback","type":["function"],"help":"","inlineHelp":"A callback that can be fired on a touchStart event.","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_onTouchCancel","type":["function"],"help":"","inlineHelp":"Internal event handler reference.","line":108,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onTouchEnd","type":["function"],"help":"","inlineHelp":"Internal event handler reference.","line":90,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onTouchEnter","type":["function"],"help":"","inlineHelp":"Internal event handler reference.","line":96,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onTouchLeave","type":["function"],"help":"","inlineHelp":"Internal event handler reference.","line":102,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onTouchMove","type":["function"],"help":"","inlineHelp":"Internal event handler reference.","line":114,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_onTouchStart","type":["function"],"help":"","inlineHelp":"Internal event handler reference.","line":78,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}}