2013-10-02 12:18:58 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > Phaser Class: Input< / title >
<!-- [if lt IE 9]>
< script src = "//html5shiv.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
< link type = "text/css" rel = "stylesheet" href = "styles/sunlight.default.css" >
< link type = "text/css" rel = "stylesheet" href = "styles/site.cerulean.css" >
< / head >
< body >
< div class = "container-fluid" >
< div class = "navbar navbar-fixed-top navbar-inverse" >
< div class = "navbar-inner" >
< a class = "brand" href = "index.html" > Phaser< / a >
< ul class = "nav" >
< li class = "dropdown" >
2013-10-03 01:38:35 +00:00
< a href = "namespaces.list.html" class = "dropdown-toggle" data-toggle = "dropdown" > Namespaces< b
2013-10-02 12:18:58 +00:00
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.html" > Phaser< / a >
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 " >
< li >
< a href = "Phaser.Animation.html" > Animation< / a >
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.AnimationManager.html" > AnimationManager< / a >
2013-10-02 12:18:58 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.AnimationParser.html" > AnimationParser< / a >
2013-10-02 12:18:58 +00:00
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.BitmapData.html" > BitmapData< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.BitmapText.html" > BitmapText< / a >
< / li >
< li >
< a href = "Phaser.Button.html" > Button< / a >
< / li >
2013-10-02 12:18:58 +00:00
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Cache.html" > Cache< / a >
2013-10-02 12:18:58 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Camera.html" > Camera< / a >
2013-10-02 12:18:58 +00:00
< / li >
2013-10-02 14:05:55 +00:00
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Canvas.html" > Canvas< / a >
2013-10-02 14:05:55 +00:00
< / li >
2013-10-02 12:18:58 +00:00
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Circle.html" > Circle< / a >
2013-10-02 12:18:58 +00:00
< / li >
2013-10-03 00:21:08 +00:00
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Color.html" > Color< / a >
2013-10-03 00:21:08 +00:00
< / li >
2013-10-02 12:18:58 +00:00
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Device.html" > Device< / a >
2013-10-02 12:18:58 +00:00
< / li >
2013-10-03 00:21:08 +00:00
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.html" > Easing< / a >
< / li >
< li >
< a href = "Phaser.Easing.Back.html" > Back< / a >
< / li >
< li >
< a href = "Phaser.Easing.Bounce.html" > Bounce< / a >
< / li >
< li >
< a href = "Phaser.Easing.Circular.html" > Circular< / a >
< / li >
< li >
< a href = "Phaser.Easing.Cubic.html" > Cubic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Elastic.html" > Elastic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Exponential.html" > Exponential< / a >
< / li >
< li >
< a href = "Phaser.Easing.Linear.html" > Linear< / a >
< / li >
< li >
< a href = "Phaser.Easing.Quadratic.html" > Quadratic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Quartic.html" > Quartic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Quintic.html" > Quintic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Sinusoidal.html" > Sinusoidal< / a >
< / li >
2014-02-18 03:01:51 +00:00
< li >
< a href = "Phaser.Ellipse.html" > Ellipse< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Events.html" > Events< / a >
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.Filter.html" > Filter< / a >
< / li >
2013-10-03 01:38:35 +00:00
< li >
< a href = "Phaser.Frame.html" > Frame< / a >
< / li >
< li >
< a href = "Phaser.FrameData.html" > FrameData< / a >
2013-10-03 00:21:08 +00:00
< / li >
2013-10-02 12:18:58 +00:00
< li >
< a href = "Phaser.Game.html" > Game< / a >
< / li >
2014-02-21 15:37:26 +00:00
< li >
< a href = "Phaser.GameObjectCreator.html" > GameObjectCreator< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.GameObjectFactory.html" > GameObjectFactory< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.Gamepad.html" > Gamepad< / a >
< / li >
< li >
< a href = "Phaser.GamepadButton.html" > GamepadButton< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Graphics.html" > Graphics< / a >
< / li >
2013-10-02 12:18:58 +00:00
< li >
< a href = "Phaser.Group.html" > Group< / a >
< / li >
2014-02-08 07:24:22 +00:00
< li >
< a href = "Phaser.Image.html" > Image< / a >
< / li >
2013-10-02 12:18:58 +00:00
< li >
< a href = "Phaser.Input.html" > Input< / a >
< / li >
2013-10-02 14:05:55 +00:00
< li >
< a href = "Phaser.InputHandler.html" > InputHandler< / a >
< / li >
< li >
< a href = "Phaser.Key.html" > Key< / a >
< / li >
< li >
< a href = "Phaser.Keyboard.html" > Keyboard< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.Line.html" > Line< / a >
< / li >
2013-10-02 12:18:58 +00:00
< li >
< a href = "Phaser.LinkedList.html" > LinkedList< / a >
< / li >
< li >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.Loader.html" > Loader< / a >
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.LoaderParser.html" > LoaderParser< / a >
2013-10-02 14:05:55 +00:00
< / li >
< li >
< a href = "Phaser.Math.html" > Math< / a >
< / li >
< li >
< a href = "Phaser.Mouse.html" > Mouse< / a >
< / li >
< li >
< a href = "Phaser.MSPointer.html" > MSPointer< / a >
2013-10-02 12:18:58 +00:00
< / li >
2013-10-02 19:18:24 +00:00
< li >
< a href = "Phaser.Net.html" > Net< / a >
< / li >
< li >
< a href = "Phaser.Particles.html" > Particles< / a >
< / li >
< li >
< a href = "Phaser.Particles.Arcade.Emitter.html" > Emitter< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Physics.html" > Physics< / a >
< / li >
< li >
< a href = "Phaser.Physics.Arcade.html" > Arcade< / a >
< / li >
2014-02-21 15:37:26 +00:00
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Arcade.Body.html" > Body< / a >
< / li >
< li >
< a href = "Phaser.Physics.Ninja.html" > Ninja< / a >
< / li >
< li >
< a href = "Phaser.Physics.Ninja.AABB.html" > AABB< / a >
< / li >
< li >
< a href = "Phaser.Physics.Ninja.Body.html" > Body< / a >
< / li >
< li >
< a href = "Phaser.Physics.Ninja.Circle.html" > Circle< / a >
< / li >
< li >
< a href = "Phaser.Physics.Ninja.Tile.html" > Tile< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.html" > P2< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.Body.html" > Body< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.BodyDebug.html" > BodyDebug< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.CollisionGroup.html" > CollisionGroup< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.ContactMaterial.html" > ContactMaterial< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.DistanceConstraint.html" > DistanceConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.GearConstraint.html" > GearConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.InversePointProxy.html" > InversePointProxy< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.LockConstraint.html" > LockConstraint< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.Material.html" > Material< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.PointProxy.html" > PointProxy< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.PrismaticConstraint.html" > PrismaticConstraint< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.RevoluteConstraint.html" > RevoluteConstraint< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.Spring.html" > Spring< / a >
2014-02-21 15:37:26 +00:00
< / li >
2013-10-02 12:18:58 +00:00
< li >
< a href = "Phaser.Plugin.html" > Plugin< / a >
< / li >
2013-10-02 14:05:55 +00:00
< li >
< a href = "Phaser.PluginManager.html" > PluginManager< / a >
< / li >
2013-10-02 12:18:58 +00:00
< li >
< a href = "Phaser.Point.html" > Point< / a >
< / li >
2013-10-02 14:05:55 +00:00
< li >
< a href = "Phaser.Pointer.html" > Pointer< / a >
< / li >
2013-11-07 06:10:15 +00:00
< li >
< a href = "Phaser.Polygon.html" > Polygon< / a >
< / li >
2014-03-14 06:36:05 +00:00
< li >
< a href = "Phaser.QuadTree.html" > QuadTree< / a >
< / li >
2013-10-02 14:05:55 +00:00
< li >
< a href = "Phaser.RandomDataGenerator.html" > RandomDataGenerator< / a >
< / li >
2013-10-02 12:18:58 +00:00
< li >
< a href = "Phaser.Rectangle.html" > Rectangle< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.RenderTexture.html" > RenderTexture< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.RequestAnimationFrame.html" > RequestAnimationFrame< / a >
< / li >
2014-03-14 06:36:05 +00:00
< li >
< a href = "Phaser.RetroFont.html" > RetroFont< / a >
< / li >
< li >
< a href = "Phaser.ScaleManager.html" > ScaleManager< / a >
< / li >
2013-10-02 12:18:58 +00:00
< li >
< a href = "Phaser.Signal.html" > Signal< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.SinglePad.html" > SinglePad< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.Sound.html" > Sound< / a >
< / li >
< li >
< a href = "Phaser.SoundManager.html" > SoundManager< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Sprite.html" > Sprite< / a >
< / li >
2014-02-18 03:01:51 +00:00
< li >
< a href = "Phaser.SpriteBatch.html" > SpriteBatch< / a >
< / li >
2013-10-02 12:18:58 +00:00
< li >
< a href = "Phaser.Stage.html" > Stage< / a >
< / li >
< li >
< a href = "Phaser.State.html" > State< / a >
< / li >
< li >
< a href = "Phaser.StateManager.html" > StateManager< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Text.html" > Text< / a >
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.Tile.html" > Tile< / a >
< / li >
< li >
< a href = "Phaser.Tilemap.html" > Tilemap< / a >
< / li >
< li >
< a href = "Phaser.TilemapLayer.html" > TilemapLayer< / a >
< / li >
< li >
< a href = "Phaser.TilemapParser.html" > TilemapParser< / a >
< / li >
< li >
< a href = "Phaser.Tileset.html" > Tileset< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.TileSprite.html" > TileSprite< / a >
< / li >
2013-10-03 01:38:35 +00:00
< li >
< a href = "Phaser.Time.html" > Time< / a >
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.Timer.html" > Timer< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.TimerEvent.html" > TimerEvent< / a >
< / li >
2013-10-02 14:05:55 +00:00
< li >
< a href = "Phaser.Touch.html" > Touch< / a >
< / li >
2013-10-03 01:38:35 +00:00
< li >
< a href = "Phaser.Tween.html" > Tween< / a >
< / li >
< li >
< a href = "Phaser.TweenManager.html" > TweenManager< / a >
< / li >
< li >
< a href = "Phaser.Utils.html" > Utils< / a >
< / li >
< li >
< a href = "Phaser.Utils.Debug.html" > Debug< / a >
< / li >
2013-10-02 12:18:58 +00:00
< li >
< a href = "Phaser.World.html" > World< / a >
< / li >
< li >
< a href = "SignalBinding.html" > SignalBinding< / a >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / div >
< div class = "row-fluid" >
< div class = "span8" >
< div id = "main" >
< h1 class = "page-title" > Class: Input< / h1 >
< section >
< header >
< h2 >
2013-10-03 01:38:35 +00:00
< span class = "ancestors" > < a href = "Phaser.html" > Phaser< / a > .< / span >
2013-10-02 12:18:58 +00:00
Input
< / h2 >
2013-11-28 15:57:09 +00:00
< div class = "class-description" > < p > Phaser.Input< / p > < / div >
2013-10-02 12:18:58 +00:00
< / header >
< article >
< div class = "container-overview" >
< dt >
< h4 class = "name" id = "Input" > < span class = "type-signature" > < / span > new Input< span class = "signature" > (game)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
2013-11-28 15:57:09 +00:00
< p > Phaser.Input is the Input Manager for all types of Input across Phaser, including mouse, keyboard, touch and MSPointer.
The Input manager is updated automatically by the core game loop.< / p >
2013-10-02 12:18:58 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > game< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Game.html" > Phaser.Game< / a > < / span >
< / td >
< td class = "description last" > < p > Current game instance.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-15" > line 15< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / div >
< h3 class = "subsection-title" > Members< / h3 >
< dl >
< dt >
< h4 class = "name" id = "MOUSE_OVERRIDES_TOUCH" > < span class = "type-signature" > < static, constant> < / span > MOUSE_OVERRIDES_TOUCH< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > number< / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-306" > line 306< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "MOUSE_TOUCH_COMBINE" > < span class = "type-signature" > < static, constant> < / span > MOUSE_TOUCH_COMBINE< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > number< / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-318" > line 318< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "TOUCH_OVERRIDES_MOUSE" > < span class = "type-signature" > < static, constant> < / span > TOUCH_OVERRIDES_MOUSE< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > number< / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-312" > line 312< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2013-10-02 14:05:55 +00:00
< h4 class = "name" id = "activePointer" > < span class = "type-signature" > < / span > activePointer< span class = "type-signature" > < / span > < / h4 >
2013-10-02 12:18:58 +00:00
< / dt >
< dd >
< div class = "description" >
2013-10-02 14:05:55 +00:00
< p > The most recently active Pointer object.
When you've limited max pointers to 1 this will accurately be either the first finger touched or mouse.< / p >
2013-10-02 12:18:58 +00:00
< / div >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2013-10-02 14:05:55 +00:00
< td class = "name" > < code > activePointer< / code > < / td >
2013-10-02 12:18:58 +00:00
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-207" > line 207< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2013-10-02 14:05:55 +00:00
< h4 class = "name" id = "circle" > < span class = "type-signature" > < / span > circle< span class = "type-signature" > < / span > < / h4 >
2013-10-02 12:18:58 +00:00
< / dt >
< dd >
< div class = "description" >
2013-10-02 14:05:55 +00:00
< p > A Circle object centered on the x/y screen coordinates of the Input.
Default size of 44px (Apples recommended " finger tip" size) but can be changed to anything.< / p >
2013-10-02 12:18:58 +00:00
< / div >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2013-10-02 14:05:55 +00:00
< td class = "name" > < code > circle< / code > < / td >
2013-10-02 12:18:58 +00:00
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Circle.html" > Phaser.Circle< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-80" > line 80< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2013-10-02 14:05:55 +00:00
< h4 class = "name" id = "currentPointers" > < span class = "type-signature" > < / span > currentPointers< span class = "type-signature" > < / span > < / h4 >
2013-10-02 12:18:58 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2013-10-02 14:05:55 +00:00
< td class = "name" > < code > currentPointers< / code > < / td >
2013-10-02 12:18:58 +00:00
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > number< / span >
2013-10-02 12:18:58 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The current number of active Pointers.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
2013-10-02 14:05:55 +00:00
< dd class = "tag-default" > < ul class = "dummy" > < li > 0< / li > < / ul > < / dd >
2013-10-02 12:18:58 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-97" > line 97< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2013-10-02 14:05:55 +00:00
< h4 class = "name" id = "disabled" > < span class = "type-signature" > < / span > disabled< span class = "type-signature" > < / span > < / h4 >
2013-10-02 12:18:58 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-08 07:24:22 +00:00
< p > You can disable all Input by setting Input.disabled = true. While set all new input related events will be ignored.
If you need to disable just one type of input; for example mouse; use Input.mouse.disabled = true instead< / p >
2013-10-02 12:18:58 +00:00
< / div >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2013-10-02 14:05:55 +00:00
< td class = "name" > < code > disabled< / code > < / td >
2013-10-02 12:18:58 +00:00
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > boolean< / span >
2013-10-02 12:18:58 +00:00
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
2013-10-02 14:05:55 +00:00
< dd class = "tag-default" > < ul class = "dummy" > < li > false< / li > < / ul > < / dd >
2013-10-02 12:18:58 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-56" > line 56< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2013-10-02 14:05:55 +00:00
< h4 class = "name" id = "doubleTapRate" > < span class = "type-signature" > < / span > doubleTapRate< span class = "type-signature" > < / span > < / h4 >
2013-10-02 12:18:58 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2013-10-02 14:05:55 +00:00
< td class = "name" > < code > doubleTapRate< / code > < / td >
2013-10-02 12:18:58 +00:00
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > number< / span >
2013-10-02 12:18:58 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The number of milliseconds between taps of the same Pointer for it to be considered a double tap / click.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
2013-10-02 14:05:55 +00:00
< dd class = "tag-default" > < ul class = "dummy" > < li > 300< / li > < / ul > < / dd >
2013-10-02 12:18:58 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-109" > line 109< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2013-10-02 14:05:55 +00:00
< h4 class = "name" id = "game" > < span class = "type-signature" > < / span > game< span class = "type-signature" > < / span > < / h4 >
2013-10-02 12:18:58 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2013-10-02 14:05:55 +00:00
< td class = "name" > < code > game< / code > < / td >
2013-10-02 12:18:58 +00:00
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Game.html" > Phaser.Game< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
2013-10-02 14:05:55 +00:00
< td class = "description last" > < p > A reference to the currently running game.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-02 14:05:55 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-20" > line 20< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
2014-02-05 06:29:17 +00:00
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "gamepad" > < span class = "type-signature" > < / span > gamepad< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > gamepad< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Gamepad.html" > Phaser.Gamepad< / a > < / span >
< / td >
< td class = "description last" > < p > The Gamepad Input manager.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-237" > line 237< / a >
2014-02-05 06:29:17 +00:00
< / li > < / ul > < / dd >
2013-10-02 12:18:58 +00:00
< / dl >
< / dd >
< dt >
2013-10-02 14:05:55 +00:00
< h4 class = "name" id = "hitCanvas" > < span class = "type-signature" > < / span > hitCanvas< span class = "type-signature" > < / span > < / h4 >
2013-10-02 12:18:58 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2013-10-02 14:05:55 +00:00
< td class = "name" > < code > hitCanvas< / code > < / td >
2013-10-02 12:18:58 +00:00
< td class = "type" >
2013-11-28 15:57:09 +00:00
< span class = "param-type" > HTMLCanvasElement< / span >
2013-10-02 12:18:58 +00:00
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The canvas to which single pixels are drawn in order to perform pixel-perfect hit detection.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
2013-10-02 14:05:55 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > null< / li > < / ul > < / dd >
2013-10-02 12:18:58 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-02 14:05:55 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-26" > line 26< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2013-10-02 14:05:55 +00:00
< h4 class = "name" id = "hitContext" > < span class = "type-signature" > < / span > hitContext< span class = "type-signature" > < / span > < / h4 >
2013-10-02 12:18:58 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2013-10-02 14:05:55 +00:00
< td class = "name" > < code > hitContext< / code > < / td >
2013-10-02 12:18:58 +00:00
< td class = "type" >
2013-11-28 15:57:09 +00:00
< span class = "param-type" > CanvasRenderingContext2D< / span >
2013-10-02 12:18:58 +00:00
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The context of the pixel perfect hit canvas.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > null< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-02 14:05:55 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-32" > line 32< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2013-10-02 14:05:55 +00:00
< h4 class = "name" id = "holdRate" > < span class = "type-signature" > < / span > holdRate< span class = "type-signature" > < / span > < / h4 >
2013-10-02 12:18:58 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2013-10-02 14:05:55 +00:00
< td class = "name" > < code > holdRate< / code > < / td >
2013-10-02 12:18:58 +00:00
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > number< / span >
2013-10-02 12:18:58 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The number of milliseconds that the Pointer has to be pressed down for it to fire a onHold event.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
2013-10-02 14:05:55 +00:00
< dd class = "tag-default" > < ul class = "dummy" > < li > 2000< / li > < / ul > < / dd >
2013-10-02 12:18:58 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-115" > line 115< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2013-10-02 14:05:55 +00:00
< h4 class = "name" id = "interactiveItems" > < span class = "type-signature" > < / span > interactiveItems< span class = "type-signature" > < / span > < / h4 >
2013-10-02 12:18:58 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-08 07:24:22 +00:00
< p > A linked list of interactive objects; the InputHandler components (belonging to Sprites) register themselves with this.< / p >
2013-10-02 12:18:58 +00:00
< / div >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2013-10-02 14:05:55 +00:00
< td class = "name" > < code > interactiveItems< / code > < / td >
2013-10-02 12:18:58 +00:00
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.LinkedList.html" > Phaser.LinkedList< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-268" > line 268< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "justPressedRate" > < span class = "type-signature" > < / span > justPressedRate< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > justPressedRate< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The number of milliseconds below which the Pointer is considered justPressed.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 200< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-121" > line 121< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "justReleasedRate" > < span class = "type-signature" > < / span > justReleasedRate< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > justReleasedRate< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The number of milliseconds below which the Pointer is considered justReleased .< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 200< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-127" > line 127< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "keyboard" > < span class = "type-signature" > < / span > keyboard< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > keyboard< / code > < / td >
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Keyboard.html" > Phaser.Keyboard< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
2013-10-02 14:05:55 +00:00
< td class = "description last" > < p > The Keyboard Input manager.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-222" > line 222< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "maxPointers" > < span class = "type-signature" > < / span > maxPointers< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > maxPointers< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The maximum number of Pointers allowed to be active at any one time. For lots of games it's useful to set this to 1.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 10< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-91" > line 91< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "mouse" > < span class = "type-signature" > < / span > mouse< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > mouse< / code > < / td >
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Mouse.html" > Phaser.Mouse< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
2013-10-02 14:05:55 +00:00
< td class = "description last" > < p > The Mouse Input manager.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-217" > line 217< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "mousePointer" > < span class = "type-signature" > < / span > mousePointer< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > mousePointer< / code > < / td >
< td class = "type" >
< span class = "param-type" > Pointer< / span >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The mouse has its own unique Phaser.Pointer object which you can use if making a desktop specific game.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-212" > line 212< / a >
2014-02-05 06:29:17 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "moveCallback" > < span class = "type-signature" > < / span > moveCallback< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > moveCallback< / code > < / td >
< td class = "type" >
< span class = "param-type" > function< / span >
< / td >
< td class = "description last" > < p > An optional callback that will be fired every time the activePointer receives a move event from the DOM. Set to null to disable.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-37" > line 37< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "moveCallbackContext" > < span class = "type-signature" > < / span > moveCallbackContext< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > moveCallbackContext< / code > < / td >
< td class = "type" >
< span class = "param-type" > object< / span >
< / td >
< td class = "description last" > < p > The context in which the moveCallback will be sent. Defaults to Phaser.Input but can be set to any valid JS object.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-42" > line 42< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "mspointer" > < span class = "type-signature" > < / span > mspointer< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > mspointer< / code > < / td >
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.MSPointer.html" > Phaser.MSPointer< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
2013-10-02 14:05:55 +00:00
< td class = "description last" > < p > The MSPointer Input manager.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-232" > line 232< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "multiInputOverride" > < span class = "type-signature" > < / span > multiInputOverride< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > multiInputOverride< / code > < / td >
< td class = "type" >
2014-02-08 07:24:22 +00:00
< span class = "param-type" > number< / span >
2013-10-02 12:18:58 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > Controls the expected behaviour when using a mouse and touch together on a multi-input device.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-62" > line 62< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "onDown" > < span class = "type-signature" > < / span > onDown< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > onDown< / code > < / td >
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Signal.html" > Phaser.Signal< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > A Signal that is dispatched each time a pointer is pressed down.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-247" > line 247< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "onHold" > < span class = "type-signature" > < / span > onHold< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > onHold< / code > < / td >
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Signal.html" > Phaser.Signal< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > A Signal that is dispatched each time a pointer is held down.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-262" > line 262< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "onTap" > < span class = "type-signature" > < / span > onTap< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > onTap< / code > < / td >
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Signal.html" > Phaser.Signal< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > A Signal that is dispatched each time a pointer is tapped.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-257" > line 257< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "onUp" > < span class = "type-signature" > < / span > onUp< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > onUp< / code > < / td >
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Signal.html" > Phaser.Signal< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > A Signal that is dispatched each time a pointer is released.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-252" > line 252< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "pointer1" > < span class = "type-signature" > < / span > pointer1< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > pointer1< / code > < / td >
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > A Pointer object.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-155" > line 155< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "pointer2" > < span class = "type-signature" > < / span > pointer2< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > pointer2< / code > < / td >
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > A Pointer object.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-160" > line 160< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "pointer3" > < span class = "type-signature" > < / span > pointer3< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > pointer3< / code > < / td >
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > A Pointer object.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-165" > line 165< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "pointer4" > < span class = "type-signature" > < / span > pointer4< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > pointer4< / code > < / td >
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > A Pointer object.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-170" > line 170< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "pointer5" > < span class = "type-signature" > < / span > pointer5< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > pointer5< / code > < / td >
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > A Pointer object.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-175" > line 175< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "pointer6" > < span class = "type-signature" > < / span > pointer6< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > pointer6< / code > < / td >
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > A Pointer object.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-180" > line 180< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "pointer7" > < span class = "type-signature" > < / span > pointer7< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > pointer7< / code > < / td >
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > A Pointer object.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-185" > line 185< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "pointer8" > < span class = "type-signature" > < / span > pointer8< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > pointer8< / code > < / td >
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > A Pointer object.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-190" > line 190< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "pointer9" > < span class = "type-signature" > < / span > pointer9< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > pointer9< / code > < / td >
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > A Pointer object.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-195" > line 195< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "pointer10" > < span class = "type-signature" > < / span > pointer10< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > pointer10< / code > < / td >
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > A Pointer object.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-200" > line 200< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "pollLocked" > < span class = "type-signature" > < readonly> < / span > pollLocked< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > pollLocked< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > < p > True if the Input is currently poll rate locked.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-829" > line 829< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "pollRate" > < span class = "type-signature" > < / span > pollRate< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > pollRate< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > How often should the input pointers be checked for updates? A value of 0 means every single frame (60fps); a value of 1 means every other frame (30fps) and so on.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 0< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-08 07:24:22 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-48" > line 48< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "position" > < span class = "type-signature" > < / span > position< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > position< / code > < / td >
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > A point object representing the current position of the Pointer.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > null< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-68" > line 68< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "recordLimit" > < span class = "type-signature" > < / span > recordLimit< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The total number of entries that can be recorded into the Pointer objects tracking history.
2014-02-08 07:24:22 +00:00
If the Pointer is tracking one event every 100ms; then a trackLimit of 100 would store the last 10 seconds worth of history.< / p >
2013-10-02 12:18:58 +00:00
< / div >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > recordLimit< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 100< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-150" > line 150< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "recordPointerHistory" > < span class = "type-signature" > < / span > recordPointerHistory< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Sets if the Pointer objects should record a history of x/y coordinates they have passed through.
The history is cleared each time the Pointer is pressed down.
The history is updated at the rate specified in Input.pollRate< / p >
< / div >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > recordPointerHistory< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > false< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-136" > line 136< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "recordRate" > < span class = "type-signature" > < / span > recordRate< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > recordRate< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The rate in milliseconds at which the Pointer objects should update their tracking history.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 100< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-142" > line 142< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "scale" > < span class = "type-signature" > < / span > scale< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > scale< / code > < / td >
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
2014-03-14 06:36:05 +00:00
< td class = "description last" > < p > The scale by which all input coordinates are multiplied; calculated by the ScaleManager. In an un-scaled game the values will be x = 1 and y = 1.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-85" > line 85< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "speed" > < span class = "type-signature" > < / span > speed< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > speed< / code > < / td >
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > A point object representing the speed of the Pointer. Only really useful in single Pointer games; otherwise see the Pointer objects directly.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-73" > line 73< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "tapRate" > < span class = "type-signature" > < / span > tapRate< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > tapRate< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The number of milliseconds that the Pointer has to be pressed down and then released to be considered a tap or click.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 200< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-103" > line 103< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "totalActivePointers" > < span class = "type-signature" > < readonly> < / span > totalActivePointers< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The total number of active Pointers< / p >
< / div >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > totalActivePointers< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The total number of active Pointers.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-856" > line 856< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "totalInactivePointers" > < span class = "type-signature" > < readonly> < / span > totalInactivePointers< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The total number of inactive Pointers< / p >
< / div >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > totalInactivePointers< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The total number of inactive Pointers.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-842" > line 842< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "touch" > < span class = "type-signature" > < / span > touch< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > touch< / code > < / td >
< td class = "type" >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Touch.html" > Phaser.Touch< / a > < / span >
2013-10-02 12:18:58 +00:00
< / td >
2013-10-02 14:05:55 +00:00
< td class = "description last" > < p > the Touch Input manager.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-227" > line 227< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "worldX" > < span class = "type-signature" > < / span > worldX< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The world X coordinate of the most recently active pointer.< / p >
< / div >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > worldX< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The world X coordinate of the most recently active pointer.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-882" > line 882< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "worldY" > < span class = "type-signature" > < / span > worldY< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The world Y coordinate of the most recently active pointer.< / p >
< / div >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > worldY< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The world Y coordinate of the most recently active pointer.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-895" > line 895< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "x" > < span class = "type-signature" > < / span > x< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The X coordinate of the most recently active pointer. This value takes game scaling into account automatically. See Pointer.screenX/clientX for source values.< / p >
< / div >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The X coordinate of the most recently active pointer.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-795" > line 795< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "y" > < span class = "type-signature" > < / span > y< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The Y coordinate of the most recently active pointer. This value takes game scaling into account automatically. See Pointer.screenY/clientY for source values.< / p >
< / div >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The Y coordinate of the most recently active pointer.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-812" > line 812< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
< dl >
< dt >
2013-10-02 14:05:55 +00:00
< h4 class = "name" id = "addPointer" > < span class = "type-signature" > < / span > addPointer< span class = "signature" > ()< / span > < span class = "type-signature" > → {< a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > }< / span > < / h4 >
2013-10-02 12:18:58 +00:00
< / dt >
< dd >
< div class = "description" >
2013-10-02 14:05:55 +00:00
< p > Add a new Pointer object to the Input Manager. By default Input creates 3 pointer objects: mousePointer, pointer1 and pointer2.
If you need more then use this to create a new one, up to a maximum of 10.< / p >
2013-10-02 12:18:58 +00:00
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-400" > line 400< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2013-10-02 14:05:55 +00:00
< p > A reference to the new Pointer object that was created.< / p >
2013-10-02 12:18:58 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > < / span >
2013-10-02 12:18:58 +00:00
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "boot" > < span class = "type-signature" > < protected> < / span > boot< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Starts the Input Manager running.< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-322" > line 322< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2013-10-25 15:54:40 +00:00
< h4 class = "name" id = "destroy" > < span class = "type-signature" > < / span > destroy< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 12:18:58 +00:00
< / dt >
< dd >
< div class = "description" >
2013-10-25 15:54:40 +00:00
< p > Stops all of the Input Managers from running.< / p >
2013-10-02 12:18:58 +00:00
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-368" > line 368< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-02-08 07:24:22 +00:00
< / dd >
< dt >
< h4 class = "name" id = "getLocalPosition" > < span class = "type-signature" > < / span > getLocalPosition< span class = "signature" > (displayObject, pointer)< / span > < span class = "type-signature" > → {< a href = "Phaser.Point.html" > Phaser.Point< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > This will return the local coordinates of the specified displayObject based on the given Pointer.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > displayObject< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Sprite.html" > Phaser.Sprite< / a > < / span >
|
< span class = "param-type" > < a href = "Phaser.Image.html" > Phaser.Image< / a > < / span >
< / td >
< td class = "description last" > < p > The DisplayObject to get the local coordinates for.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > pointer< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > < / span >
< / td >
< td class = "description last" > < p > The Pointer to use in the check against the displayObject.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-698" > line 698< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > A point containing the coordinates of the Pointer position relative to the DisplayObject.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / dd >
< / dl >
2013-10-02 12:18:58 +00:00
< / dd >
< dt >
2013-10-02 14:05:55 +00:00
< h4 class = "name" id = "getPointer" > < span class = "type-signature" > < / span > getPointer< span class = "signature" > (state)< / span > < span class = "type-signature" > → {< a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > }< / span > < / h4 >
2013-10-02 12:18:58 +00:00
< / dt >
< dd >
< div class = "description" >
< p > Get the next Pointer object whos active property matches the given state< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > state< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > < p > The state the Pointer should be in (false for inactive, true for active).< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-634" > line 634< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > A Pointer object or null if no Pointer object matches the requested state.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > < / span >
2013-10-02 12:18:58 +00:00
< / dd >
< / dl >
< / dd >
< dt >
2013-10-02 14:05:55 +00:00
< h4 class = "name" id = "getPointerFromIdentifier" > < span class = "type-signature" > < / span > getPointerFromIdentifier< span class = "signature" > (identifier)< / span > < span class = "type-signature" > → {< a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > }< / span > < / h4 >
2013-10-02 12:18:58 +00:00
< / dt >
< dd >
< div class = "description" >
< p > Get the Pointer object whos identified property matches the given identifier value.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > identifier< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The Pointer.identifier value to search for.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-667" > line 667< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > A Pointer object or null if no Pointer object matches the requested identifier.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > < / span >
2013-10-02 12:18:58 +00:00
< / dd >
< / dl >
2014-03-14 06:36:05 +00:00
< / dd >
< dt >
< h4 class = "name" id = "hitTest" > < span class = "type-signature" > < / span > hitTest< span class = "signature" > (displayObject, pointer, localPoint)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Tests if the pointer hits the given object.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > displayObject< / code > < / td >
< td class = "type" >
< span class = "param-type" > DisplayObject< / span >
< / td >
< td class = "description last" > < p > The displayObject to test for a hit.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > pointer< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > < / span >
< / td >
< td class = "description last" > < p > The pointer to use for the test.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > localPoint< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / td >
< td class = "description last" > < p > The local translated point.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-719" > line 719< / a >
< / li > < / ul > < / dd >
< / dl >
2013-10-02 12:18:58 +00:00
< / dd >
< dt >
< h4 class = "name" id = "reset" > < span class = "type-signature" > < / span > reset< span class = "signature" > (hard)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Reset all of the Pointers and Input states< / 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 > hard< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
2013-10-02 14:05:55 +00:00
< td class = "description last" > < p > A soft reset (hard = false) won't reset any Signals that might be bound. A hard reset will.< / p > < / td >
2013-10-02 12:18:58 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-472" > line 472< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "resetSpeed" > < span class = "type-signature" > < / span > resetSpeed< span class = "signature" > (x, y)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Resets the speed and old position properties.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > Sets the oldPosition.x value.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > Sets the oldPosition.y value.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-523" > line 523< / a >
2014-02-05 06:29:17 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "setMoveCallback" > < span class = "type-signature" > < / span > setMoveCallback< span class = "signature" > (callback, callbackContext)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Sets a callback that is fired every time the activePointer receives a DOM move event such as a mousemove or touchmove.
It will be called every time the activePointer moves, which in a multi-touch game can be a lot of times, so this is best
to only use if you've limited input to a single pointer (i.e. mouse or touch)< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > callback< / code > < / td >
< td class = "type" >
< span class = "param-type" > function< / span >
< / td >
< td class = "description last" > < p > The callback that will be called each time the activePointer receives a DOM move event.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > callbackContext< / code > < / td >
< td class = "type" >
< span class = "param-type" > object< / span >
< / td >
< td class = "description last" > < p > The context in which the callback will be called.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-385" > line 385< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2013-10-02 14:05:55 +00:00
< h4 class = "name" id = "startPointer" > < span class = "type-signature" > < / span > startPointer< span class = "signature" > (event)< / span > < span class = "type-signature" > → {< a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > }< / span > < / h4 >
2013-10-02 12:18:58 +00:00
< / dt >
< dd >
< div class = "description" >
2013-10-02 14:05:55 +00:00
< p > Find the first free Pointer object and start it, passing in the event data. This is called automatically by Phaser.Touch and Phaser.MSPointer.< / p >
2013-10-02 12:18:58 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > event< / code > < / td >
< td class = "type" >
< span class = "param-type" > Any< / span >
< / td >
< td class = "description last" > < p > The event data from the Touch event.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-536" > line 536< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The Pointer object that was started or null if no Pointer object is available.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > < / span >
2013-10-02 12:18:58 +00:00
< / dd >
< / dl >
< / dd >
< dt >
2013-10-02 14:05:55 +00:00
< h4 class = "name" id = "stopPointer" > < span class = "type-signature" > < / span > stopPointer< span class = "signature" > (event)< / span > < span class = "type-signature" > → {< a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > }< / span > < / h4 >
2013-10-02 12:18:58 +00:00
< / dt >
< dd >
< div class = "description" >
< p > Stops the matching Pointer object, passing in the event data.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > event< / code > < / td >
< td class = "type" >
< span class = "param-type" > Any< / span >
< / td >
< td class = "description last" > < p > The event data from the Touch event.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-603" > line 603< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The Pointer object that was stopped or null if no Pointer object is available.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > < / span >
2013-10-02 12:18:58 +00:00
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "update" > < span class = "type-signature" > < protected> < / span > update< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Updates the Input Manager. Called by the core Game loop.< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-431" > line 431< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2013-10-02 14:05:55 +00:00
< h4 class = "name" id = "updatePointer" > < span class = "type-signature" > < / span > updatePointer< span class = "signature" > (event)< / span > < span class = "type-signature" > → {< a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > }< / span > < / h4 >
2013-10-02 12:18:58 +00:00
< / dt >
< dd >
< div class = "description" >
2013-10-02 14:05:55 +00:00
< p > Updates the matching Pointer object, passing in the event data. This is called automatically and should not normally need to be invoked.< / p >
2013-10-02 12:18:58 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > event< / code > < / td >
< td class = "type" >
< span class = "param-type" > Any< / span >
< / td >
< td class = "description last" > < p > The event data from the Touch event.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Input.js.html" > input/Input.js< / a > , < a href = "Input.js.html#sunlight-1-line-572" > line 572< / a >
2013-10-02 12:18:58 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The Pointer object that was updated or null if no Pointer object is available.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2013-10-02 14:05:55 +00:00
< span class = "param-type" > < a href = "Phaser.Pointer.html" > Phaser.Pointer< / a > < / span >
2013-10-02 12:18:58 +00:00
< / 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 12:18:58 +00:00
< / span >
< br / >
< span class = "jsdoc-message" >
2013-10-25 15:54:40 +00:00
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.3.0-dev< / a >
2014-03-14 06:36:05 +00:00
on Fri Mar 14 2014 06:34:25 GMT-0000 (GMT) using the < a href = "https://github.com/terryweiss/docstrap" > DocStrap template< / a > .
2013-10-02 12:18:58 +00:00
< / span >
< / footer >
< / div >
< div class = "span3" >
< div id = "toc" > < / div >
< / div >
< br clear = "both" >
< / div >
< / div >
< script src = "scripts/sunlight.js" > < / script >
< script src = "scripts/sunlight.javascript.js" > < / script >
< script src = "scripts/sunlight-plugin.doclinks.js" > < / script >
< script src = "scripts/sunlight-plugin.linenumbers.js" > < / script >
< script src = "scripts/sunlight-plugin.menu.js" > < / script >
< script src = "scripts/jquery.min.js" > < / script >
< script src = "scripts/jquery.scrollTo.js" > < / script >
< script src = "scripts/jquery.localScroll.js" > < / script >
< script src = "scripts/bootstrap-dropdown.js" > < / script >
< script src = "scripts/toc.js" > < / script >
< script > Sunlight . highlightAll ( { lineNumbers : true , showMenu : true , enableDoclinks : true } ) ; < / script >
< script >
$( function () {
$( "#toc" ).toc( {
2014-03-14 06:36:05 +00:00
anchorName : function(i, heading, prefix) {
return $(heading).attr("id") || ( prefix + i );
},
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 >
