2013-10-02 14:05:55 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > Phaser Class: Mouse< / 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 14:05:55 +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 14:05:55 +00:00
< / li >
< / ul >
< / li >
< li class = "dropdown" >
< a href = "classes.list.html" class = "dropdown-toggle" data-toggle = "dropdown" > Classes< b
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
< 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 14:05:55 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.AnimationParser.html" > AnimationParser< / a >
2013-10-02 14:05:55 +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 14:05:55 +00:00
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Cache.html" > Cache< / a >
2013-10-02 14:05:55 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Camera.html" > Camera< / a >
2013-10-02 14:05:55 +00:00
< / li >
< 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 >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Circle.html" > Circle< / a >
2013-10-02 14:05:55 +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 14:05:55 +00:00
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Device.html" > Device< / a >
2013-10-02 14:05:55 +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 14:05:55 +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 14:05:55 +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 14:05:55 +00:00
< li >
< a href = "Phaser.Input.html" > Input< / a >
< / li >
< 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 14:05:55 +00:00
< li >
< a href = "Phaser.LinkedList.html" > LinkedList< / a >
< / li >
< li >
< 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 >
< / 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 >
< / li >
< li >
< a href = "Phaser.Physics.P2.BodyDebug.html" > BodyDebug< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.CollisionGroup.html" > CollisionGroup< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.ContactMaterial.html" > ContactMaterial< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.DistanceConstraint.html" > DistanceConstraint< / a >
< / li >
< li >
< 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 >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.Material.html" > Material< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.PointProxy.html" > PointProxy< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.PrismaticConstraint.html" > PrismaticConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.RevoluteConstraint.html" > RevoluteConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.Spring.html" > Spring< / a >
2014-02-21 15:37:26 +00:00
< / li >
2013-10-02 14:05:55 +00:00
< li >
< a href = "Phaser.Plugin.html" > Plugin< / a >
< / li >
< li >
< a href = "Phaser.PluginManager.html" > PluginManager< / a >
< / li >
< li >
< a href = "Phaser.Point.html" > Point< / a >
< / li >
< 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 >
< 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 14:05:55 +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 14:05:55 +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 14:05:55 +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: Mouse< / 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 14:05:55 +00:00
Mouse
< / h2 >
2013-11-28 15:57:09 +00:00
< div class = "class-description" > < p > Phaser.Mouse< / p > < / div >
2013-10-02 14:05:55 +00:00
< / header >
< article >
< div class = "container-overview" >
< dt >
< h4 class = "name" id = "Mouse" > < span class = "type-signature" > < / span > new Mouse< 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.Mouse is responsible for handling all aspects of mouse interaction with the browser. It captures and processes mouse events.< / p >
2013-10-02 14:05:55 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > game< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Game.html" > Phaser.Game< / a > < / span >
< / td >
< td class = "description last" > < p > A reference to the currently running game.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Mouse.js.html" > input/Mouse.js< / a > , < a href = "Mouse.js.html#sunlight-1-line-14" > line 14< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / div >
< h3 class = "subsection-title" > Members< / h3 >
< dl >
< dt >
< h4 class = "name" id = "LEFT_BUTTON" > < span class = "type-signature" > < static, constant> < / span > LEFT_BUTTON< 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-02-05 06:29:17 +00:00
< a href = "Mouse.js.html" > input/Mouse.js< / a > , < a href = "Mouse.js.html#sunlight-1-line-106" > line 106< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "MIDDLE_BUTTON" > < span class = "type-signature" > < static, constant> < / span > MIDDLE_BUTTON< 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-02-05 06:29:17 +00:00
< a href = "Mouse.js.html" > input/Mouse.js< / a > , < a href = "Mouse.js.html#sunlight-1-line-112" > line 112< / a >
2013-11-07 06:10:15 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "NO_BUTTON" > < span class = "type-signature" > < static, constant> < / span > NO_BUTTON< 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-02-05 06:29:17 +00:00
< a href = "Mouse.js.html" > input/Mouse.js< / a > , < a href = "Mouse.js.html#sunlight-1-line-100" > line 100< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "RIGHT_BUTTON" > < span class = "type-signature" > < static, constant> < / span > RIGHT_BUTTON< 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-02-05 06:29:17 +00:00
< a href = "Mouse.js.html" > input/Mouse.js< / a > , < a href = "Mouse.js.html#sunlight-1-line-118" > line 118< / a >
2013-11-07 06:10:15 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "button" > < span class = "type-signature" > < / span > button< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > button-< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The type of click, either: Phaser.Mouse.NO_BUTTON, Phaser.Mouse.LEFT_BUTTON, Phaser.Mouse.MIDDLE_BUTTON or Phaser.Mouse.RIGHT_BUTTON.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Mouse.js.html" > input/Mouse.js< / a > , < a href = "Mouse.js.html#sunlight-1-line-50" > line 50< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "callbackContext" > < span class = "type-signature" > < / span > callbackContext< 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 > callbackContext< / code > < / td >
< td class = "type" >
< span class = "param-type" > Object< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The context under which callbacks are called.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Mouse.js.html" > input/Mouse.js< / a > , < a href = "Mouse.js.html#sunlight-1-line-24" > line 24< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2013-11-28 15:57:09 +00:00
< h4 class = "name" id = "capture" > < span class = "type-signature" > < / span > capture< span class = "type-signature" > < / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
2013-11-28 15:57:09 +00:00
< 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 > capture< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > < p > If true the DOM mouse events will have event.preventDefault applied to them, if false they will propogate fully.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Mouse.js.html" > input/Mouse.js< / a > , < a href = "Mouse.js.html#sunlight-1-line-44" > line 44< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "disabled" > < span class = "type-signature" > < / span > disabled< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
2013-10-02 14:05:55 +00:00
< 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 > disabled< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > You can disable all Input by setting disabled = true. While set all new input related events will be ignored.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > false< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-07 06:10:15 +00:00
< a href = "Mouse.js.html" > input/Mouse.js< / a > , < a href = "Mouse.js.html#sunlight-1-line-56" > line 56< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
2013-11-28 15:57:09 +00:00
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "event" > < span class = "type-signature" > < / span > event< 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 > event< / code > < / td >
< td class = "type" >
< span class = "param-type" > MouseEvent< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The browser mouse DOM event. Will be set to null if no mouse event has ever been received.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
2014-02-05 06:29:17 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > null< / li > < / ul > < / dd >
2013-11-28 15:57:09 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Mouse.js.html" > input/Mouse.js< / a > , < a href = "Mouse.js.html#sunlight-1-line-74" > line 74< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
2013-10-02 14:05:55 +00:00
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "game" > < span class = "type-signature" > < / span > game< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > game< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Game.html" > Phaser.Game< / a > < / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > A reference to the currently running game.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Mouse.js.html" > input/Mouse.js< / a > , < a href = "Mouse.js.html#sunlight-1-line-19" > line 19< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "locked" > < span class = "type-signature" > < / span > locked< 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 > locked< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > If the mouse has been Pointer Locked successfully this will be set to true.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > false< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Mouse.js.html" > input/Mouse.js< / a > , < a href = "Mouse.js.html#sunlight-1-line-62" > line 62< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "mouseDownCallback" > < span class = "type-signature" > < / span > mouseDownCallback< 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 > mouseDownCallback< / code > < / td >
< td class = "type" >
2013-11-07 06:10:15 +00:00
< span class = "param-type" > function< / span >
2013-10-02 14:05:55 +00:00
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > A callback that can be fired when the mouse is pressed down.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Mouse.js.html" > input/Mouse.js< / a > , < a href = "Mouse.js.html#sunlight-1-line-29" > line 29< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "mouseMoveCallback" > < span class = "type-signature" > < / span > mouseMoveCallback< 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 > mouseMoveCallback< / code > < / td >
< td class = "type" >
2013-11-07 06:10:15 +00:00
< span class = "param-type" > function< / span >
2013-10-02 14:05:55 +00:00
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > A callback that can be fired when the mouse is moved while pressed down.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Mouse.js.html" > input/Mouse.js< / a > , < a href = "Mouse.js.html#sunlight-1-line-34" > line 34< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "mouseUpCallback" > < span class = "type-signature" > < / span > mouseUpCallback< 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 > mouseUpCallback< / code > < / td >
< td class = "type" >
2013-11-07 06:10:15 +00:00
< span class = "param-type" > function< / span >
2013-10-02 14:05:55 +00:00
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > A callback that can be fired when the mouse is released from a pressed down state.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Mouse.js.html" > input/Mouse.js< / a > , < a href = "Mouse.js.html#sunlight-1-line-39" > line 39< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
2013-11-07 06:10:15 +00:00
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "pointerLock" > < span class = "type-signature" > < / span > pointerLock< 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 > pointerLock< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Signal.html" > Phaser.Signal< / a > < / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > This event is dispatched when the browser enters or leaves pointer lock state.< / p > < / td >
2013-11-07 06:10:15 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Mouse.js.html" > input/Mouse.js< / a > , < a href = "Mouse.js.html#sunlight-1-line-68" > line 68< / a >
2013-11-07 06:10:15 +00:00
< / li > < / ul > < / dd >
2013-10-02 14:05:55 +00:00
< / dl >
< / dd >
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
< dl >
< dt >
< h4 class = "name" id = "onMouseDown" > < span class = "type-signature" > < / span > onMouseDown< span class = "signature" > (event)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
2013-11-07 06:10:15 +00:00
< p > The internal method that handles the mouse down event from the browser.< / p >
2013-10-02 14:05:55 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > event< / code > < / td >
< td class = "type" >
< span class = "param-type" > MouseEvent< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The native event from the browser. This gets stored in Mouse.event.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Mouse.js.html" > input/Mouse.js< / a > , < a href = "Mouse.js.html#sunlight-1-line-160" > line 160< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "onMouseMove" > < span class = "type-signature" > < / span > onMouseMove< span class = "signature" > (event)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
2013-11-07 06:10:15 +00:00
< p > The internal method that handles the mouse move event from the browser.< / p >
2013-10-02 14:05:55 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > event< / code > < / td >
< td class = "type" >
< span class = "param-type" > MouseEvent< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The native event from the browser. This gets stored in Mouse.event.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Mouse.js.html" > input/Mouse.js< / a > , < a href = "Mouse.js.html#sunlight-1-line-192" > line 192< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "onMouseUp" > < span class = "type-signature" > < / span > onMouseUp< span class = "signature" > (event)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
2013-11-07 06:10:15 +00:00
< p > The internal method that handles the mouse up event from the browser.< / p >
2013-10-02 14:05:55 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > event< / code > < / td >
< td class = "type" >
< span class = "param-type" > MouseEvent< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The native event from the browser. This gets stored in Mouse.event.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Mouse.js.html" > input/Mouse.js< / a > , < a href = "Mouse.js.html#sunlight-1-line-222" > line 222< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "pointerLockChange" > < span class = "type-signature" > < / span > pointerLockChange< span class = "signature" > (event)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
2013-11-07 06:10:15 +00:00
< p > Internal pointerLockChange handler.< / p >
2013-10-02 14:05:55 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > event< / code > < / td >
< td class = "type" >
2013-11-28 15:57:09 +00:00
< span class = "param-type" > pointerlockchange< / span >
2013-10-02 14:05:55 +00:00
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The native event from the browser. This gets stored in Mouse.event.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Mouse.js.html" > input/Mouse.js< / a > , < a href = "Mouse.js.html#sunlight-1-line-283" > line 283< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "releasePointerLock" > < span class = "type-signature" > < / span > releasePointerLock< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
2013-11-07 06:10:15 +00:00
< p > Internal release pointer lock handler.< / p >
2013-10-02 14:05:55 +00:00
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Mouse.js.html" > input/Mouse.js< / a > , < a href = "Mouse.js.html#sunlight-1-line-307" > line 307< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "requestPointerLock" > < span class = "type-signature" > < / span > requestPointerLock< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
2013-11-07 06:10:15 +00:00
< p > If the browser supports it you can request that the pointer be locked to the browser window.
This is classically known as 'FPS controls', where the pointer can't leave the browser until the user presses an exit key.
If the browser successfully enters a locked state the event Phaser.Mouse.pointerLock will be dispatched and the first parameter will be 'true'.< / p >
2013-10-02 14:05:55 +00:00
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Mouse.js.html" > input/Mouse.js< / a > , < a href = "Mouse.js.html#sunlight-1-line-254" > line 254< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "start" > < span class = "type-signature" > < / span > start< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Starts the event listeners running.< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Mouse.js.html" > input/Mouse.js< / a > , < a href = "Mouse.js.html#sunlight-1-line-122" > line 122< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "stop" > < span class = "type-signature" > < / span > stop< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Stop the event listeners.< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Mouse.js.html" > input/Mouse.js< / a > , < a href = "Mouse.js.html#sunlight-1-line-323" > line 323< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / dl >
< / article >
< / section >
< / div >
< div class = "clearfix" > < / div >
< footer >
< span class = "copyright" >
2014-02-05 06:29:17 +00:00
Phaser Copyright © 2012-2014 Photon Storm Ltd.
2013-10-02 14:05:55 +00:00
< / span >
< br / >
< span class = "jsdoc-message" >
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-24 12:41:45 +00:00
on Mon Mar 24 2014 12:38:47 GMT-0000 (GMT) using the < a href = "https://github.com/terryweiss/docstrap" > DocStrap template< / a > .
2013-10-02 14:05:55 +00:00
< / span >
< / footer >
< / div >
< div class = "span3" >
< div id = "toc" > < / div >
< / div >
< br clear = "both" >
< / div >
< / div >
< script src = "scripts/sunlight.js" > < / script >
< script src = "scripts/sunlight.javascript.js" > < / script >
< script src = "scripts/sunlight-plugin.doclinks.js" > < / script >
< script src = "scripts/sunlight-plugin.linenumbers.js" > < / script >
< script src = "scripts/sunlight-plugin.menu.js" > < / script >
< script src = "scripts/jquery.min.js" > < / script >
< script src = "scripts/jquery.scrollTo.js" > < / script >
< script src = "scripts/jquery.localScroll.js" > < / script >
< script src = "scripts/bootstrap-dropdown.js" > < / script >
< script src = "scripts/toc.js" > < / script >
< script > Sunlight . highlightAll ( { lineNumbers : true , showMenu : true , enableDoclinks : true } ) ; < / script >
< script >
$( function () {
$( "#toc" ).toc( {
2014-03-14 06:36:05 +00:00
anchorName : function(i, heading, prefix) {
return $(heading).attr("id") || ( prefix + i );
},
2013-10-02 14:05:55 +00:00
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
< / script >
< / body >
< / html >
