phaser/docs/Phaser.Pointer.html

5920 lines
81 KiB
HTML
Raw Normal View History

2013-10-02 14:05:55 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Class: Pointer</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">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
2013-10-02 14:05:55 +00:00
class="caret"></b></a>
<ul class="dropdown-menu ">
2014-04-10 22:13:43 +00:00
<li class="class-depth-0">
<a href="Phaser.html">Phaser</a>
2013-10-02 14:05:55 +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 ">
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Animation.html">Animation</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.AnimationManager.html">AnimationManager</a>
2013-10-02 14:05:55 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.AnimationParser.html">AnimationParser</a>
2013-10-02 14:05:55 +00:00
</li>
2014-04-29 14:39:02 +00:00
<li class="class-depth-1">
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Button.html">Button</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Cache.html">Cache</a>
2013-10-02 14:05:55 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Camera.html">Camera</a>
2013-10-02 14:05:55 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Canvas.html">Canvas</a>
2013-10-02 14:05:55 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Circle.html">Circle</a>
2013-10-02 14:05:55 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Color.html">Color</a>
2013-10-03 00:21:08 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Device.html">Device</a>
2013-10-02 14:05:55 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Easing.html">Easing</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Back.html">Back</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Bounce.html">Bounce</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Circular.html">Circular</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Cubic.html">Cubic</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Elastic.html">Elastic</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Exponential.html">Exponential</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Linear.html">Linear</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Quadratic.html">Quadratic</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Quartic.html">Quartic</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Quintic.html">Quintic</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Ellipse.html">Ellipse</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Events.html">Events</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Filter.html">Filter</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Frame.html">Frame</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.FrameData.html">FrameData</a>
2013-10-03 00:21:08 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Game.html">Game</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Gamepad.html">Gamepad</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.GamepadButton.html">GamepadButton</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Graphics.html">Graphics</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Group.html">Group</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Image.html">Image</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Input.html">Input</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.InputHandler.html">InputHandler</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Key.html">Key</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Keyboard.html">Keyboard</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Line.html">Line</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Loader.html">Loader</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.LoaderParser.html">LoaderParser</a>
2013-10-02 14:05:55 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Math.html">Math</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Mouse.html">Mouse</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.MSPointer.html">MSPointer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 19:18:24 +00:00
<a href="Phaser.Net.html">Net</a>
</li>
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">
2013-10-02 19:18:24 +00:00
<a href="Phaser.Particles.html">Particles</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
2013-10-02 19:18:24 +00:00
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Physics.html">Physics</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Physics.Ninja.html">Ninja</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Physics.P2.html">P2</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Body.html">Body</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Material.html">Material</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Plugin.html">Plugin</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Point.html">Point</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Pointer.html">Pointer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Polygon.html">Polygon</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.QuadTree.html">QuadTree</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.RetroFont.html">RetroFont</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.ScaleManager.html">ScaleManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Signal.html">Signal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SignalBinding.html">SignalBinding</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Sound.html">Sound</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Sprite.html">Sprite</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Stage.html">Stage</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.State.html">State</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.StateManager.html">StateManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Text.html">Text</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tile.html">Tile</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tileset.html">Tileset</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Time.html">Time</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Timer.html">Timer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Touch.html">Touch</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Tween.html">Tween</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Utils.html">Utils</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.World.html">World</a>
</li>
</ul>
</li>
2014-07-18 11:45:51 +00:00
</strong>
2013-10-02 14:05:55 +00:00
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span8">
<div id="main">
<h1 class="page-title">Class: Pointer</h1>
<section>
<header>
<h2>
<span class="ancestors"><a href="Phaser.html">Phaser</a>.</span>
2013-10-02 14:05:55 +00:00
Pointer
</h2>
<div class="class-description"><p>A Pointer object is used by the Mouse, Touch and MSPoint managers and represents a single finger on the touch screen.</p></div>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="Pointer"><span class="type-signature"></span>new Pointer<span class="signature">(game, id)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Phaser - Pointer constructor.</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>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>A reference to the currently running game.</p></td>
</tr>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
2013-11-28 15:57:09 +00:00
<span class="param-type">number</span>
2013-10-02 14:05:55 +00:00
</td>
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The ID of the Pointer object within the game. Each game can have up to 10 active pointers.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-16">line 16</a>
</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="active"><span class="type-signature"></span>active<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>
2013-11-28 15:57:09 +00:00
<td class="name"><code>active</code></td>
2013-10-02 14:05:55 +00:00
<td class="type">
<span class="param-type">boolean</span>
</td>
2013-11-28 15:57:09 +00:00
<td class="description last"><p>An active pointer is one that is currently pressed down on the display. A Mouse is always active.</p></td>
2013-10-02 14:05:55 +00:00
</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>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-218">line 218</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="button"><span class="type-signature"></span>button<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>button</code></td>
<td class="type">
<span class="param-type">any</span>
</td>
<td class="description last"><p>The button property of the Pointer as set by the DOM event when this Pointer is started.</p></td>
</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>
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-62">line 62</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="circle"><span class="type-signature"></span>circle<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>A Phaser.Circle that is centered on the x/y coordinates of this pointer, useful for hit detection.
The Circle size is 44px (Apples recommended &quot;finger tip&quot; size).</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>circle</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Circle.html">Phaser.Circle</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-240">line 240</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="clientX"><span class="type-signature"></span>clientX<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>clientX</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The horizontal coordinate of the Pointer within the application's client area at which the event occurred (as opposed to the coordinates within the page).</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-97">line 97</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="clientY"><span class="type-signature"></span>clientY<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>clientY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The vertical coordinate of the Pointer within the application's client area at which the event occurred (as opposed to the coordinates within the page).</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-102">line 102</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="duration"><span class="type-signature">&lt;readonly> </span>duration<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>How long the Pointer has been depressed on the touchscreen. If not currently down it returns -1.</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>duration</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>How long the Pointer has been depressed on the touchscreen. If not currently down it returns -1.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-07-18 11:45:51 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-705">line 705</a>
2014-05-20 09:12:48 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="exists"><span class="type-signature"></span>exists<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>exists</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>A Pointer object that exists is allowed to be checked for physics collisions and overlaps.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>true</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-38">line 38</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="game"><span class="type-signature"></span>game<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>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>A reference to the currently running game.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-21">line 21</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="id"><span class="type-signature"></span>id<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>id</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The ID of the Pointer object within the game. Each game can have up to 10 active pointers.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-26">line 26</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="identifier"><span class="type-signature"></span>identifier<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>identifier</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The identifier property of the Pointer as set by the DOM event when this Pointer is started.</p></td>
</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>
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-44">line 44</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="isDown"><span class="type-signature"></span>isDown<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>isDown</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>If the Pointer is touching the touchscreen, or the mouse button is held down, isDown is set to true.</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="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-170">line 170</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-05-20 09:12:48 +00:00
<h4 class="name" id="isMouse"><span class="type-signature"></span>isMouse<span class="type-signature"></span></h4>
2013-10-02 14:05:55 +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>
2014-05-20 09:12:48 +00:00
<td class="name"><code>isMouse</code></td>
2013-10-02 14:05:55 +00:00
<td class="type">
2014-05-20 09:12:48 +00:00
<span class="param-type">boolean</span>
2013-10-02 14:05:55 +00:00
</td>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>If the Pointer is a mouse this is true, otherwise false.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
</dl>
2014-05-20 09:12:48 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
2013-10-02 14:05:55 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-164">line 164</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-05-20 09:12:48 +00:00
<h4 class="name" id="isUp"><span class="type-signature"></span>isUp<span class="type-signature"></span></h4>
2013-10-02 14:05:55 +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>
2014-05-20 09:12:48 +00:00
<td class="name"><code>isUp</code></td>
2013-10-02 14:05:55 +00:00
<td class="type">
2014-05-20 09:12:48 +00:00
<span class="param-type">boolean</span>
2013-10-02 14:05:55 +00:00
</td>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>If the Pointer is not touching the touchscreen, or the mouse button is up, isUp is set to true.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
</dl>
2014-05-20 09:12:48 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>true</li></ul></dd>
2013-10-02 14:05:55 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-176">line 176</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-05-20 09:12:48 +00:00
<h4 class="name" id="movementX"><span class="type-signature"></span>movementX<span class="type-signature"></span></h4>
2013-10-02 14:05:55 +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>
2014-05-20 09:12:48 +00:00
<td class="name"><code>movementX</code></td>
2013-10-02 14:05:55 +00:00
<td class="type">
<span class="param-type">number</span>
</td>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>The horizontal processed relative movement of the Pointer in pixels since last event.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
</dl>
2014-05-20 09:12:48 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>0</li></ul></dd>
2013-10-02 14:05:55 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-140">line 140</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-05-20 09:12:48 +00:00
<h4 class="name" id="movementY"><span class="type-signature"></span>movementY<span class="type-signature"></span></h4>
2013-10-02 14:05:55 +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>
2014-05-20 09:12:48 +00:00
<td class="name"><code>movementY</code></td>
2013-10-02 14:05:55 +00:00
<td class="type">
<span class="param-type">number</span>
</td>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>The vertical processed relative movement of the Pointer in pixels since last event.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
</dl>
2014-05-20 09:12:48 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>0</li></ul></dd>
2013-10-02 14:05:55 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-146">line 146</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-05-20 09:12:48 +00:00
<h4 class="name" id="msSinceLastClick"><span class="type-signature"></span>msSinceLastClick<span class="type-signature"></span></h4>
2013-10-02 14:05:55 +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>
2014-05-20 09:12:48 +00:00
<td class="name"><code>msSinceLastClick</code></td>
2013-10-02 14:05:55 +00:00
<td class="type">
2014-05-20 09:12:48 +00:00
<span class="param-type">number</span>
2013-10-02 14:05:55 +00:00
</td>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>The number of milliseconds since the last click or touch event.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-206">line 206</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-05-20 09:12:48 +00:00
<h4 class="name" id="pageX"><span class="type-signature"></span>pageX<span class="type-signature"></span></h4>
2013-10-02 14:05:55 +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>
2014-05-20 09:12:48 +00:00
<td class="name"><code>pageX</code></td>
2013-10-02 14:05:55 +00:00
<td class="type">
2013-11-28 15:57:09 +00:00
<span class="param-type">number</span>
2013-10-02 14:05:55 +00:00
</td>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>The horizontal coordinate of the Pointer relative to whole document.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-107">line 107</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-05-20 09:12:48 +00:00
<h4 class="name" id="pageY"><span class="type-signature"></span>pageY<span class="type-signature"></span></h4>
2013-10-02 14:05:55 +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>
2014-05-20 09:12:48 +00:00
<td class="name"><code>pageY</code></td>
2013-10-02 14:05:55 +00:00
<td class="type">
2014-05-20 09:12:48 +00:00
<span class="param-type">number</span>
2013-10-02 14:05:55 +00:00
</td>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>The vertical coordinate of the Pointer relative to whole document.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-112">line 112</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-05-20 09:12:48 +00:00
<h4 class="name" id="pointerId"><span class="type-signature"></span>pointerId<span class="type-signature"></span></h4>
2013-10-02 14:05:55 +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>
2014-05-20 09:12:48 +00:00
<td class="name"><code>pointerId</code></td>
2013-10-02 14:05:55 +00:00
<td class="type">
2014-05-20 09:12:48 +00:00
<span class="param-type">number</span>
2013-10-02 14:05:55 +00:00
</td>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>The pointerId property of the Pointer as set by the DOM event when this Pointer is started. The browser can and will recycle this value.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
</dl>
2013-11-28 15:57:09 +00:00
<dt class="tag-default">Default Value:</dt>
2014-05-20 09:12:48 +00:00
<dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd>
2013-11-28 15:57:09 +00:00
2013-10-02 14:05:55 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-50">line 50</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-05-20 09:12:48 +00:00
<h4 class="name" id="position"><span class="type-signature"></span>position<span class="type-signature"></span></h4>
2013-10-02 14:05:55 +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>
2014-05-20 09:12:48 +00:00
<td class="name"><code>position</code></td>
2013-10-02 14:05:55 +00:00
<td class="type">
2014-05-20 09:12:48 +00:00
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>
2013-10-02 14:05:55 +00:00
</td>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>A Phaser.Point object containing the current x/y values of the pointer on the display.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-223">line 223</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-05-20 09:12:48 +00:00
<h4 class="name" id="positionDown"><span class="type-signature"></span>positionDown<span class="type-signature"></span></h4>
2013-10-02 14:05:55 +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>
2014-05-20 09:12:48 +00:00
<td class="name"><code>positionDown</code></td>
2013-10-02 14:05:55 +00:00
<td class="type">
2014-05-20 09:12:48 +00:00
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>
2013-10-02 14:05:55 +00:00
</td>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>A Phaser.Point object containing the x/y values of the pointer when it was last in a down state on the display.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-228">line 228</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-05-20 09:12:48 +00:00
<h4 class="name" id="positionUp"><span class="type-signature"></span>positionUp<span class="type-signature"></span></h4>
2013-10-02 14:05:55 +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>
2014-05-20 09:12:48 +00:00
<td class="name"><code>positionUp</code></td>
2013-10-02 14:05:55 +00:00
<td class="type">
2014-05-20 09:12:48 +00:00
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>
2013-10-02 14:05:55 +00:00
</td>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>A Phaser.Point object containing the x/y values of the pointer when it was last released.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-233">line 233</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-05-20 09:12:48 +00:00
<h4 class="name" id="previousTapTime"><span class="type-signature"></span>previousTapTime<span class="type-signature"></span></h4>
2013-10-02 14:05:55 +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>
2014-05-20 09:12:48 +00:00
<td class="name"><code>previousTapTime</code></td>
2013-10-02 14:05:55 +00:00
<td class="type">
2013-11-28 15:57:09 +00:00
<span class="param-type">number</span>
2013-10-02 14:05:55 +00:00
</td>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>A timestamp representing when the Pointer was last tapped or clicked.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
</dl>
2014-05-20 09:12:48 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>0</li></ul></dd>
2013-10-02 14:05:55 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-194">line 194</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-05-20 09:12:48 +00:00
<h4 class="name" id="rawMovementX"><span class="type-signature"></span>rawMovementX<span class="type-signature"></span></h4>
2013-10-02 14:05:55 +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>
2014-05-20 09:12:48 +00:00
<td class="name"><code>rawMovementX</code></td>
2013-10-02 14:05:55 +00:00
<td class="type">
2014-05-20 09:12:48 +00:00
<span class="param-type">number</span>
2013-10-02 14:05:55 +00:00
</td>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>The horizontal raw relative movement of the Pointer in pixels since last event.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
</dl>
2014-05-20 09:12:48 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>0</li></ul></dd>
2013-10-02 14:05:55 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-128">line 128</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-05-20 09:12:48 +00:00
<h4 class="name" id="rawMovementY"><span class="type-signature"></span>rawMovementY<span class="type-signature"></span></h4>
2013-10-02 14:05:55 +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>
2014-05-20 09:12:48 +00:00
<td class="name"><code>rawMovementY</code></td>
2013-10-02 14:05:55 +00:00
<td class="type">
2014-05-20 09:12:48 +00:00
<span class="param-type">number</span>
2013-10-02 14:05:55 +00:00
</td>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>The vertical raw relative movement of the Pointer in pixels since last event.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
</dl>
2014-05-20 09:12:48 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>0</li></ul></dd>
2013-10-02 14:05:55 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-134">line 134</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
2014-04-10 22:13:43 +00:00
</dl>
</dd>
<dt>
2014-05-20 09:12:48 +00:00
<h4 class="name" id="screenX"><span class="type-signature"></span>screenX<span class="type-signature"></span></h4>
2014-04-10 22:13:43 +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>
2014-05-20 09:12:48 +00:00
<td class="name"><code>screenX</code></td>
2014-04-10 22:13:43 +00:00
<td class="type">
2014-05-20 09:12:48 +00:00
<span class="param-type">number</span>
2014-04-10 22:13:43 +00:00
</td>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>The horizontal coordinate of the Pointer relative to the screen.</p></td>
2014-04-10 22:13:43 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-117">line 117</a>
2014-04-10 22:13:43 +00:00
</li></ul></dd>
2013-10-02 14:05:55 +00:00
</dl>
</dd>
<dt>
2014-05-20 09:12:48 +00:00
<h4 class="name" id="screenY"><span class="type-signature"></span>screenY<span class="type-signature"></span></h4>
2013-10-02 14:05:55 +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>
2014-05-20 09:12:48 +00:00
<td class="name"><code>screenY</code></td>
2013-10-02 14:05:55 +00:00
<td class="type">
<span class="param-type">number</span>
</td>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>The vertical coordinate of the Pointer relative to the screen.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-122">line 122</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-05-20 09:12:48 +00:00
<h4 class="name" id="target"><span class="type-signature"></span>target<span class="type-signature"></span></h4>
2013-10-02 14:05:55 +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>
2014-05-20 09:12:48 +00:00
<td class="name"><code>target</code></td>
2013-10-02 14:05:55 +00:00
<td class="type">
2014-05-20 09:12:48 +00:00
<span class="param-type">any</span>
2013-10-02 14:05:55 +00:00
</td>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>The target property of the Pointer as set by the DOM event when this Pointer is started.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
</dl>
2014-05-20 09:12:48 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd>
2013-10-02 14:05:55 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-56">line 56</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-05-20 09:12:48 +00:00
<h4 class="name" id="targetObject"><span class="type-signature"></span>targetObject<span class="type-signature"></span></h4>
2013-10-02 14:05:55 +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>
2014-05-20 09:12:48 +00:00
<td class="name"><code>targetObject</code></td>
2013-10-02 14:05:55 +00:00
<td class="type">
2014-05-20 09:12:48 +00:00
<span class="param-type">any</span>
2013-10-02 14:05:55 +00:00
</td>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>The Game Object this Pointer is currently over / touching / dragging.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
</dl>
2014-05-20 09:12:48 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd>
2013-10-02 14:05:55 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-212">line 212</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-05-20 09:12:48 +00:00
<h4 class="name" id="timeDown"><span class="type-signature"></span>timeDown<span class="type-signature"></span></h4>
2013-10-02 14:05:55 +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>
2014-05-20 09:12:48 +00:00
<td class="name"><code>timeDown</code></td>
2013-10-02 14:05:55 +00:00
<td class="type">
2014-05-20 09:12:48 +00:00
<span class="param-type">number</span>
2013-10-02 14:05:55 +00:00
</td>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>A timestamp representing when the Pointer first touched the touchscreen.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
2014-05-20 09:12:48 +00:00
<dd class="tag-default"><ul class="dummy"><li>0</li></ul></dd>
2013-10-02 14:05:55 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-182">line 182</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-05-20 09:12:48 +00:00
<h4 class="name" id="timeUp"><span class="type-signature"></span>timeUp<span class="type-signature"></span></h4>
2013-10-02 14:05:55 +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>
2014-05-20 09:12:48 +00:00
<td class="name"><code>timeUp</code></td>
2013-10-02 14:05:55 +00:00
<td class="type">
<span class="param-type">number</span>
</td>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>A timestamp representing when the Pointer left the touchscreen.</p></td>
2013-10-02 14:05:55 +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>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-188">line 188</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-05-20 09:12:48 +00:00
<h4 class="name" id="totalTouches"><span class="type-signature"></span>totalTouches<span class="type-signature"></span></h4>
2013-10-02 14:05:55 +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>
2014-05-20 09:12:48 +00:00
<td class="name"><code>totalTouches</code></td>
2013-10-02 14:05:55 +00:00
<td class="type">
<span class="param-type">number</span>
</td>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>The total number of times this Pointer has been touched to the touchscreen.</p></td>
2013-10-02 14:05:55 +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>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-200">line 200</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
2014-05-20 09:12:48 +00:00
<h4 class="name" id="type"><span class="type-signature">&lt;readonly> </span>type<span class="type-signature"></span></h4>
2013-10-02 14:05:55 +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>
2014-05-20 09:12:48 +00:00
<td class="name"><code>type</code></td>
2013-10-02 14:05:55 +00:00
<td class="type">
<span class="param-type">number</span>
</td>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>The const type of this object.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-32">line 32</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="withinGame"><span class="type-signature"></span>withinGame<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>withinGame</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>true if the Pointer is over the game canvas, otherwise false.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-92">line 92</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="worldX"><span class="type-signature">&lt;readonly> </span>worldX<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Gets the X value of this Pointer in world coordinates based on the world camera.</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>duration</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The X value of this Pointer in world coordinates based on the world camera.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-07-18 11:45:51 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-726">line 726</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="worldY"><span class="type-signature">&lt;readonly> </span>worldY<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Gets the Y value of this Pointer in world coordinates based on the world camera.</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>duration</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The Y value of this Pointer in world coordinates based on the world camera.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-07-18 11:45:51 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-742">line 742</a>
2013-10-02 14:05:55 +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>
<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>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>The horizontal coordinate of the Pointer. This value is automatically scaled based on the game scale.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-152">line 152</a>
2013-10-02 14:05:55 +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>
<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>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>The vertical coordinate of the Pointer. This value is automatically scaled based on the game scale.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-158">line 158</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="justPressed"><span class="type-signature"></span>justPressed<span class="signature">(<span class="optional">duration</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
2013-11-28 15:57:09 +00:00
<p>The Pointer is considered justPressed if the time it was pressed onto the touchscreen or clicked is less than justPressedRate.
Note that calling justPressed doesn't reset the pressed status of the Pointer, it will return <code>true</code> for as long as the duration is valid.
If you wish to check if the Pointer was pressed down just once then see the Sprite.events.onInputDown event.</p>
2013-10-02 14:05:55 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>duration</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The time to check against. If none given it will use InputManager.justPressedRate.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-07-18 11:45:51 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-629">line 629</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
2013-11-28 15:57:09 +00:00
<div class="param-desc">
<p>true if the Pointer was pressed down within the duration given.</p>
</div>
2013-10-02 14:05:55 +00:00
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="justReleased"><span class="type-signature"></span>justReleased<span class="signature">(<span class="optional">duration</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
2013-11-28 15:57:09 +00:00
<p>The Pointer is considered justReleased if the time it left the touchscreen is less than justReleasedRate.
Note that calling justReleased doesn't reset the pressed status of the Pointer, it will return <code>true</code> for as long as the duration is valid.
If you wish to check if the Pointer was released just once then see the Sprite.events.onInputUp event.</p>
2013-10-02 14:05:55 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>duration</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The time to check against. If none given it will use InputManager.justReleasedRate.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-07-18 11:45:51 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-645">line 645</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
2013-11-28 15:57:09 +00:00
<div class="param-desc">
<p>true if the Pointer was released within the duration given.</p>
</div>
2013-10-02 14:05:55 +00:00
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="leave"><span class="type-signature"></span>leave<span class="signature">(event)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Called when the Pointer leaves the target area.</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">
2013-11-28 15:57:09 +00:00
<span class="param-type">MouseEvent</span>
|
<span class="param-type">PointerEvent</span>
|
<span class="param-type">TouchEvent</span>
2013-10-02 14:05:55 +00:00
</td>
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The event passed up from the input handler.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-07-18 11:45:51 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-550">line 550</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="move"><span class="type-signature"></span>move<span class="signature">(event, <span class="optional">fromClick</span>)</span><span class="type-signature"></span></h4>
2013-10-02 14:05:55 +00:00
</dt>
<dd>
<div class="description">
2013-11-28 15:57:09 +00:00
<p>Called when the Pointer is moved.</p>
2013-10-02 14:05:55 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
2013-10-02 14:05:55 +00:00
<th>Default</th>
2013-10-02 14:05:55 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>event</code></td>
<td class="type">
2013-11-28 15:57:09 +00:00
<span class="param-type">MouseEvent</span>
|
<span class="param-type">PointerEvent</span>
|
<span class="param-type">TouchEvent</span>
2013-10-02 14:05:55 +00:00
</td>
<td class="attributes">
2013-10-02 14:05:55 +00:00
</td>
<td class="default">
</td>
2013-10-02 14:05:55 +00:00
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The event passed up from the input handler.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
<tr>
<td class="name"><code>fromClick</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>Was this called from the click event?</p></td>
</tr>
2013-10-02 14:05:55 +00:00
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-351">line 351</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
2014-07-18 11:45:51 +00:00
</dd>
<dt>
<h4 class="name" id="processInteractiveObjects"><span class="type-signature">&lt;protected> </span>processInteractiveObjects<span class="signature">(<span class="optional">fromClick</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Process all interactive objects to find out which ones were updated in the recent Pointer move.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fromClick</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>Was this called from the click event?</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-447">line 447</a>
</li></ul></dd>
</dl>
2013-10-02 14:05:55 +00:00
</dd>
<dt>
<h4 class="name" id="reset"><span class="type-signature"></span>reset<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Resets the Pointer properties. Called by InputManager.reset when you perform a State change.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-07-18 11:45:51 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-661">line 661</a>
2014-05-20 09:12:48 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="resetMovement"><span class="type-signature"></span>resetMovement<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Resets the movementX and movementY properties. Use in your update handler after retrieving the values.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-07-18 11:45:51 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-690">line 690</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="start"><span class="type-signature"></span>start<span class="signature">(event)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Called when the Pointer is pressed onto the touchscreen.</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">
2014-05-20 09:12:48 +00:00
<span class="param-type">any</span>
2013-10-02 14:05:55 +00:00
</td>
2014-05-20 09:12:48 +00:00
<td class="description last"><p>The DOM event from the browser.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-251">line 251</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="stop"><span class="type-signature"></span>stop<span class="signature">(event)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Called when the Pointer leaves the touchscreen.</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">
2013-11-28 15:57:09 +00:00
<span class="param-type">MouseEvent</span>
|
<span class="param-type">PointerEvent</span>
|
<span class="param-type">TouchEvent</span>
2013-10-02 14:05:55 +00:00
</td>
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The event passed up from the input handler.</p></td>
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-07-18 11:45:51 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-563">line 563</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="update"><span class="type-signature"></span>update<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
2014-02-05 06:29:17 +00:00
<p>Called by the Input Manager.</p>
2013-10-02 14:05:55 +00:00
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
2014-05-20 09:12:48 +00:00
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-314">line 314</a>
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
2014-02-05 06:29:17 +00:00
Phaser Copyright © 2012-2014 Photon Storm Ltd.
2013-10-02 14:05:55 +00:00
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
2014-07-18 11:45:51 +00:00
on Fri Jul 18 2014 12:36:52 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
2013-10-02 14:05:55 +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( {
2014-04-10 22:13:43 +00:00
anchorName : function(i, heading, prefix) {
return $(heading).attr("id") || ( prefix + i );
},
2013-10-02 14:05:55 +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>