Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-09-21 15:01:57 +00:00
Code Issues Projects Releases Packages Wiki Activity
phaser/docs/Phaser.Input.html

8092 lines
107 KiB
HTML
Raw Normal View History

Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Class: Input</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<div class="navbar-inner">
<a class="brand" href="index.html">Phaser</a>
<ul class="nav">
<li class="dropdown">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
class="caret"></b></a>
<ul class="dropdown-menu ">
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-0">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.html">Phaser</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<a href="Phaser.Animation.html">Animation</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.AnimationManager.html">AnimationManager</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.AnimationParser.html">AnimationParser</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated documentation.
2013-11-28 15:57:09 +00:00
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.Button.html">Button</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Cache.html">Cache</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Camera.html">Camera</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Canvas.html">Canvas</a>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Circle.html">Circle</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Color.html">Color</a>
More Docs!
2013-10-03 00:21:08 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Device.html">Device</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Easing.html">Easing</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Easing.Back.html">Back</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Easing.Bounce.html">Bounce</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Easing.Circular.html">Circular</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Easing.Cubic.html">Cubic</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Easing.Elastic.html">Elastic</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Easing.Exponential.html">Exponential</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Easing.Linear.html">Linear</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Easing.Quadratic.html">Quadratic</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Easing.Quartic.html">Quartic</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Easing.Quintic.html">Quintic</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
<a href="Phaser.Ellipse.html">Ellipse</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.Events.html">Events</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated documentation.
2013-11-28 15:57:09 +00:00
<a href="Phaser.Filter.html">Filter</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Frame.html">Frame</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.FrameData.html">FrameData</a>
More Docs!
2013-10-03 00:21:08 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<a href="Phaser.Game.html">Game</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated doc files.
2014-02-05 06:29:17 +00:00
<a href="Phaser.Gamepad.html">Gamepad</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated doc files.
2014-02-05 06:29:17 +00:00
<a href="Phaser.GamepadButton.html">GamepadButton</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.Graphics.html">Graphics</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<a href="Phaser.Group.html">Group</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Image.html">Image</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<a href="Phaser.Input.html">Input</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.InputHandler.html">InputHandler</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.Key.html">Key</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.Keyboard.html">Keyboard</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated doc files.
2014-02-05 06:29:17 +00:00
<a href="Phaser.Line.html">Line</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.Loader.html">Loader</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.LoaderParser.html">LoaderParser</a>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.Math.html">Math</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.Mouse.html">Mouse</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.MSPointer.html">MSPointer</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Yet more documentation done.
2013-10-02 19:18:24 +00:00
<a href="Phaser.Net.html">Net</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Particle.html">Particle</a>
</li>
<li class="class-depth-1">
Yet more documentation done.
2013-10-02 19:18:24 +00:00
<a href="Phaser.Particles.html">Particles</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Yet more documentation done.
2013-10-02 19:18:24 +00:00
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.Physics.html">Physics</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.html">Ninja</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.html">P2</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.Body.html">Body</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.Material.html">Material</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<a href="Phaser.Plugin.html">Plugin</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<a href="Phaser.Point.html">Point</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.Pointer.html">Pointer</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Added in a Group.sort demo, also updated the documentation and build files.
2013-11-07 06:10:15 +00:00
<a href="Phaser.Polygon.html">Polygon</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.QuadTree.html">QuadTree</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
More Docs!
2013-10-03 00:21:08 +00:00
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.RetroFont.html">RetroFont</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.ScaleManager.html">ScaleManager</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<a href="Phaser.Signal.html">Signal</a>
</li>
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
<li class="class-depth-1">
<a href="Phaser.SignalBinding.html">SignalBinding</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated doc files.
2014-02-05 06:29:17 +00:00
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
More Docs!
2013-10-03 00:21:08 +00:00
<a href="Phaser.Sound.html">Sound</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
More Docs!
2013-10-03 00:21:08 +00:00
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.Sprite.html">Sprite</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<a href="Phaser.Stage.html">Stage</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<a href="Phaser.State.html">State</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<a href="Phaser.StateManager.html">StateManager</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.Text.html">Text</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated documentation.
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tile.html">Tile</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated documentation.
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated documentation.
2013-11-28 15:57:09 +00:00
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated documentation.
2013-11-28 15:57:09 +00:00
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated documentation.
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tileset.html">Tileset</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Time.html">Time</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated documentation.
2013-11-28 15:57:09 +00:00
<a href="Phaser.Timer.html">Timer</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated doc files.
2014-02-05 06:29:17 +00:00
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.Touch.html">Touch</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Tween.html">Tween</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Utils.html">Utils</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<a href="Phaser.World.html">World</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span8">
<div id="main">
<h1 class="page-title">Class: Input</h1>
<section>
<header>
<h2>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<span class="ancestors"><a href="Phaser.html">Phaser</a>.</span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
Input
</h2>
Updated documentation.
2013-11-28 15:57:09 +00:00
<div class="class-description"><p>Phaser.Input</p></div>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="Input"><span class="type-signature"></span>new Input<span class="signature">(game)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Updated documentation.
2013-11-28 15:57:09 +00:00
<p>Phaser.Input is the Input Manager for all types of Input across Phaser, including mouse, keyboard, touch and MSPointer.
The Input manager is updated automatically by the core game loop.</p>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>game</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>
</td>
<td class="description last"><p>Current game instance.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-15">line 15</a>
</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="MOUSE_OVERRIDES_TOUCH"><span class="type-signature">&lt;static, constant> </span>MOUSE_OVERRIDES_TOUCH<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-312">line 312</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="MOUSE_TOUCH_COMBINE"><span class="type-signature">&lt;static, constant> </span>MOUSE_TOUCH_COMBINE<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-324">line 324</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="TOUCH_OVERRIDES_MOUSE"><span class="type-signature">&lt;static, constant> </span>TOUCH_OVERRIDES_MOUSE<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-318">line 318</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<h4 class="name" id="activePointer"><span class="type-signature"></span>activePointer<span class="type-signature"></span></h4>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dt>
<dd>
<div class="description">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<p>The most recently active Pointer object.
When you've limited max pointers to 1 this will accurately be either the first finger touched or mouse.</p>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="name"><code>activePointer</code></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-207">line 207</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<h4 class="name" id="circle"><span class="type-signature"></span>circle<span class="type-signature"></span></h4>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dt>
<dd>
<div class="description">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<p>A Circle object centered on the x/y screen coordinates of the Input.
Default size of 44px (Apples recommended &quot;finger tip&quot; size) but can be changed to anything.</p>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="name"><code>circle</code></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Circle.html">Phaser.Circle</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-80">line 80</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<h4 class="name" id="currentPointers"><span class="type-signature"></span>currentPointers<span class="type-signature"></span></h4>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="name"><code>currentPointers</code></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type">number</span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>The current number of active Pointers.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dd class="tag-default"><ul class="dummy"><li>0</li></ul></dd>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-97">line 97</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<h4 class="name" id="disabled"><span class="type-signature"></span>disabled<span class="type-signature"></span></h4>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dt>
<dd>
<div class="description">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<p>You can disable all Input by setting Input.disabled = true. While set all new input related events will be ignored.
If you need to disable just one type of input; for example mouse; use Input.mouse.disabled = true instead</p>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="name"><code>disabled</code></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type">boolean</span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-56">line 56</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<h4 class="name" id="doubleTapRate"><span class="type-signature"></span>doubleTapRate<span class="type-signature"></span></h4>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="name"><code>doubleTapRate</code></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type">number</span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>The number of milliseconds between taps of the same Pointer for it to be considered a double tap / click.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dd class="tag-default"><ul class="dummy"><li>300</li></ul></dd>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-109">line 109</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<h4 class="name" id="game"><span class="type-signature"></span>game<span class="type-signature"></span></h4>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="name"><code>game</code></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="description last"><p>A reference to the currently running game.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-20">line 20</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
Updated doc files.
2014-02-05 06:29:17 +00:00
</dl>
</dd>
<dt>
<h4 class="name" id="gamepad"><span class="type-signature"></span>gamepad<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>gamepad</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Gamepad.html">Phaser.Gamepad</a></span>
</td>
<td class="description last"><p>The Gamepad Input manager.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-237">line 237</a>
Updated doc files.
2014-02-05 06:29:17 +00:00
</li></ul></dd>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dl>
</dd>
<dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<h4 class="name" id="hitCanvas"><span class="type-signature"></span>hitCanvas<span class="type-signature"></span></h4>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="name"><code>hitCanvas</code></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<td class="type">
Updated documentation.
2013-11-28 15:57:09 +00:00
<span class="param-type">HTMLCanvasElement</span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The canvas to which single pixels are drawn in order to perform pixel-perfect hit detection.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-26">line 26</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<h4 class="name" id="hitContext"><span class="type-signature"></span>hitContext<span class="type-signature"></span></h4>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="name"><code>hitContext</code></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<td class="type">
Updated documentation.
2013-11-28 15:57:09 +00:00
<span class="param-type">CanvasRenderingContext2D</span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The context of the pixel perfect hit canvas.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-32">line 32</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<h4 class="name" id="holdRate"><span class="type-signature"></span>holdRate<span class="type-signature"></span></h4>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="name"><code>holdRate</code></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type">number</span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>The number of milliseconds that the Pointer has to be pressed down for it to fire a onHold event.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dd class="tag-default"><ul class="dummy"><li>2000</li></ul></dd>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-115">line 115</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<h4 class="name" id="interactiveItems"><span class="type-signature"></span>interactiveItems<span class="type-signature"></span></h4>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dt>
<dd>
<div class="description">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<p>A linked list of interactive objects; the InputHandler components (belonging to Sprites) register themselves with this.</p>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="name"><code>interactiveItems</code></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.LinkedList.html">Phaser.LinkedList</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-274">line 274</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="justPressedRate"><span class="type-signature"></span>justPressedRate<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>justPressedRate</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>The number of milliseconds below which the Pointer is considered justPressed.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>200</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-121">line 121</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="justReleasedRate"><span class="type-signature"></span>justReleasedRate<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>justReleasedRate</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>The number of milliseconds below which the Pointer is considered justReleased .</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>200</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-127">line 127</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="keyboard"><span class="type-signature"></span>keyboard<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>keyboard</code></td>
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Keyboard.html">Phaser.Keyboard</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="description last"><p>The Keyboard Input manager.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-222">line 222</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="maxPointers"><span class="type-signature"></span>maxPointers<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>maxPointers</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>The maximum number of Pointers allowed to be active at any one time. For lots of games it's useful to set this to 1.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>10</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-91">line 91</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="mouse"><span class="type-signature"></span>mouse<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>mouse</code></td>
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Mouse.html">Phaser.Mouse</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="description last"><p>The Mouse Input manager.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-217">line 217</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="mousePointer"><span class="type-signature"></span>mousePointer<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>mousePointer</code></td>
<td class="type">
<span class="param-type">Pointer</span>
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>The mouse has its own unique Phaser.Pointer object which you can use if making a desktop specific game.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-212">line 212</a>
Updated doc files.
2014-02-05 06:29:17 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="moveCallback"><span class="type-signature"></span>moveCallback<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>moveCallback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"><p>An optional callback that will be fired every time the activePointer receives a move event from the DOM. Set to null to disable.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-37">line 37</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="moveCallbackContext"><span class="type-signature"></span>moveCallbackContext<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>moveCallbackContext</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The context in which the moveCallback will be sent. Defaults to Phaser.Input but can be set to any valid JS object.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-42">line 42</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="mspointer"><span class="type-signature"></span>mspointer<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>mspointer</code></td>
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.MSPointer.html">Phaser.MSPointer</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="description last"><p>The MSPointer Input manager.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-232">line 232</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="multiInputOverride"><span class="type-signature"></span>multiInputOverride<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>multiInputOverride</code></td>
<td class="type">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<span class="param-type">number</span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>Controls the expected behaviour when using a mouse and touch together on a multi-input device.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-62">line 62</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="onDown"><span class="type-signature"></span>onDown<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>onDown</code></td>
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>A Signal that is dispatched each time a pointer is pressed down.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-253">line 253</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="onHold"><span class="type-signature"></span>onHold<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>onHold</code></td>
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>A Signal that is dispatched each time a pointer is held down.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-268">line 268</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="onTap"><span class="type-signature"></span>onTap<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>onTap</code></td>
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>A Signal that is dispatched each time a pointer is tapped.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-263">line 263</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="onUp"><span class="type-signature"></span>onUp<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>onUp</code></td>
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>A Signal that is dispatched each time a pointer is released.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-258">line 258</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="pointer1"><span class="type-signature"></span>pointer1<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pointer1</code></td>
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>A Pointer object.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-155">line 155</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="pointer2"><span class="type-signature"></span>pointer2<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pointer2</code></td>
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>A Pointer object.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-160">line 160</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="pointer3"><span class="type-signature"></span>pointer3<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pointer3</code></td>
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>A Pointer object.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-165">line 165</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="pointer4"><span class="type-signature"></span>pointer4<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pointer4</code></td>
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>A Pointer object.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-170">line 170</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="pointer5"><span class="type-signature"></span>pointer5<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pointer5</code></td>
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>A Pointer object.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-175">line 175</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="pointer6"><span class="type-signature"></span>pointer6<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pointer6</code></td>
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>A Pointer object.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-180">line 180</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="pointer7"><span class="type-signature"></span>pointer7<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pointer7</code></td>
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>A Pointer object.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-185">line 185</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="pointer8"><span class="type-signature"></span>pointer8<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pointer8</code></td>
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>A Pointer object.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-190">line 190</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="pointer9"><span class="type-signature"></span>pointer9<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pointer9</code></td>
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>A Pointer object.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-195">line 195</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="pointer10"><span class="type-signature"></span>pointer10<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pointer10</code></td>
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>A Pointer object.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-200">line 200</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="pollLocked"><span class="type-signature">&lt;readonly> </span>pollLocked<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pollLocked</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>True if the Input is currently poll rate locked.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-838">line 838</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="pollRate"><span class="type-signature"></span>pollRate<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pollRate</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>How often should the input pointers be checked for updates? A value of 0 means every single frame (60fps); a value of 1 means every other frame (30fps) and so on.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>0</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-48">line 48</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="position"><span class="type-signature"></span>position<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>position</code></td>
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>A point object representing the current position of the Pointer.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-68">line 68</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="recordLimit"><span class="type-signature"></span>recordLimit<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The total number of entries that can be recorded into the Pointer objects tracking history.
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
If the Pointer is tracking one event every 100ms; then a trackLimit of 100 would store the last 10 seconds worth of history.</p>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>recordLimit</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>100</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-150">line 150</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="recordPointerHistory"><span class="type-signature"></span>recordPointerHistory<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Sets if the Pointer objects should record a history of x/y coordinates they have passed through.
The history is cleared each time the Pointer is pressed down.
The history is updated at the rate specified in Input.pollRate</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>recordPointerHistory</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-136">line 136</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="recordRate"><span class="type-signature"></span>recordRate<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>recordRate</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>The rate in milliseconds at which the Pointer objects should update their tracking history.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>100</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-142">line 142</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
Build files + docs update.
2014-04-15 14:39:23 +00:00
</dl>
</dd>
<dt>
<h4 class="name" id="resetLocked"><span class="type-signature"></span>resetLocked<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>resetLocked</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>If the Input Manager has been reset locked then all calls made to InputManager.reset, such as from a State change, are ignored.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-248">line 248</a>
</li></ul></dd>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dl>
</dd>
<dt>
<h4 class="name" id="scale"><span class="type-signature"></span>scale<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>scale</code></td>
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="description last"><p>The scale by which all input coordinates are multiplied; calculated by the ScaleManager. In an un-scaled game the values will be x = 1 and y = 1.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-85">line 85</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="speed"><span class="type-signature"></span>speed<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>speed</code></td>
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>A point object representing the speed of the Pointer. Only really useful in single Pointer games; otherwise see the Pointer objects directly.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-73">line 73</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="tapRate"><span class="type-signature"></span>tapRate<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>tapRate</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>The number of milliseconds that the Pointer has to be pressed down and then released to be considered a tap or click.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>200</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-103">line 103</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="totalActivePointers"><span class="type-signature">&lt;readonly> </span>totalActivePointers<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The total number of active Pointers</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>totalActivePointers</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The total number of active Pointers.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-865">line 865</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="totalInactivePointers"><span class="type-signature">&lt;readonly> </span>totalInactivePointers<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The total number of inactive Pointers</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>totalInactivePointers</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The total number of inactive Pointers.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-851">line 851</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="touch"><span class="type-signature"></span>touch<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>touch</code></td>
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Touch.html">Phaser.Touch</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="description last"><p>the Touch Input manager.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-227">line 227</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="worldX"><span class="type-signature"></span>worldX<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The world X coordinate of the most recently active pointer.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>worldX</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The world X coordinate of the most recently active pointer.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-891">line 891</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="worldY"><span class="type-signature"></span>worldY<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The world Y coordinate of the most recently active pointer.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>worldY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The world Y coordinate of the most recently active pointer.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-904">line 904</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="x"><span class="type-signature"></span>x<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The X coordinate of the most recently active pointer. This value takes game scaling into account automatically. See Pointer.screenX/clientX for source values.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The X coordinate of the most recently active pointer.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-804">line 804</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="y"><span class="type-signature"></span>y<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The Y coordinate of the most recently active pointer. This value takes game scaling into account automatically. See Pointer.screenY/clientY for source values.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The Y coordinate of the most recently active pointer.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-821">line 821</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<h4 class="name" id="addPointer"><span class="type-signature"></span>addPointer<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="Phaser.Pointer.html">Phaser.Pointer</a>}</span></h4>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dt>
<dd>
<div class="description">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<p>Add a new Pointer object to the Input Manager. By default Input creates 3 pointer objects: mousePointer, pointer1 and pointer2.
If you need more then use this to create a new one, up to a maximum of 10.</p>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-406">line 406</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<p>A reference to the new Pointer object that was created.</p>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="boot"><span class="type-signature">&lt;protected> </span>boot<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Starts the Input Manager running.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-328">line 328</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<h4 class="name" id="destroy"><span class="type-signature"></span>destroy<span class="signature">()</span><span class="type-signature"></span></h4>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dt>
<dd>
<div class="description">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<p>Stops all of the Input Managers from running.</p>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-374">line 374</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dd>
<dt>
<h4 class="name" id="getLocalPosition"><span class="type-signature"></span>getLocalPosition<span class="signature">(displayObject, pointer)</span><span class="type-signature"> &rarr; {<a href="Phaser.Point.html">Phaser.Point</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>This will return the local coordinates of the specified displayObject based on the given Pointer.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>displayObject</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
|
<span class="param-type"><a href="Phaser.Image.html">Phaser.Image</a></span>
</td>
<td class="description last"><p>The DisplayObject to get the local coordinates for.</p></td>
</tr>
<tr>
<td class="name"><code>pointer</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span>
</td>
<td class="description last"><p>The Pointer to use in the check against the displayObject.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-707">line 707</a>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A point containing the coordinates of the Pointer position relative to the DisplayObject.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>
</dd>
</dl>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dd>
<dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<h4 class="name" id="getPointer"><span class="type-signature"></span>getPointer<span class="signature">(state)</span><span class="type-signature"> &rarr; {<a href="Phaser.Pointer.html">Phaser.Pointer</a>}</span></h4>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dt>
<dd>
<div class="description">
<p>Get the next Pointer object whos active property matches the given state</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>state</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>The state the Pointer should be in (false for inactive, true for active).</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-643">line 643</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A Pointer object or null if no Pointer object matches the requested state.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dd>
</dl>
</dd>
<dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<h4 class="name" id="getPointerFromIdentifier"><span class="type-signature"></span>getPointerFromIdentifier<span class="signature">(identifier)</span><span class="type-signature"> &rarr; {<a href="Phaser.Pointer.html">Phaser.Pointer</a>}</span></h4>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dt>
<dd>
<div class="description">
<p>Get the Pointer object whos identified property matches the given identifier value.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>identifier</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The Pointer.identifier value to search for.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-676">line 676</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A Pointer object or null if no Pointer object matches the requested identifier.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dd>
</dl>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</dd>
<dt>
<h4 class="name" id="hitTest"><span class="type-signature"></span>hitTest<span class="signature">(displayObject, pointer, localPoint)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Tests if the pointer hits the given object.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>displayObject</code></td>
<td class="type">
<span class="param-type">DisplayObject</span>
</td>
<td class="description last"><p>The displayObject to test for a hit.</p></td>
</tr>
<tr>
<td class="name"><code>pointer</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span>
</td>
<td class="description last"><p>The pointer to use for the test.</p></td>
</tr>
<tr>
<td class="name"><code>localPoint</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>
</td>
<td class="description last"><p>The local translated point.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-728">line 728</a>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</li></ul></dd>
</dl>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dd>
<dt>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<h4 class="name" id="reset"><span class="type-signature"></span>reset<span class="signature">(<span class="optional">hard</span>)</span><span class="type-signature"></span></h4>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dt>
<dd>
<div class="description">
Build files + docs update.
2014-04-15 14:39:23 +00:00
<p>Reset all of the Pointers and Input states. The optional <code>hard</code> parameter will reset any events or callbacks that may be bound.
Input.reset is called automatically during a State change or if a game loses focus / visibility. If you wish to control the reset
directly yourself then set InputManager.resetLocked to <code>true</code>.</p>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<th>Argument</th>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
Build files + docs update.
2014-04-15 14:39:23 +00:00
<th>Default</th>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>hard</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<td class="attributes">
&lt;optional><br>
</td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
Build files + docs update.
2014-04-15 14:39:23 +00:00
<td class="default">
false
</td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
Build files + docs update.
2014-04-15 14:39:23 +00:00
<td class="description last"><p>A soft reset won't reset any events or callbacks that are bound. A hard reset will.</p></td>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-478">line 478</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="resetSpeed"><span class="type-signature"></span>resetSpeed<span class="signature">(x, y)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Resets the speed and old position properties.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Sets the oldPosition.x value.</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Sets the oldPosition.y value.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-532">line 532</a>
Updated doc files.
2014-02-05 06:29:17 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setMoveCallback"><span class="type-signature"></span>setMoveCallback<span class="signature">(callback, callbackContext)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Sets a callback that is fired every time the activePointer receives a DOM move event such as a mousemove or touchmove.
It will be called every time the activePointer moves, which in a multi-touch game can be a lot of times, so this is best
to only use if you've limited input to a single pointer (i.e. mouse or touch)</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"><p>The callback that will be called each time the activePointer receives a DOM move event.</p></td>
</tr>
<tr>
<td class="name"><code>callbackContext</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The context in which the callback will be called.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-391">line 391</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<h4 class="name" id="startPointer"><span class="type-signature"></span>startPointer<span class="signature">(event)</span><span class="type-signature"> &rarr; {<a href="Phaser.Pointer.html">Phaser.Pointer</a>}</span></h4>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dt>
<dd>
<div class="description">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<p>Find the first free Pointer object and start it, passing in the event data. This is called automatically by Phaser.Touch and Phaser.MSPointer.</p>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>event</code></td>
<td class="type">
<span class="param-type">Any</span>
</td>
<td class="description last"><p>The event data from the Touch event.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-545">line 545</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The Pointer object that was started or null if no Pointer object is available.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dd>
</dl>
</dd>
<dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<h4 class="name" id="stopPointer"><span class="type-signature"></span>stopPointer<span class="signature">(event)</span><span class="type-signature"> &rarr; {<a href="Phaser.Pointer.html">Phaser.Pointer</a>}</span></h4>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dt>
<dd>
<div class="description">
<p>Stops the matching Pointer object, passing in the event data.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>event</code></td>
<td class="type">
<span class="param-type">Any</span>
</td>
<td class="description last"><p>The event data from the Touch event.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-612">line 612</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The Pointer object that was stopped or null if no Pointer object is available.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="update"><span class="type-signature">&lt;protected> </span>update<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Updates the Input Manager. Called by the core Game loop.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-437">line 437</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<h4 class="name" id="updatePointer"><span class="type-signature"></span>updatePointer<span class="signature">(event)</span><span class="type-signature"> &rarr; {<a href="Phaser.Pointer.html">Phaser.Pointer</a>}</span></h4>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dt>
<dd>
<div class="description">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<p>Updates the matching Pointer object, passing in the event data. This is called automatically and should not normally need to be invoked.</p>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>event</code></td>
<td class="type">
<span class="param-type">Any</span>
</td>
<td class="description last"><p>The event data from the Touch event.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Build files + docs update.
2014-04-15 14:39:23 +00:00
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-581">line 581</a>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The Pointer object that was updated or null if no Pointer object is available.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Pointer.html">Phaser.Pointer</a></span>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Updated doc files.
2014-02-05 06:29:17 +00:00
Phaser Copyright © 2012-2014 Photon Storm Ltd.
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</span>
<br />
<span class="jsdoc-message">
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
Build files + docs update.
2014-04-15 14:39:23 +00:00
on Tue Apr 15 2014 02:52:29 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</span>
</footer>
</div>
<div class="span3">
<div id="toc"></div>
</div>
<br clear="both">
</div>
</div>
<script src="scripts/sunlight.js"></script>
<script src="scripts/sunlight.javascript.js"></script>
<script src="scripts/sunlight-plugin.doclinks.js"></script>
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
<script src="scripts/sunlight-plugin.menu.js"></script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/jquery.scrollTo.js"></script>
<script src="scripts/jquery.localScroll.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
<script>
$( function () {
$( "#toc" ).toc( {
re-generated documentation
2014-04-10 22:13:43 +00:00
anchorName : function(i, heading, prefix) {
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
return $(heading).attr("id") || ( prefix + i );
},
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
</script>
</body>
</html>
Reference in a new issue Copy permalink