phaser/docs/SinglePad.js.html

1124 lines
30 KiB
HTML
Raw Normal View History

2014-02-05 06:29:17 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Source: input/SinglePad.js</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<div class="navbar-inner">
<a class="brand" href="index.html">Phaser</a>
<ul class="nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
class="caret"></b></a>
<ul class="dropdown-menu ">
2014-04-10 22:13:43 +00:00
<li class="class-depth-0">
2014-02-05 06:29:17 +00:00
<a href="Phaser.html">Phaser</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Animation.html">Animation</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.AnimationManager.html">AnimationManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.AnimationParser.html">AnimationParser</a>
</li>
2014-04-29 14:39:02 +00:00
<li class="class-depth-1">
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Button.html">Button</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Cache.html">Cache</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Camera.html">Camera</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Canvas.html">Canvas</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Circle.html">Circle</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Color.html">Color</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Device.html">Device</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Easing.html">Easing</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Easing.Back.html">Back</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Easing.Bounce.html">Bounce</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Easing.Circular.html">Circular</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Easing.Cubic.html">Cubic</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Easing.Elastic.html">Elastic</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Easing.Exponential.html">Exponential</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Easing.Linear.html">Linear</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Easing.Quadratic.html">Quadratic</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Easing.Quartic.html">Quartic</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Easing.Quintic.html">Quintic</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Ellipse.html">Ellipse</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Events.html">Events</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Filter.html">Filter</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Frame.html">Frame</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.FrameData.html">FrameData</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Game.html">Game</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Gamepad.html">Gamepad</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.GamepadButton.html">GamepadButton</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Graphics.html">Graphics</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Group.html">Group</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Image.html">Image</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Input.html">Input</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.InputHandler.html">InputHandler</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Key.html">Key</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Keyboard.html">Keyboard</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Line.html">Line</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Loader.html">Loader</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.LoaderParser.html">LoaderParser</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Math.html">Math</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Mouse.html">Mouse</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.MSPointer.html">MSPointer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Net.html">Net</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Particle.html">Particle</a>
</li>
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Particles.html">Particles</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Physics.html">Physics</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Physics.Ninja.html">Ninja</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Physics.P2.html">P2</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Body.html">Body</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Material.html">Material</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Plugin.html">Plugin</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Point.html">Point</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Pointer.html">Pointer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Polygon.html">Polygon</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.QuadTree.html">QuadTree</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.RetroFont.html">RetroFont</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.ScaleManager.html">ScaleManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Signal.html">Signal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SignalBinding.html">SignalBinding</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Sound.html">Sound</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Sprite.html">Sprite</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Stage.html">Stage</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.State.html">State</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.StateManager.html">StateManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Text.html">Text</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Tile.html">Tile</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Tileset.html">Tileset</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Time.html">Time</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Timer.html">Timer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Touch.html">Touch</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Tween.html">Tween</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Utils.html">Utils</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.World.html">World</a>
</li>
</ul>
</li>
2014-07-18 11:45:51 +00:00
</strong>
2014-02-05 06:29:17 +00:00
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span12">
<div id="main">
<h1 class="page-title">Source: input/SinglePad.js</h1>
<section>
<article>
<pre class="sunlight-highlight-javascript linenums">/**
* @author @karlmacklin &lt;tacklemcclean@gmail.com>
2014-07-10 19:31:11 +00:00
* @author Richard Davey &lt;rich@photonstorm.com>
2014-02-05 06:29:17 +00:00
* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
* @class Phaser.SinglePad
* @classdesc A single Phaser Gamepad
* @constructor
* @param {Phaser.Game} game - Current game instance.
* @param {Object} padParent - The parent Phaser.Gamepad object (all gamepads reside under this)
*/
Phaser.SinglePad = function (game, padParent) {
/**
* @property {Phaser.Game} game - Local reference to game.
*/
this.game = game;
/**
2014-07-10 19:31:11 +00:00
* @property {number} index - The gamepad index as per browsers data
* @readonly
2014-02-05 06:29:17 +00:00
*/
2014-07-10 19:31:11 +00:00
this.index = null;
2014-02-05 06:29:17 +00:00
/**
2014-07-10 19:31:11 +00:00
* @property {boolean} connected - Whether or not this particular gamepad is connected or not.
* @readonly
2014-02-05 06:29:17 +00:00
*/
2014-07-10 19:31:11 +00:00
this.connected = false;
2014-02-05 06:29:17 +00:00
/**
2014-07-10 19:31:11 +00:00
* @property {Object} callbackContext - The context under which the callbacks are run.
2014-02-05 06:29:17 +00:00
*/
2014-07-10 19:31:11 +00:00
this.callbackContext = this;
2014-02-05 06:29:17 +00:00
/**
2014-07-10 19:31:11 +00:00
* @property {function} onConnectCallback - This callback is invoked every time this gamepad is connected
2014-02-05 06:29:17 +00:00
*/
2014-07-10 19:31:11 +00:00
this.onConnectCallback = null;
2014-02-05 06:29:17 +00:00
/**
2014-07-10 19:31:11 +00:00
* @property {function} onDisconnectCallback - This callback is invoked every time this gamepad is disconnected
2014-02-05 06:29:17 +00:00
*/
2014-07-10 19:31:11 +00:00
this.onDisconnectCallback = null;
2014-02-05 06:29:17 +00:00
/**
2014-07-10 19:31:11 +00:00
* @property {function} onDownCallback - This callback is invoked every time a button is pressed down.
2014-02-05 06:29:17 +00:00
*/
2014-07-10 19:31:11 +00:00
this.onDownCallback = null;
2014-02-05 06:29:17 +00:00
/**
2014-07-10 19:31:11 +00:00
* @property {function} onUpCallback - This callback is invoked every time a gamepad button is released.
2014-02-05 06:29:17 +00:00
*/
2014-07-10 19:31:11 +00:00
this.onUpCallback = null;
2014-02-05 06:29:17 +00:00
/**
2014-07-10 19:31:11 +00:00
* @property {function} onAxisCallback - This callback is invoked every time an axis is changed.
2014-02-05 06:29:17 +00:00
*/
2014-07-10 19:31:11 +00:00
this.onAxisCallback = null;
2014-02-05 06:29:17 +00:00
/**
2014-07-10 19:31:11 +00:00
* @property {function} onFloatCallback - This callback is invoked every time a button is changed to a value where value > 0 and value &lt; 1.
2014-02-05 06:29:17 +00:00
*/
2014-07-10 19:31:11 +00:00
this.onFloatCallback = null;
2014-02-05 06:29:17 +00:00
/**
2014-07-10 19:31:11 +00:00
* @property {number} deadZone - Dead zone for axis feedback - within this value you won't trigger updates.
2014-02-05 06:29:17 +00:00
*/
2014-07-10 19:31:11 +00:00
this.deadZone = 0.26;
2014-02-05 06:29:17 +00:00
/**
2014-07-10 19:31:11 +00:00
* @property {Phaser.Gamepad} padParent - Main Phaser Gamepad object
* @private
2014-02-05 06:29:17 +00:00
*/
2014-07-10 19:31:11 +00:00
this._padParent = padParent;
2014-02-05 06:29:17 +00:00
/**
2014-07-10 19:31:11 +00:00
* @property {Object} _rawPad - The 'raw' gamepad data.
* @private
2014-02-05 06:29:17 +00:00
*/
2014-07-10 19:31:11 +00:00
this._rawPad = null;
2014-02-05 06:29:17 +00:00
/**
2014-07-10 19:31:11 +00:00
* @property {number} _prevTimestamp - Used to check for differences between earlier polls and current state of gamepads.
* @private
2014-02-05 06:29:17 +00:00
*/
2014-07-10 19:31:11 +00:00
this._prevTimestamp = null;
2014-02-05 06:29:17 +00:00
/**
2014-07-10 19:31:11 +00:00
* @property {Array} _buttons - Array of Phaser.GamepadButton objects. This array is populated when the gamepad is connected.
* @private
2014-02-05 06:29:17 +00:00
*/
2014-07-10 19:31:11 +00:00
this._buttons = [];
2014-02-05 06:29:17 +00:00
/**
2014-07-10 19:31:11 +00:00
* @property {number} _buttonsLen - Length of the _buttons array.
* @private
2014-02-05 06:29:17 +00:00
*/
2014-07-10 19:31:11 +00:00
this._buttonsLen = 0;
2014-02-05 06:29:17 +00:00
/**
2014-07-10 19:31:11 +00:00
* @property {Array} _axes - Current axes state.
* @private
2014-02-05 06:29:17 +00:00
*/
2014-07-10 19:31:11 +00:00
this._axes = [];
2014-02-05 06:29:17 +00:00
/**
2014-07-10 19:31:11 +00:00
* @property {number} _axesLen - Length of the _axes array.
* @private
2014-02-05 06:29:17 +00:00
*/
2014-07-10 19:31:11 +00:00
this._axesLen = 0;
2014-02-05 06:29:17 +00:00
};
Phaser.SinglePad.prototype = {
/**
2014-07-10 19:31:11 +00:00
* Add callbacks to the this Gamepad to handle connect / disconnect / button down / button up / axis change / float value buttons.
*
* @method Phaser.SinglePad#addCallbacks
2014-02-05 06:29:17 +00:00
* @param {Object} context - The context under which the callbacks are run.
* @param {Object} callbacks - Object that takes six different callbak methods:
* onConnectCallback, onDisconnectCallback, onDownCallback, onUpCallback, onAxisCallback, onFloatCallback
*/
addCallbacks: function (context, callbacks) {
if (typeof callbacks !== 'undefined')
{
this.onConnectCallback = (typeof callbacks.onConnect === 'function') ? callbacks.onConnect : this.onConnectCallback;
this.onDisconnectCallback = (typeof callbacks.onDisconnect === 'function') ? callbacks.onDisconnect : this.onDisconnectCallback;
this.onDownCallback = (typeof callbacks.onDown === 'function') ? callbacks.onDown : this.onDownCallback;
this.onUpCallback = (typeof callbacks.onUp === 'function') ? callbacks.onUp : this.onUpCallback;
this.onAxisCallback = (typeof callbacks.onAxis === 'function') ? callbacks.onAxis : this.onAxisCallback;
this.onFloatCallback = (typeof callbacks.onFloat === 'function') ? callbacks.onFloat : this.onFloatCallback;
}
},
/**
2014-07-10 19:31:11 +00:00
* DEPRECATED: Please see SinglePad.getButton for the same functionality.
*
* If you need more fine-grained control over a gamepad button you can create a new Phaser.GamepadButton object via this method.
* The GamepadButton object can then be polled, have events attached to it, etc.
2014-02-05 06:29:17 +00:00
*
* @method Phaser.SinglePad#addButton
2014-07-10 19:31:11 +00:00
* @param {number} buttonCode - The buttonCode of the button, i.e. Phaser.Gamepad.BUTTON_0, Phaser.Gamepad.XBOX360_A, etc.
2014-02-05 06:29:17 +00:00
* @return {Phaser.GamepadButton} The GamepadButton object which you can store locally and reference directly.
*/
addButton: function (buttonCode) {
2014-07-10 19:31:11 +00:00
return this.getButton(buttonCode);
2014-02-05 06:29:17 +00:00
},
/**
2014-07-10 19:31:11 +00:00
* Gets a GamepadButton object from this controller to be stored and referenced locally.
* The GamepadButton object can then be polled, have events attached to it, etc.
*
* @method Phaser.SinglePad#getButton
* @param {number} buttonCode - The buttonCode of the button, i.e. Phaser.Gamepad.BUTTON_0, Phaser.Gamepad.XBOX360_A, etc.
* @return {Phaser.GamepadButton} The GamepadButton object which you can store locally and reference directly.
*/
getButton: function (buttonCode) {
if (this._buttons[buttonCode])
{
return this._buttons[buttonCode];
}
else
{
return null;
}
},
/**
* Main update function, should be called by Phaser.Gamepad.
*
2014-02-05 06:29:17 +00:00
* @method Phaser.SinglePad#pollStatus
*/
pollStatus: function () {
2014-07-10 19:31:11 +00:00
if (!this.connected || this.game.input.disabled || this.game.input.gamepad.disabled || (this._rawPad.timestamp && (this._rawPad.timestamp === this._prevTimestamp)))
2014-02-05 06:29:17 +00:00
{
return;
}
2014-07-10 19:31:11 +00:00
for (var i = 0; i &lt; this._buttonsLen; i++)
2014-02-05 06:29:17 +00:00
{
2014-07-10 19:31:11 +00:00
var rawButtonVal = isNaN(this._rawPad.buttons[i]) ? this._rawPad.buttons[i].value : this._rawPad.buttons[i];
2014-02-05 06:29:17 +00:00
2014-07-10 19:31:11 +00:00
if (rawButtonVal !== this._buttons[i].value)
2014-02-05 06:29:17 +00:00
{
2014-07-10 19:31:11 +00:00
if (rawButtonVal === 1)
2014-02-05 06:29:17 +00:00
{
2014-07-10 19:31:11 +00:00
this.processButtonDown(i, rawButtonVal);
2014-02-05 06:29:17 +00:00
}
2014-07-10 19:31:11 +00:00
else if (rawButtonVal === 0)
2014-02-05 06:29:17 +00:00
{
2014-07-10 19:31:11 +00:00
this.processButtonUp(i, rawButtonVal);
2014-02-05 06:29:17 +00:00
}
else
{
2014-07-10 19:31:11 +00:00
this.processButtonFloat(i, rawButtonVal);
2014-02-05 06:29:17 +00:00
}
}
}
2014-07-10 19:31:11 +00:00
for (var j = 0; j &lt; this._axesLen; j++)
2014-02-05 06:29:17 +00:00
{
2014-07-10 19:31:11 +00:00
var axis = this._rawPad.axes[j];
2014-02-05 06:29:17 +00:00
if (axis > 0 && axis > this.deadZone || axis &lt; 0 && axis &lt; -this.deadZone)
2014-02-05 06:29:17 +00:00
{
2014-07-10 19:31:11 +00:00
this.processAxisChange( { axis: j, value: axis } );
2014-02-05 06:29:17 +00:00
}
else
{
2014-07-10 19:31:11 +00:00
this.processAxisChange( { axis: j, value: 0 } );
2014-02-05 06:29:17 +00:00
}
}
this._prevTimestamp = this._rawPad.timestamp;
},
/**
2014-07-10 19:31:11 +00:00
* Gamepad connect function, should be called by Phaser.Gamepad.
*
2014-02-05 06:29:17 +00:00
* @method Phaser.SinglePad#connect
* @param {Object} rawPad - The raw gamepad object
2014-02-05 06:29:17 +00:00
*/
connect: function (rawPad) {
2014-07-10 19:31:11 +00:00
var triggerCallback = !this.connected;
this.connected = true;
this.index = rawPad.index;
2014-02-05 06:29:17 +00:00
this._rawPad = rawPad;
2014-07-10 19:31:11 +00:00
this._buttons = [];
this._buttonsLen = rawPad.buttons.length;
2014-02-05 06:29:17 +00:00
this._axes = rawPad.axes;
2014-07-10 19:31:11 +00:00
this._axesLen = rawPad.axes.length;
for (var buttonCode in rawPad.buttons)
{
buttonCode = parseInt(buttonCode, 10);
this._buttons[buttonCode] = new Phaser.GamepadButton(this, buttonCode);
}
2014-02-05 06:29:17 +00:00
if (triggerCallback && this._padParent.onConnectCallback)
2014-02-05 06:29:17 +00:00
{
2014-07-10 19:31:11 +00:00
this._padParent.onConnectCallback.call(this._padParent.callbackContext, this.index);
2014-02-05 06:29:17 +00:00
}
if (triggerCallback && this.onConnectCallback)
2014-02-05 06:29:17 +00:00
{
this.onConnectCallback.call(this.callbackContext);
}
},
/**
2014-07-10 19:31:11 +00:00
* Gamepad disconnect function, should be called by Phaser.Gamepad.
*
2014-02-05 06:29:17 +00:00
* @method Phaser.SinglePad#disconnect
*/
disconnect: function () {
2014-07-10 19:31:11 +00:00
var triggerCallback = this.connected;
var disconnectingIndex = this.index;
this.connected = false;
this.index = null;
2014-02-05 06:29:17 +00:00
this._rawPad = undefined;
2014-07-10 19:31:11 +00:00
for (var i = 0; i &lt; this._buttonsLen; i++)
{
this._buttons[i].destroy();
}
2014-02-05 06:29:17 +00:00
this._buttons = [];
2014-07-10 19:31:11 +00:00
this._buttonsLen = 0;
this._axes = [];
this._axesLen = 0;
2014-02-05 06:29:17 +00:00
if (triggerCallback && this._padParent.onDisconnectCallback)
2014-02-05 06:29:17 +00:00
{
this._padParent.onDisconnectCallback.call(this._padParent.callbackContext, disconnectingIndex);
}
if (triggerCallback && this.onDisconnectCallback)
2014-02-05 06:29:17 +00:00
{
this.onDisconnectCallback.call(this.callbackContext);
}
},
/**
2014-07-10 19:31:11 +00:00
* Handles changes in axis.
*
2014-02-05 06:29:17 +00:00
* @method Phaser.SinglePad#processAxisChange
* @param {Object} axisState - State of the relevant axis
2014-02-05 06:29:17 +00:00
*/
processAxisChange: function (axisState) {
if (this._axes[axisState.axis] === axisState.value)
{
return;
}
this._axes[axisState.axis] = axisState.value;
2014-02-05 06:29:17 +00:00
if (this._padParent.onAxisCallback)
{
2014-07-10 19:31:11 +00:00
this._padParent.onAxisCallback.call(this._padParent.callbackContext, axisState, this.index);
2014-02-05 06:29:17 +00:00
}
if (this.onAxisCallback)
{
this.onAxisCallback.call(this.callbackContext, axisState);
}
},
/**
2014-07-10 19:31:11 +00:00
* Handles button down press.
*
* @method Phaser.SinglePad#processButtonDown
2014-02-05 06:29:17 +00:00
* @param {number} buttonCode - Which buttonCode of this button
* @param {Object} value - Button value
*/
processButtonDown: function (buttonCode, value) {
if (this._padParent.onDownCallback)
{
2014-07-10 19:31:11 +00:00
this._padParent.onDownCallback.call(this._padParent.callbackContext, buttonCode, value, this.index);
2014-02-05 06:29:17 +00:00
}
if (this.onDownCallback)
{
this.onDownCallback.call(this.callbackContext, buttonCode, value);
}
2014-07-10 19:31:11 +00:00
if (this._buttons[buttonCode])
2014-02-05 06:29:17 +00:00
{
2014-07-10 19:31:11 +00:00
this._buttons[buttonCode].processButtonDown(value);
2014-02-05 06:29:17 +00:00
}
},
/**
2014-07-10 19:31:11 +00:00
* Handles button release.
*
* @method Phaser.SinglePad#processButtonUp
2014-02-05 06:29:17 +00:00
* @param {number} buttonCode - Which buttonCode of this button
* @param {Object} value - Button value
*/
processButtonUp: function (buttonCode, value) {
if (this._padParent.onUpCallback)
{
2014-07-10 19:31:11 +00:00
this._padParent.onUpCallback.call(this._padParent.callbackContext, buttonCode, value, this.index);
2014-02-05 06:29:17 +00:00
}
if (this.onUpCallback)
{
this.onUpCallback.call(this.callbackContext, buttonCode, value);
}
if (this._buttons[buttonCode])
{
2014-07-10 19:31:11 +00:00
this._buttons[buttonCode].processButtonUp(value);
2014-02-05 06:29:17 +00:00
}
},
/**
* Handles buttons with floating values (like analog buttons that acts almost like an axis but still registers like a button)
2014-07-10 19:31:11 +00:00
*
* @method Phaser.SinglePad#processButtonFloat
2014-02-05 06:29:17 +00:00
* @param {number} buttonCode - Which buttonCode of this button
* @param {Object} value - Button value (will range somewhere between 0 and 1, but not specifically 0 or 1.
*/
processButtonFloat: function (buttonCode, value) {
if (this._padParent.onFloatCallback)
{
2014-07-10 19:31:11 +00:00
this._padParent.onFloatCallback.call(this._padParent.callbackContext, buttonCode, value, this.index);
2014-02-05 06:29:17 +00:00
}
if (this.onFloatCallback)
{
this.onFloatCallback.call(this.callbackContext, buttonCode, value);
}
2014-07-10 19:31:11 +00:00
if (this._buttons[buttonCode])
2014-02-05 06:29:17 +00:00
{
2014-07-10 19:31:11 +00:00
this._buttons[buttonCode].processButtonFloat(value);
2014-02-05 06:29:17 +00:00
}
},
/**
2014-07-10 19:31:11 +00:00
* Returns value of requested axis.
*
* @method Phaser.SinglePad#axis
2014-02-05 06:29:17 +00:00
* @param {number} axisCode - The index of the axis to check
* @return {number} Axis value if available otherwise false
*/
axis: function (axisCode) {
if (this._axes[axisCode])
{
return this._axes[axisCode];
}
return false;
},
/**
2014-07-10 19:31:11 +00:00
* Returns true if the button is pressed down.
*
2014-02-05 06:29:17 +00:00
* @method Phaser.SinglePad#isDown
2014-07-10 19:31:11 +00:00
* @param {number} buttonCode - The buttonCode of the button to check.
* @return {boolean} True if the button is pressed down.
2014-02-05 06:29:17 +00:00
*/
isDown: function (buttonCode) {
if (this._buttons[buttonCode])
{
return this._buttons[buttonCode].isDown;
}
return false;
},
2014-07-10 19:31:11 +00:00
/**
* Returns true if the button is not currently pressed.
*
* @method Phaser.SinglePad#isUp
* @param {number} buttonCode - The buttonCode of the button to check.
* @return {boolean} True if the button is not currently pressed down.
*/
isUp: function (buttonCode) {
if (this._buttons[buttonCode])
{
return this._buttons[buttonCode].isUp;
}
return false;
},
2014-02-05 06:29:17 +00:00
/**
* Returns the "just released" state of a button from this gamepad. Just released is considered as being true if the button was released within the duration given (default 250ms).
2014-07-10 19:31:11 +00:00
*
* @method Phaser.SinglePad#justReleased
2014-02-05 06:29:17 +00:00
* @param {number} buttonCode - The buttonCode of the button to check for.
* @param {number} [duration=250] - The duration below which the button is considered as being just released.
* @return {boolean} True if the button is just released otherwise false.
*/
justReleased: function (buttonCode, duration) {
2014-07-10 19:31:11 +00:00
if (this._buttons[buttonCode])
{
return this._buttons[buttonCode].justReleased(duration);
}
2014-02-05 06:29:17 +00:00
},
/**
* Returns the "just pressed" state of a button from this gamepad. Just pressed is considered true if the button was pressed down within the duration given (default 250ms).
2014-07-10 19:31:11 +00:00
*
2014-02-05 06:29:17 +00:00
* @method Phaser.SinglePad#justPressed
* @param {number} buttonCode - The buttonCode of the button to check for.
* @param {number} [duration=250] - The duration below which the button is considered as being just pressed.
* @return {boolean} True if the button is just pressed otherwise false.
*/
justPressed: function (buttonCode, duration) {
2014-07-10 19:31:11 +00:00
if (this._buttons[buttonCode])
{
return this._buttons[buttonCode].justPressed(duration);
}
2014-02-05 06:29:17 +00:00
},
/**
* Returns the value of a gamepad button. Intended mainly for cases when you have floating button values, for example
2014-07-10 19:31:11 +00:00
* analog trigger buttons on the XBOX 360 controller.
*
2014-02-05 06:29:17 +00:00
* @method Phaser.SinglePad#buttonValue
* @param {number} buttonCode - The buttonCode of the button to check.
2014-07-10 19:31:11 +00:00
* @return {number} Button value if available otherwise null. Be careful as this can incorrectly evaluate to 0.
2014-02-05 06:29:17 +00:00
*/
buttonValue: function (buttonCode) {
if (this._buttons[buttonCode])
{
return this._buttons[buttonCode].value;
}
2014-07-10 19:31:11 +00:00
return null;
2014-02-05 06:29:17 +00:00
},
/**
2014-07-10 19:31:11 +00:00
* Reset all buttons/axes of this gamepad.
*
2014-02-05 06:29:17 +00:00
* @method Phaser.SinglePad#reset
*/
reset: function () {
for (var j = 0; j &lt; this._axes.length; j++)
{
this._axes[j] = 0;
}
}
};
Phaser.SinglePad.prototype.constructor = Phaser.SinglePad;
</pre>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Phaser Copyright © 2012-2014 Photon Storm Ltd.
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
2014-07-18 11:45:51 +00:00
on Fri Jul 18 2014 12:36:37 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
2014-02-05 06:29:17 +00:00
</span>
</footer>
</div>
<br clear="both">
</div>
</div>
<script src="scripts/sunlight.js"></script>
<script src="scripts/sunlight.javascript.js"></script>
<script src="scripts/sunlight-plugin.doclinks.js"></script>
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
<script src="scripts/sunlight-plugin.menu.js"></script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/jquery.scrollTo.js"></script>
<script src="scripts/jquery.localScroll.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
<script>
$( function () {
$( "#toc" ).toc( {
2014-04-10 22:13:43 +00:00
anchorName : function(i, heading, prefix) {
return $(heading).attr("id") || ( prefix + i );
},
2014-02-05 06:29:17 +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>