Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-12-12 06:12:53 +00:00
Code Issues Projects Releases Packages Wiki Activity
phaser/docs/Input.js.html

1589 lines
45 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 Source: input/Input.js</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>
Docs update.
2014-04-29 14:39:02 +00:00
<li class="class-depth-1">
<a href="Phaser.ArrayList.html">ArrayList</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.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>
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-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>
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.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>
</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>
</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>
New docs generated.
2014-07-18 11:45:51 +00:00
</strong>
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span12">
<div id="main">
<h1 class="page-title">Source: input/Input.js</h1>
<section>
<article>
<pre class="sunlight-highlight-javascript linenums">/**
* @author Richard Davey &lt;rich@photonstorm.com>
Updated doc files.
2014-02-05 06:29:17 +00:00
* @copyright 2014 Photon Storm Ltd.
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
Updated documentation.
2013-11-28 15:57:09 +00:00
* 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.
*
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
* @class Phaser.Input
* @constructor
* @param {Phaser.Game} game - Current game instance.
*/
Phaser.Input = function (game) {
Updated documentation.
2013-11-28 15:57:09 +00:00
/**
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
* @property {Phaser.Game} game - A reference to the currently running game.
Updated documentation.
2013-11-28 15:57:09 +00:00
*/
this.game = game;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
/**
* @property {HTMLCanvasElement} hitCanvas - The canvas to which single pixels are drawn in order to perform pixel-perfect hit detection.
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
* @default
Updated documentation.
2013-11-28 15:57:09 +00:00
*/
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
this.hitCanvas = null;
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
/**
* @property {CanvasRenderingContext2D} hitContext - The context of the pixel perfect hit canvas.
* @default
*/
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
this.hitContext = null;
Updated doc files.
2014-02-05 06:29:17 +00:00
Docs rebuilt for 2.0.5
2014-05-20 09:12:48 +00:00
/**
* @property {array} moveCallbacks - An array of callbacks that will be fired every time the activePointer receives a move event from the DOM.
*/
this.moveCallbacks = [];
Updated doc files.
2014-02-05 06:29:17 +00:00
/**
* @property {function} moveCallback - An optional callback that will be fired every time the activePointer receives a move event from the DOM. Set to null to disable.
*/
this.moveCallback = null;
/**
* @property {object} moveCallbackContext - The context in which the moveCallback will be sent. Defaults to Phaser.Input but can be set to any valid JS object.
*/
this.moveCallbackContext = this;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {number} pollRate - 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.
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
* @default
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.pollRate = 0;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* 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
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
* @property {boolean} disabled
* @default
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.disabled = false;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {number} multiInputOverride - Controls the expected behaviour when using a mouse and touch together on a multi-input device.
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
* @default
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.multiInputOverride = Phaser.Input.MOUSE_TOUCH_COMBINE;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Updated documentation.
2013-11-28 15:57:09 +00:00
* @property {Phaser.Point} position - A point object representing the current position of the Pointer.
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
* @default
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.position = null;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {Phaser.Point} speed - A point object representing the speed of the Pointer. Only really useful in single Pointer games; otherwise see the Pointer objects directly.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.speed = null;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
* A Circle object centered on the x/y screen coordinates of the Input.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
* Default size of 44px (Apples recommended "finger tip" size) but can be changed to anything.
* @property {Phaser.Circle} circle
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.circle = null;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
* @property {Phaser.Point} scale - 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.
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.scale = null;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {number} maxPointers - 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.
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
* @default
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.maxPointers = 10;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {number} currentPointers - The current number of active Pointers.
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
* @default
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.currentPointers = 0;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {number} tapRate - The number of milliseconds that the Pointer has to be pressed down and then released to be considered a tap or click.
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
* @default
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.tapRate = 200;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {number} doubleTapRate - The number of milliseconds between taps of the same Pointer for it to be considered a double tap / click.
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
* @default
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.doubleTapRate = 300;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {number} holdRate - The number of milliseconds that the Pointer has to be pressed down for it to fire a onHold event.
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
* @default
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.holdRate = 2000;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {number} justPressedRate - The number of milliseconds below which the Pointer is considered justPressed.
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
* @default
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.justPressedRate = 200;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {number} justReleasedRate - The number of milliseconds below which the Pointer is considered justReleased .
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
* @default
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.justReleasedRate = 200;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
* 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
* @property {boolean} recordPointerHistory
* @default
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.recordPointerHistory = false;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {number} recordRate - The rate in milliseconds at which the Pointer objects should update their tracking history.
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
* @default
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.recordRate = 100;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
* 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.
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
* @property {number} recordLimit
* @default
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.recordLimit = 100;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {Phaser.Pointer} pointer1 - A Pointer object.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.pointer1 = null;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {Phaser.Pointer} pointer2 - A Pointer object.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.pointer2 = null;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {Phaser.Pointer} pointer3 - A Pointer object.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.pointer3 = null;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {Phaser.Pointer} pointer4 - A Pointer object.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.pointer4 = null;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {Phaser.Pointer} pointer5 - A Pointer object.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.pointer5 = null;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {Phaser.Pointer} pointer6 - A Pointer object.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.pointer6 = null;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {Phaser.Pointer} pointer7 - A Pointer object.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.pointer7 = null;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {Phaser.Pointer} pointer8 - A Pointer object.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.pointer8 = null;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {Phaser.Pointer} pointer9 - A Pointer object.
Updated documentation.
2013-11-28 15:57:09 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.pointer9 = null;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {Phaser.Pointer} pointer10 - A Pointer object.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.pointer10 = null;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
* 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.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
* @property {Phaser.Pointer} activePointer
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.activePointer = null;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {Pointer} mousePointer - The mouse has its own unique Phaser.Pointer object which you can use if making a desktop specific game.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.mousePointer = null;
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
* @property {Phaser.Mouse} mouse - The Mouse Input manager.
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.mouse = null;
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
* @property {Phaser.Keyboard} keyboard - The Keyboard Input manager.
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.keyboard = null;
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
* @property {Phaser.Touch} touch - the Touch Input manager.
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.touch = null;
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
* @property {Phaser.MSPointer} mspointer - The MSPointer Input manager.
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.mspointer = null;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {Phaser.Gamepad} gamepad - The Gamepad Input manager.
*/
this.gamepad = null;
Updated doc files.
2014-02-05 06:29:17 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
/**
* @property {Phaser.Gestures} gestures - The Gestures manager.
*/
// this.gestures = null;
Build files + docs update.
2014-04-15 14:39:23 +00:00
/**
* @property {boolean} resetLocked - If the Input Manager has been reset locked then all calls made to InputManager.reset, such as from a State change, are ignored.
* @default
*/
this.resetLocked = false;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {Phaser.Signal} onDown - A Signal that is dispatched each time a pointer is pressed down.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.onDown = null;
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {Phaser.Signal} onUp - A Signal that is dispatched each time a pointer is released.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.onUp = null;
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {Phaser.Signal} onTap - A Signal that is dispatched each time a pointer is tapped.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.onTap = null;
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @property {Phaser.Signal} onHold - A Signal that is dispatched each time a pointer is held down.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.onHold = null;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
Docs rebuilt for 2.0.5
2014-05-20 09:12:48 +00:00
/**
* @property {number} minPriorityID - You can tell all Pointers to ignore any object with a priorityID lower than the minPriorityID. Useful when stacking UI layers. Set to zero to disable.
* @default
*/
this.minPriorityID = 0;
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
/**
New docs generated.
2014-07-18 11:45:51 +00:00
* A list of interactive objects. The InputHandler components add and remove themselves from this list.
Docs update.
2014-04-29 14:39:02 +00:00
* @property {Phaser.ArrayList} interactiveItems
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Docs update.
2014-04-29 14:39:02 +00:00
this.interactiveItems = new Phaser.ArrayList();
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
/**
* @property {Phaser.Point} _localPoint - Internal cache var.
* @private
*/
this._localPoint = new Phaser.Point();
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
/**
* @property {number} _pollCounter - Internal var holding the current poll counter.
* @private
*/
this._pollCounter = 0;
/**
* @property {Phaser.Point} _oldPosition - A point object representing the previous position of the Pointer.
* @private
*/
this._oldPosition = null;
/**
* @property {number} _x - x coordinate of the most recent Pointer event
* @private
*/
this._x = 0;
/**
* @property {number} _y - Y coordinate of the most recent Pointer event
* @private
*/
this._y = 0;
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
};
/**
* @constant
* @type {number}
*/
Phaser.Input.MOUSE_OVERRIDES_TOUCH = 0;
/**
* @constant
* @type {number}
*/
Phaser.Input.TOUCH_OVERRIDES_MOUSE = 1;
/**
* @constant
* @type {number}
*/
Phaser.Input.MOUSE_TOUCH_COMBINE = 2;
Phaser.Input.prototype = {
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
/**
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
* Starts the Input Manager running.
* @method Phaser.Input#boot
* @protected
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
boot: function () {
Updated documentation.
2013-11-28 15:57:09 +00:00
this.mousePointer = new Phaser.Pointer(this.game, 0);
this.pointer1 = new Phaser.Pointer(this.game, 1);
this.pointer2 = new Phaser.Pointer(this.game, 2);
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
this.mouse = new Phaser.Mouse(this.game);
this.keyboard = new Phaser.Keyboard(this.game);
this.touch = new Phaser.Touch(this.game);
this.mspointer = new Phaser.MSPointer(this.game);
Updated doc files.
2014-02-05 06:29:17 +00:00
this.gamepad = new Phaser.Gamepad(this.game);
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
// this.gestures = new Phaser.Gestures(this.game);
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
this.onDown = new Phaser.Signal();
this.onUp = new Phaser.Signal();
this.onTap = new Phaser.Signal();
this.onHold = new Phaser.Signal();
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
this.scale = new Phaser.Point(1, 1);
this.speed = new Phaser.Point();
this.position = new Phaser.Point();
this._oldPosition = new Phaser.Point();
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
this.circle = new Phaser.Circle(0, 0, 44);
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
this.activePointer = this.mousePointer;
this.currentPointers = 0;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
this.hitCanvas = document.createElement('canvas');
this.hitCanvas.width = 1;
this.hitCanvas.height = 1;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
this.hitContext = this.hitCanvas.getContext('2d');
this.mouse.start();
this.keyboard.start();
this.touch.start();
this.mspointer.start();
this.mousePointer.active = true;
Lots of doc updates!
2013-10-25 15:54:40 +00:00
},
/**
* Stops all of the Input Managers from running.
* @method Phaser.Input#destroy
*/
destroy: function () {
this.mouse.stop();
this.keyboard.stop();
this.touch.stop();
this.mspointer.stop();
Updated doc files.
2014-02-05 06:29:17 +00:00
this.gamepad.stop();
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
// this.gestures.stop();
Updated doc files.
2014-02-05 06:29:17 +00:00
Docs rebuilt for 2.0.5
2014-05-20 09:12:48 +00:00
this.moveCallbacks = [];
// DEPRECATED
Updated doc files.
2014-02-05 06:29:17 +00:00
this.moveCallback = null;
},
/**
Docs rebuilt for 2.0.5
2014-05-20 09:12:48 +00:00
* DEPRECATED: This method will be removed in a future major point release. Please use Input.addMoveCallback instead.
*
Updated doc files.
2014-02-05 06:29:17 +00:00
* 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)
Docs rebuilt for 2.0.5
2014-05-20 09:12:48 +00:00
*
Updated doc files.
2014-02-05 06:29:17 +00:00
* @method Phaser.Input#setMoveCallback
* @param {function} callback - The callback that will be called each time the activePointer receives a DOM move event.
* @param {object} callbackContext - The context in which the callback will be called.
*/
setMoveCallback: function (callback, callbackContext) {
this.moveCallback = callback;
this.moveCallbackContext = callbackContext;
Lots of doc updates!
2013-10-25 15:54:40 +00:00
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
},
Docs rebuilt for 2.0.5
2014-05-20 09:12:48 +00:00
/**
* Adds 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).
* The callback is added to the Phaser.Input.moveCallbacks array and should be removed with Phaser.Input.deleteMoveCallback.
*
* @method Phaser.Input#addMoveCallback
* @param {function} callback - The callback that will be called each time the activePointer receives a DOM move event.
* @param {object} callbackContext - The context in which the callback will be called.
* @return {number} The index of the callback entry. Use this index when calling Input.deleteMoveCallback.
*/
addMoveCallback: function (callback, callbackContext) {
return this.moveCallbacks.push( { callback: callback, context: callbackContext }) - 1;
},
/**
Republished docs.
2014-07-10 19:31:11 +00:00
* Removes the callback at the defined index from the Phaser.Input.moveCallbacks array
Docs rebuilt for 2.0.5
2014-05-20 09:12:48 +00:00
*
* @method Phaser.Input#deleteMoveCallback
* @param {number} index - The index of the callback to remove.
*/
deleteMoveCallback: function (index) {
if (this.moveCallbacks[index])
{
this.moveCallbacks.splice(index, 1);
}
},
Updated documentation.
2013-11-28 15:57:09 +00:00
/**
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
* 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.
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
* @method Phaser.Input#addPointer
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
* @return {Phaser.Pointer} A reference to the new Pointer object that was created.
*/
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
addPointer: function () {
var next = 0;
for (var i = 10; i > 0; i--)
{
if (this['pointer' + i] === null)
{
next = i;
}
}
Updated documentation.
2013-11-28 15:57:09 +00:00
if (next === 0)
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
{
console.warn("You can only have 10 Pointer objects");
return null;
}
else
{
this['pointer' + next] = new Phaser.Pointer(this.game, next);
return this['pointer' + next];
}
},
Updated documentation.
2013-11-28 15:57:09 +00:00
/**
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
* Updates the Input Manager. Called by the core Game loop.
New docs generated.
2014-07-18 11:45:51 +00:00
*
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
* @method Phaser.Input#update
* @protected
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
update: function () {
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
this.keyboard.update();
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
if (this.pollRate > 0 && this._pollCounter &lt; this.pollRate)
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
{
this._pollCounter++;
return;
}
this.speed.x = this.position.x - this._oldPosition.x;
this.speed.y = this.position.y - this._oldPosition.y;
this._oldPosition.copyFrom(this.position);
this.mousePointer.update();
Updated doc files.
2014-02-05 06:29:17 +00:00
if (this.gamepad.active) { this.gamepad.update(); }
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
this.pointer1.update();
this.pointer2.update();
if (this.pointer3) { this.pointer3.update(); }
if (this.pointer4) { this.pointer4.update(); }
if (this.pointer5) { this.pointer5.update(); }
if (this.pointer6) { this.pointer6.update(); }
if (this.pointer7) { this.pointer7.update(); }
if (this.pointer8) { this.pointer8.update(); }
if (this.pointer9) { this.pointer9.update(); }
if (this.pointer10) { this.pointer10.update(); }
this._pollCounter = 0;
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
// if (this.gestures.active) { this.gestures.update(); }
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
},
Updated documentation.
2013-11-28 15:57:09 +00:00
/**
Build files + docs update.
2014-04-15 14:39:23 +00:00
* Reset all of the Pointers and Input states. The optional `hard` 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 `true`.
*
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
* @method Phaser.Input#reset
Build files + docs update.
2014-04-15 14:39:23 +00:00
* @param {boolean} [hard=false] - A soft reset won't reset any events or callbacks that are bound. A hard reset will.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
reset: function (hard) {
Build files + docs update.
2014-04-15 14:39:23 +00:00
if (!this.game.isBooted || this.resetLocked)
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
{
return;
}
Build files + docs update.
2014-04-15 14:39:23 +00:00
if (typeof hard === 'undefined') { hard = false; }
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
Build files + docs update.
2014-04-15 14:39:23 +00:00
this.keyboard.reset(hard);
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
this.mousePointer.reset();
Updated doc files.
2014-02-05 06:29:17 +00:00
this.gamepad.reset();
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
for (var i = 1; i &lt;= 10; i++)
{
if (this['pointer' + i])
{
this['pointer' + i].reset();
}
}
this.currentPointers = 0;
Updated doc files.
2014-02-05 06:29:17 +00:00
if (this.game.canvas.style.cursor !== 'none')
{
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
this.game.canvas.style.cursor = 'inherit';
Updated doc files.
2014-02-05 06:29:17 +00:00
}
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
Build files + docs update.
2014-04-15 14:39:23 +00:00
if (hard)
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
{
this.onDown.dispose();
this.onUp.dispose();
this.onTap.dispose();
this.onHold.dispose();
this.onDown = new Phaser.Signal();
this.onUp = new Phaser.Signal();
this.onTap = new Phaser.Signal();
this.onHold = new Phaser.Signal();
Docs rebuilt for 2.0.5
2014-05-20 09:12:48 +00:00
this.moveCallbacks = [];
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
}
this._pollCounter = 0;
},
/**
* Resets the speed and old position properties.
* @method Phaser.Input#resetSpeed
* @param {number} x - Sets the oldPosition.x value.
* @param {number} y - Sets the oldPosition.y value.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
resetSpeed: function (x, y) {
this._oldPosition.setTo(x, y);
this.speed.setTo(0, 0);
},
Updated documentation.
2013-11-28 15:57:09 +00:00
/**
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
* Find the first free Pointer object and start it, passing in the event data. This is called automatically by Phaser.Touch and Phaser.MSPointer.
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
* @method Phaser.Input#startPointer
* @param {Any} event - The event data from the Touch event.
* @return {Phaser.Pointer} The Pointer object that was started or null if no Pointer object is available.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
*/
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
startPointer: function (event) {
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
if (this.maxPointers &lt; 10 && this.totalActivePointers == this.maxPointers)
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
{
return null;
}
Updated documentation.
2013-11-28 15:57:09 +00:00
if (this.pointer1.active === false)
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
{
return this.pointer1.start(event);
}
Updated documentation.
2013-11-28 15:57:09 +00:00
else if (this.pointer2.active === false)
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
{
return this.pointer2.start(event);
}
else
{
for (var i = 3; i &lt;= 10; i++)
{
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
if (this['pointer' + i] && this['pointer' + i].active === false)
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
{
return this['pointer' + i].start(event);
}
}
}
return null;
},
Updated documentation.
2013-11-28 15:57:09 +00:00
/**
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
* Updates the matching Pointer object, passing in the event data. This is called automatically and should not normally need to be invoked.
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
* @method Phaser.Input#updatePointer
* @param {Any} event - The event data from the Touch event.
* @return {Phaser.Pointer} The Pointer object that was updated or null if no Pointer object is available.
*/
updatePointer: function (event) {
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
if (this.pointer1.active && this.pointer1.identifier == event.identifier)
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
{
return this.pointer1.move(event);
}
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
else if (this.pointer2.active && this.pointer2.identifier == event.identifier)
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
{
return this.pointer2.move(event);
}
else
{
for (var i = 3; i &lt;= 10; i++)
{
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
if (this['pointer' + i] && this['pointer' + i].active && this['pointer' + i].identifier == event.identifier)
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
{
return this['pointer' + i].move(event);
}
}
}
return null;
},
Updated documentation.
2013-11-28 15:57:09 +00:00
/**
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
* Stops the matching Pointer object, passing in the event data.
* @method Phaser.Input#stopPointer
* @param {Any} event - The event data from the Touch event.
* @return {Phaser.Pointer} The Pointer object that was stopped or null if no Pointer object is available.
*/
stopPointer: function (event) {
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
if (this.pointer1.active && this.pointer1.identifier == event.identifier)
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
{
return this.pointer1.stop(event);
}
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
else if (this.pointer2.active && this.pointer2.identifier == event.identifier)
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
{
return this.pointer2.stop(event);
}
else
{
for (var i = 3; i &lt;= 10; i++)
{
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
if (this['pointer' + i] && this['pointer' + i].active && this['pointer' + i].identifier == event.identifier)
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
{
return this['pointer' + i].stop(event);
}
}
}
return null;
},
Updated documentation.
2013-11-28 15:57:09 +00:00
/**
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
* Get the next Pointer object whos active property matches the given state
* @method Phaser.Input#getPointer
* @param {boolean} state - The state the Pointer should be in (false for inactive, true for active).
* @return {Phaser.Pointer} A Pointer object or null if no Pointer object matches the requested state.
*/
getPointer: function (state) {
state = state || false;
if (this.pointer1.active == state)
{
return this.pointer1;
}
else if (this.pointer2.active == state)
{
return this.pointer2;
}
else
{
for (var i = 3; i &lt;= 10; i++)
{
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
if (this['pointer' + i] && this['pointer' + i].active == state)
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
{
return this['pointer' + i];
}
}
}
return null;
},
Updated documentation.
2013-11-28 15:57:09 +00:00
/**
Docs rebuilt for 2.0.5
2014-05-20 09:12:48 +00:00
* Get the Pointer object whos `identifier` property matches the given identifier value.
* The identifier property is not set until the Pointer has been used at least once, as its populated by the DOM event.
* Also it can change every time you press the pointer down, and is not fixed once set.
* Note: Not all browsers set the identifier property and it's not part of the W3C spec, so you may need getPointerFromId instead.
*
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
* @method Phaser.Input#getPointerFromIdentifier
* @param {number} identifier - The Pointer.identifier value to search for.
* @return {Phaser.Pointer} A Pointer object or null if no Pointer object matches the requested identifier.
*/
getPointerFromIdentifier: function (identifier) {
Docs rebuilt for 2.0.5
2014-05-20 09:12:48 +00:00
if (this.pointer1.identifier === identifier)
{
return this.pointer1;
}
else if (this.pointer2.identifier === identifier)
{
return this.pointer2;
}
else
{
for (var i = 3; i &lt;= 10; i++)
{
if (this['pointer' + i] && this['pointer' + i].identifier === identifier)
{
return this['pointer' + i];
}
}
}
return null;
},
/**
* Get the Pointer object whos `pointerId` property matches the given value.
* The pointerId property is not set until the Pointer has been used at least once, as its populated by the DOM event.
* Also it can change every time you press the pointer down if the browser recycles it.
*
* @method Phaser.Input#getPointerFromId
* @param {number} pointerId - The Pointer.pointerId value to search for.
* @return {Phaser.Pointer} A Pointer object or null if no Pointer object matches the requested identifier.
*/
getPointerFromId: function (pointerId) {
if (this.pointer1.pointerId === pointerId)
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
{
return this.pointer1;
}
Docs rebuilt for 2.0.5
2014-05-20 09:12:48 +00:00
else if (this.pointer2.pointerId === pointerId)
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
{
return this.pointer2;
}
else
{
for (var i = 3; i &lt;= 10; i++)
{
Docs rebuilt for 2.0.5
2014-05-20 09:12:48 +00:00
if (this['pointer' + i] && this['pointer' + i].pointerId === pointerId)
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
{
return this['pointer' + i];
}
}
}
return null;
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
},
/**
* This will return the local coordinates of the specified displayObject based on the given Pointer.
* @method Phaser.Input#getLocalPosition
* @param {Phaser.Sprite|Phaser.Image} displayObject - The DisplayObject to get the local coordinates for.
* @param {Phaser.Pointer} pointer - The Pointer to use in the check against the displayObject.
* @return {Phaser.Point} A point containing the coordinates of the Pointer position relative to the DisplayObject.
*/
getLocalPosition: function (displayObject, pointer, output) {
if (typeof output === 'undefined') { output = new Phaser.Point(); }
var wt = displayObject.worldTransform;
var id = 1 / (wt.a * wt.d + wt.b * -wt.c);
return output.setTo(
wt.d * id * pointer.x + -wt.b * id * pointer.y + (wt.ty * wt.b - wt.tx * wt.d) * id,
wt.a * id * pointer.y + -wt.c * id * pointer.x + (-wt.ty * wt.a + wt.tx * wt.c) * id
);
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
},
/**
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
* Tests if the pointer hits the given object.
*
* @method Phaser.Input#hitTest
* @param {DisplayObject} displayObject - The displayObject to test for a hit.
* @param {Phaser.Pointer} pointer - The pointer to use for the test.
* @param {Phaser.Point} localPoint - The local translated point.
*/
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
hitTest: function (displayObject, pointer, localPoint) {
if (!displayObject.worldVisible)
{
return false;
}
this.getLocalPosition(displayObject, pointer, this._localPoint);
localPoint.copyFrom(this._localPoint);
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
if (displayObject.hitArea && displayObject.hitArea.contains)
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
{
if (displayObject.hitArea.contains(this._localPoint.x, this._localPoint.y))
{
return true;
}
return false;
}
Tidying up the repo, moving old wip stuff out, clearing up the docs.
2014-02-24 12:14:30 +00:00
else if (displayObject instanceof Phaser.TileSprite)
{
var width = displayObject.width;
var height = displayObject.height;
var x1 = -width * displayObject.anchor.x;
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
if (this._localPoint.x > x1 && this._localPoint.x &lt; x1 + width)
Tidying up the repo, moving old wip stuff out, clearing up the docs.
2014-02-24 12:14:30 +00:00
{
var y1 = -height * displayObject.anchor.y;
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
if (this._localPoint.y > y1 && this._localPoint.y &lt; y1 + height)
Tidying up the repo, moving old wip stuff out, clearing up the docs.
2014-02-24 12:14:30 +00:00
{
return true;
}
}
}
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
else if (displayObject instanceof PIXI.Sprite)
{
var width = displayObject.texture.frame.width;
var height = displayObject.texture.frame.height;
var x1 = -width * displayObject.anchor.x;
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
if (this._localPoint.x > x1 && this._localPoint.x &lt; x1 + width)
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
{
var y1 = -height * displayObject.anchor.y;
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
if (this._localPoint.y > y1 && this._localPoint.y &lt; y1 + height)
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
{
return true;
}
}
}
for (var i = 0, len = displayObject.children.length; i &lt; len; i++)
{
if (this.hitTest(displayObject.children[i], pointer, localPoint))
{
return true;
}
}
return false;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
}
};
Updated doc files.
2014-02-05 06:29:17 +00:00
Phaser.Input.prototype.constructor = Phaser.Input;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
/**
* The X coordinate of the most recently active pointer. This value takes game scaling into account automatically. See Pointer.screenX/clientX for source values.
* @name Phaser.Input#x
* @property {number} x - The X coordinate of the most recently active pointer.
*/
Object.defineProperty(Phaser.Input.prototype, "x", {
get: function () {
return this._x;
},
set: function (value) {
this._x = Math.floor(value);
}
});
/**
* The Y coordinate of the most recently active pointer. This value takes game scaling into account automatically. See Pointer.screenY/clientY for source values.
* @name Phaser.Input#y
* @property {number} y - The Y coordinate of the most recently active pointer.
*/
Object.defineProperty(Phaser.Input.prototype, "y", {
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
get: function () {
return this._y;
},
set: function (value) {
this._y = Math.floor(value);
}
});
/**
* @name Phaser.Input#pollLocked
* @property {boolean} pollLocked - True if the Input is currently poll rate locked.
* @readonly
*/
Object.defineProperty(Phaser.Input.prototype, "pollLocked", {
get: function () {
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
return (this.pollRate > 0 && this._pollCounter &lt; this.pollRate);
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
}
});
/**
* The total number of inactive Pointers
* @name Phaser.Input#totalInactivePointers
* @property {number} totalInactivePointers - The total number of inactive Pointers.
* @readonly
*/
Object.defineProperty(Phaser.Input.prototype, "totalInactivePointers", {
get: function () {
return 10 - this.currentPointers;
}
});
/**
* The total number of active Pointers
* @name Phaser.Input#totalActivePointers
* @property {number} totalActivePointers - The total number of active Pointers.
* @readonly
*/
Object.defineProperty(Phaser.Input.prototype, "totalActivePointers", {
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
get: function () {
this.currentPointers = 0;
for (var i = 1; i &lt;= 10; i++)
{
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
if (this['pointer' + i] && this['pointer' + i].active)
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
{
this.currentPointers++;
}
}
return this.currentPointers;
}
});
/**
* The world X coordinate of the most recently active pointer.
* @name Phaser.Input#worldX
* @property {number} worldX - The world X coordinate of the most recently active pointer.
*/
Object.defineProperty(Phaser.Input.prototype, "worldX", {
get: function () {
Updated documentation.
2013-11-28 15:57:09 +00:00
return this.game.camera.view.x + this.x;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
}
});
/**
* The world Y coordinate of the most recently active pointer.
* @name Phaser.Input#worldY
* @property {number} worldY - The world Y coordinate of the most recently active pointer.
*/
Object.defineProperty(Phaser.Input.prototype, "worldY", {
get: function () {
Updated documentation.
2013-11-28 15:57:09 +00:00
return this.game.camera.view.y + this.y;
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
}
});
</pre>
</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>
New docs generated.
2014-07-18 11:45:51 +00:00
on Fri Jul 18 2014 12:36:36 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>
<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