/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -466,7 +460,7 @@ Phaser.Animation = function (game, parent, name, frameData, frames, delay, loope
this.name = name;
/**
- * @property {object} _frames
+ * @property {array} _frames
* @private
*/
this._frames = [];
@@ -483,7 +477,8 @@ Phaser.Animation = function (game, parent, name, frameData, frames, delay, loope
this.looped = looped;
/**
- * @property {boolean} looped - The loop state of the Animation.
+ * @property {boolean} killOnComplete - Should the parent of this Animation be killed when the animation completes?
+ * @default
*/
this.killOnComplete = false;
@@ -750,6 +745,8 @@ Phaser.Animation.prototype = {
};
+Phaser.Animation.prototype.constructor = Phaser.Animation;
+
/**
* @name Phaser.Animation#paused
* @property {boolean} paused - Gets and sets the paused state of this Animation.
@@ -906,13 +903,13 @@ Phaser.Animation.generateFrameNames = function (prefix, start, stop, suffix, zer
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/AnimationManager.js.html b/docs/AnimationManager.js.html
index 48a1f83a..7361a183 100644
--- a/docs/AnimationManager.js.html
+++ b/docs/AnimationManager.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -734,6 +728,8 @@ Phaser.AnimationManager.prototype = {
};
+Phaser.AnimationManager.prototype.constructor = Phaser.AnimationManager;
+
/**
* @name Phaser.AnimationManager#frameData
* @property {Phaser.FrameData} frameData - The current animations FrameData.
@@ -863,13 +859,13 @@ Object.defineProperty(Phaser.AnimationManager.prototype, 'frameName', {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/AnimationParser.js.html b/docs/AnimationParser.js.html
index 7e14835d..63062ca5 100644
--- a/docs/AnimationParser.js.html
+++ b/docs/AnimationParser.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -443,9 +437,11 @@ Phaser.AnimationParser = {
* @param {number} frameWidth - The fixed width of each frame of the animation.
* @param {number} frameHeight - The fixed height of each frame of the animation.
* @param {number} [frameMax=-1] - The total number of animation frames to extact from the Sprite Sheet. The default value of -1 means "extract all frames".
+ * @param {number} [margin=0] - If the frames have been drawn with a margin, specify the amount here.
+ * @param {number} [spacing=0] - If the frames have been drawn with spacing between them, specify the amount here.
* @return {Phaser.FrameData} A FrameData object containing the parsed frames.
*/
- spriteSheet: function (game, key, frameWidth, frameHeight, frameMax) {
+ spriteSheet: function (game, key, frameWidth, frameHeight, frameMax, margin, spacing) {
// How big is our image?
var img = game.cache.getImage(key);
@@ -486,8 +482,8 @@ Phaser.AnimationParser = {
// Let's create some frames then
var data = new Phaser.FrameData();
- var x = 0;
- var y = 0;
+ var x = margin;
+ var y = margin;
for (var i = 0; i < total; i++)
{
@@ -502,12 +498,12 @@ Phaser.AnimationParser = {
height: frameHeight
});
- x += frameWidth;
+ x += frameWidth + spacing;
if (x === width)
{
- x = 0;
- y += frameHeight;
+ x = margin;
+ y += frameHeight + spacing;
}
}
@@ -761,13 +757,13 @@ Phaser.AnimationParser = {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/ArcadePhysics.js.html b/docs/ArcadePhysics.js.html
index 0dd1246e..f1d2775b 100644
--- a/docs/ArcadePhysics.js.html
+++ b/docs/ArcadePhysics.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -453,9 +447,34 @@ Phaser.Physics.Arcade = function (game) {
this.gravity = new Phaser.Point();
/**
- * @property {Phaser.Rectangle} bounds - The bounds inside of which the physics world exists. Defaults to match the world bounds.
+ * @property {SAT.Box} worldLeft - The left hand side of the physics bounds.
*/
- this.bounds = new Phaser.Rectangle(0, 0, game.world.width, game.world.height);
+ this.worldLeft = null;
+
+ /**
+ * @property {SAT.Box} worldRight - The right hand side of the physics bounds.
+ */
+ this.worldRight = null;
+
+ /**
+ * @property {SAT.Box} worldTop - The top side of the physics bounds.
+ */
+ this.worldTop = null;
+
+ /**
+ * @property {SAT.Box} worldBottom - The bottom of the physics bounds.
+ */
+ this.worldBottom = null;
+
+ /**
+ * @property {array<SAT.Polygon>} worldPolys - An array of the polygon data from the physics bounds.
+ */
+ this.worldPolys = [ null, null, null, null ];
+
+ /**
+ * @property {Phaser.QuadTree} quadTree - The world QuadTree.
+ */
+ this.quadTree = new Phaser.QuadTree(this.game.world.bounds.x, this.game.world.bounds.y, this.game.world.bounds.width, this.game.world.bounds.height, this.maxObjects, this.maxLevels);
/**
* @property {number} maxObjects - Used by the QuadTree to set the maximum number of objects per quad.
@@ -467,77 +486,6 @@ Phaser.Physics.Arcade = function (game) {
*/
this.maxLevels = 4;
- /**
- * @property {number} OVERLAP_BIAS - A value added to the delta values during collision checks.
- */
- this.OVERLAP_BIAS = 4;
-
- /**
- * @property {Phaser.QuadTree} quadTree - The world QuadTree.
- */
- this.quadTree = new Phaser.QuadTree(this, this.game.world.bounds.x, this.game.world.bounds.y, this.game.world.bounds.width, this.game.world.bounds.height, this.maxObjects, this.maxLevels);
-
- /**
- * @property {number} quadTreeID - The QuadTree ID.
- */
- this.quadTreeID = 0;
-
- // Avoid gc spikes by caching these values for re-use
-
- /**
- * @property {Phaser.Rectangle} _bounds1 - Internal cache var.
- * @private
- */
- this._bounds1 = new Phaser.Rectangle();
-
- /**
- * @property {Phaser.Rectangle} _bounds2 - Internal cache var.
- * @private
- */
- this._bounds2 = new Phaser.Rectangle();
-
- /**
- * @property {number} _overlap - Internal cache var.
- * @private
- */
- this._overlap = 0;
-
- /**
- * @property {number} _maxOverlap - Internal cache var.
- * @private
- */
- this._maxOverlap = 0;
-
- /**
- * @property {number} _velocity1 - Internal cache var.
- * @private
- */
- this._velocity1 = 0;
-
- /**
- * @property {number} _velocity2 - Internal cache var.
- * @private
- */
- this._velocity2 = 0;
-
- /**
- * @property {number} _newVelocity1 - Internal cache var.
- * @private
- */
- this._newVelocity1 = 0;
-
- /**
- * @property {number} _newVelocity2 - Internal cache var.
- * @private
- */
- this._newVelocity2 = 0;
-
- /**
- * @property {number} _average - Internal cache var.
- * @private
- */
- this._average = 0;
-
/**
* @property {Array} _mapData - Internal cache var.
* @private
@@ -568,6 +516,12 @@ Phaser.Physics.Arcade = function (game) {
*/
this._angle = 0;
+ /**
+ * @property {number} _drag - Internal cache var.
+ * @private
+ */
+ this._drag = 0;
+
/**
* @property {number} _dx - Internal cache var.
* @private
@@ -580,10 +534,212 @@ Phaser.Physics.Arcade = function (game) {
*/
this._dy = 0;
+ /**
+ * @property {Phaser.Point} _p - Internal cache var.
+ * @private
+ */
+ this._p = new Phaser.Point(0, 0);
+
+ /**
+ * @property {number} _intersection - Internal cache var.
+ * @private
+ */
+ this._intersection = [0,0,0,0];
+
+ /**
+ * @property {number} _gravityX - Internal cache var.
+ * @private
+ */
+ this._gravityX = 0;
+
+ /**
+ * @property {number} _gravityY - Internal cache var.
+ * @private
+ */
+ this._gravityY = 0;
+
+ /**
+ * @property {SAT.Response} _response - Internal cache var.
+ * @private
+ */
+ this._response = new SAT.Response();
+
+ // Set the bounds to the world as default
+ this.setBoundsToWorld(true, true, true, true);
+
};
+/**
+* @constant
+* @type {number}
+*/
+Phaser.Physics.Arcade.RECT = 0;
+
+/**
+* @constant
+* @type {number}
+*/
+Phaser.Physics.Arcade.CIRCLE = 1;
+
+/**
+* @constant
+* @type {number}
+*/
+Phaser.Physics.Arcade.POLYGON = 2;
+
Phaser.Physics.Arcade.prototype = {
+ /**
+ * Checks the given Physics.Body against the Physics Bounds, if any are set, and separates them, setting the blocked flags on the Body as it does so.
+ *
+ * @method Phaser.Physics.Arcade#checkBounds
+ * @param {Phaser.Physics.Arcade.Body} The Body object to be checked.
+ * @return {boolean} True if the body hit the bounds, otherwise false.
+ */
+ checkBounds: function (body) {
+
+ if (!body.collideWorldBounds || (!this.worldLeft && !this.worldRight && !this.worldTop && !this.worldBottom))
+ {
+ return false;
+ }
+
+ this._response.clear();
+
+ var test = SAT.testPolygonPolygon;
+ var part = body.polygon;
+ var rebounded = false;
+
+ if (body.type === Phaser.Physics.Arcade.CIRCLE)
+ {
+ test = SAT.testPolygonCircle;
+ part = body.shape;
+ }
+
+ if (this.worldLeft && test(this.worldPolys[0], part, this._response))
+ {
+ body.blocked.left = true;
+ part.pos.add(this._response.overlapV);
+ body.blocked.x = Math.floor(body.x);
+ body.blocked.y = Math.floor(body.y);
+ rebounded = true;
+ }
+ else if (this.worldRight && test(this.worldPolys[1], part, this._response))
+ {
+ body.blocked.right = true;
+ part.pos.add(this._response.overlapV);
+ body.blocked.x = Math.floor(body.x);
+ body.blocked.y = Math.floor(body.y);
+ rebounded = true;
+ }
+
+ this._response.clear();
+
+ if (this.worldTop && test(this.worldPolys[2], part, this._response))
+ {
+ body.blocked.up = true;
+ part.pos.add(this._response.overlapV);
+ body.blocked.x = Math.floor(body.x);
+ body.blocked.y = Math.floor(body.y);
+ rebounded = true;
+ }
+ else if (this.worldBottom && test(this.worldPolys[3], part, this._response))
+ {
+ body.blocked.down = true;
+ part.pos.add(this._response.overlapV);
+ body.blocked.x = Math.floor(body.x);
+ body.blocked.y = Math.floor(body.y);
+ rebounded = true;
+ }
+
+ return rebounded;
+
+ },
+
+ /**
+ * Sets the bounds of the Physics world to match the Game.World.
+ * You can optionally set which 'walls' to create: left, right, top or bottom.
+ *
+ * @method Phaser.Physics.Arcade#setBoundsToWorld
+ * @param {boolean} [left=true] - If true will create the left bounds wall.
+ * @param {boolean} [right=true] - If true will create the right bounds wall.
+ * @param {boolean} [top=true] - If true will create the top bounds wall.
+ * @param {boolean} [bottom=true] - If true will create the bottom bounds wall.
+ */
+ setBoundsToWorld: function (left, right, top, bottom) {
+
+ this.setBounds(this.game.world.bounds.x, this.game.world.bounds.y, this.game.world.bounds.width, this.game.world.bounds.height, left, right, top, bottom);
+
+ },
+
+ /**
+ * Sets the bounds of the Physics world to match the given world pixel dimensions.
+ * You can optionally set which 'walls' to create: left, right, top or bottom.
+ *
+ * @method Phaser.Physics.Arcade#setBounds
+ * @param {number} x - The x coordinate of the top-left corner of the bounds.
+ * @param {number} y - The y coordinate of the top-left corner of the bounds.
+ * @param {number} width - The width of the bounds.
+ * @param {number} height - The height of the bounds.
+ * @param {boolean} [left=true] - If true will create the left bounds wall.
+ * @param {boolean} [right=true] - If true will create the right bounds wall.
+ * @param {boolean} [top=true] - If true will create the top bounds wall.
+ * @param {boolean} [bottom=true] - If true will create the bottom bounds wall.
+ */
+ setBounds: function (x, y, width, height, left, right, top, bottom) {
+
+ if (typeof left === 'undefined') { left = true; }
+ if (typeof right === 'undefined') { right = true; }
+ if (typeof top === 'undefined') { top = true; }
+ if (typeof bottom === 'undefined') { bottom = true; }
+
+ var thickness = 100;
+
+ if (left)
+ {
+ this.worldLeft = new SAT.Box(new SAT.Vector(x - thickness, y), thickness, height);
+ this.worldPolys[0] = this.worldLeft.toPolygon();
+ }
+ else
+ {
+ this.worldLeft = null;
+ this.worldPolys[0] = null;
+ }
+
+ if (right)
+ {
+ this.worldRight = new SAT.Box(new SAT.Vector(x + width, y), thickness, height);
+ this.worldPolys[1] = this.worldRight.toPolygon();
+ }
+ else
+ {
+ this.worldRight = null;
+ this.worldPolys[1] = null;
+ }
+
+ if (top)
+ {
+ this.worldTop = new SAT.Box(new SAT.Vector(x, y - thickness), width, thickness);
+ this.worldPolys[2] = this.worldTop.toPolygon();
+ }
+ else
+ {
+ this.worldTop = null;
+ this.worldPolys[2] = null;
+ }
+
+ if (bottom)
+ {
+ this.worldBottom = new SAT.Box(new SAT.Vector(x, y + height), width, thickness);
+ this.worldPolys[3] = this.worldBottom.toPolygon();
+ }
+ else
+ {
+ this.worldBottom = null;
+ this.worldPolys[3] = null;
+ }
+
+ },
+
/**
* Called automatically by a Physics body, it updates all motion related values on the Body.
*
@@ -594,113 +750,68 @@ Phaser.Physics.Arcade.prototype = {
// If you're wondering why the velocity is halved and applied twice, read this: http://www.niksula.hut.fi/~hkankaan/Homepages/gravity.html
+ // World gravity is allowed
+ if (body.allowGravity)
+ {
+ this._gravityX = this.gravity.x + body.gravity.x;
+ this._gravityY = this.gravity.y + body.gravity.y;
+ }
+ else
+ {
+ this._gravityX = body.gravity.x;
+ this._gravityY = body.gravity.y;
+ }
+
+ // Don't apply gravity to any body that is blocked
+ if ((this._gravityX < 0 && body.blocked.left) || (this._gravityX > 0 && body.blocked.right))
+ {
+ this._gravityX = 0;
+ }
+
+ if ((this._gravityY < 0 && body.blocked.up) || (this._gravityY > 0 && body.blocked.down))
+ {
+ this._gravityY = 0;
+ }
+
// Rotation
- this._velocityDelta = (this.computeVelocity(0, body, body.angularVelocity, body.angularAcceleration, body.angularDrag, body.maxAngular) - body.angularVelocity) * this.game.time.physicsElapsed * 0.5 * 60;
- body.angularVelocity += this._velocityDelta;
- body.rotation += (body.angularVelocity * this.game.time.physicsElapsed);
- body.angularVelocity += this._velocityDelta;
-
- // Horizontal
- this._velocityDelta = (this.computeVelocity(1, body, body.velocity.x, body.acceleration.x, body.drag.x, body.maxVelocity.x) - body.velocity.x) * this.game.time.physicsElapsed * 0.5 * 60;
- body.velocity.x += this._velocityDelta;
- body.x += (body.velocity.x * this.game.time.physicsElapsed);
- body.velocity.x += this._velocityDelta;
-
- // Vertical
- this._velocityDelta = (this.computeVelocity(2, body, body.velocity.y, body.acceleration.y, body.drag.y, body.maxVelocity.y) - body.velocity.y) * this.game.time.physicsElapsed * 0.5 * 60;
- body.velocity.y += this._velocityDelta;
- body.y += (body.velocity.y * this.game.time.physicsElapsed);
- body.velocity.y += this._velocityDelta;
-
- },
-
- /**
- * A tween-like function that takes a starting velocity and some other factors and returns an altered velocity.
- *
- * @method Phaser.Physics.Arcade#computeVelocity
- * @param {number} axis - 1 for horizontal, 2 for vertical.
- * @param {Phaser.Physics.Arcade.Body} body - The Body object to be updated.
- * @param {number} velocity - Any component of velocity (e.g. 20).
- * @param {number} acceleration - Rate at which the velocity is changing.
- * @param {number} drag - Really kind of a deceleration, this is how much the velocity changes if Acceleration is not set.
- * @param {number} mMax - An absolute value cap for the velocity.
- * @return {number} The altered Velocity value.
- */
- computeVelocity: function (axis, body, velocity, acceleration, drag, max) {
-
- max = max || 10000;
-
- if (axis == 1 && body.allowGravity)
+ if (body.allowRotation)
{
- velocity += this.gravity.x + body.gravity.x;
- }
- else if (axis == 2 && body.allowGravity)
- {
- velocity += this.gravity.y + body.gravity.y;
- }
+ this._velocityDelta = body.angularAcceleration * this.game.time.physicsElapsed;
- if (acceleration !== 0)
- {
- velocity += acceleration * this.game.time.physicsElapsed;
- }
- else if (drag !== 0)
- {
- this._drag = drag * this.game.time.physicsElapsed;
-
- if (velocity - this._drag > 0)
+ if (body.angularDrag !== 0 && body.angularAcceleration === 0)
{
- velocity -= this._drag;
+ this._drag = body.angularDrag * this.game.time.physicsElapsed;
+
+ if (body.angularVelocity > 0)
+ {
+ body.angularVelocity -= this._drag;
+ }
+ else if (body.angularVelocity < 0)
+ {
+ body.angularVelocity += this._drag;
+ }
}
- else if (velocity + this._drag < 0)
+
+ body.rotation += this.game.time.physicsElapsed * (body.angularVelocity + this._velocityDelta / 2);
+ body.angularVelocity += this._velocityDelta;
+
+ if (body.angularVelocity > body.maxAngular)
{
- velocity += this._drag;
+ body.angularVelocity = body.maxAngular;
}
- else
+ else if (body.angularVelocity < -body.maxAngular)
{
- velocity = 0;
+ body.angularVelocity = -body.maxAngular;
}
}
- if (velocity > max)
- {
- velocity = max;
- }
- else if (velocity < -max)
- {
- velocity = -max;
- }
+ // temp = acc*dt
+ // pos = pos + dt*(vel + temp/2)
+ // vel = vel + temp
- return velocity;
+ this._p.setTo((body.acceleration.x + this._gravityX) * this.game.time.physicsElapsed, (body.acceleration.y + this._gravityY) * this.game.time.physicsElapsed);
- },
-
- /**
- * Called automatically by the core game loop.
- *
- * @method Phaser.Physics.Arcade#preUpdate
- * @protected
- */
- preUpdate: function () {
-
- // Clear the tree
- this.quadTree.clear();
-
- // Create our tree which all of the Physics bodies will add themselves to
- this.quadTreeID = 0;
- this.quadTree = new Phaser.QuadTree(this, this.game.world.bounds.x, this.game.world.bounds.y, this.game.world.bounds.width, this.game.world.bounds.height, this.maxObjects, this.maxLevels);
-
- },
-
- /**
- * Called automatically by the core game loop.
- *
- * @method Phaser.Physics.Arcade#postUpdate
- * @protected
- */
- postUpdate: function () {
-
- // Clear the tree ready for the next update
- this.quadTree.clear();
+ return this._p;
},
@@ -708,10 +819,11 @@ Phaser.Physics.Arcade.prototype = {
* Checks for overlaps between two game objects. The objects can be Sprites, Groups or Emitters.
* You can perform Sprite vs. Sprite, Sprite vs. Group and Group vs. Group overlap checks.
* Unlike collide the objects are NOT automatically separated or have any physics applied, they merely test for overlap results.
+ * The second parameter can be an array of objects, of differing types.
*
* @method Phaser.Physics.Arcade#overlap
* @param {Phaser.Sprite|Phaser.Group|Phaser.Particles.Emitter} object1 - The first object to check. Can be an instance of Phaser.Sprite, Phaser.Group or Phaser.Particles.Emitter.
- * @param {Phaser.Sprite|Phaser.Group|Phaser.Particles.Emitter} object2 - The second object to check. Can be an instance of Phaser.Sprite, Phaser.Group or Phaser.Particles.Emitter.
+ * @param {Phaser.Sprite|Phaser.Group|Phaser.Particles.Emitter|array} object2 - The second object or array of objects to check. Can be Phaser.Sprite, Phaser.Group or Phaser.Particles.Emitter.
* @param {function} [overlapCallback=null] - An optional callback function that is called if the objects overlap. The two objects will be passed to this function in the same order in which you specified them.
* @param {function} [processCallback=null] - A callback function that lets you perform additional checks against the two objects if they overlap. If this is set then overlapCallback will only be called if processCallback returns true.
* @param {object} [callbackContext] - The context in which to run the callbacks.
@@ -726,83 +838,144 @@ Phaser.Physics.Arcade.prototype = {
this._result = false;
this._total = 0;
- // Only test valid objects
- if (object1 && object2 && object1.exists && object2.exists)
+ if (Array.isArray(object2))
{
- // SPRITES
- if (object1.type == Phaser.SPRITE)
+ for (var i = 0, len = object2.length; i < len; i++)
{
- if (object2.type == Phaser.SPRITE)
- {
- this.overlapSpriteVsSprite(object1, object2, overlapCallback, processCallback, callbackContext);
- }
- else if (object2.type == Phaser.GROUP || object2.type == Phaser.EMITTER)
- {
- this.overlapSpriteVsGroup(object1, object2, overlapCallback, processCallback, callbackContext);
- }
- }
- // GROUPS
- else if (object1.type == Phaser.GROUP)
- {
- if (object2.type == Phaser.SPRITE)
- {
- this.overlapSpriteVsGroup(object2, object1, overlapCallback, processCallback, callbackContext);
- }
- else if (object2.type == Phaser.GROUP || object2.type == Phaser.EMITTER)
- {
- this.overlapGroupVsGroup(object1, object2, overlapCallback, processCallback, callbackContext);
- }
- }
- // EMITTER
- else if (object1.type == Phaser.EMITTER)
- {
- if (object2.type == Phaser.SPRITE)
- {
- this.overlapSpriteVsGroup(object2, object1, overlapCallback, processCallback, callbackContext);
- }
- else if (object2.type == Phaser.GROUP || object2.type == Phaser.EMITTER)
- {
- this.overlapGroupVsGroup(object1, object2, overlapCallback, processCallback, callbackContext);
- }
+ this.collideHandler(object1, object2[i], overlapCallback, processCallback, callbackContext, true);
}
}
+ else
+ {
+ this.collideHandler(object1, object2, overlapCallback, processCallback, callbackContext, true);
+ }
return (this._total > 0);
},
/**
- * An internal function. Use Phaser.Physics.Arcade.overlap instead.
+ * Checks for collision between two game objects. You can perform Sprite vs. Sprite, Sprite vs. Group, Group vs. Group, Sprite vs. Tilemap Layer or Group vs. Tilemap Layer collisions.
+ * The second parameter can be an array of objects, of differing types.
+ * The objects are also automatically separated. If you don't require separation then use ArcadePhysics.overlap instead.
+ * An optional processCallback can be provided. If given this function will be called when two sprites are found to be colliding. It is called before any separation takes place,
+ * giving you the chance to perform additional checks. If the function returns true then the collision and separation is carried out. If it returns false it is skipped.
+ * The collideCallback is an optional function that is only called if two sprites collide. If a processCallback has been set then it needs to return true for collideCallback to be called.
*
- * @method Phaser.Physics.Arcade#overlapSpriteVsSprite
- * @private
+ * @method Phaser.Physics.Arcade#collide
+ * @param {Phaser.Sprite|Phaser.Group|Phaser.Particles.Emitter|Phaser.Tilemap} object1 - The first object to check. Can be an instance of Phaser.Sprite, Phaser.Group, Phaser.Particles.Emitter, or Phaser.Tilemap.
+ * @param {Phaser.Sprite|Phaser.Group|Phaser.Particles.Emitter|Phaser.Tilemap|array} object2 - The second object or array of objects to check. Can be Phaser.Sprite, Phaser.Group, Phaser.Particles.Emitter or Phaser.Tilemap.
+ * @param {function} [collideCallback=null] - An optional callback function that is called if the objects collide. The two objects will be passed to this function in the same order in which you specified them.
+ * @param {function} [processCallback=null] - A callback function that lets you perform additional checks against the two objects if they overlap. If this is set then collision will only happen if processCallback returns true. The two objects will be passed to this function in the same order in which you specified them.
+ * @param {object} [callbackContext] - The context in which to run the callbacks.
+ * @returns {boolean} True if a collision occured otherwise false.
*/
- overlapSpriteVsSprite: function (sprite1, sprite2, overlapCallback, processCallback, callbackContext) {
+ collide: function (object1, object2, collideCallback, processCallback, callbackContext) {
- this._result = Phaser.Rectangle.intersects(sprite1.body, sprite2.body);
+ collideCallback = collideCallback || null;
+ processCallback = processCallback || null;
+ callbackContext = callbackContext || collideCallback;
- if (this._result)
+ this._result = false;
+ this._total = 0;
+
+ if (Array.isArray(object2))
{
- // They collided, is there a custom process callback?
- if (processCallback)
+ for (var i = 0, len = object2.length; i < len; i++)
{
- if (processCallback.call(callbackContext, sprite1, sprite2))
- {
- this._total++;
+ this.collideHandler(object1, object2[i], collideCallback, processCallback, callbackContext, false);
+ }
+ }
+ else
+ {
+ this.collideHandler(object1, object2, collideCallback, processCallback, callbackContext, false);
+ }
- if (overlapCallback)
- {
- overlapCallback.call(callbackContext, sprite1, sprite2);
- }
+ return (this._total > 0);
+
+ },
+
+ /**
+ * Internal collision handler.
+ *
+ * @method Phaser.Physics.Arcade#collideHandler
+ * @private
+ * @param {Phaser.Sprite|Phaser.Group|Phaser.Particles.Emitter|Phaser.Tilemap} object1 - The first object to check. Can be an instance of Phaser.Sprite, Phaser.Group, Phaser.Particles.Emitter, or Phaser.Tilemap.
+ * @param {Phaser.Sprite|Phaser.Group|Phaser.Particles.Emitter|Phaser.Tilemap} object2 - The second object to check. Can be an instance of Phaser.Sprite, Phaser.Group, Phaser.Particles.Emitter or Phaser.Tilemap. Can also be an array of objects to check.
+ * @param {function} collideCallback - An optional callback function that is called if the objects collide. The two objects will be passed to this function in the same order in which you specified them.
+ * @param {function} processCallback - A callback function that lets you perform additional checks against the two objects if they overlap. If this is set then collision will only happen if processCallback returns true. The two objects will be passed to this function in the same order in which you specified them.
+ * @param {object} callbackContext - The context in which to run the callbacks.
+ * @param {boolean} overlapOnly - Just run an overlap or a full collision.
+ */
+ collideHandler: function (object1, object2, collideCallback, processCallback, callbackContext, overlapOnly) {
+
+ // Only collide valid objects
+ if (typeof object2 === 'undefined' && (object1.type === Phaser.GROUP || object1.type === Phaser.EMITTER))
+ {
+ this.collideGroupVsSelf(object1, collideCallback, processCallback, callbackContext, overlapOnly);
+ return;
+ }
+
+ if (object1 && object2 && object1.exists && object2.exists)
+ {
+ // SPRITES
+ if (object1.type == Phaser.SPRITE || object1.type == Phaser.TILESPRITE)
+ {
+ if (object2.type == Phaser.SPRITE || object2.type == Phaser.TILESPRITE)
+ {
+ this.collideSpriteVsSprite(object1, object2, collideCallback, processCallback, callbackContext, overlapOnly);
+ }
+ else if (object2.type == Phaser.GROUP || object2.type == Phaser.EMITTER)
+ {
+ this.collideSpriteVsGroup(object1, object2, collideCallback, processCallback, callbackContext, overlapOnly);
+ }
+ else if (object2.type == Phaser.TILEMAPLAYER)
+ {
+ this.collideSpriteVsTilemapLayer(object1, object2, collideCallback, processCallback, callbackContext);
}
}
- else
+ // GROUPS
+ else if (object1.type == Phaser.GROUP)
{
- this._total++;
-
- if (overlapCallback)
+ if (object2.type == Phaser.SPRITE || object2.type == Phaser.TILESPRITE)
{
- overlapCallback.call(callbackContext, sprite1, sprite2);
+ this.collideSpriteVsGroup(object2, object1, collideCallback, processCallback, callbackContext, overlapOnly);
+ }
+ else if (object2.type == Phaser.GROUP || object2.type == Phaser.EMITTER)
+ {
+ this.collideGroupVsGroup(object1, object2, collideCallback, processCallback, callbackContext, overlapOnly);
+ }
+ else if (object2.type == Phaser.TILEMAPLAYER)
+ {
+ this.collideGroupVsTilemapLayer(object1, object2, collideCallback, processCallback, callbackContext);
+ }
+ }
+ // TILEMAP LAYERS
+ else if (object1.type == Phaser.TILEMAPLAYER)
+ {
+ if (object2.type == Phaser.SPRITE || object2.type == Phaser.TILESPRITE)
+ {
+ this.collideSpriteVsTilemapLayer(object2, object1, collideCallback, processCallback, callbackContext);
+ }
+ else if (object2.type == Phaser.GROUP || object2.type == Phaser.EMITTER)
+ {
+ this.collideGroupVsTilemapLayer(object2, object1, collideCallback, processCallback, callbackContext);
+ }
+ }
+ // EMITTER
+ else if (object1.type == Phaser.EMITTER)
+ {
+ if (object2.type == Phaser.SPRITE || object2.type == Phaser.TILESPRITE)
+ {
+ this.collideSpriteVsGroup(object2, object1, collideCallback, processCallback, callbackContext, overlapOnly);
+ }
+ else if (object2.type == Phaser.GROUP || object2.type == Phaser.EMITTER)
+ {
+ this.collideGroupVsGroup(object1, object2, collideCallback, processCallback, callbackContext, overlapOnly);
+ }
+ else if (object2.type == Phaser.TILEMAPLAYER)
+ {
+ this.collideGroupVsTilemapLayer(object1, object2, collideCallback, processCallback, callbackContext);
}
}
}
@@ -810,12 +983,32 @@ Phaser.Physics.Arcade.prototype = {
},
/**
- * An internal function. Use Phaser.Physics.Arcade.overlap instead.
+ * An internal function. Use Phaser.Physics.Arcade.collide instead.
*
- * @method Phaser.Physics.Arcade#overlapSpriteVsGroup
+ * @method Phaser.Physics.Arcade#collideSpriteVsSprite
* @private
*/
- overlapSpriteVsGroup: function (sprite, group, overlapCallback, processCallback, callbackContext) {
+ collideSpriteVsSprite: function (sprite1, sprite2, collideCallback, processCallback, callbackContext, overlapOnly) {
+
+ if (this.separate(sprite1.body, sprite2.body, processCallback, callbackContext, overlapOnly))
+ {
+ if (collideCallback)
+ {
+ collideCallback.call(callbackContext, sprite1, sprite2);
+ }
+
+ this._total++;
+ }
+
+ },
+
+ /**
+ * An internal function. Use Phaser.Physics.Arcade.collide instead.
+ *
+ * @method Phaser.Physics.Arcade#collideSpriteVsGroup
+ * @private
+ */
+ collideSpriteVsGroup: function (sprite, group, collideCallback, processCallback, callbackContext, overlapOnly) {
if (group.length === 0)
{
@@ -823,28 +1016,52 @@ Phaser.Physics.Arcade.prototype = {
}
// What is the sprite colliding with in the quadtree?
+ this.quadTree.clear();
+
+ this.quadTree = new Phaser.QuadTree(this.game.world.bounds.x, this.game.world.bounds.y, this.game.world.bounds.width, this.game.world.bounds.height, this.maxObjects, this.maxLevels);
+
+ this.quadTree.populate(group);
+
this._potentials = this.quadTree.retrieve(sprite);
for (var i = 0, len = this._potentials.length; i < len; i++)
{
// We have our potential suspects, are they in this group?
- if (this._potentials[i].sprite.group == group)
+ if (this.separate(sprite.body, this._potentials[i], processCallback, callbackContext, overlapOnly))
{
- this._result = Phaser.Rectangle.intersects(sprite.body, this._potentials[i]);
-
- if (this._result && processCallback)
+ if (collideCallback)
{
- this._result = processCallback.call(callbackContext, sprite, this._potentials[i].sprite);
+ collideCallback.call(callbackContext, sprite, this._potentials[i].sprite);
}
- if (this._result)
- {
- this._total++;
+ this._total++;
+ }
+ }
- if (overlapCallback)
- {
- overlapCallback.call(callbackContext, sprite, this._potentials[i].sprite);
- }
+ },
+
+ /**
+ * An internal function. Use Phaser.Physics.Arcade.collide instead.
+ *
+ * @method Phaser.Physics.Arcade#collideGroupVsSelf
+ * @private
+ */
+ collideGroupVsSelf: function (group, collideCallback, processCallback, callbackContext, overlapOnly) {
+
+ if (group.length === 0)
+ {
+ return;
+ }
+
+ var len = group._container.children.length;
+
+ for (var i = 0; i < len; i++)
+ {
+ for (var j = i + 1; j <= len; j++)
+ {
+ if (group._container.children[i] && group._container.children[j] && group._container.children[i].exists && group._container.children[j].exists)
+ {
+ this.collideSpriteVsSprite(group._container.children[i], group._container.children[j], collideCallback, processCallback, callbackContext, overlapOnly);
}
}
}
@@ -852,12 +1069,12 @@ Phaser.Physics.Arcade.prototype = {
},
/**
- * An internal function. Use Phaser.Physics.Arcade.overlap instead.
+ * An internal function. Use Phaser.Physics.Arcade.collide instead.
*
- * @method Phaser.Physics.Arcade#overlapGroupVsGroup
+ * @method Phaser.Physics.Arcade#collideGroupVsGroup
* @private
*/
- overlapGroupVsGroup: function (group1, group2, overlapCallback, processCallback, callbackContext) {
+ collideGroupVsGroup: function (group1, group2, collideCallback, processCallback, callbackContext, overlapOnly) {
if (group1.length === 0 || group2.length === 0)
{
@@ -872,7 +1089,7 @@ Phaser.Physics.Arcade.prototype = {
{
if (currentNode.exists)
{
- this.overlapSpriteVsGroup(currentNode, group2, overlapCallback, processCallback, callbackContext);
+ this.collideSpriteVsGroup(currentNode, group2, collideCallback, processCallback, callbackContext, overlapOnly);
}
currentNode = currentNode._iNext;
}
@@ -881,99 +1098,6 @@ Phaser.Physics.Arcade.prototype = {
},
- /**
- * Checks for collision between two game objects. The objects can be Sprites, Groups, Emitters or Tilemap Layers.
- * You can perform Sprite vs. Sprite, Sprite vs. Group, Group vs. Group, Sprite vs. Tilemap Layer or Group vs. Tilemap Layer collisions.
- * The objects are also automatically separated.
- *
- * @method Phaser.Physics.Arcade#collide
- * @param {Phaser.Sprite|Phaser.Group|Phaser.Particles.Emitter|Phaser.Tilemap} object1 - The first object to check. Can be an instance of Phaser.Sprite, Phaser.Group, Phaser.Particles.Emitter, or Phaser.Tilemap
- * @param {Phaser.Sprite|Phaser.Group|Phaser.Particles.Emitter|Phaser.Tilemap} object2 - The second object to check. Can be an instance of Phaser.Sprite, Phaser.Group, Phaser.Particles.Emitter or Phaser.Tilemap
- * @param {function} [collideCallback=null] - An optional callback function that is called if the objects overlap. The two objects will be passed to this function in the same order in which you specified them.
- * @param {function} [processCallback=null] - A callback function that lets you perform additional checks against the two objects if they overlap. If this is set then collideCallback will only be called if processCallback returns true.
- * @param {object} [callbackContext] - The context in which to run the callbacks.
- * @returns {boolean} True if a collision occured otherwise false.
- */
- collide: function (object1, object2, collideCallback, processCallback, callbackContext) {
-
- collideCallback = collideCallback || null;
- processCallback = processCallback || null;
- callbackContext = callbackContext || collideCallback;
-
- this._result = false;
- this._total = 0;
-
- // Only collide valid objects
- if (object1 && object2 && object1.exists && object2.exists)
- {
- // Can expand to support Buttons, Text, etc at a later date. For now these are the essentials.
-
- // SPRITES
- if (object1.type == Phaser.SPRITE)
- {
- if (object2.type == Phaser.SPRITE)
- {
- this.collideSpriteVsSprite(object1, object2, collideCallback, processCallback, callbackContext);
- }
- else if (object2.type == Phaser.GROUP || object2.type == Phaser.EMITTER)
- {
- this.collideSpriteVsGroup(object1, object2, collideCallback, processCallback, callbackContext);
- }
- else if (object2.type == Phaser.TILEMAPLAYER)
- {
- this.collideSpriteVsTilemapLayer(object1, object2, collideCallback, processCallback, callbackContext);
- }
- }
- // GROUPS
- else if (object1.type == Phaser.GROUP)
- {
- if (object2.type == Phaser.SPRITE)
- {
- this.collideSpriteVsGroup(object2, object1, collideCallback, processCallback, callbackContext);
- }
- else if (object2.type == Phaser.GROUP || object2.type == Phaser.EMITTER)
- {
- this.collideGroupVsGroup(object1, object2, collideCallback, processCallback, callbackContext);
- }
- else if (object2.type == Phaser.TILEMAPLAYER)
- {
- this.collideGroupVsTilemapLayer(object1, object2, collideCallback, processCallback, callbackContext);
- }
- }
- // TILEMAP LAYERS
- else if (object1.type == Phaser.TILEMAPLAYER)
- {
- if (object2.type == Phaser.SPRITE)
- {
- this.collideSpriteVsTilemapLayer(object2, object1, collideCallback, processCallback, callbackContext);
- }
- else if (object2.type == Phaser.GROUP || object2.type == Phaser.EMITTER)
- {
- this.collideGroupVsTilemapLayer(object2, object1, collideCallback, processCallback, callbackContext);
- }
- }
- // EMITTER
- else if (object1.type == Phaser.EMITTER)
- {
- if (object2.type == Phaser.SPRITE)
- {
- this.collideSpriteVsGroup(object2, object1, collideCallback, processCallback, callbackContext);
- }
- else if (object2.type == Phaser.GROUP || object2.type == Phaser.EMITTER)
- {
- this.collideGroupVsGroup(object1, object2, collideCallback, processCallback, callbackContext);
- }
- else if (object2.type == Phaser.TILEMAPLAYER)
- {
- this.collideGroupVsTilemapLayer(object1, object2, collideCallback, processCallback, callbackContext);
- }
- }
- }
-
- return (this._total > 0);
-
- },
-
/**
* An internal function. Use Phaser.Physics.Arcade.collide instead.
*
@@ -982,15 +1106,21 @@ Phaser.Physics.Arcade.prototype = {
*/
collideSpriteVsTilemapLayer: function (sprite, tilemapLayer, collideCallback, processCallback, callbackContext) {
- this._mapData = tilemapLayer.getTiles(sprite.body.x, sprite.body.y, sprite.body.width, sprite.body.height, true);
+ this._mapData = tilemapLayer.getTiles(sprite.body.left, sprite.body.top, sprite.body.width, sprite.body.height, true);
if (this._mapData.length === 0)
{
return;
}
- for (var i = 0; i < this._mapData.length; i++)
+ if (this._mapData.length > 1)
{
+ this.separateTiles(sprite.body, this._mapData);
+ }
+ else
+ {
+ var i = 0;
+
if (this.separateTile(sprite.body, this._mapData[i]))
{
// They collided, is there a custom process callback?
@@ -1033,11 +1163,6 @@ Phaser.Physics.Arcade.prototype = {
return;
}
- if (group.length === 0)
- {
- return;
- }
-
if (group._container.first._iNext)
{
var currentNode = group._container.first._iNext;
@@ -1055,232 +1180,39 @@ Phaser.Physics.Arcade.prototype = {
},
- /**
- * An internal function. Use Phaser.Physics.Arcade.collide instead.
- *
- * @method Phaser.Physics.Arcade#collideSpriteVsSprite
- * @private
- */
- collideSpriteVsSprite: function (sprite1, sprite2, collideCallback, processCallback, callbackContext) {
-
- this.separate(sprite1.body, sprite2.body);
-
- if (this._result)
- {
- // They collided, is there a custom process callback?
- if (processCallback)
- {
- if (processCallback.call(callbackContext, sprite1, sprite2))
- {
- this._total++;
-
- if (collideCallback)
- {
- collideCallback.call(callbackContext, sprite1, sprite2);
- }
- }
- }
- else
- {
- this._total++;
-
- if (collideCallback)
- {
- collideCallback.call(callbackContext, sprite1, sprite2);
- }
- }
- }
-
- },
-
- /**
- * An internal function. Use Phaser.Physics.Arcade.collide instead.
- *
- * @method Phaser.Physics.Arcade#collideSpriteVsGroup
- * @private
- */
- collideSpriteVsGroup: function (sprite, group, collideCallback, processCallback, callbackContext) {
-
- if (group.length === 0)
- {
- return;
- }
-
- // What is the sprite colliding with in the quadtree?
- this._potentials = this.quadTree.retrieve(sprite);
-
- for (var i = 0, len = this._potentials.length; i < len; i++)
- {
- // We have our potential suspects, are they in this group?
- if (this._potentials[i].sprite.group == group)
- {
- this.separate(sprite.body, this._potentials[i]);
-
- if (this._result && processCallback)
- {
- this._result = processCallback.call(callbackContext, sprite, this._potentials[i].sprite);
- }
-
- if (this._result)
- {
- this._total++;
-
- if (collideCallback)
- {
- collideCallback.call(callbackContext, sprite, this._potentials[i].sprite);
- }
- }
- }
- }
-
- },
-
- /**
- * An internal function. Use Phaser.Physics.Arcade.collide instead.
- *
- * @method Phaser.Physics.Arcade#collideGroupVsGroup
- * @private
- */
- collideGroupVsGroup: function (group1, group2, collideCallback, processCallback, callbackContext) {
-
- if (group1.length === 0 || group2.length === 0)
- {
- return;
- }
-
- if (group1._container.first._iNext)
- {
- var currentNode = group1._container.first._iNext;
-
- do
- {
- if (currentNode.exists)
- {
- this.collideSpriteVsGroup(currentNode, group2, collideCallback, processCallback, callbackContext);
- }
- currentNode = currentNode._iNext;
- }
- while (currentNode != group1._container.last._iNext);
- }
-
- },
-
/**
* The core separation function to separate two physics bodies.
* @method Phaser.Physics.Arcade#separate
* @param {Phaser.Physics.Arcade.Body} body1 - The Body object to separate.
* @param {Phaser.Physics.Arcade.Body} body2 - The Body object to separate.
- * @returns {boolean} Returns true if the bodies were separated, otherwise false.
+ * @param {function} [processCallback=null] - A callback function that lets you perform additional checks against the two objects if they overlap. If this function is set then the sprites will only be collided if it returns true.
+ * @param {object} [callbackContext] - The context in which to run the process callback.
+ * @returns {boolean} Returns true if the bodies collided, otherwise false.
*/
- separate: function (body1, body2) {
+ separate: function (body1, body2, processCallback, callbackContext, overlapOnly) {
- this._result = (this.separateX(body1, body2) || this.separateY(body1, body2));
-
- },
-
- /**
- * The core separation function to separate two physics bodies on the x axis.
- * @method Phaser.Physics.Arcade#separateX
- * @param {Phaser.Physics.Arcade.Body} body1 - The Body object to separate.
- * @param {Phaser.Physics.Arcade.Body} body2 - The Body object to separate.
- * @returns {boolean} Returns true if the bodies were separated, otherwise false.
- */
- separateX: function (body1, body2) {
-
- // Can't separate two immovable bodies
- if (body1.immovable && body2.immovable)
+ if (body1 === body2 || this.intersects(body1, body2) === false)
{
return false;
}
- this._overlap = 0;
-
- // Check if the hulls actually overlap
- if (Phaser.Rectangle.intersects(body1, body2))
+ // They overlap. Is there a custom process callback? If it returns true then we can carry on, otherwise we should abort.
+ if (processCallback && processCallback.call(callbackContext, body1.sprite, body2.sprite) === false)
{
- this._maxOverlap = body1.deltaAbsX() + body2.deltaAbsX() + this.OVERLAP_BIAS;
+ return false;
+ }
- if (body1.deltaX() === 0 && body2.deltaX() === 0)
+ this._response.clear();
+
+ if (overlapOnly)
+ {
+ return body1.overlap(body2, this._response);
+ }
+ else
+ {
+ if (body1.overlap(body2, this._response))
{
- // They overlap but neither of them are moving
- body1.embedded = true;
- body2.embedded = true;
- }
- else if (body1.deltaX() > body2.deltaX())
- {
- // Body1 is moving right and/or Body2 is moving left
- this._overlap = body1.x + body1.width - body2.x;
-
- if ((this._overlap > this._maxOverlap) || body1.allowCollision.right === false || body2.allowCollision.left === false)
- {
- this._overlap = 0;
- }
- else
- {
- body1.touching.right = true;
- body2.touching.left = true;
- }
- }
- else if (body1.deltaX() < body2.deltaX())
- {
- // Body1 is moving left and/or Body2 is moving right
- this._overlap = body1.x - body2.width - body2.x;
-
- if ((-this._overlap > this._maxOverlap) || body1.allowCollision.left === false || body2.allowCollision.right === false)
- {
- this._overlap = 0;
- }
- else
- {
- body1.touching.left = true;
- body2.touching.right = true;
- }
- }
-
- // Then adjust their positions and velocities accordingly (if there was any overlap)
- if (this._overlap !== 0)
- {
- body1.overlapX = this._overlap;
- body2.overlapX = this._overlap;
-
- if (body1.customSeparateX || body2.customSeparateX)
- {
- return true;
- }
-
- this._velocity1 = body1.velocity.x;
- this._velocity2 = body2.velocity.x;
-
- if (!body1.immovable && !body2.immovable)
- {
- this._overlap *= 0.5;
-
- body1.x = body1.x - this._overlap;
- body2.x += this._overlap;
-
- this._newVelocity1 = Math.sqrt((this._velocity2 * this._velocity2 * body2.mass) / body1.mass) * ((this._velocity2 > 0) ? 1 : -1);
- this._newVelocity2 = Math.sqrt((this._velocity1 * this._velocity1 * body1.mass) / body2.mass) * ((this._velocity1 > 0) ? 1 : -1);
- this._average = (this._newVelocity1 + this._newVelocity2) * 0.5;
- this._newVelocity1 -= this._average;
- this._newVelocity2 -= this._average;
-
- body1.velocity.x = this._average + this._newVelocity1 * body1.bounce.x;
- body2.velocity.x = this._average + this._newVelocity2 * body2.bounce.x;
- }
- else if (!body1.immovable)
- {
- body1.x = body1.x - this._overlap;
- body1.velocity.x = this._velocity2 - this._velocity1 * body1.bounce.x;
- }
- else if (!body2.immovable)
- {
- body2.x += this._overlap;
- body2.velocity.x = this._velocity1 - this._velocity2 * body2.bounce.x;
- }
- body1.updateHulls();
- body2.updateHulls();
-
- return true;
+ return body1.separate(body2, this._response);
}
}
@@ -1289,221 +1221,203 @@ Phaser.Physics.Arcade.prototype = {
},
/**
- * The core separation function to separate two physics bodies on the y axis.
- * @method Phaser.Physics.Arcade#separateY
- * @param {Phaser.Physics.Arcade.Body} body1 - The Body object to separate.
- * @param {Phaser.Physics.Arcade.Body} body2 - The Body object to separate.
- * @returns {boolean} Returns true if the bodies were separated, otherwise false.
+ * Performs a rect intersection test against the two objects.
+ * Objects must expose properties: width, height, left, right, top, bottom.
+ * @method Phaser.Physics.Arcade#intersects
+ * @param {object} a - The first object to test.
+ * @param {object} b - The second object to test.
+ * @returns {boolean} Returns true if the objects intersect, otherwise false.
*/
- separateY: function (body1, body2) {
+ intersects: function (a, b) {
- // Can't separate two immovable or non-existing bodys
- if (body1.immovable && body2.immovable)
+ var result = false;
+
+ if (a.width <= 0 || a.height <= 0 || b.width <= 0 || b.height <= 0)
{
- return false;
+ result = false;
}
- this._overlap = 0;
+ result = !(a.right < b.left || a.bottom < b.top || a.left > b.right || a.top > b.bottom);
- // Check if the hulls actually overlap
- if (Phaser.Rectangle.intersects(body1, body2))
+ if (!result && a.inContact(b))
{
- this._maxOverlap = body1.deltaAbsY() + body2.deltaAbsY() + this.OVERLAP_BIAS;
-
- if (body1.deltaY() === 0 && body2.deltaY() === 0)
- {
- // They overlap but neither of them are moving
- body1.embedded = true;
- body2.embedded = true;
- }
- else if (body1.deltaY() > body2.deltaY())
- {
- // Body1 is moving down and/or Body2 is moving up
- this._overlap = body1.y + body1.height - body2.y;
-
- if ((this._overlap > this._maxOverlap) || body1.allowCollision.down === false || body2.allowCollision.up === false)
- {
- this._overlap = 0;
- }
- else
- {
- body1.touching.down = true;
- body2.touching.up = true;
- }
- }
- else if (body1.deltaY() < body2.deltaY())
- {
- // Body1 is moving up and/or Body2 is moving down
- this._overlap = body1.y - body2.height - body2.y;
-
- if ((-this._overlap > this._maxOverlap) || body1.allowCollision.up === false || body2.allowCollision.down === false)
- {
- this._overlap = 0;
- }
- else
- {
- body1.touching.up = true;
- body2.touching.down = true;
- }
- }
-
- // Then adjust their positions and velocities accordingly (if there was any overlap)
- if (this._overlap !== 0)
- {
- body1.overlapY = this._overlap;
- body2.overlapY = this._overlap;
-
- if (body1.customSeparateY || body2.customSeparateY)
- {
- return true;
- }
-
- this._velocity1 = body1.velocity.y;
- this._velocity2 = body2.velocity.y;
-
- if (!body1.immovable && !body2.immovable)
- {
- this._overlap *= 0.5;
-
- body1.y = body1.y - this._overlap;
- body2.y += this._overlap;
-
- this._newVelocity1 = Math.sqrt((this._velocity2 * this._velocity2 * body2.mass) / body1.mass) * ((this._velocity2 > 0) ? 1 : -1);
- this._newVelocity2 = Math.sqrt((this._velocity1 * this._velocity1 * body1.mass) / body2.mass) * ((this._velocity1 > 0) ? 1 : -1);
- this._average = (this._newVelocity1 + this._newVelocity2) * 0.5;
- this._newVelocity1 -= this._average;
- this._newVelocity2 -= this._average;
-
- body1.velocity.y = this._average + this._newVelocity1 * body1.bounce.y;
- body2.velocity.y = this._average + this._newVelocity2 * body2.bounce.y;
- }
- else if (!body1.immovable)
- {
- body1.y = body1.y - this._overlap;
- body1.velocity.y = this._velocity2 - this._velocity1 * body1.bounce.y;
-
- // This is special case code that handles things like horizontal moving platforms you can ride
- if (body2.active && body2.moves && (body1.deltaY() > body2.deltaY()))
- {
- body1.x += body2.x - body2.lastX;
- }
- }
- else if (!body2.immovable)
- {
- body2.y += this._overlap;
- body2.velocity.y = this._velocity1 - this._velocity2 * body2.bounce.y;
-
- // This is special case code that handles things like horizontal moving platforms you can ride
- if (body1.sprite.active && body1.moves && (body1.deltaY() < body2.deltaY()))
- {
- body2.x += body1.x - body1.lastX;
- }
- }
- body1.updateHulls();
- body2.updateHulls();
-
- return true;
- }
-
+ a.removeContact(b);
}
- return false;
+ },
+
+ /**
+ * Performs a rect intersection test against the two objects.
+ * Objects must expose properties: width, height, left, right, top, bottom.
+ * @method Phaser.Physics.Arcade#tileIntersects
+ * @param {object} body - The Body to test.
+ * @param {object} tile - The Tile to test.
+ * @returns {boolean} Returns true if the objects intersect, otherwise false.
+ */
+ tileIntersects: function (body, tile) {
+
+ if (body.width <= 0 || body.height <= 0 || tile.width <= 0 || tile.height <= 0)
+ {
+ this._intersection[4] = 0;
+ return this._intersection;
+ }
+
+ if (!(body.right < tile.x || body.bottom < tile.y || body.left > tile.right || body.top > tile.bottom))
+ {
+ this._intersection[0] = Math.max(body.left, tile.x); // x
+ this._intersection[1] = Math.max(body.top, tile.y); // y
+ this._intersection[2] = Math.min(body.right, tile.right) - this._intersection[0]; // width
+ this._intersection[3] = Math.min(body.bottom, tile.bottom) - this._intersection[1]; // height
+ this._intersection[4] = 1;
+
+ return this._intersection;
+ }
+
+ this._intersection[4] = 0;
+
+ return this._intersection;
+
+ },
+
+ /**
+ * The core separation function to separate a physics body and an array of tiles.
+ * @method Phaser.Physics.Arcade#separateTiles
+ * @param {Phaser.Physics.Arcade.Body} body - The Body object to separate.
+ * @param {array<Phaser.Tile>} tiles - The array of tiles to collide against.
+ * @returns {boolean} Returns true if the body was separated, otherwise false.
+ */
+ separateTiles: function (body, tiles) {
+
+ var tile;
+ var result = false;
+
+ for (var i = 0; i < tiles.length; i++)
+ {
+ tile = tiles[i];
+
+ if (this.separateTile(body, tile))
+ {
+ result = true;
+ }
+ }
+
+ return result;
},
/**
* The core separation function to separate a physics body and a tile.
* @method Phaser.Physics.Arcade#separateTile
- * @param {Phaser.Physics.Arcade.Body} body1 - The Body object to separate.
+ * @param {Phaser.Physics.Arcade.Body} body - The Body object to separate.
* @param {Phaser.Tile} tile - The tile to collide against.
- * @returns {boolean} Returns true if the bodies were separated, otherwise false.
+ * @returns {boolean} Returns true if the body was separated, otherwise false.
*/
separateTile: function (body, tile) {
- this._result = (this.separateTileX(body, tile, true) || this.separateTileY(body, tile, true));
+ this._intersection = this.tileIntersects(body, tile);
- return this._result;
-
- },
-
- /**
- * The core separation function to separate a physics body and a tile on the x axis.
- * @method Phaser.Physics.Arcade#separateTileX
- * @param {Phaser.Physics.Arcade.Body} body1 - The Body object to separate.
- * @param {Phaser.Tile} tile - The tile to collide against.
- * @returns {boolean} Returns true if the bodies were separated, otherwise false.
- */
- separateTileX: function (body, tile, separate) {
-
- // Can't separate two immovable objects (tiles are always immovable)
- if (body.immovable || body.deltaX() === 0 || Phaser.Rectangle.intersects(body.hullX, tile) === false)
+ // If the intersection area is either entirely null, or has a width/height of zero, we bail out now
+ if (this._intersection[4] === 0 || this._intersection[2] === 0 || this._intersection[3] === 0)
{
return false;
}
- this._overlap = 0;
-
- // The hulls overlap, let's process it
- // this._maxOverlap = body.deltaAbsX() + this.OVERLAP_BIAS;
-
- if (body.deltaX() < 0)
+ // They overlap. Any custom callbacks?
+ if (tile.tile.callback || tile.layer.callbacks[tile.tile.index])
{
- // Moving left
- this._overlap = tile.right - body.hullX.x;
-
- // if ((this._overlap > this._maxOverlap) || body.allowCollision.left === false || tile.tile.collideRight === false)
- if (body.allowCollision.left === false || tile.tile.collideRight === false)
+ // A local callback takes priority over a global callback.
+ if (tile.tile.callback && tile.tile.callback.call(tile.tile.callbackContext, body.sprite, tile) === false)
{
- this._overlap = 0;
+ // Is there a tile specific collision callback? If it returns true then we can carry on, otherwise we should abort.
+ return false;
}
- else
+ else if (tile.layer.callbacks[tile.tile.index] && tile.layer.callbacks[tile.tile.index].callback.call(tile.layer.callbacks[tile.tile.index].callbackContext, body.sprite, tile) === false)
{
- body.touching.left = true;
- }
- }
- else
- {
- // Moving right
- this._overlap = body.hullX.right - tile.x;
-
- // if ((this._overlap > this._maxOverlap) || body.allowCollision.right === false || tile.tile.collideLeft === false)
- if (body.allowCollision.right === false || tile.tile.collideLeft === false)
- {
- this._overlap = 0;
- }
- else
- {
- body.touching.right = true;
+ // Is there a tile index collision callback? If it returns true then we can carry on, otherwise we should abort.
+ return false;
}
}
- // Then adjust their positions and velocities accordingly (if there was any overlap)
- if (this._overlap !== 0)
+ body.overlapX = 0;
+ body.overlapY = 0;
+
+ var process = false;
+
+ if (body.deltaX() < 0 && body.checkCollision.left && tile.tile.faceRight && !body.blocked.left)
{
- if (separate)
+ // LEFT
+ body.overlapX = body.left - tile.right;
+
+ if (body.overlapX < 0)
{
- if (body.deltaX() < 0)
- {
- body.x = body.x + this._overlap;
- }
- else
- {
- body.x = body.x - this._overlap;
- }
-
- if (body.bounce.x === 0)
- {
- body.velocity.x = 0;
- }
- else
- {
- body.velocity.x = -body.velocity.x * body.bounce.x;
- }
-
- body.updateHulls();
+ process = true;
}
+ else
+ {
+ body.overlapX = 0;
+ }
+ }
+ else if (body.deltaX() > 0 && body.checkCollision.right && tile.tile.faceLeft && !body.blocked.right)
+ {
+ // RIGHT
+ body.overlapX = body.right - tile.x;
- return true;
+ if (body.overlapX > 0)
+ {
+ process = true;
+ }
+ else
+ {
+ body.overlapX = 0;
+ }
+ }
+
+ if (body.deltaY() < 0 && body.checkCollision.up && tile.tile.faceBottom && !body.blocked.up)
+ {
+ // UP
+ body.overlapY = body.top - tile.bottom;
+
+ if (body.overlapY < 0)
+ {
+ process = true;
+ }
+ else
+ {
+ body.overlapY = 0;
+ }
+ }
+ else if (body.deltaY() > 0 && body.checkCollision.down && tile.tile.faceTop && !body.blocked.down)
+ {
+ // DOWN
+ body.overlapY = body.bottom - tile.y;
+
+ if (body.overlapY > 0)
+ {
+ process = true;
+ }
+ else
+ {
+ body.overlapY = 0;
+ }
+ }
+
+ // Only separate on the smallest of the two values if it's a single tile
+ if (body.overlapX !== 0 && body.overlapY !== 0)
+ {
+ if (Math.abs(body.overlapX) > Math.abs(body.overlapY))
+ {
+ body.overlapX = 0;
+ }
+ else
+ {
+ body.overlapY = 0;
+ }
+ }
+
+ // Separate in a single sweep
+ if (process)
+ {
+ return this.processTileSeparation(body);
}
else
{
@@ -1513,88 +1427,53 @@ Phaser.Physics.Arcade.prototype = {
},
/**
- * The core separation function to separate a physics body and a tile on the x axis.
- * @method Phaser.Physics.Arcade#separateTileY
+ * Internal function to process the separation of a physics body from a tile.
+ * @method Phaser.Physics.Arcade#processTileSeparation
+ * @protected
* @param {Phaser.Physics.Arcade.Body} body1 - The Body object to separate.
- * @param {Phaser.Tile} tile - The tile to collide against.
- * @returns {boolean} Returns true if the bodies were separated, otherwise false.
+ * @returns {boolean} Returns true if separated, false if not.
*/
- separateTileY: function (body, tile, separate) {
+ processTileSeparation: function (body) {
- // Can't separate two immovable objects (tiles are always immovable)
- if (body.immovable || body.deltaY() === 0 || Phaser.Rectangle.intersects(body.hullY, tile) === false)
+ if (body.overlapX < 0)
{
- return false;
+ body.x -= body.overlapX;
+ body.left -= body.overlapX;
+ body.right -= body.overlapX;
+ body.blocked.x = Math.floor(body.x);
+ body.blocked.y = Math.floor(body.y);
+ body.blocked.left = true;
+ }
+ else if (body.overlapX > 0)
+ {
+ body.x -= body.overlapX;
+ body.left -= body.overlapX;
+ body.right -= body.overlapX;
+ body.blocked.x = Math.floor(body.x);
+ body.blocked.y = Math.floor(body.y);
+ body.blocked.right = true;
}
- this._overlap = 0;
-
- // The hulls overlap, let's process it
- // this._maxOverlap = body.deltaAbsY() + this.OVERLAP_BIAS;
-
- if (body.deltaY() < 0)
+ if (body.overlapY < 0)
{
- // Moving up
- this._overlap = tile.bottom - body.hullY.y;
-
- // if ((this._overlap > this._maxOverlap) || body.allowCollision.up === false || tile.tile.collideDown === false)
- if (body.allowCollision.up === false || tile.tile.collideDown === false)
- {
- this._overlap = 0;
- }
- else
- {
- body.touching.up = true;
- }
+ body.y -= body.overlapY;
+ body.top -= body.overlapY;
+ body.bottom -= body.overlapY;
+ body.blocked.x = Math.floor(body.x);
+ body.blocked.y = Math.floor(body.y);
+ body.blocked.up = true;
}
- else
+ else if (body.overlapY > 0)
{
- // Moving down
- this._overlap = body.hullY.bottom - tile.y;
-
- // if ((this._overlap > this._maxOverlap) || body.allowCollision.down === false || tile.tile.collideUp === false)
- if (body.allowCollision.down === false || tile.tile.collideUp === false)
- {
- this._overlap = 0;
- }
- else
- {
- body.touching.down = true;
- }
+ body.y -= body.overlapY;
+ body.top -= body.overlapY;
+ body.bottom -= body.overlapY;
+ body.blocked.x = Math.floor(body.x);
+ body.blocked.y = Math.floor(body.y);
+ body.blocked.down = true;
}
- // Then adjust their positions and velocities accordingly (if there was any overlap)
- if (this._overlap !== 0)
- {
- if (separate)
- {
- if (body.deltaY() < 0)
- {
- body.y = body.y + this._overlap;
- }
- else
- {
- body.y = body.y - this._overlap;
- }
-
- if (body.bounce.y === 0)
- {
- body.velocity.y = 0;
- }
- else
- {
- body.velocity.y = -body.velocity.y * body.bounce.y;
- }
-
- body.updateHulls();
- }
-
- return true;
- }
- else
- {
- return false;
- }
+ return true;
},
@@ -1744,7 +1623,7 @@ Phaser.Physics.Arcade.prototype = {
/**
* Given the rotation (in radians) and speed calculate the acceleration and return it as a Point object, or set it to the given point object.
- * One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) which will set the values directly to the sprites velocity and not create a new Point object.
+ * One way to use this is: accelerationFromRotation(rotation, 200, sprite.acceleration) which will set the values directly to the sprites acceleration and not create a new Point object.
*
* @method Phaser.Physics.Arcade#accelerationFromRotation
* @param {number} rotation - The angle in radians.
@@ -1963,6 +1842,8 @@ Phaser.Physics.Arcade.prototype = {
}
};
+
+Phaser.Physics.Arcade.prototype.constructor = Phaser.Physics.Arcade;
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/BitmapData.js.html b/docs/BitmapData.js.html index b38a31c2..f1e849a9 100644 --- a/docs/BitmapData.js.html +++ b/docs/BitmapData.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -1380,7 +1374,9 @@ Phaser.BitmapData.prototype = {
}
-}
+};
+
+Phaser.BitmapData.prototype.constructor = Phaser.BitmapData;
// EaselJS Tiny API emulation
@@ -1554,13 +1550,13 @@ Phaser.BitmapData.prototype.de = Phaser.BitmapData.prototype.ellipse;
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/BitmapText.js.html b/docs/BitmapText.js.html
index 87502549..3f69ce4e 100644
--- a/docs/BitmapText.js.html
+++ b/docs/BitmapText.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -543,11 +537,6 @@ Phaser.BitmapText = function (game, x, y, text, style) {
this._cache.x = this.x;
this._cache.y = this.y;
- /**
- * @property {boolean} renderable - A renderable object will be rendered to the context each frame.
- */
- this.renderable = true;
-
};
Phaser.BitmapText.prototype = Object.create(PIXI.BitmapText.prototype);
@@ -576,8 +565,8 @@ Phaser.BitmapText.prototype.update = function() {
this._cache.dirty = true;
}
- this.pivot.x = this.anchor.x*this.width;
- this.pivot.y = this.anchor.y*this.height;
+ this.pivot.x = this.anchor.x * this.width;
+ this.pivot.y = this.anchor.y * this.height;
}
@@ -674,13 +663,13 @@ Object.defineProperty(Phaser.BitmapText.prototype, 'y', {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Body.js.html b/docs/Body.js.html
index 244d0230..0168e9ab 100644
--- a/docs/Body.js.html
+++ b/docs/Body.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
-* The Physics Body is linked to a single Sprite. All physics operations should be performed against the body rather than
-* the Sprite itself. For example you can set the velocity, acceleration, bounce values etc all on the Body.
+* The Physics Body is linked to a single Sprite and defines properties that determine how the physics body is simulated.
+* These properties affect how the body reacts to forces, what forces it generates on itself (to simulate friction), and how it reacts to collisions in the scene. In most cases, the properties are used to simulate physical effects.
+* Each body also has its own property values that determine exactly how it reacts to forces and collisions in the scene.
*
* @class Phaser.Physics.Arcade.Body
* @classdesc Arcade Physics Body Constructor
@@ -453,29 +448,17 @@ Phaser.Physics.Arcade.Body = function (sprite) {
*/
this.offset = new Phaser.Point();
- /**
- * @property {number} x - The x position of the physics body.
- * @readonly
- */
- this.x = sprite.x;
-
- /**
- * @property {number} y - The y position of the physics body.
- * @readonly
- */
- this.y = sprite.y;
-
/**
* @property {number} preX - The previous x position of the physics body.
* @readonly
*/
- this.preX = sprite.x;
+ this.preX = sprite.world.x;
/**
* @property {number} preY - The previous y position of the physics body.
* @readonly
*/
- this.preY = sprite.y;
+ this.preY = sprite.world.y;
/**
* @property {number} preRotation - The previous rotation of the physics body.
@@ -484,53 +467,262 @@ Phaser.Physics.Arcade.Body = function (sprite) {
this.preRotation = sprite.angle;
/**
- * @property {number} screenX - The x position of the physics body translated to screen space.
+ * @property {Phaser.Point} velocity - The velocity of the Body.
+ */
+ this.velocity = new Phaser.Point();
+
+ /**
+ * @property {Phaser.Point} acceleration - The acceleration in pixels per second sq. of the Body.
+ */
+ this.acceleration = new Phaser.Point();
+
+ /**
+ * @property {number} speed - The speed in pixels per second sq. of the Body.
+ */
+ this.speed = 0;
+
+ /**
+ * @property {number} angle - The angle of the Body based on its velocity in radians.
+ */
+ this.angle = 0;
+
+ /**
+ * @property {Phaser.Point} gravity - The gravity applied to the motion of the Body. This works in addition to any gravity set on the world.
+ */
+ this.gravity = new Phaser.Point();
+
+ /**
+ * @property {Phaser.Point} bounce - The elasticitiy of the Body when colliding. This property determines how much energy a body maintains during a collision, i.e. its bounciness.
+ */
+ this.bounce = new Phaser.Point();
+
+ /**
+ * @property {Phaser.Point} minVelocity - When a body rebounds off another body or a wall the minVelocity is checked. If the new velocity is lower than minVelocity the body is stopped.
+ * @default
+ */
+ this.minVelocity = new Phaser.Point();
+
+ /**
+ * @property {Phaser.Point} maxVelocity - The maximum velocity that the Body can reach.
+ * @default
+ */
+ this.maxVelocity = new Phaser.Point(1000, 1000);
+
+ /**
+ * @property {number} angularVelocity - The angular velocity of the Body.
+ * @default
+ */
+ this.angularVelocity = 0;
+
+ /**
+ * @property {number} angularAcceleration - The angular acceleration of the Body.
+ * @default
+ */
+ this.angularAcceleration = 0;
+
+ /**
+ * @property {number} angularDrag - angularDrag is used to calculate friction on the body as it rotates.
+ * @default
+ */
+ this.angularDrag = 0;
+
+ /**
+ * @property {number} maxAngular - The maximum angular velocity that the Body can reach.
+ * @default
+ */
+ this.maxAngular = 1000;
+
+ /**
+ * @property {number} mass - The mass property determines how forces affect the body, as well as how much momentum the body has when it is involved in a collision.
+ * @default
+ */
+ this.mass = 1;
+
+ /**
+ * @property {number} linearDamping - linearDamping is used to calculate friction on the body as it moves through the world. For example, this might be used to simulate air or water friction.
+ * @default
+ */
+ this.linearDamping = 0.0;
+
+ /**
+ * Set the checkCollision properties to control which directions collision is processed for this Body.
+ * For example checkCollision.up = false means it won't collide when the collision happened while moving up.
+ * @property {object} checkCollision - An object containing allowed collision.
+ */
+ this.checkCollision = { none: false, any: true, up: true, down: true, left: true, right: true };
+
+ /**
+ * This object is populated with boolean values when the Body collides with another.
+ * touching.up = true means the collision happened to the top of this Body for example.
+ * @property {object} touching - An object containing touching results.
+ */
+ this.touching = { none: true, up: false, down: false, left: false, right: false };
+
+ /**
+ * This object is populated with boolean values when the Body collides with the World bounds or a Tile.
+ * For example if blocked.up is true then the Body cannot move up.
+ * @property {object} blocked - An object containing on which faces this Body is blocked from moving, if any.
+ */
+ this.blocked = { x: 0, y: 0, up: false, down: false, left: false, right: false };
+
+ /**
+ * @property {number} facing - A const reference to the direction the Body is traveling or facing.
+ * @default
+ */
+ this.facing = Phaser.NONE;
+
+ /**
+ * @property {boolean} rebound - A Body set to rebound will exchange velocity with another Body during collision. Set to false to allow this body to be 'pushed' rather than exchange velocity.
+ * @default
+ */
+ this.rebound = true;
+
+ /**
+ * @property {boolean} immovable - An immovable Body will not receive any impacts or exchanges of velocity from other bodies.
+ * @default
+ */
+ this.immovable = false;
+
+ /**
+ * @property {boolean} moves - Set to true to allow the Physics system (such as velocity) to move this Body, or false to move it manually.
+ * @default
+ */
+ this.moves = true;
+
+ /**
+ * @property {number} rotation - The amount the parent Sprite is rotated.
+ * @default
+ */
+ this.rotation = 0;
+
+ /**
+ * @property {boolean} allowRotation - Allow angular rotation? This will cause the Sprite to be rotated via angularVelocity, etc.
+ * @default
+ */
+ this.allowRotation = true;
+
+ /**
+ * @property {boolean} allowGravity - Allow this Body to be influenced by the global Gravity value? Note: It will always be influenced by the local gravity if set.
+ * @default
+ */
+ this.allowGravity = true;
+
+ /**
+ * @property {function} customSeparateCallback - If set this callback will be used for Body separation instead of the built-in one. Callback should return true if separated, otherwise false.
+ * @default
+ */
+ this.customSeparateCallback = null;
+
+ /**
+ * @property {object} customSeparateContext - The context in which the customSeparateCallback is called.
+ * @default
+ */
+ this.customSeparateContext = null;
+
+ /**
+ * @property {function} collideCallback - If set this callback will be fired whenever this Body is hit (on any face). It will send three parameters, the face it hit on, this Body and the Body that hit it.
+ * @default
+ */
+ this.collideCallback = null;
+
+ /**
+ * @property {object} collideCallbackContext - The context in which the collideCallback is called.
+ * @default
+ */
+ this.collideCallbackContext = null;
+
+ /**
+ * A Body can be set to collide against the World bounds automatically and rebound back into the World if this is set to true. Otherwise it will leave the World.
+ * @property {boolean} collideWorldBounds - Should the Body collide with the World bounds?
+ */
+ this.collideWorldBounds = false;
+
+ /**
+ * @property {Phaser.Physics.Arcade.RECT|Phaser.Physics.Arcade.CIRCLE} type - The type of SAT Shape.
+ */
+ this.type = Phaser.Physics.Arcade.RECT;
+
+ /**
+ * @property {SAT.Box|SAT.Circle|SAT.Polygon} shape - The SAT Collision shape.
+ */
+ this.shape = null;
+
+ /**
+ * @property {SAT.Polygon} polygon - The SAT Polygons, as derived from the Shape.
+ */
+ this.polygon = null;
+
+ /**
+ * @property {number} left - The left-most point of this Body.
* @readonly
*/
- this.screenX = sprite.x;
+ this.left = 0;
/**
- * @property {number} screenY - The y position of the physics body translated to screen space.
+ * @property {number} right - The right-most point of this Body.
* @readonly
*/
- this.screenY = sprite.y;
+ this.right = 0;
/**
- * @property {number} sourceWidth - The un-scaled original size.
+ * @property {number} top - The top-most point of this Body.
* @readonly
*/
- this.sourceWidth = sprite.currentFrame.sourceSizeW;
+ this.top = 0;
/**
- * @property {number} sourceHeight - The un-scaled original size.
+ * @property {number} bottom - The bottom-most point of this Body.
* @readonly
*/
- this.sourceHeight = sprite.currentFrame.sourceSizeH;
+ this.bottom = 0;
/**
- * @property {number} width - The calculated width of the physics body.
+ * @property {number} width - The current width of the Body, taking into account the point rotation.
+ * @readonly
*/
- this.width = sprite.currentFrame.sourceSizeW;
+ this.width = 0;
/**
- * @property .numInternal ID cache
+ * @property {number} height - The current height of the Body, taking into account the point rotation.
+ * @readonly
*/
- this.height = sprite.currentFrame.sourceSizeH;
+ this.height = 0;
/**
- * @property {number} halfWidth - The calculated width / 2 of the physics body.
+ * @property {array<Phaser.Physics.Arcade.Body>} contacts - Used to store references to bodies this Body is in contact with.
+ * @protected
*/
- this.halfWidth = Math.floor(sprite.currentFrame.sourceSizeW / 2);
+ this.contacts = [];
/**
- * @property {number} halfHeight - The calculated height / 2 of the physics body.
+ * @property {number} overlapX - Mostly used internally to store the overlap values from Tile seperation.
+ * @protected
*/
- this.halfHeight = Math.floor(sprite.currentFrame.sourceSizeH / 2);
+ this.overlapX = 0;
/**
- * @property {Phaser.Point} center - The center coordinate of the Physics Body.
+ * @property {number} overlapY - Mostly used internally to store the overlap values from Tile seperation.
+ * @protected
*/
- this.center = new Phaser.Point(this.x + this.halfWidth, this.y + this.halfHeight);
+ this.overlapY = 0;
+
+ /**
+ * @property {Phaser.Point} _temp - Internal cache var.
+ * @private
+ */
+ this._temp = null;
+
+ /**
+ * @property {number} _dx - Internal cache var.
+ * @private
+ */
+ this._dx = 0;
+
+ /**
+ * @property {number} _dy - Internal cache var.
+ * @private
+ */
+ this._dy = 0;
/**
* @property {number} _sx - Internal cache var.
@@ -545,231 +737,80 @@ Phaser.Physics.Arcade.Body = function (sprite) {
this._sy = sprite.scale.y;
/**
- * @property {Phaser.Point} velocity - The velocity in pixels per second sq. of the Body.
+ * @property {array} _distances - Internal cache var.
+ * @private
*/
- this.velocity = new Phaser.Point();
+ this._distances = [0, 0, 0, 0];
/**
- * @property {Phaser.Point} acceleration - The velocity in pixels per second sq. of the Body.
+ * @property {number} _vx - Internal cache var.
+ * @private
*/
- this.acceleration = new Phaser.Point();
+ this._vx = 0;
/**
- * @property {Phaser.Point} drag - The drag applied to the motion of the Body.
+ * @property {number} _vy - Internal cache var.
+ * @private
*/
- this.drag = new Phaser.Point();
+ this._vy = 0;
- /**
- * @property {Phaser.Point} gravity - A private Gravity setting for the Body.
- */
- this.gravity = new Phaser.Point();
+ // Set-up the default shape
+ this.setRectangle(sprite.width, sprite.height, 0, 0);
- /**
- * @property {Phaser.Point} bounce - The elasticitiy of the Body when colliding. bounce.x/y = 1 means full rebound, bounce.x/y = 0.5 means 50% rebound velocity.
- */
- this.bounce = new Phaser.Point();
-
- /**
- * @property {Phaser.Point} maxVelocity - The maximum velocity in pixels per second sq. that the Body can reach.
- * @default
- */
- this.maxVelocity = new Phaser.Point(10000, 10000);
-
- /**
- * @property {number} angularVelocity - The angular velocity in pixels per second sq. of the Body.
- * @default
- */
- this.angularVelocity = 0;
-
- /**
- * @property {number} angularAcceleration - The angular acceleration in pixels per second sq. of the Body.
- * @default
- */
- this.angularAcceleration = 0;
-
- /**
- * @property {number} angularDrag - The angular drag applied to the rotation of the Body.
- * @default
- */
- this.angularDrag = 0;
-
- /**
- * @property {number} maxAngular - The maximum angular velocity in pixels per second sq. that the Body can reach.
- * @default
- */
- this.maxAngular = 1000;
-
- /**
- * @property {number} mass - The mass of the Body.
- * @default
- */
- this.mass = 1;
-
- /**
- * @property {boolean} skipQuadTree - If the Body is an irregular shape you can set this to true to avoid it being added to the World quad tree.
- * @default
- */
- this.skipQuadTree = false;
-
- /**
- * @property {Array} quadTreeIDs - Internal ID cache.
- * @protected
- */
- this.quadTreeIDs = [];
-
- /**
- * @property {number} quadTreeIndex - Internal ID cache.
- * @protected
- */
- this.quadTreeIndex = -1;
-
- // Allow collision
-
- /**
- * Set the allowCollision properties to control which directions collision is processed for this Body.
- * For example allowCollision.up = false means it won't collide when the collision happened while moving up.
- * @property {object} allowCollision - An object containing allowed collision.
- */
- this.allowCollision = { none: false, any: true, up: true, down: true, left: true, right: true };
-
- /**
- * This object is populated with boolean values when the Body collides with another.
- * touching.up = true means the collision happened to the top of this Body for example.
- * @property {object} touching - An object containing touching results.
- */
- this.touching = { none: true, up: false, down: false, left: false, right: false };
-
- /**
- * This object is populated with previous touching values from the bodies previous collision.
- * @property {object} wasTouching - An object containing previous touching results.
- */
- this.wasTouching = { none: true, up: false, down: false, left: false, right: false };
-
- /**
- * @property {number} facing - A const reference to the direction the Body is traveling or facing.
- * @default
- */
- this.facing = Phaser.NONE;
-
- /**
- * @property {boolean} immovable - An immovable Body will not receive any impacts from other bodies.
- * @default
- */
- this.immovable = false;
-
- /**
- * @property {boolean} moves - Set to true to allow the Physics system to move this Body, other false to move it manually.
- * @default
- */
- this.moves = true;
-
- /**
- * @property {number} rotation - The amount the Body is rotated.
- * @default
- */
- this.rotation = 0;
-
- /**
- * @property {boolean} allowRotation - Allow this Body to be rotated? (via angularVelocity, etc)
- * @default
- */
- this.allowRotation = true;
-
- /**
- * @property {boolean} allowGravity - Allow this Body to be influenced by the global Gravity?
- * @default
- */
- this.allowGravity = true;
-
- /**
- * This flag allows you to disable the custom x separation that takes place by Physics.Arcade.separate.
- * Used in combination with your own collision processHandler you can create whatever type of collision response you need.
- * @property {boolean} customSeparateX - Use a custom separation system or the built-in one?
- * @default
- */
- this.customSeparateX = false;
-
- /**
- * This flag allows you to disable the custom y separation that takes place by Physics.Arcade.separate.
- * Used in combination with your own collision processHandler you can create whatever type of collision response you need.
- * @property {boolean} customSeparateY - Use a custom separation system or the built-in one?
- * @default
- */
- this.customSeparateY = false;
-
- /**
- * When this body collides with another, the amount of overlap is stored here.
- * @property {number} overlapX - The amount of horizontal overlap during the collision.
- */
- this.overlapX = 0;
-
- /**
- * When this body collides with another, the amount of overlap is stored here.
- * @property {number} overlapY - The amount of vertical overlap during the collision.
- */
- this.overlapY = 0;
-
- /**
- * @property {Phaser.Rectangle} hullX - The dynamically calculated hull used during collision.
- */
- this.hullX = new Phaser.Rectangle();
-
- /**
- * @property {Phaser.Rectangle} hullY - The dynamically calculated hull used during collision.
- */
- this.hullY = new Phaser.Rectangle();
-
- /**
- * If a body is overlapping with another body, but neither of them are moving (maybe they spawned on-top of each other?) this is set to true.
- * @property {boolean} embedded - Body embed value.
- */
- this.embedded = false;
-
- /**
- * A Body can be set to collide against the World bounds automatically and rebound back into the World if this is set to true. Otherwise it will leave the World.
- * @property {boolean} collideWorldBounds - Should the Body collide with the World bounds?
- */
- this.collideWorldBounds = false;
+ // Set-up contact events
+ this.sprite.events.onBeginContact = new Phaser.Signal();
+ this.sprite.events.onEndContact = new Phaser.Signal();
};
Phaser.Physics.Arcade.Body.prototype = {
/**
- * Internal method.
+ * Internal method that updates the Body scale in relation to the parent Sprite.
*
- * @method Phaser.Physics.Arcade#updateBounds
+ * @method Phaser.Physics.Arcade.Body#updateScale
* @protected
*/
- updateBounds: function (centerX, centerY, scaleX, scaleY) {
+ updateScale: function () {
- if (scaleX != this._sx || scaleY != this._sy)
+ if (this.polygon)
{
- this.width = this.sourceWidth * scaleX;
- this.height = this.sourceHeight * scaleY;
- this.halfWidth = Math.floor(this.width / 2);
- this.halfHeight = Math.floor(this.height / 2);
- this._sx = scaleX;
- this._sy = scaleY;
- this.center.setTo(this.x + this.halfWidth, this.y + this.halfHeight);
+ this.polygon.scale(this.sprite.scale.x / this._sx, this.sprite.scale.y / this._sy);
}
+ else
+ {
+ this.shape.r *= Math.max(this.sprite.scale.x, this.sprite.scale.y);
+ }
+
+ this._sx = this.sprite.scale.x;
+ this._sy = this.sprite.scale.y;
},
/**
- * Internal method.
+ * Internal method that updates the Body position in relation to the parent Sprite.
*
- * @method Phaser.Physics.Arcade#preUpdate
+ * @method Phaser.Physics.Arcade.Body#preUpdate
* @protected
*/
preUpdate: function () {
- // Store and reset collision flags
- this.wasTouching.none = this.touching.none;
- this.wasTouching.up = this.touching.up;
- this.wasTouching.down = this.touching.down;
- this.wasTouching.left = this.touching.left;
- this.wasTouching.right = this.touching.right;
+ this.x = (this.sprite.world.x - (this.sprite.anchor.x * this.sprite.width)) + this.offset.x;
+ this.y = (this.sprite.world.y - (this.sprite.anchor.y * this.sprite.height)) + this.offset.y;
+
+ // This covers any motion that happens during this frame, not since the last frame
+ this.preX = this.x;
+ this.preY = this.y;
+ this.preRotation = this.sprite.angle;
+
+ this.rotation = this.preRotation;
+
+ if (this.sprite.scale.x !== this._sx || this.sprite.scale.y !== this._sy)
+ {
+ this.updateScale();
+ }
+
+ this.checkBlocked();
this.touching.none = true;
this.touching.up = false;
@@ -777,290 +818,1116 @@ Phaser.Physics.Arcade.Body.prototype = {
this.touching.left = false;
this.touching.right = false;
- this.embedded = false;
-
- this.screenX = (this.sprite.worldTransform[2] - (this.sprite.anchor.x * this.width)) + this.offset.x;
- this.screenY = (this.sprite.worldTransform[5] - (this.sprite.anchor.y * this.height)) + this.offset.y;
-
- this.preX = (this.sprite.world.x - (this.sprite.anchor.x * this.width)) + this.offset.x;
- this.preY = (this.sprite.world.y - (this.sprite.anchor.y * this.height)) + this.offset.y;
-
- this.preRotation = this.sprite.angle;
-
- this.x = this.preX;
- this.y = this.preY;
- this.rotation = this.preRotation;
-
if (this.moves)
{
- this.game.physics.updateMotion(this);
-
- if (this.collideWorldBounds)
+ if (this._vx !== this.velocity.x || this._vy !== this.velocity.y)
{
- this.checkWorldBounds();
+ // No need to re-calc these if they haven't changed
+ this._vx = this.velocity.x;
+ this._vy = this.velocity.y;
+ this.speed = Math.sqrt(this.velocity.x * this.velocity.x + this.velocity.y * this.velocity.y);
+ this.angle = Math.atan2(this.velocity.y, this.velocity.x);
}
- this.updateHulls();
- }
+ if (this.game.physics.checkBounds(this))
+ {
+ this.reboundCheck(true, true, true);
+ }
- if (this.skipQuadTree === false && this.allowCollision.none === false && this.sprite.visible && this.sprite.alive)
+ this.applyDamping();
+
+ this.integrateVelocity();
+
+ this.updateBounds();
+
+ this.checkBlocked();
+ }
+ else
{
- this.quadTreeIDs = [];
- this.quadTreeIndex = -1;
- this.game.physics.quadTree.insert(this);
+ this.updateBounds();
}
},
/**
- * Internal method.
+ * Internal method that checks and potentially resets the blocked status flags.
*
- * @method Phaser.Physics.Arcade#postUpdate
+ * @method Phaser.Physics.Arcade.Body#checkBlocked
+ * @protected
+ */
+ checkBlocked: function () {
+
+ if ((this.blocked.left || this.blocked.right) && (Math.floor(this.x) !== this.blocked.x || Math.floor(this.y) !== this.blocked.y))
+ {
+ this.blocked.left = false;
+ this.blocked.right = false;
+ }
+
+ if ((this.blocked.up || this.blocked.down) && (Math.floor(this.x) !== this.blocked.x || Math.floor(this.y) !== this.blocked.y))
+ {
+ this.blocked.up = false;
+ this.blocked.down = false;
+ }
+
+ },
+
+ /**
+ * Internal method that updates the left, right, top, bottom, width and height properties.
+ *
+ * @method Phaser.Physics.Arcade.Body#updateBounds
+ * @protected
+ */
+ updateBounds: function () {
+
+ if (this.type === Phaser.Physics.Arcade.CIRCLE)
+ {
+ this.left = this.shape.pos.x - this.shape.r;
+ this.right = this.shape.pos.x + this.shape.r;
+ this.top = this.shape.pos.y - this.shape.r;
+ this.bottom = this.shape.pos.y + this.shape.r;
+ }
+ else
+ {
+ this.left = Phaser.Math.minProperty('x', this.polygon.points) + this.polygon.pos.x;
+ this.right = Phaser.Math.maxProperty('x', this.polygon.points) + this.polygon.pos.x;
+ this.top = Phaser.Math.minProperty('y', this.polygon.points) + this.polygon.pos.y;
+ this.bottom = Phaser.Math.maxProperty('y', this.polygon.points) + this.polygon.pos.y;
+ }
+
+ this.width = this.right - this.left;
+ this.height = this.bottom - this.top;
+
+ },
+
+ /**
+ * Internal method that checks the acceleration and applies damping if not set.
+ *
+ * @method Phaser.Physics.Arcade.Body#applyDamping
+ * @protected
+ */
+ applyDamping: function () {
+
+ if (this.linearDamping > 0 && this.acceleration.isZero())
+ {
+ if (this.speed > this.linearDamping)
+ {
+ this.speed -= this.linearDamping;
+ }
+ else
+ {
+ this.speed = 0;
+ }
+
+ // Don't bother if speed 0
+ if (this.speed > 0)
+ {
+ this.velocity.x = Math.cos(this.angle) * this.speed;
+ this.velocity.y = Math.sin(this.angle) * this.speed;
+
+ this.speed = Math.sqrt(this.velocity.x * this.velocity.x + this.velocity.y * this.velocity.y);
+ this.angle = Math.atan2(this.velocity.y, this.velocity.x);
+ }
+ }
+
+ },
+
+ /**
+ * Check if we're below minVelocity and gravity isn't trying to drag us in the opposite direction.
+ *
+ * @method Phaser.Physics.Arcade.Body#reboundCheck
+ * @protected
+ * @param {boolean} x - Check the X axis?
+ * @param {boolean} y - Check the Y axis?
+ * @param {boolean} rebound - If true it will reverse the velocity on the given axis
+ */
+ reboundCheck: function (x, y, rebound) {
+
+ if (x)
+ {
+ if (rebound && this.bounce.x !== 0 && (this.blocked.left || this.blocked.right || this.touching.left || this.touching.right))
+ {
+ // Don't rebound if they've already rebounded in this frame
+ if (!(this._vx <= 0 && this.velocity.x > 0) && !(this._vx >= 0 && this.velocity.x < 0))
+ {
+ this.velocity.x *= -this.bounce.x;
+ this.angle = Math.atan2(this.velocity.y, this.velocity.x);
+ }
+ }
+
+ if (this.bounce.x === 0 || Math.abs(this.velocity.x) < this.minVelocity.x)
+ {
+ var gx = this.getUpwardForce();
+
+ if (((this.blocked.left || this.touching.left) && (gx < 0 || this.velocity.x < 0)) || ((this.blocked.right || this.touching.right) && (gx > 0 || this.velocity.x > 0)))
+ {
+ this.velocity.x = 0;
+ }
+ }
+ }
+
+ if (y)
+ {
+ if (rebound && this.bounce.y !== 0 && (this.blocked.up || this.blocked.down || this.touching.up || this.touching.down))
+ {
+ // Don't rebound if they've already rebounded in this frame
+ if (!(this._vy <= 0 && this.velocity.y > 0) && !(this._vy >= 0 && this.velocity.y < 0))
+ {
+ this.velocity.y *= -this.bounce.y;
+ this.angle = Math.atan2(this.velocity.y, this.velocity.x);
+ }
+ }
+
+ if (this.bounce.y === 0 || Math.abs(this.velocity.y) < this.minVelocity.y)
+ {
+ var gy = this.getDownwardForce();
+
+ if (((this.blocked.up || this.touching.up) && (gy < 0 || this.velocity.y < 0)) || ((this.blocked.down || this.touching.down) && (gy > 0 || this.velocity.y > 0)))
+ {
+ this.velocity.y = 0;
+ }
+ }
+ }
+
+ },
+
+ /**
+ * Gets the total force being applied on the X axis, including gravity and velocity.
+ *
+ * @method Phaser.Physics.Arcade.Body#getUpwardForce
+ * @return {number} The total force being applied on the X axis.
+ */
+ getUpwardForce: function () {
+
+ if (this.allowGravity)
+ {
+ return this.gravity.x + this.game.physics.gravity.x + this.velocity.x;
+ }
+ else
+ {
+ return this.gravity.x + this.velocity.x;
+ }
+
+ },
+
+ /**
+ * Gets the total force being applied on the X axis, including gravity and velocity.
+ *
+ * @method Phaser.Physics.Arcade.Body#getDownwardForce
+ * @return {number} The total force being applied on the Y axis.
+ */
+ getDownwardForce: function () {
+
+ if (this.allowGravity)
+ {
+ return this.gravity.y + this.game.physics.gravity.y + this.velocity.y;
+ }
+ else
+ {
+ return this.gravity.y + this.velocity.y;
+ }
+
+ },
+
+ /**
+ * Subtracts the given Vector from this Body.
+ *
+ * @method Phaser.Physics.Arcade.Body#sub
+ * @protected
+ * @param {SAT.Vector} v - The vector to substract from this Body.
+ */
+ sub: function (v) {
+
+ this.x -= v.x;
+ this.y -= v.y;
+
+ },
+
+ /**
+ * Adds the given Vector to this Body.
+ *
+ * @method Phaser.Physics.Arcade.Body#add
+ * @protected
+ * @param {SAT.Vector} v - The vector to add to this Body.
+ */
+ add: function (v) {
+
+ this.x += v.x;
+ this.y += v.y;
+
+ },
+
+ /**
+ * Separation response handler.
+ *
+ * @method Phaser.Physics.Arcade.Body#give
+ * @protected
+ * @param {Phaser.Physics.Arcade.Body} body - The Body that collided.
+ * @param {SAT.Response} response - The SAT Response object containing the collision data.
+ */
+ give: function (body, response) {
+
+ this.add(response.overlapV);
+
+ if (this.rebound)
+ {
+ this.processRebound(body);
+ this.reboundCheck(true, true, false);
+ body.reboundCheck(true, true, false);
+ }
+
+ },
+
+ /**
+ * Separation response handler.
+ *
+ * @method Phaser.Physics.Arcade.Body#take
+ * @protected
+ * @param {Phaser.Physics.Arcade.Body} body - The Body that collided.
+ * @param {SAT.Response} response - The SAT Response object containing the collision data.
+ */
+ take: function (body, response) {
+
+ this.sub(response.overlapV);
+
+ if (this.rebound)
+ {
+ this.processRebound(body);
+ this.reboundCheck(true, true, false);
+ body.reboundCheck(true, true, false);
+ }
+
+ },
+
+ /**
+ * Split the collision response evenly between the two bodies.
+ *
+ * @method Phaser.Physics.Arcade.Body#split
+ * @protected
+ * @param {Phaser.Physics.Arcade.Body} body - The Body that collided.
+ * @param {SAT.Response} response - The SAT Response object containing the collision data.
+ */
+ split: function (body, response) {
+
+ response.overlapV.scale(0.5);
+ this.sub(response.overlapV);
+ body.add(response.overlapV);
+
+ if (this.rebound)
+ {
+ this.exchange(body);
+ this.reboundCheck(true, true, false);
+ body.reboundCheck(true, true, false);
+ }
+
+ },
+
+ /**
+ * Exchange velocity with the given Body.
+ *
+ * @method Phaser.Physics.Arcade.Body#exchange
+ * @protected
+ * @param {Phaser.Physics.Arcade.Body} body - The Body that collided.
+ */
+ exchange: function (body) {
+
+ if (this.mass === body.mass && this.speed > 0 && body.speed > 0)
+ {
+ // A direct velocity exchange (as they are both moving and have the same mass)
+ this._dx = body.velocity.x;
+ this._dy = body.velocity.y;
+
+ body.velocity.x = this.velocity.x * body.bounce.x;
+ body.velocity.y = this.velocity.y * body.bounce.x;
+
+ this.velocity.x = this._dx * this.bounce.x;
+ this.velocity.y = this._dy * this.bounce.y;
+ }
+ else
+ {
+ var nv1 = Math.sqrt((body.velocity.x * body.velocity.x * body.mass) / this.mass) * ((body.velocity.x > 0) ? 1 : -1);
+ var nv2 = Math.sqrt((this.velocity.x * this.velocity.x * this.mass) / body.mass) * ((this.velocity.x > 0) ? 1 : -1);
+ var average = (nv1 + nv2) * 0.5;
+ nv1 -= average;
+ nv2 -= average;
+
+ this.velocity.x = nv1;
+ body.velocity.x = nv2;
+
+ nv1 = Math.sqrt((body.velocity.y * body.velocity.y * body.mass) / this.mass) * ((body.velocity.y > 0) ? 1 : -1);
+ nv2 = Math.sqrt((this.velocity.y * this.velocity.y * this.mass) / body.mass) * ((this.velocity.y > 0) ? 1 : -1);
+ average = (nv1 + nv2) * 0.5;
+ nv1 -= average;
+ nv2 -= average;
+
+ this.velocity.y = nv1;
+ body.velocity.y = nv2;
+ }
+
+ // update speed / angle?
+
+ },
+
+ /**
+ * Rebound the velocity of this Body.
+ *
+ * @method Phaser.Physics.Arcade.Body#processRebound
+ * @protected
+ * @param {Phaser.Physics.Arcade.Body} body - The Body that collided.
+ */
+ processRebound: function (body) {
+
+ // Don't rebound again if they've already rebounded in this frame
+ if (!(this._vx <= 0 && this.velocity.x > 0) && !(this._vx >= 0 && this.velocity.x < 0))
+ {
+ this.velocity.x = body.velocity.x - this.velocity.x * this.bounce.x;
+ }
+
+ if (!(this._vy <= 0 && this.velocity.y > 0) && !(this._vy >= 0 && this.velocity.y < 0))
+ {
+ this.velocity.y = body.velocity.y - this.velocity.y * this.bounce.y;
+ }
+
+ this.angle = Math.atan2(this.velocity.y, this.velocity.x);
+
+ this.reboundCheck(true, true, false);
+
+ },
+
+ /**
+ * Checks for an overlap between this Body and the given Body.
+ *
+ * @method Phaser.Physics.Arcade.Body#overlap
+ * @param {Phaser.Physics.Arcade.Body} body - The Body that is being checked against this Body.
+ * @param {SAT.Response} response - SAT Response handler.
+ * @return {boolean} True if the two bodies overlap, otherwise false.
+ */
+ overlap: function (body, response) {
+
+ var result = false;
+
+ if ((this.type === Phaser.Physics.Arcade.RECT || this.type === Phaser.Physics.Arcade.POLYGON) && (body.type === Phaser.Physics.Arcade.RECT || body.type === Phaser.Physics.Arcade.POLYGON))
+ {
+ result = SAT.testPolygonPolygon(this.polygon, body.polygon, response);
+ }
+ else if (this.type === Phaser.Physics.Arcade.CIRCLE && body.type === Phaser.Physics.Arcade.CIRCLE)
+ {
+ result = SAT.testCircleCircle(this.shape, body.shape, response);
+ }
+ else if ((this.type === Phaser.Physics.Arcade.RECT || this.type === Phaser.Physics.Arcade.POLYGON) && body.type === Phaser.Physics.Arcade.CIRCLE)
+ {
+ result = SAT.testPolygonCircle(this.polygon, body.shape, response);
+ }
+ else if (this.type === Phaser.Physics.Arcade.CIRCLE && (body.type === Phaser.Physics.Arcade.RECT || body.type === Phaser.Physics.Arcade.POLYGON))
+ {
+ result = SAT.testCirclePolygon(this.shape, body.polygon, response);
+ }
+
+ if (!result)
+ {
+ this.removeContact(body);
+ }
+
+ return result;
+
+ },
+
+ /**
+ * Checks if this Body is already in contact with the given Body.
+ *
+ * @method Phaser.Physics.Arcade.Body#inContact
+ * @param {Phaser.Physics.Arcade.Body} body - The Body to be checked.
+ * @return {boolean} True if the given Body is already in contact with this Body.
+ */
+ inContact: function (body) {
+
+ return (this.contacts.indexOf(body) != -1);
+
+ },
+
+ /**
+ * Adds the given Body to the contact list of this Body. Also adds this Body to the contact list of the given Body.
+ *
+ * @method Phaser.Physics.Arcade.Body#addContact
+ * @param {Phaser.Physics.Arcade.Body} body - The Body to be added.
+ * @return {boolean} True if the given Body was added to this contact list, false if already on it.
+ */
+ addContact: function (body) {
+
+ if (this.inContact(body))
+ {
+ return false;
+ }
+
+ this.contacts.push(body);
+
+ this.sprite.events.onBeginContact.dispatch(this.sprite, body.sprite, this, body);
+
+ body.addContact(this);
+
+ return true;
+
+ },
+
+ /**
+ * Removes the given Body from the contact list of this Body. Also removes this Body from the contact list of the given Body.
+ *
+ * @method Phaser.Physics.Arcade.Body#removeContact
+ * @param {Phaser.Physics.Arcade.Body} body - The Body to be removed.
+ * @return {boolean} True if the given Body was removed from this contact list, false if wasn't on it.
+ */
+ removeContact: function (body) {
+
+ if (!this.inContact(body))
+ {
+ return false;
+ }
+
+ this.contacts.splice(this.contacts.indexOf(body), 1);
+
+ this.sprite.events.onEndContact.dispatch(this.sprite, body.sprite, this, body);
+
+ body.removeContact(this);
+
+ return true;
+
+ },
+
+ /**
+ * This separates this Body from the given Body unless a customSeparateCallback is set.
+ * It assumes they have already been overlap checked and the resulting overlap is stored in the SAT response.
+ *
+ * @method Phaser.Physics.Arcade.Body#separate
+ * @protected
+ * @param {Phaser.Physics.Arcade.Body} body - The Body to be separated from this one.
+ * @param {SAT.Response} response - SAT Response handler.
+ * @return {boolean} True if the bodies were separated, false if not (for example checkCollide allows them to pass through)
+ */
+ separate: function (body, response) {
+
+ if (this.inContact(body))
+ {
+ return false;
+ }
+
+ this._distances[0] = body.right - this.x; // Distance of B to face on left side of A
+ this._distances[1] = this.right - body.x; // Distance of B to face on right side of A
+ this._distances[2] = body.bottom - this.y; // Distance of B to face on bottom side of A
+ this._distances[3] = this.bottom - body.y; // Distance of B to face on top side of A
+
+ // If we've zero distance then check for side-slicing
+ if (response.overlapN.x && (this._distances[0] === 0 || this._distances[1] === 0))
+ {
+ response.overlapN.x = false;
+ response.overlapN.y = true;
+ }
+ else if (response.overlapN.y && (this._distances[2] === 0 || this._distances[3] === 0))
+ {
+ response.overlapN.x = true;
+ response.overlapN.y = false;
+ }
+
+ if (this.customSeparateCallback)
+ {
+ return this.customSeparateCallback.call(this.customSeparateContext, this, response, this._distances);
+ }
+
+ var hasSeparated = false;
+
+ if (response.overlapN.x)
+ {
+ // Which is smaller? Left or Right?
+ if (this._distances[0] < this._distances[1] && (body.checkCollision.right || this.checkCollision.left))
+ {
+ hasSeparated = this.hitLeft(body, response);
+ }
+ else if (this._distances[1] < this._distances[0] && (body.checkCollision.left || this.checkCollision.right))
+ {
+ hasSeparated = this.hitRight(body, response);
+ }
+ }
+ else if (response.overlapN.y)
+ {
+ // Which is smaller? Top or Bottom?
+ if (this._distances[2] < this._distances[3] && (body.checkCollision.down || this.checkCollision.up))
+ {
+ hasSeparated = this.hitTop(body, response);
+ }
+ else if (this._distances[3] < this._distances[2] && (body.checkCollision.up || this.checkCollision.down))
+ {
+ hasSeparated = this.hitBottom(body, response);
+ }
+ }
+
+ if (hasSeparated)
+ {
+ this.game.physics.checkBounds(this);
+ this.game.physics.checkBounds(body);
+ }
+ else
+ {
+ // They can only contact like this if at least one of their sides is open, otherwise it's a separation
+ if (!this.checkCollision.up || !this.checkCollision.down || !this.checkCollision.left || !this.checkCollision.right || !body.checkCollision.up || !body.checkCollision.down || !body.checkCollision.left || !body.checkCollision.right)
+ {
+ this.addContact(body);
+ }
+ }
+
+ return hasSeparated;
+
+ },
+
+ /**
+ * Process a collision with the left face of this Body.
+ * Collision and separation can be further checked by setting a collideCallback.
+ * This callback will be sent 4 parameters: The face of collision, this Body, the colliding Body and the SAT Response.
+ * If the callback returns true then separation, rebounds and the touching flags will all be set.
+ * If it returns false this will be skipped and must be handled manually.
+ *
+ * @method Phaser.Physics.Arcade.Body#hitLeft
+ * @protected
+ * @param {Phaser.Physics.Arcade.Body} body - The Body that collided.
+ * @param {SAT.Response} response - The SAT Response object containing the collision data.
+ */
+ hitLeft: function (body, response) {
+
+ if (this.collideCallback && !this.collideCallback.call(this.collideCallbackContext, Phaser.LEFT, this, body, response))
+ {
+ return;
+ }
+
+ if (!this.moves || this.immovable || this.blocked.right || this.touching.right)
+ {
+ body.give(this, response);
+ }
+ else
+ {
+ if (body.immovable || body.blocked.left || body.touching.left)
+ {
+ // We take the full separation
+ this.take(body, response);
+ }
+ else
+ {
+ // Share out the separation
+ this.split(body, response);
+ }
+ }
+
+ this.touching.left = true;
+ body.touching.right = true;
+
+ },
+
+ /**
+ * Process a collision with the right face of this Body.
+ * Collision and separation can be further checked by setting a collideCallback.
+ * This callback will be sent 4 parameters: The face of collision, this Body, the colliding Body and the SAT Response.
+ * If the callback returns true then separation, rebounds and the touching flags will all be set.
+ * If it returns false this will be skipped and must be handled manually.
+ *
+ * @method Phaser.Physics.Arcade.Body#hitRight
+ * @protected
+ * @param {Phaser.Physics.Arcade.Body} body - The Body that collided.
+ * @param {SAT.Response} response - The SAT Response object containing the collision data.
+ */
+ hitRight: function (body, response) {
+
+ if (this.collideCallback && !this.collideCallback.call(this.collideCallbackContext, Phaser.RIGHT, this, body))
+ {
+ return;
+ }
+
+ if (!this.moves || this.immovable || this.blocked.left || this.touching.left)
+ {
+ body.give(this, response);
+ }
+ else
+ {
+ if (body.immovable || body.blocked.right || body.touching.right)
+ {
+ // We take the full separation
+ this.take(body, response);
+ }
+ else
+ {
+ // Share out the separation
+ this.split(body, response);
+ }
+ }
+
+ this.touching.right = true;
+ body.touching.left = true;
+
+ },
+
+ /**
+ * Process a collision with the top face of this Body.
+ * Collision and separation can be further checked by setting a collideCallback.
+ * This callback will be sent 4 parameters: The face of collision, this Body, the colliding Body and the SAT Response.
+ * If the callback returns true then separation, rebounds and the touching flags will all be set.
+ * If it returns false this will be skipped and must be handled manually.
+ *
+ * @method Phaser.Physics.Arcade.Body#hitTop
+ * @protected
+ * @param {Phaser.Physics.Arcade.Body} body - The Body that collided.
+ * @param {SAT.Response} response - The SAT Response object containing the collision data.
+ */
+ hitTop: function (body, response) {
+
+ if (this.collideCallback && !this.collideCallback.call(this.collideCallbackContext, Phaser.UP, this, body))
+ {
+ return false;
+ }
+
+ if (!this.moves || this.immovable || this.blocked.down || this.touching.down)
+ {
+ body.give(this, response);
+ }
+ else
+ {
+ if (body.immovable || body.blocked.up || body.touching.up)
+ {
+ // We take the full separation
+ this.take(body, response);
+ }
+ else
+ {
+ // Share out the separation
+ this.split(body, response);
+ }
+ }
+
+ this.touching.up = true;
+ body.touching.down = true;
+
+ return true;
+
+ },
+
+ /**
+ * Process a collision with the bottom face of this Body.
+ * Collision and separation can be further checked by setting a collideCallback.
+ * This callback will be sent 4 parameters: The face of collision, this Body, the colliding Body and the SAT Response.
+ * If the callback returns true then separation, rebounds and the touching flags will all be set.
+ * If it returns false this will be skipped and must be handled manually.
+ *
+ * @method Phaser.Physics.Arcade.Body#hitBottom
+ * @protected
+ * @param {Phaser.Physics.Arcade.Body} body - The Body that collided.
+ * @param {SAT.Response} response - The SAT Response object containing the collision data.
+ */
+ hitBottom: function (body, response) {
+
+ if (this.collideCallback && !this.collideCallback.call(this.collideCallbackContext, Phaser.DOWN, this, body))
+ {
+ return false;
+ }
+
+ if (!this.moves || this.immovable || this.blocked.up || this.touching.up)
+ {
+ body.give(this, response);
+ }
+ else
+ {
+ if (body.immovable || body.blocked.down || body.touching.down)
+ {
+ // We take the full separation
+ this.take(body, response);
+ }
+ else
+ {
+ // Share out the separation
+ this.split(body, response);
+ }
+ }
+
+ this.touching.down = true;
+ body.touching.up = true;
+
+ return true;
+
+ },
+
+ /**
+ * Internal method. Integrates velocity, global gravity and the delta timer.
+ *
+ * @method Phaser.Physics.Arcade.Body#integrateVelocity
+ * @protected
+ */
+ integrateVelocity: function () {
+
+ this._temp = this.game.physics.updateMotion(this);
+ this._dx = this.game.time.physicsElapsed * (this.velocity.x + this._temp.x / 2);
+ this._dy = this.game.time.physicsElapsed * (this.velocity.y + this._temp.y / 2);
+
+ // positive = RIGHT / DOWN
+ // negative = LEFT / UP
+
+ if ((this._dx < 0 && !this.blocked.left && !this.touching.left) || (this._dx > 0 && !this.blocked.right && !this.touching.right))
+ {
+ this.x += this._dx;
+ this.velocity.x += this._temp.x;
+ }
+
+ if ((this._dy < 0 && !this.blocked.up && !this.touching.up) || (this._dy > 0 && !this.blocked.down && !this.touching.down))
+ {
+ this.y += this._dy;
+ this.velocity.y += this._temp.y;
+ }
+
+ if (this.velocity.x > this.maxVelocity.x)
+ {
+ this.velocity.x = this.maxVelocity.x;
+ }
+ else if (this.velocity.x < -this.maxVelocity.x)
+ {
+ this.velocity.x = -this.maxVelocity.x;
+ }
+
+ if (this.velocity.y > this.maxVelocity.y)
+ {
+ this.velocity.y = this.maxVelocity.y;
+ }
+ else if (this.velocity.y < -this.maxVelocity.y)
+ {
+ this.velocity.y = -this.maxVelocity.y;
+ }
+
+ },
+
+ /**
+ * Internal method. This is called directly before the sprites are sent to the renderer and after the update function has finished.
+ *
+ * @method Phaser.Physics.Arcade.Body#postUpdate
* @protected
*/
postUpdate: function () {
- if (this.deltaX() < 0)
+ if (this.moves)
{
- this.facing = Phaser.LEFT;
- }
- else if (this.deltaX() > 0)
- {
- this.facing = Phaser.RIGHT;
- }
+ this.reboundCheck(true, true, true);
- if (this.deltaY() < 0)
- {
- this.facing = Phaser.UP;
- }
- else if (this.deltaY() > 0)
- {
- this.facing = Phaser.DOWN;
- }
+ this.game.physics.checkBounds(this);
- if (this.deltaX() !== 0 || this.deltaY() !== 0)
- {
- this.sprite.x += this.deltaX();
- this.sprite.y += this.deltaY();
- this.center.setTo(this.x + this.halfWidth, this.y + this.halfHeight);
- }
+ this._dx = this.deltaX();
+ this._dy = this.deltaY();
+
+ if (this._dx < 0)
+ {
+ this.facing = Phaser.LEFT;
+ }
+ else if (this._dx > 0)
+ {
+ this.facing = Phaser.RIGHT;
+ }
+
+ if (this._dy < 0)
+ {
+ this.facing = Phaser.UP;
+ }
+ else if (this._dy > 0)
+ {
+ this.facing = Phaser.DOWN;
+ }
+
+ if (this._dx !== 0 || this._dy !== 0)
+ {
+ this.sprite.x += this._dx;
+ this.sprite.y += this._dy;
+ }
+
+ if (this.allowRotation && this.deltaZ() !== 0)
+ {
+ this.sprite.angle += this.deltaZ();
+ }
+
+ if (this.sprite.scale.x !== this._sx || this.sprite.scale.y !== this._sy)
+ {
+ this.updateScale();
+ }
- if (this.allowRotation)
- {
- this.sprite.angle += this.deltaZ();
}
},
/**
- * Internal method.
+ * Resets the Body motion values: velocity, acceleration, angularVelocity and angularAcceleration.
+ * Also resets the forces to defaults: gravity, bounce, minVelocity,maxVelocity, angularDrag, maxAngular, mass, friction and checkCollision if 'full' specified.
*
- * @method Phaser.Physics.Arcade#updateHulls
- * @protected
+ * @method Phaser.Physics.Arcade.Body#reset
+ * @param {boolean} [full=false] - A full reset clears down settings you may have set, such as gravity, bounce and drag. A non-full reset just clears motion values.
*/
- updateHulls: function () {
+ reset: function (full) {
- this.hullX.setTo(this.x, this.preY, this.width, this.height);
- this.hullY.setTo(this.preX, this.y, this.width, this.height);
+ if (typeof full === 'undefined') { full = false; }
- },
-
- /**
- * Internal method.
- *
- * @method Phaser.Physics.Arcade#checkWorldBounds
- * @protected
- */
- checkWorldBounds: function () {
-
- if (this.x < this.game.world.bounds.x)
+ if (full)
{
- this.x = this.game.world.bounds.x;
- this.velocity.x *= -this.bounce.x;
+ this.gravity.setTo(0, 0);
+ this.bounce.setTo(0, 0);
+ this.minVelocity.setTo(5, 5);
+ this.maxVelocity.setTo(1000, 1000);
+ this.angularDrag = 0;
+ this.maxAngular = 1000;
+ this.mass = 1;
+ this.friction = 0.0;
+ this.checkCollision = { none: false, any: true, up: true, down: true, left: true, right: true };
}
- else if (this.right > this.game.world.bounds.right)
- {
- this.x = this.game.world.bounds.right - this.width;
- this.velocity.x *= -this.bounce.x;
- }
-
- if (this.y < this.game.world.bounds.y)
- {
- this.y = this.game.world.bounds.y;
- this.velocity.y *= -this.bounce.y;
- }
- else if (this.bottom > this.game.world.bounds.bottom)
- {
- this.y = this.game.world.bounds.bottom - this.height;
- this.velocity.y *= -this.bounce.y;
- }
-
- },
-
- /**
- * You can modify the size of the physics Body to be any dimension you need.
- * So it could be smaller or larger than the parent Sprite. You can also control the x and y offset, which
- * is the position of the Body relative to the top-left of the Sprite.
- *
- * @method Phaser.Physics.Arcade#setSize
- * @param {number} width - The width of the Body.
- * @param {number} height - The height of the Body.
- * @param {number} offsetX - The X offset of the Body from the Sprite position.
- * @param {number} offsetY - The Y offset of the Body from the Sprite position.
- */
- setSize: function (width, height, offsetX, offsetY) {
-
- offsetX = offsetX || this.offset.x;
- offsetY = offsetY || this.offset.y;
-
- this.sourceWidth = width;
- this.sourceHeight = height;
- this.width = this.sourceWidth * this._sx;
- this.height = this.sourceHeight * this._sy;
- this.halfWidth = Math.floor(this.width / 2);
- this.halfHeight = Math.floor(this.height / 2);
- this.offset.setTo(offsetX, offsetY);
-
- this.center.setTo(this.x + this.halfWidth, this.y + this.halfHeight);
-
- },
-
- /**
- * Resets all Body values (velocity, acceleration, rotation, etc)
- *
- * @method Phaser.Physics.Arcade#reset
- */
- reset: function () {
this.velocity.setTo(0, 0);
this.acceleration.setTo(0, 0);
-
this.angularVelocity = 0;
this.angularAcceleration = 0;
- this.preX = (this.sprite.world.x - (this.sprite.anchor.x * this.width)) + this.offset.x;
- this.preY = (this.sprite.world.y - (this.sprite.anchor.y * this.height)) + this.offset.y;
- this.preRotation = this.sprite.angle;
+ this.blocked = { x: 0, y: 0, up: false, down: false, left: false, right: false };
+ this.x = (this.sprite.world.x - (this.sprite.anchor.x * this.sprite.width)) + this.offset.x;
+ this.y = (this.sprite.world.y - (this.sprite.anchor.y * this.sprite.height)) + this.offset.y;
+ this.preX = this.x;
+ this.preY = this.y;
+ this.updateBounds();
- this.x = this.preX;
- this.y = this.preY;
- this.rotation = this.preRotation;
-
- this.center.setTo(this.x + this.halfWidth, this.y + this.halfHeight);
+ this.contacts.length = 0;
},
/**
- * Returns the absolute delta x value.
+ * Destroys this Body and all references it holds to other objects.
*
- * @method Phaser.Physics.Arcade.Body#deltaAbsX
- * @return {number} The absolute delta value.
+ * @method Phaser.Physics.Arcade.Body#destroy
*/
- deltaAbsX: function () {
- return (this.deltaX() > 0 ? this.deltaX() : -this.deltaX());
+ destroy: function () {
+
+ this.sprite = null;
+
+ this.collideCallback = null;
+ this.collideCallbackContext = null;
+
+ this.customSeparateCallback = null;
+ this.customSeparateContext = null;
+
+ this.contacts.length = 0;
+
},
/**
- * Returns the absolute delta y value.
+ * Sets this Body to use a circle of the given radius for all collision.
+ * The Circle will be centered on the center of the Sprite by default, but can be adjusted via the Body.offset property and the setCircle x/y parameters.
*
- * @method Phaser.Physics.Arcade.Body#deltaAbsY
- * @return {number} The absolute delta value.
+ * @method Phaser.Physics.Arcade.Body#setCircle
+ * @param {number} radius - The radius of this circle (in pixels)
+ * @param {number} [offsetX=0] - The x amount the circle will be offset from the Sprites center.
+ * @param {number} [offsetY=0] - The y amount the circle will be offset from the Sprites center.
*/
- deltaAbsY: function () {
- return (this.deltaY() > 0 ? this.deltaY() : -this.deltaY());
+ setCircle: function (radius, offsetX, offsetY) {
+
+ if (typeof offsetX === 'undefined') { offsetX = this.sprite._cache.halfWidth; }
+ if (typeof offsetY === 'undefined') { offsetY = this.sprite._cache.halfHeight; }
+
+ this.type = Phaser.Physics.Arcade.CIRCLE;
+ this.shape = new SAT.Circle(new SAT.Vector(this.sprite.x, this.sprite.y), radius);
+ this.polygon = null;
+
+ this.offset.setTo(offsetX, offsetY);
+
},
/**
- * Returns the delta x value. The difference between Body.x now and in the previous step.
+ * Sets this Body to use a rectangle for all collision.
+ * If you don't specify any parameters it will be sized to match the parent Sprites current width and height (including scale factor) and centered on the sprite.
+ *
+ * @method Phaser.Physics.Arcade.Body#setRectangle
+ * @param {number} [width] - The width of the rectangle. If not specified it will default to the width of the parent Sprite.
+ * @param {number} [height] - The height of the rectangle. If not specified it will default to the height of the parent Sprite.
+ * @param {number} [translateX] - The x amount the rectangle will be translated from the Sprites center.
+ * @param {number} [translateY] - The y amount the rectangle will be translated from the Sprites center.
+ */
+ setRectangle: function (width, height, translateX, translateY) {
+
+ if (typeof width === 'undefined') { width = this.sprite.width; }
+ if (typeof height === 'undefined') { height = this.sprite.height; }
+ if (typeof translateX === 'undefined') { translateX = -this.sprite._cache.halfWidth; }
+ if (typeof translateY === 'undefined') { translateY = -this.sprite._cache.halfHeight; }
+
+ this.type = Phaser.Physics.Arcade.RECT;
+ this.shape = new SAT.Box(new SAT.Vector(this.sprite.world.x, this.sprite.world.y), width, height);
+ this.polygon = this.shape.toPolygon();
+ this.polygon.translate(translateX, translateY);
+
+ this.offset.setTo(0, 0);
+
+ },
+
+ /**
+ * Sets this Body to use a convex polygon for collision.
+ * The points are specified in a counter-clockwise direction and must create a convex polygon.
+ * Use Body.translate and/or Body.offset to re-position the polygon from the Sprite origin.
+ *
+ * @method Phaser.Physics.Arcade.Body#setPolygon
+ * @param {(SAT.Vector[]|number[]|...SAT.Vector|...number)} points - This can be an array of Vectors that form the polygon,
+ * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be
+ * all the points of the polygon e.g. `setPolygon(new SAT.Vector(), new SAT.Vector(), ...)`, or the
+ * arguments passed can be flat x,y values e.g. `setPolygon(x,y, x,y, x,y, ...)` where `x` and `y` are Numbers.
+ */
+ setPolygon: function (points) {
+
+ this.type = Phaser.Physics.Arcade.POLYGON;
+ this.shape = null;
+
+ if (!Array.isArray(points))
+ {
+ points = Array.prototype.slice.call(arguments);
+ }
+
+ if (typeof points[0] === 'number')
+ {
+ var p = [];
+
+ for (var i = 0, len = points.length; i < len; i += 2)
+ {
+ p.push(new SAT.Vector(points[i], points[i + 1]));
+ }
+
+ points = p;
+ }
+
+ this.polygon = new SAT.Polygon(new SAT.Vector(this.sprite.center.x, this.sprite.center.y), points);
+
+ this.offset.setTo(0, 0);
+
+ },
+
+ /**
+ * Used for translating rectangle and polygon bodies from the Sprite parent. Doesn't apply to Circles.
+ * See also the Body.offset property.
+ *
+ * @method Phaser.Physics.Arcade.Body#translate
+ * @param {number} x - The x amount the polygon or rectangle will be translated by from the Sprite.
+ * @param {number} y - The y amount the polygon or rectangle will be translated by from the Sprite.
+ */
+ translate: function (x, y) {
+
+ if (this.polygon)
+ {
+ this.polygon.translate(x, y);
+ }
+
+ },
+
+ /**
+ * Determines if this Body is 'on the floor', which means in contact with a Tile or World bounds, or other object that has set 'down' as blocked.
+ *
+ * @method Phaser.Physics.Arcade.Body#onFloor
+ * @return {boolean} True if this Body is 'on the floor', which means in contact with a Tile or World bounds, or object that has set 'down' as blocked.
+ */
+ onFloor: function () {
+ return this.blocked.down;
+ },
+
+ /**
+ * Determins if this Body is 'on a wall', which means horizontally in contact with a Tile or World bounds, or other object but not the ground.
+ *
+ * @method Phaser.Physics.Arcade.Body#onWall
+ * @return {boolean} True if this Body is 'on a wall', which means horizontally in contact with a Tile or World bounds, or other object but not the ground.
+ */
+ onWall: function () {
+ return (!this.blocked.down && (this.blocked.left || this.blocked.right));
+ },
+
+ /**
+ * Returns the delta x value. The amount the Body has moved horizontally in the current step.
*
* @method Phaser.Physics.Arcade.Body#deltaX
- * @return {number} The delta value.
+ * @return {number} The delta value. Positive if the motion was to the right, negative if to the left.
*/
deltaX: function () {
return this.x - this.preX;
},
/**
- * Returns the delta y value. The difference between Body.y now and in the previous step.
+ * Returns the delta y value. The amount the Body has moved vertically in the current step.
*
* @method Phaser.Physics.Arcade.Body#deltaY
- * @return {number} The delta value.
+ * @return {number} The delta value. Positive if the motion was downwards, negative if upwards.
*/
deltaY: function () {
return this.y - this.preY;
},
+ /**
+ * Returns the delta z value. The amount the Body has rotated in the current step.
+ *
+ * @method Phaser.Physics.Arcade.Body#deltaZ
+ * @return {number} The delta value.
+ */
deltaZ: function () {
return this.rotation - this.preRotation;
}
};
+Phaser.Physics.Arcade.Body.prototype.constructor = Phaser.Physics.Arcade.Body;
+
/**
-* @name Phaser.Physics.Arcade.Body#bottom
-* @property {number} bottom - The bottom value of this Body (same as Body.y + Body.height)
+* @name Phaser.Physics.Arcade.Body#x
+* @property {number} x - The x coordinate of this Body.
*/
-Object.defineProperty(Phaser.Physics.Arcade.Body.prototype, "bottom", {
+Object.defineProperty(Phaser.Physics.Arcade.Body.prototype, "x", {
- /**
- * The sum of the y and height properties. Changing the bottom property of a Rectangle object has no effect on the x, y and width properties, but does change the height property.
- * @method bottom
- * @return {number}
- */
get: function () {
- return this.y + this.height;
- },
-
- /**
- * The sum of the y and height properties. Changing the bottom property of a Rectangle object has no effect on the x, y and width properties, but does change the height property.
- * @method bottom
- * @param {number} value
- */
- set: function (value) {
-
- if (value <= this.y)
+
+ if (this.type === Phaser.Physics.Arcade.CIRCLE)
{
- this.height = 0;
+ return this.shape.pos.x;
}
else
{
- this.height = (this.y - value);
+ return this.polygon.pos.x;
}
-
+
+ },
+
+ set: function (value) {
+
+ if (this.type === Phaser.Physics.Arcade.CIRCLE)
+ {
+ this.shape.pos.x = value;
+ }
+ else
+ {
+ this.polygon.pos.x = value;
+ }
+
}
});
/**
-* @name Phaser.Physics.Arcade.Body#right
-* @property {number} right - The right value of this Body (same as Body.x + Body.width)
+* @name Phaser.Physics.Arcade.Body#y
+* @property {number} y - The y coordinate of this Body.
*/
-Object.defineProperty(Phaser.Physics.Arcade.Body.prototype, "right", {
+Object.defineProperty(Phaser.Physics.Arcade.Body.prototype, "y", {
- /**
- * The sum of the x and width properties. Changing the right property of a Rectangle object has no effect on the x, y and height properties.
- * However it does affect the width property.
- * @method right
- * @return {number}
- */
get: function () {
- return this.x + this.width;
- },
-
- /**
- * The sum of the x and width properties. Changing the right property of a Rectangle object has no effect on the x, y and height properties.
- * However it does affect the width property.
- * @method right
- * @param {number} value
- */
- set: function (value) {
-
- if (value <= this.x)
+
+ if (this.type === Phaser.Physics.Arcade.CIRCLE)
{
- this.width = 0;
+ return this.shape.pos.y;
}
else
{
- this.width = this.x + value;
+ return this.polygon.pos.y;
+ }
+
+ },
+
+ set: function (value) {
+
+ if (this.type === Phaser.Physics.Arcade.CIRCLE)
+ {
+ this.shape.pos.y = value;
+ }
+ else
+ {
+ this.polygon.pos.y = value;
}
}
@@ -1081,13 +1948,13 @@ Object.defineProperty(Phaser.Physics.Arcade.Body.prototype, "right", {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Button.js.html b/docs/Button.js.html
index fcdbc0b0..50feb1cd 100644
--- a/docs/Button.js.html
+++ b/docs/Button.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -442,16 +436,17 @@
* @constructor
*
* @param {Phaser.Game} game Current game instance.
-* @param {number} [x] - X position of the Button.
-* @param {number} [y] - Y position of the Button.
+* @param {number} [x=0] - X position of the Button.
+* @param {number} [y=0] - Y position of the Button.
* @param {string} [key] - The image key as defined in the Game.Cache to use as the texture for this Button.
* @param {function} [callback] - The function to call when this Button is pressed.
* @param {object} [callbackContext] - The context in which the callback will be called (usually 'this').
* @param {string|number} [overFrame] - This is the frame or frameName that will be set when this button is in an over state. Give either a number to use a frame ID or a string for a frame name.
* @param {string|number} [outFrame] - This is the frame or frameName that will be set when this button is in an out state. Give either a number to use a frame ID or a string for a frame name.
* @param {string|number} [downFrame] - This is the frame or frameName that will be set when this button is in a down state. Give either a number to use a frame ID or a string for a frame name.
+* @param {string|number} [upFrame] - This is the frame or frameName that will be set when this button is in an up state. Give either a number to use a frame ID or a string for a frame name.
*/
-Phaser.Button = function (game, x, y, key, callback, callbackContext, overFrame, outFrame, downFrame) {
+Phaser.Button = function (game, x, y, key, callback, callbackContext, overFrame, outFrame, downFrame, upFrame) {
x = x || 0;
y = y || 0;
@@ -486,7 +481,7 @@ Phaser.Button = function (game, x, y, key, callback, callbackContext, overFrame,
* @default
*/
this._onDownFrameName = null;
-
+
/**
* @property {string} _onUpFrameName - Internal variable.
* @private
@@ -514,7 +509,7 @@ Phaser.Button = function (game, x, y, key, callback, callbackContext, overFrame,
* @default
*/
this._onDownFrameID = null;
-
+
/**
* @property {number} _onUpFrameID - Internal variable.
* @private
@@ -596,13 +591,13 @@ Phaser.Button = function (game, x, y, key, callback, callbackContext, overFrame,
this.freezeFrames = false;
/**
- * When the Button is clicked you can optionally force the state to "out".
+ * When the Button is touched / clicked and then released you can force it to enter a state of "out" instead of "up".
* @property {boolean} forceOut
* @default
*/
- this.forceOut = true;
+ this.forceOut = false;
- this.setFrames(overFrame, outFrame, downFrame);
+ this.setFrames(overFrame, outFrame, downFrame, upFrame);
if (callback !== null)
{
@@ -624,15 +619,38 @@ Phaser.Button.prototype = Phaser.Utils.extend(true, Phaser.Button.prototype, Pha
Phaser.Button.prototype.constructor = Phaser.Button;
/**
-* Used to manually set the frames that will be used for the different states of the button
-* exactly like setting them in the constructor.
+* Clears all of the frames set on this Button.
+*
+* @method Phaser.Button.prototype.clearFrames
+*/
+Phaser.Button.prototype.clearFrames = function () {
+
+ this._onOverFrameName = null;
+ this._onOverFrameID = null;
+
+ this._onOutFrameName = null;
+ this._onOutFrameID = null;
+
+ this._onDownFrameName = null;
+ this._onDownFrameID = null;
+
+ this._onUpFrameName = null;
+ this._onUpFrameID = null;
+
+}
+
+/**
+* Used to manually set the frames that will be used for the different states of the Button.
*
* @method Phaser.Button.prototype.setFrames
* @param {string|number} [overFrame] - This is the frame or frameName that will be set when this button is in an over state. Give either a number to use a frame ID or a string for a frame name.
* @param {string|number} [outFrame] - This is the frame or frameName that will be set when this button is in an out state. Give either a number to use a frame ID or a string for a frame name.
* @param {string|number} [downFrame] - This is the frame or frameName that will be set when this button is in a down state. Give either a number to use a frame ID or a string for a frame name.
+* @param {string|number} [upFrame] - This is the frame or frameName that will be set when this button is in an up state. Give either a number to use a frame ID or a string for a frame name.
*/
-Phaser.Button.prototype.setFrames = function (overFrame, outFrame, downFrame) {
+Phaser.Button.prototype.setFrames = function (overFrame, outFrame, downFrame, upFrame) {
+
+ this.clearFrames();
if (overFrame !== null)
{
@@ -661,7 +679,6 @@ Phaser.Button.prototype.setFrames = function (overFrame, outFrame, downFrame) {
if (typeof outFrame === 'string')
{
this._onOutFrameName = outFrame;
- this._onUpFrameName = outFrame;
if (this.input.pointerOver() === false)
{
@@ -671,7 +688,6 @@ Phaser.Button.prototype.setFrames = function (overFrame, outFrame, downFrame) {
else
{
this._onOutFrameID = outFrame;
- this._onUpFrameID = outFrame;
if (this.input.pointerOver() === false)
{
@@ -702,6 +718,28 @@ Phaser.Button.prototype.setFrames = function (overFrame, outFrame, downFrame) {
}
}
+ if (upFrame !== null)
+ {
+ if (typeof upFrame === 'string')
+ {
+ this._onUpFrameName = upFrame;
+
+ if (this.input.pointerUp())
+ {
+ this.frameName = upFrame;
+ }
+ }
+ else
+ {
+ this._onUpFrameID = upFrame;
+
+ if (this.input.pointerUp())
+ {
+ this.frame = upFrame;
+ }
+ }
+ }
+
};
/**
@@ -723,8 +761,8 @@ Phaser.Button.prototype.setSounds = function (overSound, overMarker, downSound,
this.setOverSound(overSound, overMarker);
this.setOutSound(outSound, outMarker);
- this.setUpSound(upSound, upMarker);
this.setDownSound(downSound, downMarker);
+ this.setUpSound(upSound, upMarker);
}
@@ -777,31 +815,7 @@ Phaser.Button.prototype.setOutSound = function (sound, marker) {
}
/**
-* The Sound to be played when a Pointer clicks on this Button.
-*
-* @method Phaser.Button.prototype.setUpSound
-* @param {Phaser.Sound} sound - The Sound that will be played.
-* @param {string} [marker] - A Sound Marker that will be used in the playback.
-*/
-Phaser.Button.prototype.setUpSound = function (sound, marker) {
-
- this.onUpSound = null;
- this.onUpSoundMarker = '';
-
- if (sound instanceof Phaser.Sound)
- {
- this.onUpSound = sound;
- }
-
- if (typeof marker === 'string')
- {
- this.onUpSoundMarker = marker;
- }
-
-}
-
-/**
-* The Sound to be played when a Pointer clicks on this Button.
+* The Sound to be played when a Pointer presses down on this Button.
*
* @method Phaser.Button.prototype.setDownSound
* @param {Phaser.Sound} sound - The Sound that will be played.
@@ -824,25 +838,43 @@ Phaser.Button.prototype.setDownSound = function (sound, marker) {
}
+/**
+* The Sound to be played when a Pointer has pressed down and is released from this Button.
+*
+* @method Phaser.Button.prototype.setUpSound
+* @param {Phaser.Sound} sound - The Sound that will be played.
+* @param {string} [marker] - A Sound Marker that will be used in the playback.
+*/
+Phaser.Button.prototype.setUpSound = function (sound, marker) {
+
+ this.onUpSound = null;
+ this.onUpSoundMarker = '';
+
+ if (sound instanceof Phaser.Sound)
+ {
+ this.onUpSound = sound;
+ }
+
+ if (typeof marker === 'string')
+ {
+ this.onUpSoundMarker = marker;
+ }
+
+}
+
/**
* Internal function that handles input events.
*
* @protected
* @method Phaser.Button.prototype.onInputOverHandler
+* @param {Phaser.Button} sprite - The Button that the event occured on.
* @param {Phaser.Pointer} pointer - The Pointer that activated the Button.
*/
-Phaser.Button.prototype.onInputOverHandler = function (pointer) {
+Phaser.Button.prototype.onInputOverHandler = function (sprite, pointer) {
if (this.freezeFrames === false)
{
- if (this._onOverFrameName != null)
- {
- this.frameName = this._onOverFrameName;
- }
- else if (this._onOverFrameID != null)
- {
- this.frame = this._onOverFrameID;
- }
+ this.setState(1);
}
if (this.onOverSound)
@@ -861,20 +893,14 @@ Phaser.Button.prototype.onInputOverHandler = function (pointer) {
*
* @protected
* @method Phaser.Button.prototype.onInputOverHandler
+* @param {Phaser.Button} sprite - The Button that the event occured on.
* @param {Phaser.Pointer} pointer - The Pointer that activated the Button.
*/
-Phaser.Button.prototype.onInputOutHandler = function (pointer) {
+Phaser.Button.prototype.onInputOutHandler = function (sprite, pointer) {
if (this.freezeFrames === false)
{
- if (this._onOutFrameName != null)
- {
- this.frameName = this._onOutFrameName;
- }
- else if (this._onOutFrameID != null)
- {
- this.frame = this._onOutFrameID;
- }
+ this.setState(2);
}
if (this.onOutSound)
@@ -893,20 +919,14 @@ Phaser.Button.prototype.onInputOutHandler = function (pointer) {
*
* @protected
* @method Phaser.Button.prototype.onInputOverHandler
+* @param {Phaser.Button} sprite - The Button that the event occured on.
* @param {Phaser.Pointer} pointer - The Pointer that activated the Button.
*/
-Phaser.Button.prototype.onInputDownHandler = function (pointer) {
+Phaser.Button.prototype.onInputDownHandler = function (sprite, pointer) {
if (this.freezeFrames === false)
{
- if (this._onDownFrameName != null)
- {
- this.frameName = this._onDownFrameName;
- }
- else if (this._onDownFrameID != null)
- {
- this.frame = this._onDownFrameID;
- }
+ this.setState(3);
}
if (this.onDownSound)
@@ -925,29 +945,76 @@ Phaser.Button.prototype.onInputDownHandler = function (pointer) {
*
* @protected
* @method Phaser.Button.prototype.onInputOverHandler
+* @param {Phaser.Button} sprite - The Button that the event occured on.
* @param {Phaser.Pointer} pointer - The Pointer that activated the Button.
*/
-Phaser.Button.prototype.onInputUpHandler = function (pointer) {
-
- if (this.freezeFrames === false)
- {
- if (this._onUpFrameName != null)
- {
- this.frameName = this._onUpFrameName;
- }
- else if (this._onUpFrameID != null)
- {
- this.frame = this._onUpFrameID;
- }
- }
+Phaser.Button.prototype.onInputUpHandler = function (sprite, pointer, isOver) {
if (this.onUpSound)
{
this.onUpSound.play(this.onUpSoundMarker);
}
- if (this.forceOut && this.freezeFrames === false)
+ if (this.onInputUp)
{
+ this.onInputUp.dispatch(this, pointer, isOver);
+ }
+
+ if (this.freezeFrames)
+ {
+ return;
+ }
+
+ if (this.forceOut)
+ {
+ // Button should be forced to the Out frame when released.
+ this.setState(2);
+ }
+ else
+ {
+ if (this._onUpFrameName || this._onUpFrameID)
+ {
+ this.setState(4);
+ }
+ else
+ {
+ if (isOver)
+ {
+ this.setState(1);
+ }
+ else
+ {
+ this.setState(2);
+ }
+ }
+ }
+
+};
+
+/**
+* Internal function that handles Button state changes.
+*
+* @protected
+* @method Phaser.Button.prototype.setState
+* @param {number} newState - The new State of the Button.
+*/
+Phaser.Button.prototype.setState = function (newState) {
+
+ if (newState === 1)
+ {
+ // Over
+ if (this._onOverFrameName != null)
+ {
+ this.frameName = this._onOverFrameName;
+ }
+ else if (this._onOverFrameID != null)
+ {
+ this.frame = this._onOverFrameID;
+ }
+ }
+ else if (newState === 2)
+ {
+ // Out
if (this._onOutFrameName != null)
{
this.frameName = this._onOutFrameName;
@@ -957,10 +1024,29 @@ Phaser.Button.prototype.onInputUpHandler = function (pointer) {
this.frame = this._onOutFrameID;
}
}
-
- if (this.onInputUp)
+ else if (newState === 3)
{
- this.onInputUp.dispatch(this, pointer);
+ // Down
+ if (this._onDownFrameName != null)
+ {
+ this.frameName = this._onDownFrameName;
+ }
+ else if (this._onDownFrameID != null)
+ {
+ this.frame = this._onDownFrameID;
+ }
+ }
+ else if (newState === 4)
+ {
+ // Up
+ if (this._onUpFrameName != null)
+ {
+ this.frameName = this._onUpFrameName;
+ }
+ else if (this._onUpFrameID != null)
+ {
+ this.frame = this._onUpFrameID;
+ }
}
};
@@ -979,13 +1065,13 @@ Phaser.Button.prototype.onInputUpHandler = function (pointer) {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Cache.js.html b/docs/Cache.js.html
index b6f9b4f4..bc00d8b4 100644
--- a/docs/Cache.js.html
+++ b/docs/Cache.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
* Phaser.Cache constructor.
*
-* @class Phaser.Cache
-* @classdesc A game only has one instance of a Cache and it is used to store all externally loaded assets such
-* as images, sounds and data files as a result of Loader calls. Cache items use string based keys for look-up.
+* @class Phaser.Cache
+* @classdesc A game only has one instance of a Cache and it is used to store all externally loaded assets such as images, sounds and data files as a result of Loader calls. Cached items use string based keys for look-up.
* @constructor
* @param {Phaser.Game} game - A reference to the currently running game.
*/
@@ -480,10 +473,10 @@ Phaser.Cache = function (game) {
this._tilemaps = {};
/**
- * @property {object} _tilesets - Tileset key-value container.
+ * @property {object} _binary - Binary file key-value container.
* @private
*/
- this._tilesets = {};
+ this._binary = {};
/**
* @property {object} _bitmapDatas - BitmapData key-value container.
@@ -516,6 +509,18 @@ Phaser.Cache.prototype = {
},
+ /**
+ * Add a binary object in to the cache.
+ * @method Phaser.Cache#addBinary
+ * @param {string} key - Asset key for this binary data.
+ * @param {object} binaryData - The binary object to be addded to the cache.
+ */
+ addBinary: function (key, binaryData) {
+
+ this._binary[key] = binaryData;
+
+ },
+
/**
* Add a BitmapData object in to the cache.
* @method Phaser.Cache#addBitmapData
@@ -555,40 +560,18 @@ Phaser.Cache.prototype = {
* @param {object} data - Extra sprite sheet data.
* @param {number} frameWidth - Width of the sprite sheet.
* @param {number} frameHeight - Height of the sprite sheet.
- * @param {number} frameMax - How many frames stored in the sprite sheet.
+ * @param {number} [frameMax=-1] - How many frames stored in the sprite sheet. If -1 then it divides the whole sheet evenly.
+ * @param {number} [margin=0] - If the frames have been drawn with a margin, specify the amount here.
+ * @param {number} [spacing=0] - If the frames have been drawn with spacing between them, specify the amount here.
*/
- addSpriteSheet: function (key, url, data, frameWidth, frameHeight, frameMax) {
+ addSpriteSheet: function (key, url, data, frameWidth, frameHeight, frameMax, margin, spacing) {
- this._images[key] = { url: url, data: data, spriteSheet: true, frameWidth: frameWidth, frameHeight: frameHeight };
+ this._images[key] = { url: url, data: data, spriteSheet: true, frameWidth: frameWidth, frameHeight: frameHeight, margin: margin, spacing: spacing };
PIXI.BaseTextureCache[key] = new PIXI.BaseTexture(data);
PIXI.TextureCache[key] = new PIXI.Texture(PIXI.BaseTextureCache[key]);
- this._images[key].frameData = Phaser.AnimationParser.spriteSheet(this.game, key, frameWidth, frameHeight, frameMax);
-
- },
-
- /**
- * Add a new tile set in to the cache.
- *
- * @method Phaser.Cache#addTileset
- * @param {string} key - The unique key by which you will reference this object.
- * @param {string} url - URL of this tile set file.
- * @param {object} data - Extra tile set data.
- * @param {number} tileWidth - Width of the sprite sheet.
- * @param {number} tileHeight - Height of the sprite sheet.
- * @param {number} tileMax - How many tiles stored in the sprite sheet.
- * @param {number} [tileMargin=0] - If the tiles have been drawn with a margin, specify the amount here.
- * @param {number} [tileSpacing=0] - If the tiles have been drawn with spacing between them, specify the amount here.
- */
- addTileset: function (key, url, data, tileWidth, tileHeight, tileMax, tileMargin, tileSpacing) {
-
- this._tilesets[key] = { url: url, data: data, tileWidth: tileWidth, tileHeight: tileHeight, tileMargin: tileMargin, tileSpacing: tileSpacing };
-
- PIXI.BaseTextureCache[key] = new PIXI.BaseTexture(data);
- PIXI.TextureCache[key] = new PIXI.Texture(PIXI.BaseTextureCache[key]);
-
- this._tilesets[key].tileData = Phaser.TilemapParser.tileset(this.game, key, tileWidth, tileHeight, tileMax, tileMargin, tileSpacing);
+ this._images[key].frameData = Phaser.AnimationParser.spriteSheet(this.game, key, frameWidth, frameHeight, frameMax, margin, spacing);
},
@@ -598,15 +581,13 @@ Phaser.Cache.prototype = {
* @method Phaser.Cache#addTilemap
* @param {string} key - The unique key by which you will reference this object.
* @param {string} url - URL of the tilemap image.
- * @param {object} mapData - The tilemap data object.
+ * @param {object} mapData - The tilemap data object (either a CSV or JSON file).
* @param {number} format - The format of the tilemap data.
*/
addTilemap: function (key, url, mapData, format) {
this._tilemaps[key] = { url: url, data: mapData, format: format };
- this._tilemaps[key].layers = Phaser.TilemapParser.parse(this.game, mapData, format);
-
},
/**
@@ -756,12 +737,13 @@ Phaser.Cache.prototype = {
decoded = true;
}
- this._sounds[key] = { url: url, data: data, isDecoding: false, decoded: decoded, webAudio: webAudio, audioTag: audioTag };
+ this._sounds[key] = { url: url, data: data, isDecoding: false, decoded: decoded, webAudio: webAudio, audioTag: audioTag, locked: this.game.sound.touchLocked };
},
/**
* Reload a sound.
+ *
* @method Phaser.Cache#reloadSound
* @param {string} key - Asset key for the sound.
*/
@@ -782,7 +764,8 @@ Phaser.Cache.prototype = {
},
/**
- * Description.
+ * Fires the onSoundUnlock event when the sound has completed reloading.
+ *
* @method Phaser.Cache#reloadSoundComplete
* @param {string} key - Asset key for the sound.
*/
@@ -797,7 +780,8 @@ Phaser.Cache.prototype = {
},
/**
- * Description.
+ * Updates the sound object in the cache.
+ *
* @method Phaser.Cache#updateSound
* @param {string} key - Asset key for the sound.
*/
@@ -829,8 +813,8 @@ Phaser.Cache.prototype = {
* Get a canvas object from the cache by its key.
*
* @method Phaser.Cache#getCanvas
- * @param {string} key - Asset key of the canvas you want.
- * @return {object} The canvas you want.
+ * @param {string} key - Asset key of the canvas to retrieve from the Cache.
+ * @return {object} The canvas object.
*/
getCanvas: function (key) {
@@ -838,8 +822,10 @@ Phaser.Cache.prototype = {
{
return this._canvases[key].canvas;
}
-
- return null;
+ else
+ {
+ console.warn('Phaser.Cache.getCanvas: Invalid key: "' + key + '"');
+ }
},
@@ -847,7 +833,7 @@ Phaser.Cache.prototype = {
* Get a BitmapData object from the cache by its key.
*
* @method Phaser.Cache#getBitmapData
- * @param {string} key - Asset key of the BitmapData object you want.
+ * @param {string} key - Asset key of the BitmapData object to retrieve from the Cache.
* @return {Phaser.BitmapData} The requested BitmapData object if found, or null if not.
*/
getBitmapData: function (key) {
@@ -856,8 +842,10 @@ Phaser.Cache.prototype = {
{
return this._bitmapDatas[key];
}
-
- return null;
+ else
+ {
+ console.warn('Phaser.Cache.getBitmapData: Invalid key: "' + key + '"');
+ }
},
@@ -865,7 +853,7 @@ Phaser.Cache.prototype = {
* Checks if an image key exists.
*
* @method Phaser.Cache#checkImageKey
- * @param {string} key - Asset key of the image you want.
+ * @param {string} key - Asset key of the image to check is in the Cache.
* @return {boolean} True if the key exists, otherwise false.
*/
checkImageKey: function (key) {
@@ -883,8 +871,8 @@ Phaser.Cache.prototype = {
* Get image data by key.
*
* @method Phaser.Cache#getImage
- * @param {string} key - Asset key of the image you want.
- * @return {object} The image data you want.
+ * @param {string} key - Asset key of the image to retrieve from the Cache.
+ * @return {object} The image data.
*/
getImage: function (key) {
@@ -892,53 +880,19 @@ Phaser.Cache.prototype = {
{
return this._images[key].data;
}
-
- return null;
-
- },
-
- /**
- * Get tile set image data by key.
- *
- * @method Phaser.Cache#getTileSetImage
- * @param {string} key - Asset key of the image you want.
- * @return {object} The image data you want.
- */
- getTilesetImage: function (key) {
-
- if (this._tilesets[key])
+ else
{
- return this._tilesets[key].data;
+ console.warn('Phaser.Cache.getImage: Invalid key: "' + key + '"');
}
- return null;
-
- },
-
- /**
- * Get tile set image data by key.
- *
- * @method Phaser.Cache#getTileset
- * @param {string} key - Asset key of the image you want.
- * @return {Phaser.Tileset} The tileset data. The tileset image is in the data property, the tile data in tileData.
- */
- getTileset: function (key) {
-
- if (this._tilesets[key])
- {
- return this._tilesets[key].tileData;
- }
-
- return null;
-
},
/**
* Get tilemap data by key.
*
* @method Phaser.Cache#getTilemap
- * @param {string} key - Asset key of the tilemap you want.
- * @return {Object} The tilemap data. The tileset image is in the data property, the map data in mapData.
+ * @param {string} key - Asset key of the tilemap data to retrieve from the Cache.
+ * @return {Object} The raw tilemap data in CSV or JSON format.
*/
getTilemapData: function (key) {
@@ -946,16 +900,19 @@ Phaser.Cache.prototype = {
{
return this._tilemaps[key];
}
+ else
+ {
+ console.warn('Phaser.Cache.getTilemapData: Invalid key: "' + key + '"');
+ }
- return null;
},
/**
* Get frame data by key.
*
* @method Phaser.Cache#getFrameData
- * @param {string} key - Asset key of the frame data you want.
- * @return {Phaser.FrameData} The frame data you want.
+ * @param {string} key - Asset key of the frame data to retrieve from the Cache.
+ * @return {Phaser.FrameData} The frame data.
*/
getFrameData: function (key) {
@@ -971,8 +928,8 @@ Phaser.Cache.prototype = {
* Get a single frame out of a frameData set by key.
*
* @method Phaser.Cache#getFrameByIndex
- * @param {string} key - Asset key of the frame data you want.
- * @return {Phaser.Frame} The frame data you want.
+ * @param {string} key - Asset key of the frame data to retrieve from the Cache.
+ * @return {Phaser.Frame} The frame object.
*/
getFrameByIndex: function (key, frame) {
@@ -988,8 +945,8 @@ Phaser.Cache.prototype = {
* Get a single frame out of a frameData set by key.
*
* @method Phaser.Cache#getFrameByName
- * @param {string} key - Asset key of the frame data you want.
- * @return {Phaser.Frame} The frame data you want.
+ * @param {string} key - Asset key of the frame data to retrieve from the Cache.
+ * @return {Phaser.Frame} The frame object.
*/
getFrameByName: function (key, frame) {
@@ -1005,8 +962,8 @@ Phaser.Cache.prototype = {
* Get a single frame by key. You'd only do this to get the default Frame created for a non-atlas/spritesheet image.
*
* @method Phaser.Cache#getFrame
- * @param {string} key - Asset key of the frame data you want.
- * @return {Phaser.Frame} The frame data you want.
+ * @param {string} key - Asset key of the frame data to retrieve from the Cache.
+ * @return {Phaser.Frame} The frame data.
*/
getFrame: function (key) {
@@ -1019,11 +976,11 @@ Phaser.Cache.prototype = {
},
/**
- * Get a single frame by key. You'd only do this to get the default Frame created for a non-atlas/spritesheet image.
+ * Get a single texture frame by key. You'd only do this to get the default Frame created for a non-atlas/spritesheet image.
*
* @method Phaser.Cache#getTextureFrame
- * @param {string} key - Asset key of the frame data you want.
- * @return {Phaser.Frame} The frame data you want.
+ * @param {string} key - Asset key of the frame to retrieve from the Cache.
+ * @return {Phaser.Frame} The frame data.
*/
getTextureFrame: function (key) {
@@ -1039,8 +996,8 @@ Phaser.Cache.prototype = {
* Get a RenderTexture by key.
*
* @method Phaser.Cache#getTexture
- * @param {string} key - Asset key of the RenderTexture you want.
- * @return {Phaser.RenderTexture} The RenderTexture you want.
+ * @param {string} key - Asset key of the RenderTexture to retrieve from the Cache.
+ * @return {Phaser.RenderTexture} The RenderTexture object.
*/
getTexture: function (key) {
@@ -1048,8 +1005,10 @@ Phaser.Cache.prototype = {
{
return this._textures[key];
}
-
- return null;
+ else
+ {
+ console.warn('Phaser.Cache.getTexture: Invalid key: "' + key + '"');
+ }
},
@@ -1057,8 +1016,8 @@ Phaser.Cache.prototype = {
* Get sound by key.
*
* @method Phaser.Cache#getSound
- * @param {string} key - Asset key of the sound you want.
- * @return {Phaser.Sound} The sound you want.
+ * @param {string} key - Asset key of the sound to retrieve from the Cache.
+ * @return {Phaser.Sound} The sound object.
*/
getSound: function (key) {
@@ -1066,8 +1025,10 @@ Phaser.Cache.prototype = {
{
return this._sounds[key];
}
-
- return null;
+ else
+ {
+ console.warn('Phaser.Cache.getSound: Invalid key: "' + key + '"');
+ }
},
@@ -1075,8 +1036,8 @@ Phaser.Cache.prototype = {
* Get sound data by key.
*
* @method Phaser.Cache#getSoundData
- * @param {string} key - Asset key of the sound you want.
- * @return {object} The sound data you want.
+ * @param {string} key - Asset key of the sound to retrieve from the Cache.
+ * @return {object} The sound data.
*/
getSoundData: function (key) {
@@ -1084,8 +1045,10 @@ Phaser.Cache.prototype = {
{
return this._sounds[key].data;
}
-
- return null;
+ else
+ {
+ console.warn('Phaser.Cache.getSoundData: Invalid key: "' + key + '"');
+ }
},
@@ -1093,7 +1056,7 @@ Phaser.Cache.prototype = {
* Check if the given sound has finished decoding.
*
* @method Phaser.Cache#isSoundDecoded
- * @param {string} key - Asset key of the sound you want.
+ * @param {string} key - Asset key of the sound in the Cache.
* @return {boolean} The decoded state of the Sound object.
*/
isSoundDecoded: function (key) {
@@ -1109,7 +1072,7 @@ Phaser.Cache.prototype = {
* Check if the given sound is ready for playback. A sound is considered ready when it has finished decoding and the device is no longer touch locked.
*
* @method Phaser.Cache#isSoundReady
- * @param {string} key - Asset key of the sound you want.
+ * @param {string} key - Asset key of the sound in the Cache.
* @return {boolean} True if the sound is decoded and the device is not touch locked.
*/
isSoundReady: function (key) {
@@ -1140,8 +1103,8 @@ Phaser.Cache.prototype = {
* Get text data by key.
*
* @method Phaser.Cache#getText
- * @param {string} key - Asset key of the text data you want.
- * @return {object} The text data you want.
+ * @param {string} key - Asset key of the text data to retrieve from the Cache.
+ * @return {object} The text data.
*/
getText: function (key) {
@@ -1149,8 +1112,30 @@ Phaser.Cache.prototype = {
{
return this._text[key].data;
}
+ else
+ {
+ console.warn('Phaser.Cache.getText: Invalid key: "' + key + '"');
+ }
+
+ },
- return null;
+ /**
+ * Get binary data by key.
+ *
+ * @method Phaser.Cache#getBinary
+ * @param {string} key - Asset key of the binary data object to retrieve from the Cache.
+ * @return {object} The binary data object.
+ */
+ getBinary: function (key) {
+
+ if (this._binary[key])
+ {
+ return this._binary[key];
+ }
+ else
+ {
+ console.warn('Phaser.Cache.getBinary: Invalid key: "' + key + '"');
+ }
},
@@ -1168,7 +1153,7 @@ Phaser.Cache.prototype = {
for (var item in array)
{
- if (item !== '__default')
+ if (item !== '__default' && item !== '__missing')
{
output.push(item);
}
@@ -1277,6 +1262,8 @@ Phaser.Cache.prototype = {
}
};
+
+Phaser.Cache.prototype.constructor = Phaser.Cache;
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Camera.js.html b/docs/Camera.js.html index ee194b88..c91ddc80 100644 --- a/docs/Camera.js.html +++ b/docs/Camera.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -462,7 +456,7 @@ Phaser.Camera = function (game, id, x, y, width, height) {
* Camera view.
* The view into the world we wish to render (by default the game dimensions).
* The x/y values are in world coordinates, not screen coordinates, the width/height is how many pixels to render.
- * Objects outside of this view are not rendered (unless set to ignore the Camera, i.e. UI?).
+ * Objects outside of this view are not rendered if set to camera cull.
* @property {Phaser.Rectangle} view
*/
this.view = new Phaser.Rectangle(x, y, width, height);
@@ -509,6 +503,9 @@ Phaser.Camera = function (game, id, x, y, width, height) {
*/
this._edge = 0;
+ /**
+ * @property {PIXI.DisplayObject} displayObject - The display object to which all game objects are added. Set by World.boot
+ */
this.displayObject = null;
};
@@ -626,6 +623,11 @@ Phaser.Camera.prototype = {
},
+ /**
+ * Internal method
+ * @method Phaser.Camera#updateTarget
+ * @private
+ */
updateTarget: function () {
if (this.deadzone)
@@ -665,9 +667,13 @@ Phaser.Camera.prototype = {
},
+ /**
+ * Update the Camera bounds to match the game world.
+ * @method Phaser.Camera#setBoundsToWorld
+ */
setBoundsToWorld: function () {
- this.bounds.setTo(this.game.world.x, this.game.world.y, this.game.world.width, this.game.world.height);
+ this.bounds.setTo(this.game.world.bounds.x, this.game.world.bounds.y, this.game.world.bounds.width, this.game.world.bounds.height);
},
@@ -687,10 +693,10 @@ Phaser.Camera.prototype = {
this.view.x = this.bounds.x;
}
- if (this.view.x > this.bounds.right - this.width)
+ if (this.view.right > this.bounds.right)
{
this.atLimit.x = true;
- this.view.x = (this.bounds.right - this.width) + 1;
+ this.view.x = this.bounds.right - this.width;
}
if (this.view.y < this.bounds.top)
@@ -699,10 +705,10 @@ Phaser.Camera.prototype = {
this.view.y = this.bounds.top;
}
- if (this.view.y > this.bounds.bottom - this.height)
+ if (this.view.bottom > this.bounds.bottom)
{
this.atLimit.y = true;
- this.view.y = (this.bounds.bottom - this.height) + 1;
+ this.view.y = this.bounds.bottom - this.height;
}
this.view.floor();
@@ -745,6 +751,8 @@ Phaser.Camera.prototype = {
};
+Phaser.Camera.prototype.constructor = Phaser.Camera;
+
/**
* The Cameras x coordinate. This value is automatically clamped if it falls outside of the World bounds.
* @name Phaser.Camera#x
@@ -839,13 +847,13 @@ Object.defineProperty(Phaser.Camera.prototype, "height", {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Canvas.js.html b/docs/Canvas.js.html
index a10e0bbe..a5a6e341 100644
--- a/docs/Canvas.js.html
+++ b/docs/Canvas.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
-* The Canvas class handles everything related to the <canvas> tag as a DOM Element, like styles, offset, aspect ratio
+* The Canvas class handles everything related to creating the `canvas` DOM tag that Phaser will use, including styles, offset and aspect ratio.
*
* @class Phaser.Canvas
* @static
@@ -436,21 +430,29 @@
Phaser.Canvas = {
/**
- * Creates the <canvas> tag
+ * Creates a `canvas` DOM element. The element is not automatically added to the document.
*
* @method Phaser.Canvas.create
- * @param {number} width - The desired width.
- * @param {number} height - The desired height.
- * @return {HTMLCanvasElement} The newly created <canvas> tag.
+ * @param {number} [width=256] - The width of the canvas element.
+ * @param {number} [height=256] - The height of the canvas element..
+ * @param {string} [id=''] - If given this will be set as the ID of the canvas element, otherwise no ID will be set.
+ * @return {HTMLCanvasElement} The newly created canvas element.
*/
- create: function (width, height) {
+ create: function (width, height, id) {
width = width || 256;
height = height || 256;
var canvas = document.createElement('canvas');
+
+ if (typeof id === 'string')
+ {
+ canvas.id = id;
+ }
+
canvas.width = width;
canvas.height = height;
+
canvas.style.display = 'block';
return canvas;
@@ -471,8 +473,22 @@ Phaser.Canvas = {
var box = element.getBoundingClientRect();
var clientTop = element.clientTop || document.body.clientTop || 0;
var clientLeft = element.clientLeft || document.body.clientLeft || 0;
- var scrollTop = window.pageYOffset || element.scrollTop || document.body.scrollTop;
- var scrollLeft = window.pageXOffset || element.scrollLeft || document.body.scrollLeft;
+
+ // Without this check Chrome is now throwing console warnings about strict vs. quirks :(
+
+ var scrollTop = 0;
+ var scrollLeft = 0;
+
+ if (document.compatMode === 'CSS1Compat')
+ {
+ scrollTop = window.pageYOffset || document.documentElement.scrollTop || element.scrollTop || 0;
+ scrollLeft = window.pageXOffset || document.documentElement.scrollLeft || element.scrollLeft || 0;
+ }
+ else
+ {
+ scrollTop = window.pageYOffset || document.body.scrollTop || element.scrollTop || 0;
+ scrollLeft = window.pageXOffset || document.body.scrollLeft || element.scrollLeft || 0;
+ }
point.x = box.left + scrollLeft - clientLeft;
point.y = box.top + scrollTop - clientTop;
@@ -560,8 +576,8 @@ Phaser.Canvas = {
*
* @method Phaser.Canvas.addToDOM
* @param {HTMLCanvasElement} canvas - The canvas to set the touch action on.
- * @param {string|HTMLElement} parent - The DOM element to add the canvas to. Defaults to ''.
- * @param {boolean} overflowHidden - If set to true it will add the overflow='hidden' style to the parent DOM element.
+ * @param {string|HTMLElement} parent - The DOM element to add the canvas to.
+ * @param {boolean} [overflowHidden=true] - If set to true it will add the overflow='hidden' style to the parent DOM element.
* @return {HTMLCanvasElement} Returns the source canvas.
*/
addToDOM: function (canvas, parent, overflowHidden) {
@@ -572,29 +588,29 @@ Phaser.Canvas = {
if (parent)
{
- // hopefully an element ID
if (typeof parent === 'string')
{
+ // hopefully an element ID
target = document.getElementById(parent);
}
- // quick test for a HTMLelement
else if (typeof parent === 'object' && parent.nodeType === 1)
{
+ // quick test for a HTMLelement
target = parent;
}
-
- if (overflowHidden)
- {
- target.style.overflow = 'hidden';
- }
}
- // fallback, covers an invalid ID and a none HTMLelement object
- if(!target)
+ // Fallback, covers an invalid ID and a non HTMLelement object
+ if (!target)
{
target = document.body;
}
+ if (overflowHidden && target.style)
+ {
+ target.style.overflow = 'hidden';
+ }
+
target.appendChild(canvas);
return canvas;
@@ -656,9 +672,11 @@ Phaser.Canvas = {
*/
setImageRenderingCrisp: function (canvas) {
+ canvas.style['image-rendering'] = 'optimizeSpeed';
canvas.style['image-rendering'] = 'crisp-edges';
canvas.style['image-rendering'] = '-moz-crisp-edges';
canvas.style['image-rendering'] = '-webkit-optimize-contrast';
+ canvas.style['image-rendering'] = 'optimize-contrast';
canvas.style.msInterpolationMode = 'nearest-neighbor';
return canvas;
@@ -698,13 +716,13 @@ Phaser.Canvas = {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Circle.js.html b/docs/Circle.js.html
index 41f1a8a5..b66a23cb 100644
--- a/docs/Circle.js.html
+++ b/docs/Circle.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -432,9 +426,9 @@
* @class Circle
* @classdesc Phaser - Circle
* @constructor
-* @param {number} [x] The x coordinate of the center of the circle.
-* @param {number} [y] The y coordinate of the center of the circle.
-* @param {number} [diameter] The diameter of the circle.
+* @param {number} [x=0] - The x coordinate of the center of the circle.
+* @param {number} [y=0] - The y coordinate of the center of the circle.
+* @param {number} [diameter=0] - The diameter of the circle.
* @return {Phaser.Circle} This circle object
*/
Phaser.Circle = function (x, y, diameter) {
@@ -618,6 +612,8 @@ Phaser.Circle.prototype = {
};
+Phaser.Circle.prototype.constructor = Phaser.Circle;
+
/**
* The largest distance between any two points on the circle. The same as the radius * 2.
* @name Phaser.Circle#diameter
@@ -911,13 +907,13 @@ Phaser.Circle.intersectsRectangle = function (c, r) {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Color.js.html b/docs/Color.js.html
index 904f01d0..ed3362bd 100644
--- a/docs/Color.js.html
+++ b/docs/Color.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -787,13 +781,13 @@ Phaser.Color = {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/DOMSprite.js.html b/docs/DOMSprite.js.html
new file mode 100644
index 00000000..9bd6f200
--- /dev/null
+++ b/docs/DOMSprite.js.html
@@ -0,0 +1,567 @@
+
+
+
+
+
+ Phaser Source: gameobjects/DOMSprite.js
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source: gameobjects/DOMSprite.js
+
+
+
+ /**
+* @author Richard Davey <rich@photonstorm.com>
+* @copyright 2014 Photon Storm Ltd.
+* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
+*/
+
+/**
+* Create a new DOMSprite.
+* @class Phaser.DOMSprite
+* @constructor
+* @param {Phaser.Game} game - Current game instance.
+* @param {string} id - DOM ID.
+* @param {number} x - X position of the new text object.
+* @param {number} y - Y position of the new text object.
+* @param {string} text - The actual text that will be written.
+* @param {object} style - The style object containing style attributes like font, font size ,
+*/
+Phaser.DOMSprite = function (game, element, x, y, style) {
+
+ x = x || 0;
+ y = y || 0;
+ style = style || '';
+
+ /**
+ * @property {Phaser.Game} game - A reference to the currently running Game.
+ */
+ this.game = game;
+
+ /**
+ * @property {boolean} exists - If exists = false then the Text isn't updated by the core game loop.
+ * @default
+ */
+ this.exists = true;
+
+ /**
+ * @property {boolean} alive - This is a handy little var your game can use to determine if an object is alive or not, it doesn't effect rendering.
+ * @default
+ */
+ this.alive = true;
+
+ /**
+ * @property {Phaser.Group} group - The parent Group of this Text object.
+ */
+ this.group = null;
+
+ /**
+ * @property {string} name - The user defined name given to this object.
+ * @default
+ */
+ this.name = '';
+
+ /**
+ * @property {number} type - The const type of this object.
+ * @default
+ */
+ this.type = Phaser.DOMSPRITE;
+
+ /**
+ * @property {boolean} visible - Sets the visible state of this DOMSprite.
+ * @default
+ */
+ this.visible = true;
+
+ /*
+ if (parent)
+ {
+ if (typeof parent === 'string')
+ {
+ // hopefully an element ID
+ target = document.getElementById(parent);
+ }
+ else if (typeof parent === 'object' && parent.nodeType === 1)
+ {
+ // quick test for a HTMLelement
+ target = parent;
+ }
+
+ if (overflowHidden)
+ {
+ target.style.overflow = 'hidden';
+ }
+ }
+ */
+
+};
+
+// Phaser.DOMSprite.prototype = Object.create(PIXI.DOMSprite.prototype);
+// Phaser.DOMSprite.prototype.constructor = Phaser.DOMSprite;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/Debug.js.html b/docs/Debug.js.html
index 05fb0929..3db78003 100644
--- a/docs/Debug.js.html
+++ b/docs/Debug.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -453,6 +447,11 @@ Phaser.Utils.Debug = function (game) {
*/
this.font = '14px Courier';
+ /**
+ * @property {number} columnWidth - The spacing between columns.
+ */
+ this.columnWidth = 100;
+
/**
* @property {number} lineHeight - The line height between the debug text.
*/
@@ -488,11 +487,12 @@ Phaser.Utils.Debug.prototype = {
/**
* Internal method that resets and starts the debug output values.
* @method Phaser.Utils.Debug#start
- * @param {number} x - The X value the debug info will start from.
- * @param {number} y - The Y value the debug info will start from.
- * @param {string} color - The color the debug info will drawn in.
+ * @param {number} [x=0] - The X value the debug info will start from.
+ * @param {number} [y=0] - The Y value the debug info will start from.
+ * @param {string} [color='rgb(255,255,255)'] - The color the debug text will drawn in.
+ * @param {number} [columnWidth=0] - The spacing between columns.
*/
- start: function (x, y, color) {
+ start: function (x, y, color, columnWidth) {
if (this.context == null)
{
@@ -501,16 +501,18 @@ Phaser.Utils.Debug.prototype = {
if (typeof x !== 'number') { x = 0; }
if (typeof y !== 'number') { y = 0; }
-
color = color || 'rgb(255,255,255)';
+ if (typeof columnWidth === 'undefined') { columnWidth = 0; }
this.currentX = x;
this.currentY = y;
this.currentColor = color;
this.currentAlpha = this.context.globalAlpha;
+ this.columnWidth = columnWidth;
this.context.save();
this.context.setTransform(1, 0, 0, 1, 0, 0);
+ this.context.strokeStyle = color;
this.context.fillStyle = color;
this.context.font = this.font;
this.context.globalAlpha = 1;
@@ -523,7 +525,6 @@ Phaser.Utils.Debug.prototype = {
*/
stop: function () {
-
this.context.restore();
this.context.globalAlpha = this.currentAlpha;
@@ -533,8 +534,8 @@ Phaser.Utils.Debug.prototype = {
* Internal method that outputs a single line of text.
* @method Phaser.Utils.Debug#line
* @param {string} text - The line of text to draw.
- * @param {number} x - The X value the debug info will start from.
- * @param {number} y - The Y value the debug info will start from.
+ * @param {number} [x] - The X value the debug info will start from.
+ * @param {number} [y] - The Y value the debug info will start from.
*/
line: function (text, x, y) {
@@ -543,16 +544,8 @@ Phaser.Utils.Debug.prototype = {
return;
}
- x = x || null;
- y = y || null;
-
- if (x !== null) {
- this.currentX = x;
- }
-
- if (y !== null) {
- this.currentY = y;
- }
+ if (typeof x !== 'undefined') { this.currentX = x; }
+ if (typeof y !== 'undefined') { this.currentY = y; }
if (this.renderShadow)
{
@@ -566,6 +559,38 @@ Phaser.Utils.Debug.prototype = {
},
+ /**
+ * Internal method that outputs a single line of text split over as many columns as needed, one per parameter.
+ * @method Phaser.Utils.Debug#splitline
+ * @param {string} text - The text to render. You can have as many columns of text as you want, just pass them as additional parameters.
+ */
+ splitline: function (text) {
+
+ if (this.context == null)
+ {
+ return;
+ }
+
+ var x = this.currentX;
+
+ for (var i = 0; i < arguments.length; i++)
+ {
+ if (this.renderShadow)
+ {
+ this.context.fillStyle = 'rgb(0,0,0)';
+ this.context.fillText(arguments[i], x + 1, this.currentY + 1);
+ this.context.fillStyle = this.currentColor;
+ }
+
+ this.context.fillText(arguments[i], x, this.currentY);
+
+ x += this.columnWidth;
+ }
+
+ this.currentY += this.lineHeight;
+
+ },
+
/**
* Visually renders a QuadTree to the display.
* @method Phaser.Utils.Debug#renderQuadTree
@@ -811,25 +836,27 @@ Phaser.Utils.Debug.prototype = {
},
/**
- * Render Sprite collision.
- * @method Phaser.Utils.Debug#renderSpriteCollision
+ * Render Sprite Body Physics Data as text.
+ * @method Phaser.Utils.Debug#renderBodyInfo
* @param {Phaser.Sprite} sprite - The sprite to be rendered.
* @param {number} x - X position of the debug info to be rendered.
* @param {number} y - Y position of the debug info to be rendered.
* @param {string} [color='rgb(255,255,255)'] - color of the debug info to be rendered. (format is css color string).
*/
- renderSpriteCollision: function (sprite, x, y, color) {
+ renderBodyInfo: function (sprite, x, y, color) {
color = color || 'rgb(255,255,255)';
- this.start(x, y, color);
- this.line('Sprite Collision: (' + sprite.width + ' x ' + sprite.height + ')');
- this.line('left: ' + sprite.body.touching.left);
- this.line('right: ' + sprite.body.touching.right);
- this.line('up: ' + sprite.body.touching.up);
- this.line('down: ' + sprite.body.touching.down);
- this.line('velocity.x: ' + sprite.body.velocity.x);
- this.line('velocity.y: ' + sprite.body.velocity.y);
+ this.start(x, y, color, 210);
+
+ this.splitline('x: ' + sprite.body.x.toFixed(2), 'y: ' + sprite.body.y.toFixed(2), 'width: ' + sprite.width, 'height: ' + sprite.height);
+ this.splitline('speed: ' + sprite.body.speed.toFixed(2), 'angle: ' + sprite.body.angle.toFixed(2), 'linear damping: ' + sprite.body.linearDamping);
+ this.splitline('blocked left: ' + sprite.body.blocked.left, 'right: ' + sprite.body.blocked.right, 'up: ' + sprite.body.blocked.up, 'down: ' + sprite.body.blocked.down);
+ this.splitline('touching left: ' + sprite.body.touching.left, 'right: ' + sprite.body.touching.right, 'up: ' + sprite.body.touching.up, 'down: ' + sprite.body.touching.down);
+ this.splitline('gravity x: ' + sprite.body.gravity.x, 'y: ' + sprite.body.gravity.y, 'world gravity x: ' + this.game.physics.gravity.x, 'y: ' + this.game.physics.gravity.y);
+ this.splitline('acceleration x: ' + sprite.body.acceleration.x.toFixed(2), 'y: ' + sprite.body.acceleration.y.toFixed(2));
+ this.splitline('velocity x: ' + sprite.body.velocity.x.toFixed(2), 'y: ' + sprite.body.velocity.y.toFixed(2), 'deltaX: ' + sprite.body.deltaX().toFixed(2), 'deltaY: ' + sprite.body.deltaY().toFixed(2));
+ this.splitline('bounce x: ' + sprite.body.bounce.x.toFixed(2), 'y: ' + sprite.body.bounce.y.toFixed(2));
this.stop();
},
@@ -892,17 +919,15 @@ Phaser.Utils.Debug.prototype = {
// 4 = scaleY
// 5 = translateY
- // this.line('id: ' + sprite._id);
- // this.line('scale x: ' + sprite.worldTransform[0]);
- // this.line('scale y: ' + sprite.worldTransform[4]);
- // this.line('tx: ' + sprite.worldTransform[2]);
- // this.line('ty: ' + sprite.worldTransform[5]);
- // this.line('skew x: ' + sprite.worldTransform[3]);
- // this.line('skew y: ' + sprite.worldTransform[1]);
- this.line('deltaX: ' + sprite.body.deltaX());
- this.line('deltaY: ' + sprite.body.deltaY());
- // this.line('sdx: ' + sprite.deltaX());
- // this.line('sdy: ' + sprite.deltaY());
+ this.line('id: ' + sprite._id);
+ this.line('scale x: ' + sprite.worldTransform[0]);
+ this.line('scale y: ' + sprite.worldTransform[4]);
+ this.line('tx: ' + sprite.worldTransform[2]);
+ this.line('ty: ' + sprite.worldTransform[5]);
+ this.line('skew x: ' + sprite.worldTransform[3]);
+ this.line('skew y: ' + sprite.worldTransform[1]);
+ this.line('sdx: ' + sprite.deltaX);
+ this.line('sdy: ' + sprite.deltaY);
// this.line('inCamera: ' + this.game.renderer.spriteRenderer.inCamera(this.game.camera, sprite));
this.stop();
@@ -910,65 +935,13 @@ Phaser.Utils.Debug.prototype = {
},
/**
- * Render the World Transform information of the given Sprite.
- * @method Phaser.Utils.Debug#renderWorldTransformInfo
- * @param {Phaser.Sprite} sprite - Description.
+ * Renders the sprite coordinates in local, positional and world space.
+ * @method Phaser.Utils.Debug#renderSpriteCoords
+ * @param {Phaser.Sprite} line - The sprite to inspect.
* @param {number} x - X position of the debug info to be rendered.
* @param {number} y - Y position of the debug info to be rendered.
* @param {string} [color='rgb(255,255,255)'] - color of the debug info to be rendered. (format is css color string).
*/
- renderWorldTransformInfo: function (sprite, x, y, color) {
-
- if (this.context == null)
- {
- return;
- }
-
- color = color || 'rgb(255, 255, 255)';
-
- this.start(x, y, color);
-
- this.line('World Transform');
- this.line('skewX: ' + sprite.worldTransform[3]);
- this.line('skewY: ' + sprite.worldTransform[1]);
- this.line('scaleX: ' + sprite.worldTransform[0]);
- this.line('scaleY: ' + sprite.worldTransform[4]);
- this.line('transX: ' + sprite.worldTransform[2]);
- this.line('transY: ' + sprite.worldTransform[5]);
- this.stop();
-
- },
-
- /**
- * Render the Local Transform information of the given Sprite.
- * @method Phaser.Utils.Debug#renderLocalTransformInfo
- * @param {Phaser.Sprite} sprite - Description.
- * @param {number} x - X position of the debug info to be rendered.
- * @param {number} y - Y position of the debug info to be rendered.
- * @param {string} [color='rgb(255,255,255)'] - color of the debug info to be rendered. (format is css color string).
- */
- renderLocalTransformInfo: function (sprite, x, y, color) {
-
- if (this.context == null)
- {
- return;
- }
-
- color = color || 'rgb(255, 255, 255)';
-
- this.start(x, y, color);
-
- this.line('Local Transform');
- this.line('skewX: ' + sprite.localTransform[3]);
- this.line('skewY: ' + sprite.localTransform[1]);
- this.line('scaleX: ' + sprite.localTransform[0]);
- this.line('scaleY: ' + sprite.localTransform[4]);
- this.line('transX: ' + sprite.localTransform[2]);
- this.line('transY: ' + sprite.localTransform[5]);
- this.stop();
-
- },
-
renderSpriteCoords: function (sprite, x, y, color) {
if (this.context == null)
@@ -978,29 +951,28 @@ Phaser.Utils.Debug.prototype = {
color = color || 'rgb(255, 255, 255)';
- this.start(x, y, color);
+ this.start(x, y, color, 100);
if (sprite.name)
{
this.line(sprite.name);
}
- this.line('x: ' + sprite.x);
- this.line('y: ' + sprite.y);
- this.line('pos x: ' + sprite.position.x);
- this.line('pos y: ' + sprite.position.y);
- this.line('local x: ' + sprite.localTransform[2]);
- this.line('local y: ' + sprite.localTransform[5]);
- this.line('t x: ' + sprite.worldTransform[2]);
- this.line('t y: ' + sprite.worldTransform[5]);
- this.line('world x: ' + sprite.world.x);
- this.line('world y: ' + sprite.world.y);
+ this.splitline('x:', sprite.x.toFixed(2), 'y:', sprite.y.toFixed(2));
+ this.splitline('pos x:', sprite.position.x.toFixed(2), 'pos y:', sprite.position.y.toFixed(2));
+ this.splitline('world x:', sprite.world.x.toFixed(2), 'world y:', sprite.world.y.toFixed(2));
this.stop();
},
- renderGroupInfo: function (group, x, y, color) {
+ /**
+ * Renders a Line object in the given color.
+ * @method Phaser.Utils.Debug#renderLine
+ * @param {Phaser.Line} line - The Line to render.
+ * @param {string} [color='rgb(255,255,255)'] - color of the debug info to be rendered. (format is css color string).
+ */
+ renderLine: function (line, color) {
if (this.context == null)
{
@@ -1009,12 +981,38 @@ Phaser.Utils.Debug.prototype = {
color = color || 'rgb(255, 255, 255)';
- this.start(x, y, color);
+ this.start(0, 0, color);
+ this.context.lineWidth = 1;
+ this.context.beginPath();
+ this.context.moveTo(line.start.x + 0.5, line.start.y + 0.5);
+ this.context.lineTo(line.end.x + 0.5, line.end.y + 0.5);
+ this.context.closePath();
+ this.context.stroke();
+ this.stop();
- this.line('Group (size: ' + group.length + ')');
- this.line('x: ' + group.x);
- this.line('y: ' + group.y);
+ },
+ /**
+ * Renders Line information in the given color.
+ * @method Phaser.Utils.Debug#renderLineInfo
+ * @param {Phaser.Line} line - The Line to render.
+ * @param {number} x - X position of the debug info to be rendered.
+ * @param {number} y - Y position of the debug info to be rendered.
+ * @param {string} [color='rgb(255,255,255)'] - color of the debug info to be rendered. (format is css color string).
+ */
+ renderLineInfo: function (line, x, y, color) {
+
+ if (this.context == null)
+ {
+ return;
+ }
+
+ color = color || 'rgb(255, 255, 255)';
+
+ this.start(x, y, color, 80);
+ this.splitline('start.x:', line.start.x.toFixed(2), 'start.y:', line.start.y.toFixed(2));
+ this.splitline('end.x:', line.end.x.toFixed(2), 'end.y:', line.end.y.toFixed(2));
+ this.splitline('length:', line.length.toFixed(2), 'angle:', line.angle);
this.stop();
},
@@ -1043,24 +1041,36 @@ Phaser.Utils.Debug.prototype = {
},
/**
- * Renders just the Sprite.body bounds.
- * @method Phaser.Utils.Debug#renderSpriteBody
+ * Renders just the full Sprite bounds.
+ * @method Phaser.Utils.Debug#renderSpriteBounds
* @param {Phaser.Sprite} sprite - Description.
* @param {string} [color] - Color of the debug info to be rendered (format is css color string).
+ * @param {boolean} [fill=false] - If false the bounds outline is rendered, if true the whole rectangle is rendered.
*/
- renderSpriteBody: function (sprite, color) {
+ renderSpriteBody: function (sprite, color, fill) {
if (this.context == null)
{
return;
}
- color = color || 'rgba(255,0,255, 0.3)';
+ color = color || 'rgb(255,0,255)';
+
+ if (typeof fill === 'undefined') { fill = false; }
this.start(0, 0, color);
- this.context.fillStyle = color;
- this.context.fillRect(sprite.body.screenX, sprite.body.screenY, sprite.body.width, sprite.body.height);
+ if (fill)
+ {
+ this.context.fillStyle = color;
+ this.context.fillRect(sprite.body.left, sprite.body.top, sprite.body.width, sprite.body.height);
+ }
+ else
+ {
+ this.context.strokeStyle = color;
+ this.context.strokeRect(sprite.body.left, sprite.body.top, sprite.body.width, sprite.body.height);
+ this.context.stroke();
+ }
this.stop();
@@ -1222,86 +1232,110 @@ Phaser.Utils.Debug.prototype = {
},
/**
- * Dumps the Linked List to the console.
- *
- * @method Phaser.Utils.Debug#Phaser.LinkedList#dump
- * @param {Phaser.LinkedList} list - The LinkedList to dump.
+ * @method Phaser.Utils.Debug#renderPhysicsBody
+ * @param {array} body
+ * @param {string} [color='rgb(255,255,255)'] - The color the polygon is stroked in.
*/
- dumpLinkedList: function (list) {
+ renderPhysicsBody: function (body, color, context) {
- var spacing = 20;
-
- var output = "\n" + Phaser.Utils.pad('Node', spacing) + "|" + Phaser.Utils.pad('Next', spacing) + "|" + Phaser.Utils.pad('Previous', spacing) + "|" + Phaser.Utils.pad('First', spacing) + "|" + Phaser.Utils.pad('Last', spacing);
- console.log(output);
-
- var output = Phaser.Utils.pad('----------', spacing) + "|" + Phaser.Utils.pad('----------', spacing) + "|" + Phaser.Utils.pad('----------', spacing) + "|" + Phaser.Utils.pad('----------', spacing) + "|" + Phaser.Utils.pad('----------', spacing);
- console.log(output);
-
- var entity = list;
-
- var testObject = entity.last.next;
- entity = entity.first;
-
- do
+ if (this.context === null && context === null)
{
- var name = entity.sprite.name || '*';
- var nameNext = '-';
- var namePrev = '-';
- var nameFirst = '-';
- var nameLast = '-';
-
- if (entity.next)
- {
- nameNext = entity.next.sprite.name;
- }
-
- if (entity.prev)
- {
- namePrev = entity.prev.sprite.name;
- }
-
- if (entity.first)
- {
- nameFirst = entity.first.sprite.name;
- }
-
- if (entity.last)
- {
- nameLast = entity.last.sprite.name;
- }
-
- if (typeof nameNext === 'undefined')
- {
- nameNext = '-';
- }
-
- if (typeof namePrev === 'undefined')
- {
- namePrev = '-';
- }
-
- if (typeof nameFirst === 'undefined')
- {
- nameFirst = '-';
- }
-
- if (typeof nameLast === 'undefined')
- {
- nameLast = '-';
- }
-
- var output = Phaser.Utils.pad(name, spacing) + "|" + Phaser.Utils.pad(nameNext, spacing) + "|" + Phaser.Utils.pad(namePrev, spacing) + "|" + Phaser.Utils.pad(nameFirst, spacing) + "|" + Phaser.Utils.pad(nameLast, spacing);
- console.log(output);
-
- entity = entity.next;
-
+ return;
}
- while(entity != testObject)
+
+ color = color || 'rgb(255,255,255)';
+
+ var x = body.x - this.game.camera.x;
+ var y = body.y - this.game.camera.y;
+
+ if (body.type === Phaser.Physics.Arcade.CIRCLE)
+ {
+ this.start(0, 0, color);
+ this.context.beginPath();
+ this.context.strokeStyle = color;
+ this.context.arc(x, y, body.shape.r, 0, Math.PI * 2, false);
+ this.context.stroke();
+ this.context.closePath();
+
+ // this.context.strokeStyle = 'rgb(0,0,255)';
+ // this.context.strokeRect(body.left, body.top, body.width, body.height);
+
+ this.stop();
+ }
+ else
+ {
+ var points = body.polygon.points;
+
+ this.start(0, 0, color);
+
+ this.context.beginPath();
+ this.context.moveTo(x + points[0].x, y + points[0].y);
+
+ for (var i = 1; i < points.length; i++)
+ {
+ this.context.lineTo(x + points[i].x, y + points[i].y);
+ }
+
+ this.context.closePath();
+ this.context.strokeStyle = color;
+ this.context.stroke();
+
+ this.context.fillStyle = 'rgb(255,0,0)';
+ this.context.fillRect(x + points[0].x - 2, y + points[0].y - 2, 5, 5);
+
+ for (var i = 1; i < points.length; i++)
+ {
+ this.context.fillStyle = 'rgb(255,' + (i * 40) + ',0)';
+ this.context.fillRect(x + points[i].x - 2, y + points[i].y - 2, 5, 5);
+ }
+
+ // this.context.strokeStyle = 'rgb(0,255,255)';
+ // this.context.strokeRect(body.left, body.top, body.width, body.height);
+
+ this.stop();
+ }
+
+ },
+
+ /**
+ * @method Phaser.Utils.Debug#renderPolygon
+ * @param {array} polygon
+ * @param {string} [color='rgb(255,255,255)'] - The color the polygon is stroked in.
+ */
+ renderPolygon: function (polygon, color, context) {
+
+ if (this.context === null && context === null)
+ {
+ return;
+ }
+
+ color = color || 'rgb(255,255,255)';
+
+ var points = polygon.points;
+ var x = polygon.pos.x;
+ var y = polygon.pos.y;
+
+ this.start(0, 0, color);
+
+ this.context.beginPath();
+ this.context.moveTo(x + points[0].x, y + points[0].y);
+
+ for (var i = 1; i < points.length; i++)
+ {
+ this.context.lineTo(x + points[i].x, y + points[i].y);
+ }
+
+ this.context.closePath();
+ this.context.strokeStyle = color;
+ this.context.stroke();
+
+ this.stop();
}
-
};
+
+Phaser.Utils.Debug.prototype.constructor = Phaser.Utils.Debug;
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Device.js.html b/docs/Device.js.html index d2be1bb7..b5182378 100644 --- a/docs/Device.js.html +++ b/docs/Device.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -463,6 +457,12 @@ Phaser.Device = function () {
*/
this.cocoonJS = false;
+ /**
+ * @property {boolean} ejecta - Is the game running under Ejecta?
+ * @default
+ */
+ this.ejecta = false;
+
/**
* @property {boolean} android - Is running on android?
* @default
@@ -561,6 +561,18 @@ Phaser.Device = function () {
*/
this.typedArray = false;
+ /**
+ * @property {boolean} vibration - Does the device support the Vibration API?
+ * @default
+ */
+ this.vibration = false;
+
+ /**
+ * @property {boolean} quirksMode - Is the browser running in strict mode (false) or quirks mode? (true)
+ * @default
+ */
+ this.quirksMode = false;
+
// Browser
/**
@@ -599,6 +611,18 @@ Phaser.Device = function () {
*/
this.ieVersion = 0;
+ /**
+ * @property {boolean} trident - Set to true if running a Trident version of Internet Explorer (IE11+)
+ * @default
+ */
+ this.trident = false;
+
+ /**
+ * @property {number} tridentVersion - If running in Internet Explorer 11 this will contain the major version number. See http://msdn.microsoft.com/en-us/library/ie/ms537503(v=vs.85).aspx
+ * @default
+ */
+ this.tridentVersion = 0;
+
/**
* @property {boolean} mobileSafari - Set to true if running in Mobile Safari.
* @default
@@ -629,6 +653,12 @@ Phaser.Device = function () {
*/
this.webApp = false;
+ /**
+ * @property {boolean} silk - Set to true if running in the Silk browser (as used on the Amazon Kindle)
+ * @default
+ */
+ this.silk = false;
+
// Audio
/**
@@ -733,21 +763,33 @@ Phaser.Device.prototype = {
var ua = navigator.userAgent;
- if (/Android/.test(ua)) {
+ if (/Android/.test(ua))
+ {
this.android = true;
- } else if (/CrOS/.test(ua)) {
+ }
+ else if (/CrOS/.test(ua))
+ {
this.chromeOS = true;
- } else if (/iP[ao]d|iPhone/i.test(ua)) {
+ }
+ else if (/iP[ao]d|iPhone/i.test(ua))
+ {
this.iOS = true;
- } else if (/Linux/.test(ua)) {
+ }
+ else if (/Linux/.test(ua))
+ {
this.linux = true;
- } else if (/Mac OS/.test(ua)) {
+ }
+ else if (/Mac OS/.test(ua))
+ {
this.macOS = true;
- } else if (/Windows/.test(ua)) {
+ }
+ else if (/Windows/.test(ua))
+ {
this.windows = true;
}
- if (this.windows || this.macOS || this.linux) {
+ if (this.windows || this.macOS || (this.linux && this.silk === false))
+ {
this.desktop = true;
}
@@ -783,16 +825,20 @@ Phaser.Device.prototype = {
this.worker = !!window['Worker'];
- if ('ontouchstart' in document.documentElement || (window.navigator.maxTouchPoints && window.navigator.maxTouchPoints > 1)) {
+ if ('ontouchstart' in document.documentElement || (window.navigator.maxTouchPoints && window.navigator.maxTouchPoints > 1))
+ {
this.touch = true;
}
- if (window.navigator.msPointerEnabled || window.navigator.pointerEnabled) {
+ if (window.navigator.msPointerEnabled || window.navigator.pointerEnabled)
+ {
this.mspointer = true;
}
this.pointerLock = 'pointerLockElement' in document || 'mozPointerLockElement' in document || 'webkitPointerLockElement' in document;
+ this.quirksMode = (document.compatMode === 'CSS1Compat') ? false : true;
+
},
/**
@@ -804,36 +850,70 @@ Phaser.Device.prototype = {
var ua = navigator.userAgent;
- if (/Arora/.test(ua)) {
+ if (/Arora/.test(ua))
+ {
this.arora = true;
- } else if (/Chrome/.test(ua)) {
+ }
+ else if (/Chrome/.test(ua))
+ {
this.chrome = true;
- } else if (/Epiphany/.test(ua)) {
+ }
+ else if (/Epiphany/.test(ua))
+ {
this.epiphany = true;
- } else if (/Firefox/.test(ua)) {
+ }
+ else if (/Firefox/.test(ua))
+ {
this.firefox = true;
- } else if (/Mobile Safari/.test(ua)) {
+ }
+ else if (/Mobile Safari/.test(ua))
+ {
this.mobileSafari = true;
- } else if (/MSIE (\d+\.\d+);/.test(ua)) {
+ }
+ else if (/MSIE (\d+\.\d+);/.test(ua))
+ {
this.ie = true;
this.ieVersion = parseInt(RegExp.$1, 10);
- } else if (/Midori/.test(ua)) {
+ }
+ else if (/Midori/.test(ua))
+ {
this.midori = true;
- } else if (/Opera/.test(ua)) {
+ }
+ else if (/Opera/.test(ua))
+ {
this.opera = true;
- } else if (/Safari/.test(ua)) {
+ }
+ else if (/Safari/.test(ua))
+ {
this.safari = true;
}
+ else if (/Silk/.test(ua))
+ {
+ this.silk = true;
+ }
+ else if (/Trident\/(\d+\.\d+);/.test(ua))
+ {
+ this.ie = true;
+ this.trident = true;
+ this.tridentVersion = parseInt(RegExp.$1, 10);
+ }
// WebApp mode in iOS
- if (navigator['standalone']) {
+ if (navigator['standalone'])
+ {
this.webApp = true;
}
- if (navigator['isCocoonJS']) {
+ if (navigator['isCocoonJS'])
+ {
this.cocoonJS = true;
}
+ if (typeof window.ejecta !== "undefined")
+ {
+ this.ejecta = true;
+ }
+
},
/**
@@ -906,6 +986,13 @@ Phaser.Device.prototype = {
this.typedArray = false;
}
+ navigator.vibrate = navigator.vibrate || navigator.webkitVibrate || navigator.mozVibrate || navigator.msVibrate;
+
+ if (navigator.vibrate)
+ {
+ this.vibration = true;
+ }
+
},
/**
@@ -928,8 +1015,10 @@ Phaser.Device.prototype = {
// Add it to the body to get the computed style.
document.body.insertBefore(el, null);
- for (var t in transforms) {
- if (el.style[t] !== undefined) {
+ for (var t in transforms)
+ {
+ if (el.style[t] !== undefined)
+ {
el.style[t] = "translate3d(1px,1px,1px)";
has3d = window.getComputedStyle(el).getPropertyValue(transforms[t]);
}
@@ -1003,6 +1092,8 @@ Phaser.Device.prototype = {
}
};
+
+Phaser.Device.prototype.constructor = Phaser.Device;
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Easing.js.html b/docs/Easing.js.html index f7b7fe22..4c9ee5bf 100644 --- a/docs/Easing.js.html +++ b/docs/Easing.js.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Emitter.js.html b/docs/Emitter.js.html index fdd2c084..f12e2643 100644 --- a/docs/Emitter.js.html +++ b/docs/Emitter.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -445,7 +439,6 @@
Phaser.Particles.Arcade.Emitter = function (game, x, y, maxParticles) {
/**
- * The total number of particles in this emitter.
* @property {number} maxParticles - The total number of particles in this emitter..
* @default
*/
@@ -459,7 +452,8 @@ Phaser.Particles.Arcade.Emitter = function (game, x, y, maxParticles) {
this.name = 'emitter' + this.game.particles.ID++;
/**
- * @property {Description} type - Description.
+ * @property {number} type - Internal Phaser Type value.
+ * @protected
*/
this.type = Phaser.EMITTER;
@@ -488,140 +482,114 @@ Phaser.Particles.Arcade.Emitter = function (game, x, y, maxParticles) {
this.height = 1;
/**
- * The minimum possible velocity of a particle.
- * The default value is (-100,-100).
- * @property {Phaser.Point} minParticleSpeed
+ * @property {Phaser.Point} minParticleSpeed - The minimum possible velocity of a particle.
+ * @default
*/
this.minParticleSpeed = new Phaser.Point(-100, -100);
/**
- * The maximum possible velocity of a particle.
- * The default value is (100,100).
- * @property {Phaser.Point} maxParticleSpeed
+ * @property {Phaser.Point} maxParticleSpeed - The maximum possible velocity of a particle.
+ * @default
*/
this.maxParticleSpeed = new Phaser.Point(100, 100);
/**
- * The minimum possible scale of a particle.
- * The default value is 1.
- * @property {number} minParticleScale
+ * @property {number} minParticleScale - The minimum possible scale of a particle.
* @default
*/
this.minParticleScale = 1;
/**
- * The maximum possible scale of a particle.
- * The default value is 1.
- * @property {number} maxParticleScale
+ * @property {number} maxParticleScale - The maximum possible scale of a particle.
* @default
*/
this.maxParticleScale = 1;
/**
- * The minimum possible angular velocity of a particle. The default value is -360.
- * @property {number} minRotation
+ * @property {number} minRotation - The minimum possible angular velocity of a particle.
* @default
*/
this.minRotation = -360;
/**
- * The maximum possible angular velocity of a particle. The default value is 360.
- * @property {number} maxRotation
+ * @property {number} maxRotation - The maximum possible angular velocity of a particle.
* @default
*/
this.maxRotation = 360;
/**
- * Sets the <code>gravity.y</code> of each particle to this value on launch.
- * @property {number} gravity
+ * @property {number} gravity - Sets the `body.gravity.y` of each particle sprite to this value on launch.
* @default
*/
- this.gravity = 2;
+ this.gravity = 100;
/**
- * Set your own particle class type here.
- * @property {Description} particleClass
+ * @property {any} particleClass - For emitting your own particle class types.
* @default
*/
this.particleClass = null;
/**
- * The X and Y drag component of particles launched from the emitter.
- * @property {Phaser.Point} particleDrag
+ * @property {number} particleFriction - The friction component of particles launched from the emitter.
+ * @default
*/
- this.particleDrag = new Phaser.Point();
+ this.particleFriction = 0;
/**
- * The angular drag component of particles launched from the emitter if they are rotating.
- * @property {number} angularDrag
+ * @property {number} angularDrag - The angular drag component of particles launched from the emitter if they are rotating.
* @default
*/
this.angularDrag = 0;
/**
- * How often a particle is emitted in ms (if emitter is started with Explode === false).
- * @property {boolean} frequency
+ * @property {boolean} frequency - How often a particle is emitted in ms (if emitter is started with Explode === false).
* @default
*/
this.frequency = 100;
/**
- * How long each particle lives once it is emitted in ms. Default is 2 seconds.
- * Set lifespan to 'zero' for particles to live forever.
- * @property {number} lifespan
+ * @property {number} lifespan - How long each particle lives once it is emitted in ms. Default is 2 seconds. Set lifespan to 'zero' for particles to live forever.
* @default
*/
this.lifespan = 2000;
/**
- * How much each particle should bounce on each axis. 1 = full bounce, 0 = no bounce.
- * @property {Phaser.Point} bounce
+ * @property {Phaser.Point} bounce - How much each particle should bounce on each axis. 1 = full bounce, 0 = no bounce.
*/
this.bounce = new Phaser.Point();
/**
- * Internal helper for deciding how many particles to launch.
- * @property {number} _quantity
+ * @property {number} _quantity - Internal helper for deciding how many particles to launch.
* @private
- * @default
*/
this._quantity = 0;
/**
- * Internal helper for deciding when to launch particles or kill them.
- * @property {number} _timer
+ * @property {number} _timer - Internal helper for deciding when to launch particles or kill them.
* @private
- * @default
*/
this._timer = 0;
/**
- * Internal counter for figuring out how many particles to launch.
- * @property {number} _counter
+ * @property {number} _counter - Internal counter for figuring out how many particles to launch.
* @private
- * @default
*/
this._counter = 0;
/**
- * Internal helper for the style of particle emission (all at once, or one at a time).
- * @property {boolean} _explode
+ * @property {boolean} _explode - Internal helper for the style of particle emission (all at once, or one at a time).
* @private
- * @default
*/
this._explode = true;
/**
- * Determines whether the emitter is currently emitting particles.
- * It is totally safe to directly toggle this.
- * @property {boolean} on
+ * @property {boolean} on - Determines whether the emitter is currently emitting particles. It is totally safe to directly toggle this.
* @default
*/
this.on = false;
/**
- * Determines whether the emitter is being updated by the core game loop.
- * @property {boolean} exists
+ * @property {boolean} exists - Determines whether the emitter is being updated by the core game loop.
* @default
*/
this.exists = true;
@@ -695,43 +663,35 @@ Phaser.Particles.Arcade.Emitter.prototype.update = function () {
* This function generates a new array of particle sprites to attach to the emitter.
*
* @method Phaser.Particles.Arcade.Emitter#makeParticles
-* @param {Description} keys - Description.
-* @param {number} frames - Description.
-* @param {number} quantity - The number of particles to generate when using the "create from image" option.
-* @param {number} collide - Description.
-* @param {boolean} collideWorldBounds - Description.
-* @return This Emitter instance (nice for chaining stuff together, if you're into that).
+* @param {array|string} keys - A string or an array of strings that the particle sprites will use as their texture. If an array one is picked at random.
+* @param {array|number} frames - A frame number, or array of frames that the sprite will use. If an array one is picked at random.
+* @param {number} quantity - The number of particles to generate.
+* @param {boolean} [collide=false] - Sets the checkCollision.none flag on the particle sprites body.
+* @param {boolean} [collideWorldBounds=false] - A particle can be set to collide against the World bounds automatically and rebound back into the World if this is set to true. Otherwise it will leave the World.
+* @return {Phaser.Particles.Arcade.Emitter} This Emitter instance.
*/
Phaser.Particles.Arcade.Emitter.prototype.makeParticles = function (keys, frames, quantity, collide, collideWorldBounds) {
- if (typeof frames == 'undefined')
- {
- frames = 0;
- }
-
- quantity = quantity || this.maxParticles;
- collide = collide || 0;
-
- if (typeof collideWorldBounds == 'undefined')
- {
- collideWorldBounds = false;
- }
+ if (typeof frames === 'undefined') { frames = 0; }
+ if (typeof quantity === 'undefined') { quantity = this.maxParticles; }
+ if (typeof collide === 'undefined') { collide = false; }
+ if (typeof collideWorldBounds === 'undefined') { collideWorldBounds = false; }
var particle;
var i = 0;
var rndKey = keys;
- var rndFrame = 0;
+ var rndFrame = frames;
while (i < quantity)
{
- if (this.particleClass == null)
+ if (this.particleClass === null)
{
- if (typeof keys == 'object')
+ if (typeof keys === 'object')
{
rndKey = this.game.rnd.pick(keys);
}
- if (typeof frames == 'object')
+ if (typeof frames === 'object')
{
rndFrame = this.game.rnd.pick(frames);
}
@@ -743,14 +703,14 @@ Phaser.Particles.Arcade.Emitter.prototype.makeParticles = function (keys, frames
// particle = new this.particleClass(this.game);
// }
- if (collide > 0)
+ if (collide)
{
- particle.body.allowCollision.any = true;
- particle.body.allowCollision.none = false;
+ particle.body.checkCollision.any = true;
+ particle.body.checkCollision.none = false;
}
else
{
- particle.body.allowCollision.none = true;
+ particle.body.checkCollision.none = true;
}
particle.body.collideWorldBounds = collideWorldBounds;
@@ -770,9 +730,9 @@ Phaser.Particles.Arcade.Emitter.prototype.makeParticles = function (keys, frames
}
/**
- * Call this function to turn off all the particles and the emitter.
- * @method Phaser.Particles.Arcade.Emitter#kill
- */
+* Call this function to turn off all the particles and the emitter.
+* @method Phaser.Particles.Arcade.Emitter#kill
+*/
Phaser.Particles.Arcade.Emitter.prototype.kill = function () {
this.on = false;
@@ -782,10 +742,9 @@ Phaser.Particles.Arcade.Emitter.prototype.kill = function () {
}
/**
- * Handy for bringing game objects "back to life". Just sets alive and exists back to true.
- * In practice, this is most often called by <code>Object.reset()</code>.
- * @method Phaser.Particles.Arcade.Emitter#revive
- */
+* Handy for bringing game objects "back to life". Just sets alive and exists back to true.
+* @method Phaser.Particles.Arcade.Emitter#revive
+*/
Phaser.Particles.Arcade.Emitter.prototype.revive = function () {
this.alive = true;
@@ -794,27 +753,19 @@ Phaser.Particles.Arcade.Emitter.prototype.revive = function () {
}
/**
- * Call this function to start emitting particles.
- * @method Phaser.Particles.Arcade.Emitter#start
- * @param {boolean} explode - Whether the particles should all burst out at once.
- * @param {number} lifespan - How long each particle lives once emitted. 0 = forever.
- * @param {number} frequency - Ignored if Explode is set to true. Frequency is how often to emit a particle in ms.
- * @param {number} quantity - How many particles to launch. 0 = "all of the particles".
- */
+* Call this function to start emitting particles.
+* @method Phaser.Particles.Arcade.Emitter#start
+* @param {boolean} [explode=true] - Whether the particles should all burst out at once.
+* @param {number} [lifespan=0] - How long each particle lives once emitted. 0 = forever.
+* @param {number} [frequency=250] - Ignored if Explode is set to true. Frequency is how often to emit a particle in ms.
+* @param {number} [quantity=0] - How many particles to launch. 0 = "all of the particles".
+*/
Phaser.Particles.Arcade.Emitter.prototype.start = function (explode, lifespan, frequency, quantity) {
- if (typeof explode !== 'boolean')
- {
- explode = true;
- }
-
- lifespan = lifespan || 0;
-
- // How many ms between emissions?
- frequency = frequency || 250;
-
- // Total number of particles to emit
- quantity = quantity || 0;
+ if (typeof explode === 'undefined') { explode = true; }
+ if (typeof lifespan === 'undefined') { lifespan = 0; }
+ if (typeof frequency === 'undefined') { frequency = 250; }
+ if (typeof quantity === 'undefined') { quantity = 0; }
this.revive();
@@ -840,9 +791,9 @@ Phaser.Particles.Arcade.Emitter.prototype.start = function (explode, lifespan, f
}
/**
- * This function can be used both internally and externally to emit the next particle.
- * @method Phaser.Particles.Arcade.Emitter#emitParticle
- */
+* This function can be used both internally and externally to emit the next particle.
+* @method Phaser.Particles.Arcade.Emitter#emitParticle
+*/
Phaser.Particles.Arcade.Emitter.prototype.emitParticle = function () {
var particle = this.getFirstExists(false);
@@ -900,8 +851,7 @@ Phaser.Particles.Arcade.Emitter.prototype.emitParticle = function () {
particle.scale.setTo(scale, scale);
}
- particle.body.drag.x = this.particleDrag.x;
- particle.body.drag.y = this.particleDrag.y;
+ particle.body.friction = this.particleFriction;
particle.body.angularDrag = this.angularDrag;
}
@@ -909,8 +859,8 @@ Phaser.Particles.Arcade.Emitter.prototype.emitParticle = function () {
/**
* A more compact way of setting the width and height of the emitter.
* @method Phaser.Particles.Arcade.Emitter#setSize
-* @param {number} width - The desired width of the emitter (particles are spawned randomly within these dimensions).
-* @param {number} height - The desired height of the emitter.
+* @param {number} width - The desired width of the emitter (particles are spawned randomly within these dimensions).
+* @param {number} height - The desired height of the emitter.
*/
Phaser.Particles.Arcade.Emitter.prototype.setSize = function (width, height) {
@@ -922,8 +872,8 @@ Phaser.Particles.Arcade.Emitter.prototype.setSize = function (width, height) {
/**
* A more compact way of setting the X velocity range of the emitter.
* @method Phaser.Particles.Arcade.Emitter#setXSpeed
-* @param {number} min - The minimum value for this range.
-* @param {number} max - The maximum value for this range.
+* @param {number} [min=0] - The minimum value for this range.
+* @param {number} [max=0] - The maximum value for this range.
*/
Phaser.Particles.Arcade.Emitter.prototype.setXSpeed = function (min, max) {
@@ -938,8 +888,8 @@ Phaser.Particles.Arcade.Emitter.prototype.setXSpeed = function (min, max) {
/**
* A more compact way of setting the Y velocity range of the emitter.
* @method Phaser.Particles.Arcade.Emitter#setYSpeed
-* @param {number} min - The minimum value for this range.
-* @param {number} max - The maximum value for this range.
+* @param {number} [min=0] - The minimum value for this range.
+* @param {number} [max=0] - The maximum value for this range.
*/
Phaser.Particles.Arcade.Emitter.prototype.setYSpeed = function (min, max) {
@@ -954,8 +904,8 @@ Phaser.Particles.Arcade.Emitter.prototype.setYSpeed = function (min, max) {
/**
* A more compact way of setting the angular velocity constraints of the emitter.
* @method Phaser.Particles.Arcade.Emitter#setRotation
-* @param {number} min - The minimum value for this range.
-* @param {number} max - The maximum value for this range.
+* @param {number} [min=0] - The minimum value for this range.
+* @param {number} [max=0] - The maximum value for this range.
*/
Phaser.Particles.Arcade.Emitter.prototype.setRotation = function (min, max) {
@@ -968,14 +918,17 @@ Phaser.Particles.Arcade.Emitter.prototype.setRotation = function (min, max) {
}
/**
-* Change the emitter's midpoint to match the midpoint of a <code>Object</code>.
+* Change the emitters center to match the center of any object with a `center` property, such as a Sprite.
* @method Phaser.Particles.Arcade.Emitter#at
-* @param {object} object - The <code>Object</code> that you want to sync up with.
+* @param {object|Phaser.Sprite} object - The object that you wish to match the center with.
*/
Phaser.Particles.Arcade.Emitter.prototype.at = function (object) {
- this.emitX = object.center.x;
- this.emitY = object.center.y;
+ if (object.center)
+ {
+ this.emitX = object.center.x;
+ this.emitY = object.center.y;
+ }
}
@@ -1111,13 +1064,13 @@ Object.defineProperty(Phaser.Particles.Arcade.Emitter.prototype, "bottom", {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Events.js.html b/docs/Events.js.html
index b49c7657..0e77e3f9 100644
--- a/docs/Events.js.html
+++ b/docs/Events.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -447,6 +441,7 @@
Phaser.Events = function (sprite) {
this.parent = sprite;
+
this.onAddedToGroup = new Phaser.Signal();
this.onRemovedFromGroup = new Phaser.Signal();
this.onKilled = new Phaser.Signal();
@@ -464,6 +459,9 @@ Phaser.Events = function (sprite) {
this.onAnimationComplete = null;
this.onAnimationLoop = null;
+ this.onBeginContact = null;
+ this.onEndContact = null;
+
};
Phaser.Events.prototype = {
@@ -496,7 +494,10 @@ Phaser.Events.prototype = {
}
-};
+};
+
+Phaser.Events.prototype.constructor = Phaser.Events;
+
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Filter.js.html b/docs/Filter.js.html index 32d52126..b187003d 100644 --- a/docs/Filter.js.html +++ b/docs/Filter.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -475,9 +469,9 @@ Phaser.Filter = function (game, uniforms, fragmentSrc) {
*/
this.uniforms = {
- resolution: { type: '3f', value: { x: 256, y: 256, z: 0 }},
time: { type: '1f', value: 0 },
- mouse: { type: '4f', value: { x: 0, y: 0, z: 0, w: 0 }}
+ resolution: { type: '2f', value: { x: 256, y: 256 }},
+ mouse: { type: '2f', value: { x: 0.0, y: 0.0 }}
};
@@ -520,8 +514,15 @@ Phaser.Filter.prototype = {
if (typeof pointer !== 'undefined')
{
- this.uniforms.mouse.x = pointer.x;
- this.uniforms.mouse.y = pointer.y;
+ if (pointer.x > 0)
+ {
+ this.uniforms.mouse.x = pointer.x.toFixed(2);
+ }
+
+ if (pointer.y > 0)
+ {
+ this.uniforms.mouse.y = pointer.y.toFixed(2);
+ }
}
this.uniforms.time.value = this.game.time.totalElapsedSeconds();
@@ -540,6 +541,8 @@ Phaser.Filter.prototype = {
};
+Phaser.Filter.prototype.constructor = Phaser.Filter;
+
/**
* @name Phaser.Filter#width
* @property {number} width - The width (resolution uniform)
@@ -586,13 +589,13 @@ Object.defineProperty(Phaser.Filter.prototype, 'height', {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Frame.js.html b/docs/Frame.js.html
index 85be511e..56b5e93c 100644
--- a/docs/Frame.js.html
+++ b/docs/Frame.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -581,6 +575,8 @@ Phaser.Frame.prototype = {
}
};
+
+Phaser.Frame.prototype.constructor = Phaser.Frame;
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/FrameData.js.html b/docs/FrameData.js.html index da678000..a25b6514 100644 --- a/docs/FrameData.js.html +++ b/docs/FrameData.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -646,6 +640,8 @@ Phaser.FrameData.prototype = {
};
+Phaser.FrameData.prototype.constructor = Phaser.FrameData;
+
/**
* @name Phaser.FrameData#total
* @property {number} total - The total number of frames in this FrameData set.
@@ -673,13 +669,13 @@ Object.defineProperty(Phaser.FrameData.prototype, "total", {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Game.js.html b/docs/Game.js.html
index 1bb2ffda..b075f156 100644
--- a/docs/Game.js.html
+++ b/docs/Game.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -440,64 +434,68 @@
* @param {number} [width=800] - The width of your game in game pixels.
* @param {number} [height=600] - The height of your game in game pixels.
* @param {number} [renderer=Phaser.AUTO] - Which renderer to use: Phaser.AUTO will auto-detect, Phaser.WEBGL, Phaser.CANVAS or Phaser.HEADLESS (no rendering at all).
-* @param {HTMLElement} [parent=''] - The Games DOM parent.
-* @param {any} [state=null] - Description.
+* @param {string|HTMLElement} [parent=''] - The DOM element into which this games canvas will be injected. Either a DOM ID (string) or the element itself.
+* @param {object} [state=null] - The default state object. A object consisting of Phaser.State functions (preload, create, update, render) or null.
* @param {boolean} [transparent=false] - Use a transparent canvas background or not.
* @param {boolean} [antialias=true] - Anti-alias graphics.
*/
Phaser.Game = function (width, height, renderer, parent, state, transparent, antialias) {
- width = width || 800;
- height = height || 600;
- renderer = renderer || Phaser.AUTO;
- parent = parent || '';
- state = state || null;
-
- if (typeof transparent == 'undefined') { transparent = false; }
- if (typeof antialias == 'undefined') { antialias = true; }
-
/**
* @property {number} id - Phaser Game ID (for when Pixi supports multiple instances).
*/
this.id = Phaser.GAMES.push(this) - 1;
/**
- * @property {HTMLElement} parent - The Games DOM parent.
+ * @property {object} config - The Phaser.Game configuration object.
*/
- this.parent = parent;
+ this.config = null;
- // Do some more intelligent size parsing here, so they can set "100%" for example, maybe pass the scale mode in here too?
+ /**
+ * @property {HTMLElement} parent - The Games DOM parent.
+ * @default
+ */
+ this.parent = '';
/**
* @property {number} width - The Game width (in pixels).
+ * @default
*/
- this.width = width;
+ this.width = 800;
/**
* @property {number} height - The Game height (in pixels).
+ * @default
*/
- this.height = height;
+ this.height = 600;
/**
* @property {boolean} transparent - Use a transparent canvas background or not.
+ * @default
*/
- this.transparent = transparent;
+ this.transparent = false;
/**
* @property {boolean} antialias - Anti-alias graphics (in WebGL this helps with edges, in Canvas2D it retains pixel-art quality).
+ * @default
*/
- this.antialias = antialias;
+ this.antialias = true;
/**
* @property {number} renderer - The Pixi Renderer
* @default
*/
- this.renderer = null;
+ this.renderer = Phaser.AUTO;
+
+ /**
+ * @property {number} renderType - The Renderer this Phaser.Game will use. Either Phaser.RENDERER_AUTO, Phaser.RENDERER_CANVAS or Phaser.RENDERER_WEBGL.
+ */
+ this.renderType = Phaser.AUTO;
/**
* @property {number} state - The StateManager.
*/
- this.state = new Phaser.StateManager(this, state);
+ this.state = null;
/**
* @property {boolean} _paused - Is game paused?
@@ -506,11 +504,6 @@ Phaser.Game = function (width, height, renderer, parent, state, transparent, ant
*/
this._paused = false;
- /**
- * @property {number} renderType - The Renderer this Phaser.Game will use. Either Phaser.RENDERER_AUTO, Phaser.RENDERER_CANVAS or Phaser.RENDERER_WEBGL.
- */
- this.renderType = renderer;
-
/**
* @property {boolean} _loadComplete - Whether load complete loading or not.
* @private
@@ -650,6 +643,68 @@ Phaser.Game = function (width, height, renderer, parent, state, transparent, ant
*/
this.particles = null;
+ /**
+ * @property {boolean} stepping - Enable core loop stepping with Game.enableStep().
+ * @default
+ * @readonly
+ */
+ this.stepping = false;
+
+ /**
+ * @property {boolean} stepping - An internal property used by enableStep, but also useful to query from your own game objects.
+ * @default
+ * @readonly
+ */
+ this.pendingStep = false;
+
+ /**
+ * @property {number} stepCount - When stepping is enabled this contains the current step cycle.
+ * @default
+ * @readonly
+ */
+ this.stepCount = 0;
+
+ // Parse the configuration object (if any)
+ if (arguments.length === 1 && typeof arguments[0] === 'object')
+ {
+ this.parseConfig(arguments[0]);
+ }
+ else
+ {
+ if (typeof width !== 'undefined')
+ {
+ this.width = width;
+ }
+
+ if (typeof height !== 'undefined')
+ {
+ this.height = height;
+ }
+
+ if (typeof renderer !== 'undefined')
+ {
+ this.renderer = renderer;
+ this.renderType = renderer;
+ }
+
+ if (typeof parent !== 'undefined')
+ {
+ this.parent = parent;
+ }
+
+ if (typeof transparent !== 'undefined')
+ {
+ this.transparent = transparent;
+ }
+
+ if (typeof antialias !== 'undefined')
+ {
+ this.antialias = antialias;
+ }
+
+ this.state = new Phaser.StateManager(this, state);
+ }
+
var _this = this;
this._onBoot = function () {
@@ -672,6 +727,99 @@ Phaser.Game = function (width, height, renderer, parent, state, transparent, ant
Phaser.Game.prototype = {
+ /**
+ * Parses a Game configuration object.
+ *
+ * @method Phaser.Game#parseConfig
+ * @protected
+ */
+ parseConfig: function (config) {
+
+ this.config = config;
+
+ if (config['width'])
+ {
+ this.width = this.parseDimension(config['width'], 0);
+ }
+
+ if (config['height'])
+ {
+ this.height = this.parseDimension(config['height'], 1);
+ }
+
+ if (config['renderer'])
+ {
+ this.renderer = config['renderer'];
+ this.renderType = config['renderer'];
+ }
+
+ if (config['parent'])
+ {
+ this.parent = config['parent'];
+ }
+
+ if (config['transparent'])
+ {
+ this.transparent = config['transparent'];
+ }
+
+ if (config['antialias'])
+ {
+ this.antialias = config['antialias'];
+ }
+
+ var state = null;
+
+ if (config['state'])
+ {
+ state = config['state'];
+ }
+
+ this.state = new Phaser.StateManager(this, state);
+
+ },
+
+ /**
+ * Get dimension.
+ *
+ * @method Phaser.Game#parseDimension
+ * @protected
+ */
+ parseDimension: function (size, dimension) {
+
+ var f = 0;
+ var px = 0;
+
+ if (typeof size === 'string')
+ {
+ // %?
+ if (size.substr(-1) === '%')
+ {
+ f = parseInt(size, 10) / 100;
+
+ if (dimension === 0)
+ {
+ px = window.innerWidth * f;
+ }
+ else
+ {
+ px = window.innerHeight * f;
+ }
+ }
+ else
+ {
+ px = parseInt(size, 10);
+ }
+ }
+ else
+ {
+ px = size;
+ }
+
+ return px;
+
+ },
+
/**
* Initialize engine sub modules and start the game.
*
@@ -721,6 +869,7 @@ Phaser.Game.prototype = {
this.net = new Phaser.Net(this);
this.debug = new Phaser.Utils.Debug(this);
+ this.time.boot();
this.stage.boot();
this.world.boot();
this.input.boot();
@@ -795,6 +944,14 @@ Phaser.Game.prototype = {
*/
setUpRenderer: function () {
+ /*
+ if (this.device.trident)
+ {
+ // Pixi WebGL renderer on IE11 doesn't work correctly with masks, if you need them you may want to comment this block out
+ this.renderType = Phaser.CANVAS;
+ }
+ */
+
if (this.renderType === Phaser.HEADLESS || this.renderType === Phaser.CANVAS || (this.renderType === Phaser.AUTO && this.device.webGL === false))
{
if (this.device.canvas)
@@ -861,20 +1018,28 @@ Phaser.Game.prototype = {
}
else
{
- this.plugins.preUpdate();
- this.physics.preUpdate();
+ if (!this.pendingStep)
+ {
+ if (this.stepping)
+ {
+ this.pendingStep = true;
+ }
- this.stage.update();
- this.input.update();
- this.tweens.update();
- this.sound.update();
- this.world.update();
- this.particles.update();
- this.state.update();
- this.plugins.update();
+ this.plugins.preUpdate();
+ this.world.preUpdate();
- this.world.postUpdate();
- this.plugins.postUpdate();
+ this.stage.update();
+ this.tweens.update();
+ this.sound.update();
+ this.input.update();
+ this.state.update();
+ this.world.update();
+ this.particles.update();
+ this.plugins.update();
+
+ this.world.postUpdate();
+ this.plugins.postUpdate();
+ }
if (this.renderType !== Phaser.HEADLESS)
{
@@ -884,11 +1049,49 @@ Phaser.Game.prototype = {
this.plugins.postRender();
}
-
}
},
+ /**
+ * Enable core game loop stepping. When enabled you must call game.step() directly (perhaps via a DOM button?)
+ * Calling step will advance the game loop by one frame. This is extremely useful to hard to track down errors!
+ *
+ * @method Phaser.Game#enableStep
+ */
+ enableStep: function () {
+
+ this.stepping = true;
+ this.pendingStep = false;
+ this.stepCount = 0;
+
+ },
+
+ /**
+ * Disables core game loop stepping.
+ *
+ * @method Phaser.Game#disableStep
+ */
+ disableStep: function () {
+
+ this.stepping = false;
+ this.pendingStep = false;
+
+ },
+
+ /**
+ * When stepping is enabled you must call this function directly (perhaps via a DOM button?) to advance the game loop by one frame.
+ * This is extremely useful to hard to track down errors! Use the internal stepCount property to monitor progress.
+ *
+ * @method Phaser.Game#step
+ */
+ step: function () {
+
+ this.pendingStep = false;
+ this.stepCount++;
+
+ },
+
/**
* Nuke the entire game from orbit
*
@@ -916,6 +1119,8 @@ Phaser.Game.prototype = {
};
+Phaser.Game.prototype.constructor = Phaser.Game;
+
/**
* The paused state of the Game. A paused game doesn't update any of its subsystems.
* When a game is paused the onPause event is dispatched. When it is resumed the onResume event is dispatched.
@@ -969,13 +1174,13 @@ Object.defineProperty(Phaser.Game.prototype, "paused", {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/GameObjectFactory.js.html b/docs/GameObjectFactory.js.html
index d5083241..8665cdb7 100644
--- a/docs/GameObjectFactory.js.html
+++ b/docs/GameObjectFactory.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -470,15 +464,19 @@ Phaser.GameObjectFactory.prototype = {
* @param {number} y - Y position of the new sprite.
* @param {string|Phaser.RenderTexture|PIXI.Texture} key - This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.
* @param {string|number} [frame] - If the sprite uses an image from a texture atlas or sprite sheet you can pass the frame here. Either a number for a frame ID or a string for a frame name.
+ * @param {Phaser.Group} [group] - Optional Group to add the object to. If not specified it will be added to the World group.
* @returns {Phaser.Sprite} the newly created sprite object.
*/
- sprite: function (x, y, key, frame) {
+ sprite: function (x, y, key, frame, group) {
- return this.world.create(x, y, key, frame);
+ if (typeof group === 'undefined') { group = this.world; }
+
+ return group.create(x, y, key, frame);
},
/**
+ * DEPRECATED - will be removed in Phaser 1.2
* Create a new Sprite with specific position and sprite sheet key that will automatically be added as a child of the given parent.
*
* @method Phaser.GameObjectFactory#child
@@ -512,8 +510,8 @@ Phaser.GameObjectFactory.prototype = {
* A Group is a container for display objects that allows for fast pooling, recycling and collision checks.
*
* @method Phaser.GameObjectFactory#group
- * @param {*} parent - The parent Group or DisplayObjectContainer that will hold this group, if any.
- * @param {string} [name=group] - A name for this Group. Not used internally but useful for debugging.
+ * @param {any} parent - The parent Group or DisplayObjectContainer that will hold this group, if any.
+ * @param {string} [name='group'] - A name for this Group. Not used internally but useful for debugging.
* @return {Phaser.Group} The newly created group.
*/
group: function (parent, name) {
@@ -523,7 +521,7 @@ Phaser.GameObjectFactory.prototype = {
},
/**
- * Creates a new instance of the Sound class.
+ * Creates a new Sound object.
*
* @method Phaser.GameObjectFactory#audio
* @param {string} key - The Game.cache key of the sound that this object will use.
@@ -539,7 +537,23 @@ Phaser.GameObjectFactory.prototype = {
},
/**
- * Creates a new <code>TileSprite</code>.
+ * Creates a new Sound object.
+ *
+ * @method Phaser.GameObjectFactory#sound
+ * @param {string} key - The Game.cache key of the sound that this object will use.
+ * @param {number} [volume=1] - The volume at which the sound will be played.
+ * @param {boolean} [loop=false] - Whether or not the sound will loop.
+ * @param {boolean} [connect=true] - Controls if the created Sound object will connect to the master gainNode of the SoundManager when running under WebAudio.
+ * @return {Phaser.Sound} The newly created text object.
+ */
+ sound: function (key, volume, loop, connect) {
+
+ return this.game.sound.add(key, volume, loop, connect);
+
+ },
+
+ /**
+ * Creates a new TileSprite object.
*
* @method Phaser.GameObjectFactory#tileSprite
* @param {number} x - X position of the new tileSprite.
@@ -547,33 +561,38 @@ Phaser.GameObjectFactory.prototype = {
* @param {number} width - the width of the tilesprite.
* @param {number} height - the height of the tilesprite.
* @param {string|Phaser.RenderTexture|PIXI.Texture} key - This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.
- * @param {string|number} frame - If this Sprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.
+ * @param {Phaser.Group} [group] - Optional Group to add the object to. If not specified it will be added to the World group.
* @return {Phaser.TileSprite} The newly created tileSprite object.
*/
- tileSprite: function (x, y, width, height, key, frame) {
+ tileSprite: function (x, y, width, height, key, group) {
- return this.world.add(new Phaser.TileSprite(this.game, x, y, width, height, key, frame));
+ if (typeof group === 'undefined') { group = this.world; }
+
+ return group.add(new Phaser.TileSprite(this.game, x, y, width, height, key));
},
/**
- * Creates a new <code>Text</code>.
+ * Creates a new Text object.
*
* @method Phaser.GameObjectFactory#text
* @param {number} x - X position of the new text object.
* @param {number} y - Y position of the new text object.
* @param {string} text - The actual text that will be written.
* @param {object} style - The style object containing style attributes like font, font size , etc.
+ * @param {Phaser.Group} [group] - Optional Group to add the object to. If not specified it will be added to the World group.
* @return {Phaser.Text} The newly created text object.
*/
- text: function (x, y, text, style) {
+ text: function (x, y, text, style, group) {
- return this.world.add(new Phaser.Text(this.game, x, y, text, style));
+ if (typeof group === 'undefined') { group = this.world; }
+
+ return group.add(new Phaser.Text(this.game, x, y, text, style));
},
/**
- * Creates a new <code>Button</code> object.
+ * Creates a new Button object.
*
* @method Phaser.GameObjectFactory#button
* @param {number} [x] X position of the new button object.
@@ -584,25 +603,32 @@ Phaser.GameObjectFactory.prototype = {
* @param {string|number} [overFrame] This is the frame or frameName that will be set when this button is in an over state. Give either a number to use a frame ID or a string for a frame name.
* @param {string|number} [outFrame] This is the frame or frameName that will be set when this button is in an out state. Give either a number to use a frame ID or a string for a frame name.
* @param {string|number} [downFrame] This is the frame or frameName that will be set when this button is in a down state. Give either a number to use a frame ID or a string for a frame name.
+ * @param {string|number} [upFrame] This is the frame or frameName that will be set when this button is in an up state. Give either a number to use a frame ID or a string for a frame name.
+ * @param {Phaser.Group} [group] - Optional Group to add the object to. If not specified it will be added to the World group.
* @return {Phaser.Button} The newly created button object.
*/
- button: function (x, y, key, callback, callbackContext, overFrame, outFrame, downFrame) {
+ button: function (x, y, key, callback, callbackContext, overFrame, outFrame, downFrame, upFrame, group) {
- return this.world.add(new Phaser.Button(this.game, x, y, key, callback, callbackContext, overFrame, outFrame, downFrame));
+ if (typeof group === 'undefined') { group = this.world; }
+
+ return group.add(new Phaser.Button(this.game, x, y, key, callback, callbackContext, overFrame, outFrame, downFrame, upFrame));
},
/**
- * Creates a new <code>Graphics</code> object.
+ * Creates a new Graphics object.
*
* @method Phaser.GameObjectFactory#graphics
* @param {number} x - X position of the new graphics object.
* @param {number} y - Y position of the new graphics object.
+ * @param {Phaser.Group} [group] - Optional Group to add the object to. If not specified it will be added to the World group.
* @return {Phaser.Graphics} The newly created graphics object.
*/
- graphics: function (x, y) {
+ graphics: function (x, y, group) {
- return this.world.add(new Phaser.Graphics(this.game, x, y));
+ if (typeof group === 'undefined') { group = this.world; }
+
+ return group.add(new Phaser.Graphics(this.game, x, y));
},
@@ -624,16 +650,19 @@ Phaser.GameObjectFactory.prototype = {
},
/**
- * * Create a new <code>BitmapText</code>.
+ * * Create a new BitmapText object.
*
* @method Phaser.GameObjectFactory#bitmapText
* @param {number} x - X position of the new bitmapText object.
* @param {number} y - Y position of the new bitmapText object.
* @param {string} text - The actual text that will be written.
* @param {object} style - The style object containing style attributes like font, font size , etc.
+ * @param {Phaser.Group} [group] - Optional Group to add the object to. If not specified it will be added to the World group.
* @return {Phaser.BitmapText} The newly created bitmapText object.
*/
- bitmapText: function (x, y, text, style) {
+ bitmapText: function (x, y, text, style, group) {
+
+ if (typeof group === 'undefined') { group = this.world; }
return this.world.add(new Phaser.BitmapText(this.game, x, y, text, style));
@@ -643,41 +672,13 @@ Phaser.GameObjectFactory.prototype = {
* Creates a new Tilemap object.
*
* @method Phaser.GameObjectFactory#tilemap
- * @param {string} key - Asset key for the JSON file.
+ * @param {string} key - Asset key for the JSON or CSV map data in the cache.
+ * @param {object|string} tilesets - An object mapping Cache.tileset keys with the tileset names in the JSON file. If a string is provided that will be used.
* @return {Phaser.Tilemap} The newly created tilemap object.
*/
- tilemap: function (key) {
+ tilemap: function (key, tilesets) {
- return new Phaser.Tilemap(this.game, key);
-
- },
-
- /**
- * Creates a new Tileset object.
- *
- * @method Phaser.GameObjectFactory#tileset
- * @param {string} key - The image key as defined in the Game.Cache to use as the tileset.
- * @return {Phaser.Tileset} The newly created tileset object.
- */
- tileset: function (key) {
-
- return this.game.cache.getTileset(key);
-
- },
-
- /**
- * Creates a new Tilemap Layer object.
- *
- * @method Phaser.GameObjectFactory#tilemapLayer
- * @param {number} x - X position of the new tilemapLayer.
- * @param {number} y - Y position of the new tilemapLayer.
- * @param {number} width - the width of the tilemapLayer.
- * @param {number} height - the height of the tilemapLayer.
- * @return {Phaser.TilemapLayer} The newly created tilemaplayer object.
- */
- tilemapLayer: function (x, y, width, height, tileset, tilemap, layer) {
-
- return this.world.add(new Phaser.TilemapLayer(this.game, x, y, width, height, tileset, tilemap, layer));
+ return new Phaser.Tilemap(this.game, key, tilesets);
},
@@ -701,7 +702,7 @@ Phaser.GameObjectFactory.prototype = {
},
/**
- * A BitmapData object which can be manipulated and drawn to like a traditional Canvas object and used to texture Sprites.
+ * Experimental: A BitmapData object which can be manipulated and drawn to like a traditional Canvas object and used to texture Sprites.
*
* @method Phaser.GameObjectFactory#bitmapData
* @param {number} [width=256] - The width of the BitmapData in pixels.
@@ -734,7 +735,10 @@ Phaser.GameObjectFactory.prototype = {
}
-};
+};
+
+Phaser.GameObjectFactory.prototype.constructor = Phaser.GameObjectFactory;
+
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Gamepad.js.html b/docs/Gamepad.js.html new file mode 100644 index 00000000..54da0f92 --- /dev/null +++ b/docs/Gamepad.js.html @@ -0,0 +1,1057 @@ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/GamepadButton.js.html b/docs/GamepadButton.js.html
new file mode 100644
index 00000000..e4982105
--- /dev/null
+++ b/docs/GamepadButton.js.html
@@ -0,0 +1,654 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source: input/Gamepad.js
+ +/**
+* @author @karlmacklin <tacklemcclean@gmail.com>
+* @copyright 2014 Photon Storm Ltd.
+* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
+*/
+
+/**
+* The Gamepad class handles looking after gamepad input for your game.
+* Remember to call gamepad.start(); expecting input!
+*
+* HTML5 GAMEPAD API SUPPORT IS AT AN EXPERIMENTAL STAGE!
+* At moment of writing this (end of 2013) only Chrome supports parts of it out of the box. Firefox supports it
+* via prefs flags (about:config, search gamepad). The browsers map the same controllers differently.
+* This class has constans for Windows 7 Chrome mapping of
+* XBOX 360 controller.
+*
+* @class Phaser.Gamepad
+* @constructor
+* @param {Phaser.Game} game - A reference to the currently running game.
+*/
+Phaser.Gamepad = function (game) {
+
+ /**
+ * @property {Phaser.Game} game - Local reference to game.
+ */
+ this.game = game;
+
+ /**
+ * @property {Array<Phaser.SinglePad>} _gamepads - The four Phaser Gamepads.
+ * @private
+ */
+ this._gamepads = [
+ new Phaser.SinglePad(game, this),
+ new Phaser.SinglePad(game, this),
+ new Phaser.SinglePad(game, this),
+ new Phaser.SinglePad(game, this)
+ ];
+
+ /**
+ * @property {Object} _gamepadIndexMap - Maps the browsers gamepad indices to our Phaser Gamepads
+ * @private
+ */
+ this._gamepadIndexMap = {};
+
+ /**
+ * @property {Array} _rawPads - The raw state of the gamepads from the browser
+ * @private
+ */
+ this._rawPads = [];
+
+ /**
+ * @property {boolean} _active - Private flag for whether or not the API is polled
+ * @private
+ * @default
+ */
+ this._active = false;
+
+ /**
+ * You can disable all Gamepad Input by setting disabled to true. While true all new input related events will be ignored.
+ * @property {boolean} disabled - The disabled state of the Gamepad.
+ * @default
+ */
+ this.disabled = false;
+
+ /**
+ * Whether or not gamepads are supported in the current browser. Note that as of Dec. 2013 this check is actually not accurate at all due to poor implementation.
+ * @property {boolean} _gamepadSupportAvailable - Are gamepads supported in this browser or not?
+ * @private
+ */
+ this._gamepadSupportAvailable = !!navigator.webkitGetGamepads || !!navigator.webkitGamepads || (navigator.userAgent.indexOf('Firefox/') != -1);
+
+ /**
+ * Used to check for differences between earlier polls and current state of gamepads.
+ * @property {Array} _prevRawGamepadTypes
+ * @private
+ * @default
+ */
+ this._prevRawGamepadTypes = [];
+
+ /**
+ * Used to check for differences between earlier polls and current state of gamepads.
+ * @property {Array} _prevTimestamps
+ * @private
+ * @default
+ */
+ this._prevTimestamps = [];
+
+ /**
+ * @property {Object} callbackContext - The context under which the callbacks are run.
+ */
+ this.callbackContext = this;
+
+ /**
+ * @property {function} onConnectCallback - This callback is invoked every time any gamepad is connected
+ */
+ this.onConnectCallback = null;
+
+ /**
+ * @property {function} onDisconnectCallback - This callback is invoked every time any gamepad is disconnected
+ */
+ this.onDisconnectCallback = null;
+
+ /**
+ * @property {function} onDownCallback - This callback is invoked every time any gamepad button is pressed down.
+ */
+ this.onDownCallback = null;
+
+ /**
+ * @property {function} onUpCallback - This callback is invoked every time any gamepad button is released.
+ */
+ this.onUpCallback = null;
+
+ /**
+ * @property {function} onAxisCallback - This callback is invoked every time any gamepad axis is changed.
+ */
+ this.onAxisCallback = null;
+
+ /**
+ * @property {function} onFloatCallback - This callback is invoked every time any gamepad button is changed to a value where value > 0 and value < 1.
+ */
+ this.onFloatCallback = null;
+
+ /**
+ * @property {function} _ongamepadconnected - Private callback for Firefox gamepad connection handling
+ * @private
+ */
+ this._ongamepadconnected = null;
+
+ /**
+ * @property {function} _gamepaddisconnected - Private callback for Firefox gamepad connection handling
+ * @private
+ */
+ this._gamepaddisconnected = null;
+};
+
+Phaser.Gamepad.prototype = {
+
+ /**
+ * Add callbacks to the main Gamepad handler to handle connect/disconnect/button down/button up/axis change/float value buttons
+ * @method Phaser.Gamepad#addCallbacks
+ * @param {Object} context - The context under which the callbacks are run.
+ * @param {Object} callbacks - Object that takes six different callback 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;
+ }
+
+ },
+
+ /**
+ * Starts the Gamepad event handling.
+ * This MUST be called manually before Phaser will start polling the Gamepad API.
+ *
+ * @method Phaser.Gamepad#start
+ */
+ start: function () {
+
+ this._active = true;
+ var _this = this;
+
+ this._ongamepadconnected = function(event) {
+ var newPad = event.gamepad;
+ _this._rawPads.push(newPad);
+ _this._gamepads[newPad.index].connect(newPad);
+ };
+
+ window.addEventListener('gamepadconnected', this._ongamepadconnected, false);
+
+ this._ongamepaddisconnected = function(event) {
+
+ var removedPad = event.gamepad;
+
+ for (var i in _this._rawPads)
+ {
+ if (_this._rawPads[i].index === removedPad.index)
+ {
+ _this._rawPads.splice(i,1);
+ }
+ }
+ _this._gamepads[removedPad.index].disconnect();
+ };
+
+ window.addEventListener('gamepaddisconnected', this._ongamepaddisconnected, false);
+
+ },
+
+ /**
+ * Main gamepad update loop. Should not be called manually.
+ * @method Phaser.Gamepad#update
+ * @private
+ */
+ update: function () {
+
+ this._pollGamepads();
+
+ for (var i = 0; i < this._gamepads.length; i++)
+ {
+ if (this._gamepads[i]._connected)
+ {
+ this._gamepads[i].pollStatus();
+ }
+ }
+
+ },
+
+ /**
+ * Updating connected gamepads (for Google Chrome).
+ * Should not be called manually.
+ * @method Phaser.Gamepad#_pollGamepads
+ * @private
+ */
+ _pollGamepads: function () {
+
+ var rawGamepads = (navigator.webkitGetGamepads && navigator.webkitGetGamepads()) || navigator.webkitGamepads;
+
+ if (rawGamepads)
+ {
+ this._rawPads = [];
+
+ var gamepadsChanged = false;
+
+ for (var i = 0; i < rawGamepads.length; i++)
+ {
+ if (typeof rawGamepads[i] !== this._prevRawGamepadTypes[i])
+ {
+ gamepadsChanged = true;
+ this._prevRawGamepadTypes[i] = typeof rawGamepads[i];
+ }
+
+ if (rawGamepads[i])
+ {
+ this._rawPads.push(rawGamepads[i]);
+ }
+
+ // Support max 4 pads at the moment
+ if (i === 3)
+ {
+ break;
+ }
+ }
+
+ if (gamepadsChanged)
+ {
+ var validConnections = { rawIndices: {}, padIndices: {} };
+ var singlePad;
+
+ for (var j = 0; j < this._gamepads.length; j++)
+ {
+ singlePad = this._gamepads[j];
+
+ if (singlePad.connected)
+ {
+ for (var k = 0; k < this._rawPads.length; k++)
+ {
+ if (this._rawPads[k].index === singlePad.index)
+ {
+ validConnections.rawIndices[singlePad.index] = true;
+ validConnections.padIndices[j] = true;
+ }
+ }
+ }
+ }
+
+ for (var l = 0; l < this._gamepads.length; l++)
+ {
+ singlePad = this._gamepads[l];
+
+ if (validConnections.padIndices[l])
+ {
+ continue;
+ }
+
+ if (this._rawPads.length < 1)
+ {
+ singlePad.disconnect();
+ }
+
+ for (var m = 0; m < this._rawPads.length; m++)
+ {
+ if (validConnections.padIndices[l])
+ {
+ break;
+ }
+
+ var rawPad = this._rawPads[m];
+
+ if (rawPad)
+ {
+ if (validConnections.rawIndices[rawPad.index])
+ {
+ singlePad.disconnect();
+ continue;
+ }
+ else
+ {
+ singlePad.connect(rawPad);
+ validConnections.rawIndices[rawPad.index] = true;
+ validConnections.padIndices[l] = true;
+ }
+ }
+ else
+ {
+ singlePad.disconnect();
+ }
+ }
+ }
+ }
+ }
+ },
+
+ /**
+ * Sets the deadZone variable for all four gamepads
+ * @method Phaser.Gamepad#setDeadZones
+ */
+ setDeadZones: function (value) {
+
+ for (var i = 0; i < this._gamepads.length; i++)
+ {
+ this._gamepads[i].deadZone = value;
+ }
+
+ },
+
+ /**
+ * Stops the Gamepad event handling.
+ *
+ * @method Phaser.Gamepad#stop
+ */
+ stop: function () {
+
+ this._active = false;
+
+ window.removeEventListener('gamepadconnected', this._ongamepadconnected);
+ window.removeEventListener('gamepaddisconnected', this._ongamepaddisconnected);
+
+ },
+
+ /**
+ * Reset all buttons/axes of all gamepads
+ * @method Phaser.Gamepad#reset
+ */
+ reset: function () {
+
+ this.update();
+
+ for (var i = 0; i < this._gamepads.length; i++)
+ {
+ this._gamepads[i].reset();
+ }
+
+ },
+
+ /**
+ * Returns the "just pressed" state of a button from ANY gamepad connected. Just pressed is considered true if the button was pressed down within the duration given (default 250ms).
+ * @method Phaser.Gamepad#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) {
+
+ for (var i = 0; i < this._gamepads.length; i++)
+ {
+ if (this._gamepads[i].justPressed(buttonCode, duration) === true)
+ {
+ return true;
+ }
+ }
+
+ return false;
+
+ },
+
+ /**
+ * Returns the "just released" state of a button from ANY gamepad connected. Just released is considered as being true if the button was released within the duration given (default 250ms).
+ * @method Phaser.Gamepad#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 released.
+ * @return {boolean} True if the button is just released otherwise false.
+ */
+ justReleased: function (buttonCode, duration) {
+
+ for (var i = 0; i < this._gamepads.length; i++)
+ {
+ if (this._gamepads[i].justReleased(buttonCode, duration) === true)
+ {
+ return true;
+ }
+ }
+
+ return false;
+
+ },
+
+ /**
+ * Returns true if the button is currently pressed down, on ANY gamepad.
+ * @method Phaser.Gamepad#isDown
+ * @param {number} buttonCode - The buttonCode of the button to check for.
+ * @return {boolean} True if a button is currently down.
+ */
+ isDown: function (buttonCode) {
+
+ for (var i = 0; i < this._gamepads.length; i++)
+ {
+ if (this._gamepads[i].isDown(buttonCode) === true)
+ {
+ return true;
+ }
+ }
+
+ return false;
+ }
+
+};
+
+Phaser.Gamepad.prototype.constructor = Phaser.Gamepad;
+
+/**
+* If the gamepad input is active or not - if not active it should not be updated from Input.js
+* @name Phaser.Gamepad#active
+* @property {boolean} active - If the gamepad input is active or not.
+* @readonly
+*/
+Object.defineProperty(Phaser.Gamepad.prototype, "active", {
+
+ get: function () {
+ return this._active;
+ }
+
+});
+
+/**
+* Whether or not gamepads are supported in current browser.
+* @name Phaser.Gamepad#supported
+* @property {boolean} supported - Whether or not gamepads are supported in current browser.
+* @readonly
+*/
+Object.defineProperty(Phaser.Gamepad.prototype, "supported", {
+
+ get: function () {
+ return this._gamepadSupportAvailable;
+ }
+
+});
+
+/**
+* How many live gamepads are currently connected.
+* @name Phaser.Gamepad#padsConnected
+* @property {boolean} padsConnected - How many live gamepads are currently connected.
+* @readonly
+*/
+Object.defineProperty(Phaser.Gamepad.prototype, "padsConnected", {
+
+ get: function () {
+ return this._rawPads.length;
+ }
+
+});
+
+/**
+* Gamepad #1
+* @name Phaser.Gamepad#pad1
+* @property {boolean} pad1 - Gamepad #1;
+* @readonly
+*/
+Object.defineProperty(Phaser.Gamepad.prototype, "pad1", {
+
+ get: function () {
+ return this._gamepads[0];
+ }
+
+});
+
+/**
+* Gamepad #2
+* @name Phaser.Gamepad#pad2
+* @property {boolean} pad2 - Gamepad #2
+* @readonly
+*/
+Object.defineProperty(Phaser.Gamepad.prototype, "pad2", {
+
+ get: function () {
+ return this._gamepads[1];
+ }
+
+});
+
+/**
+* Gamepad #3
+* @name Phaser.Gamepad#pad3
+* @property {boolean} pad3 - Gamepad #3
+* @readonly
+*/
+Object.defineProperty(Phaser.Gamepad.prototype, "pad3", {
+
+ get: function () {
+ return this._gamepads[2];
+ }
+
+});
+
+/**
+* Gamepad #4
+* @name Phaser.Gamepad#pad4
+* @property {boolean} pad4 - Gamepad #4
+* @readonly
+*/
+Object.defineProperty(Phaser.Gamepad.prototype, "pad4", {
+
+ get: function () {
+ return this._gamepads[3];
+ }
+
+});
+
+Phaser.Gamepad.BUTTON_0 = 0;
+Phaser.Gamepad.BUTTON_1 = 1;
+Phaser.Gamepad.BUTTON_2 = 2;
+Phaser.Gamepad.BUTTON_3 = 3;
+Phaser.Gamepad.BUTTON_4 = 4;
+Phaser.Gamepad.BUTTON_5 = 5;
+Phaser.Gamepad.BUTTON_6 = 6;
+Phaser.Gamepad.BUTTON_7 = 7;
+Phaser.Gamepad.BUTTON_8 = 8;
+Phaser.Gamepad.BUTTON_9 = 9;
+Phaser.Gamepad.BUTTON_10 = 10;
+Phaser.Gamepad.BUTTON_11 = 11;
+Phaser.Gamepad.BUTTON_12 = 12;
+Phaser.Gamepad.BUTTON_13 = 13;
+Phaser.Gamepad.BUTTON_14 = 14;
+Phaser.Gamepad.BUTTON_15 = 15;
+
+Phaser.Gamepad.AXIS_0 = 0;
+Phaser.Gamepad.AXIS_1 = 1;
+Phaser.Gamepad.AXIS_2 = 2;
+Phaser.Gamepad.AXIS_3 = 3;
+Phaser.Gamepad.AXIS_4 = 4;
+Phaser.Gamepad.AXIS_5 = 5;
+Phaser.Gamepad.AXIS_6 = 6;
+Phaser.Gamepad.AXIS_7 = 7;
+Phaser.Gamepad.AXIS_8 = 8;
+Phaser.Gamepad.AXIS_9 = 9;
+
+// Below mapping applies to XBOX 360 Wired and Wireless controller on Google Chrome (tested on Windows 7).
+// - Firefox uses different map! Separate amount of buttons and axes. DPAD = axis and not a button.
+// In other words - discrepancies when using gamepads.
+
+Phaser.Gamepad.XBOX360_A = 0;
+Phaser.Gamepad.XBOX360_B = 1;
+Phaser.Gamepad.XBOX360_X = 2;
+Phaser.Gamepad.XBOX360_Y = 3;
+Phaser.Gamepad.XBOX360_LEFT_BUMPER = 4;
+Phaser.Gamepad.XBOX360_RIGHT_BUMPER = 5;
+Phaser.Gamepad.XBOX360_LEFT_TRIGGER = 6;
+Phaser.Gamepad.XBOX360_RIGHT_TRIGGER = 7;
+Phaser.Gamepad.XBOX360_BACK = 8;
+Phaser.Gamepad.XBOX360_START = 9;
+Phaser.Gamepad.XBOX360_STICK_LEFT_BUTTON = 10;
+Phaser.Gamepad.XBOX360_STICK_RIGHT_BUTTON = 11;
+
+Phaser.Gamepad.XBOX360_DPAD_LEFT = 14;
+Phaser.Gamepad.XBOX360_DPAD_RIGHT = 15;
+Phaser.Gamepad.XBOX360_DPAD_UP = 12;
+Phaser.Gamepad.XBOX360_DPAD_DOWN = 13;
+
+Phaser.Gamepad.XBOX360_STICK_LEFT_X = 0;
+Phaser.Gamepad.XBOX360_STICK_LEFT_Y = 1;
+Phaser.Gamepad.XBOX360_STICK_RIGHT_X = 2;
+Phaser.Gamepad.XBOX360_STICK_RIGHT_Y = 3;
+
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/Graphics.js.html b/docs/Graphics.js.html
index abb78deb..4c11d8b7 100644
--- a/docs/Graphics.js.html
+++ b/docs/Graphics.js.html
@@ -90,6 +90,10 @@
Device
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source: input/GamepadButton.js
+ +/**
+* @author @karlmacklin <tacklemcclean@gmail.com>
+* @copyright 2014 Photon Storm Ltd.
+* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
+*/
+
+/**
+* @class Phaser.GamepadButton
+* @classdesc If you need more fine-grained control over the handling of specific buttons you can create and use Phaser.GamepadButton objects.
+* @constructor
+* @param {Phaser.Game} game - Current game instance.
+* @param {number} buttoncode - The button code this GamepadButton is responsible for.
+*/
+Phaser.GamepadButton = function (game, buttoncode) {
+
+ /**
+ * @property {Phaser.Game} game - A reference to the currently running game.
+ */
+ this.game = game;
+
+ /**
+ * @property {boolean} isDown - The "down" state of the button.
+ * @default
+ */
+ this.isDown = false;
+
+ /**
+ * @property {boolean} isUp - The "up" state of the button.
+ * @default
+ */
+ this.isUp = false;
+
+ /**
+ * @property {number} timeDown - The timestamp when the button was last pressed down.
+ * @default
+ */
+ this.timeDown = 0;
+
+ /**
+ * If the button is down this value holds the duration of that button press and is constantly updated.
+ * If the button is up it holds the duration of the previous down session.
+ * @property {number} duration - The number of milliseconds this button has been held down for.
+ * @default
+ */
+ this.duration = 0;
+
+ /**
+ * @property {number} timeUp - The timestamp when the button was last released.
+ * @default
+ */
+ this.timeUp = 0;
+
+ /**
+ * @property {number} repeats - If a button is held down this holds down the number of times the button has 'repeated'.
+ * @default
+ */
+ this.repeats = 0;
+
+ /**
+ * @property {number} value - Button value. Mainly useful for checking analog buttons (like shoulder triggers)
+ * @default
+ */
+ this.value = 0;
+
+ /**
+ * @property {number} buttonCode - The buttoncode of this button.
+ */
+ this.buttonCode = buttoncode;
+
+ /**
+ * @property {Phaser.Signal} onDown - This Signal is dispatched every time this GamepadButton is pressed down. It is only dispatched once (until the button is released again).
+ */
+ this.onDown = new Phaser.Signal();
+
+ /**
+ * @property {Phaser.Signal} onUp - This Signal is dispatched every time this GamepadButton is pressed down. It is only dispatched once (until the button is released again).
+ */
+ this.onUp = new Phaser.Signal();
+
+ /**
+ * @property {Phaser.Signal} onFloat - This Signal is dispatched every time this GamepadButton changes floating value (between (but not exactly) 0 and 1)
+ */
+ this.onFloat = new Phaser.Signal();
+
+};
+
+Phaser.GamepadButton.prototype = {
+
+ /**
+ * Called automatically by Phaser.SinglePad.
+ * @method Phaser.GamepadButton#processButtonDown
+ * @param {Object} value - Button value
+ * @protected
+ */
+ processButtonDown: function (value) {
+
+ if (this.isDown)
+ {
+ this.duration = this.game.time.now - this.timeDown;
+ this.repeats++;
+ }
+ else
+ {
+ this.isDown = true;
+ this.isUp = false;
+ this.timeDown = this.game.time.now;
+ this.duration = 0;
+ this.repeats = 0;
+ this.value = value;
+
+ this.onDown.dispatch(this, value);
+ }
+
+ },
+
+ /**
+ * Called automatically by Phaser.SinglePad.
+ * @method Phaser.GamepadButton#processButtonUp
+ * @param {Object} value - Button value
+ * @protected
+ */
+ processButtonUp: function (value) {
+
+ this.isDown = false;
+ this.isUp = true;
+ this.timeUp = this.game.time.now;
+ this.value = value;
+
+ this.onUp.dispatch(this, value);
+
+ },
+
+ /**
+ * Called automatically by Phaser.Gamepad.
+ * @method Phaser.GamepadButton#processButtonFloat
+ * @param {Object} value - Button value
+ * @protected
+ */
+ processButtonFloat: function (value) {
+
+ this.value = value;
+ this.onFloat.dispatch(this, value);
+
+ },
+
+ /**
+ * Returns the "just pressed" state of this button. Just pressed is considered true if the button was pressed down within the duration given (default 250ms).
+ * @method Phaser.GamepadButton#justPressed
+ * @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 (duration) {
+
+ if (typeof duration === "undefined") { duration = 250; }
+
+ return (this.isDown && this.duration < duration);
+
+ },
+
+ /**
+ * Returns the "just released" state of this button. Just released is considered as being true if the button was released within the duration given (default 250ms).
+ * @method Phaser.GamepadButton#justPressed
+ * @param {number} [duration=250] - The duration below which the button is considered as being just released.
+ * @return {boolean} True if the button is just pressed otherwise false.
+ */
+ justReleased: function (duration) {
+
+ if (typeof duration === "undefined") { duration = 250; }
+
+ return (this.isDown === false && (this.game.time.now - this.timeUp < duration));
+ }
+
+};
+
+Phaser.GamepadButton.prototype.constructor = Phaser.GamepadButton;
+
+ +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -540,13 +534,13 @@ Object.defineProperty(Phaser.Graphics.prototype, 'y', {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Group.js.html b/docs/Group.js.html
index cfb22006..55d13f2c 100644
--- a/docs/Group.js.html
+++ b/docs/Group.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -433,32 +427,32 @@
* @classdesc A Group is a container for display objects that allows for fast pooling, recycling and collision checks.
* @constructor
* @param {Phaser.Game} game - A reference to the currently running game.
-* @param {*} parent - The parent Group or DisplayObjectContainer that will hold this group, if any.
+* @param {*} parent - The parent Group or DisplayObjectContainer that will hold this group, if any. If undefined it will use game.world.
* @param {string} [name=group] - A name for this Group. Not used internally but useful for debugging.
* @param {boolean} [useStage=false] - Should the DisplayObjectContainer this Group creates be added to the World (default, false) or direct to the Stage (true).
*/
Phaser.Group = function (game, parent, name, useStage) {
- if (typeof parent === 'undefined' || typeof parent === null)
+ /**
+ * @property {Phaser.Game} game - A reference to the currently running Game.
+ */
+ this.game = game;
+
+ if (typeof parent === 'undefined')
{
parent = game.world;
}
+ /**
+ * @property {string} name - A name for this Group. Not used internally but useful for debugging.
+ */
+ this.name = name || 'group';
+
if (typeof useStage === 'undefined')
{
useStage = false;
}
- /**
- * @property {Phaser.Game} game - A reference to the currently running Game.
- */
- this.game = game;
-
- /**
- * @property {string} name - A name for this Group. Not used internally but useful for debugging.
- */
- this.name = name || 'group';
-
if (useStage)
{
this._container = this.game.stage._stage;
@@ -473,7 +467,6 @@ Phaser.Group = function (game, parent, name, useStage) {
if (parent instanceof Phaser.Group)
{
parent._container.addChild(this._container);
- parent._container.updateTransform();
}
else
{
@@ -494,6 +487,12 @@ Phaser.Group = function (game, parent, name, useStage) {
*/
this.type = Phaser.GROUP;
+ /**
+ * @property {boolean} alive - The alive property is useful for Groups that are children of other Groups and need to be included/excluded in checks like forEachAlive.
+ * @default
+ */
+ this.alive = true;
+
/**
* @property {boolean} exists - If exists is true the the Group is updated, otherwise it is skipped.
* @default
@@ -501,9 +500,22 @@ Phaser.Group = function (game, parent, name, useStage) {
this.exists = true;
/**
- * @property {Phaser.Point} scale - Replaces the PIXI.Point with a slightly more flexible one.
+ * @property {Phaser.Group} group - The parent Group of this Group, if a child of another.
*/
- this.scale = new Phaser.Point(1, 1);
+ this.group = null;
+
+ // Replaces the PIXI.Point with a slightly more flexible one.
+ this._container.scale = new Phaser.Point(1, 1);
+
+ /**
+ * @property {Phaser.Point} scale - The scane of the Group container.
+ */
+ this.scale = this._container.scale;
+
+ /**
+ * @property {Phaser.Point} pivot - The pivot point of the Group container.
+ */
+ this.pivot = this._container.pivot;
/**
* The cursor is a simple way to iterate through the objects in a Group using the Group.next and Group.previous functions.
@@ -561,16 +573,27 @@ Phaser.Group.prototype = {
if (child.group !== this)
{
- child.group = this;
-
- if (child.events)
+ if (child.type && child.type === Phaser.GROUP)
{
- child.events.onAddedToGroup.dispatch(child, this);
+ child.group = this;
+
+ this._container.addChild(child._container);
+
+ child._container.updateTransform();
}
+ else
+ {
+ child.group = this;
- this._container.addChild(child);
+ this._container.addChild(child);
- child.updateTransform();
+ child.updateTransform();
+
+ if (child.events)
+ {
+ child.events.onAddedToGroup.dispatch(child, this);
+ }
+ }
if (this.cursor === null)
{
@@ -595,16 +618,27 @@ Phaser.Group.prototype = {
if (child.group !== this)
{
- child.group = this;
-
- if (child.events)
+ if (child.type && child.type === Phaser.GROUP)
{
- child.events.onAddedToGroup.dispatch(child, this);
+ child.group = this;
+
+ this._container.addChildAt(child._container, index);
+
+ child._container.updateTransform();
}
+ else
+ {
+ child.group = this;
- this._container.addChildAt(child, index);
+ this._container.addChildAt(child, index);
- child.updateTransform();
+ child.updateTransform();
+
+ if (child.events)
+ {
+ child.events.onAddedToGroup.dispatch(child, this);
+ }
+ }
if (this.cursor === null)
{
@@ -643,7 +677,7 @@ Phaser.Group.prototype = {
*/
create: function (x, y, key, frame, exists) {
- if (typeof exists == 'undefined') { exists = true; }
+ if (typeof exists === 'undefined') { exists = true; }
var child = new Phaser.Sprite(this.game, x, y, key, frame);
@@ -652,15 +686,15 @@ Phaser.Group.prototype = {
child.visible = exists;
child.alive = exists;
+ this._container.addChild(child);
+
+ child.updateTransform();
+
if (child.events)
{
child.events.onAddedToGroup.dispatch(child, this);
}
- this._container.addChild(child);
-
- child.updateTransform();
-
if (this.cursor === null)
{
this.cursor = child;
@@ -683,7 +717,7 @@ Phaser.Group.prototype = {
*/
createMultiple: function (quantity, key, frame, exists) {
- if (typeof exists == 'undefined') { exists = false; }
+ if (typeof exists === 'undefined') { exists = false; }
for (var i = 0; i < quantity; i++)
{
@@ -694,14 +728,15 @@ Phaser.Group.prototype = {
child.visible = exists;
child.alive = exists;
+ this._container.addChild(child);
+
+ child.updateTransform();
+
if (child.events)
{
child.events.onAddedToGroup.dispatch(child, this);
}
- this._container.addChild(child);
- child.updateTransform();
-
if (this.cursor === null)
{
this.cursor = child;
@@ -755,6 +790,11 @@ Phaser.Group.prototype = {
},
+ /**
+ * Internal test.
+ *
+ * @method Phaser.Group#childTest
+ */
childTest: function (prefix, child) {
var s = prefix + ' next: ';
@@ -783,13 +823,16 @@ Phaser.Group.prototype = {
},
+ /**
+ * Internal test.
+ *
+ * @method Phaser.Group#swapIndex
+ */
swapIndex: function (index1, index2) {
var child1 = this.getAt(index1);
var child2 = this.getAt(index2);
- console.log('swapIndex ', index1, ' with ', index2);
-
this.swap(child1, child2);
},
@@ -1054,6 +1097,32 @@ Phaser.Group.prototype = {
},
+ /**
+ * This function allows you to quickly set a property on a single child of this Group to a new value.
+ * The operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.
+ *
+ * @method Phaser.Group#set
+ * @param {Phaser.Sprite} child - The child to set the property on.
+ * @param {string} key - The property, as a string, to be set. For example: 'body.velocity.x'
+ * @param {*} value - The value that will be set.
+ * @param {boolean} [checkAlive=false] - If set then the child will only be updated if alive=true.
+ * @param {boolean} [checkVisible=false] - If set then the child will only be updated if visible=true.
+ * @param {number} [operation=0] - Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.
+ */
+ set: function (child, key, value, checkAlive, checkVisible, operation) {
+
+ key = key.split('.');
+
+ if (typeof checkAlive === 'undefined') { checkAlive = false; }
+ if (typeof checkVisible === 'undefined') { checkVisible = false; }
+
+ if ((checkAlive === false || (checkAlive && child.alive)) && (checkVisible === false || (checkVisible && child.visible)))
+ {
+ this.setProperty(child, key, value, operation);
+ }
+
+ },
+
/**
* This function allows you to quickly set the same property across all children of this Group to a new value.
* The operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.
@@ -1189,7 +1258,7 @@ Phaser.Group.prototype = {
},
/**
- * Calls a function on all of the children that have exists=true in this Group.
+ * Returns a reference to a function that exists on a child of the Group based on the given callback array.
*
* @method Phaser.Group#callbackFromArray
* @param {object} child - The object to inspect.
@@ -1247,7 +1316,7 @@ Phaser.Group.prototype = {
*
* @method Phaser.Group#callAll
* @param {string} method - A string containing the name of the function that will be called. The function must exist on the child.
- * @param {string} [context=''] - A string containing the context under which the method will be executed. Leave to '' to default to the child.
+ * @param {string} [context=null] - A string containing the context under which the method will be executed. Set to null to default to the child.
* @param {...*} parameter - Additional parameters that will be passed to the method.
*/
callAll: function (method, context) {
@@ -1314,6 +1383,7 @@ Phaser.Group.prototype = {
* Allows you to call your own function on each member of this Group. You must pass the callback and context in which it will run.
* After the checkExists parameter you can add as many parameters as you like, which will all be passed to the callback along with the child.
* For example: Group.forEach(awardBonusGold, this, true, 100, 500)
+ * Note: Currently this will skip any children which are Groups themselves.
*
* @method Phaser.Group#forEach
* @param {function} callback - The function that will be called. Each child of the Group will be passed to it as its first parameter.
@@ -1464,12 +1534,13 @@ Phaser.Group.prototype = {
* @param {number} returnType - How to return the data from this method. Either Phaser.Group.RETURN_NONE, Phaser.Group.RETURN_TOTAL or Phaser.Group.RETURN_CHILD.
* @param {function} [callback=null] - Optional function that will be called on each matching child. Each child of the Group will be passed to it as its first parameter.
* @param {Object} [callbackContext] - The context in which the function should be called (usually 'this').
+ * @return {any} Returns either a numeric total (if RETURN_TOTAL was specified) or the child object.
*/
iterate: function (key, value, returnType, callback, callbackContext, args) {
- if (returnType == Phaser.Group.RETURN_TOTAL && this._container.children.length === 0)
+ if (returnType === Phaser.Group.RETURN_TOTAL && this._container.children.length === 0)
{
- return -1;
+ return 0;
}
if (typeof callback === 'undefined')
@@ -1495,7 +1566,7 @@ Phaser.Group.prototype = {
callback.apply(callbackContext, args);
}
- if (returnType == Phaser.Group.RETURN_CHILD)
+ if (returnType === Phaser.Group.RETURN_CHILD)
{
return currentNode;
}
@@ -1506,11 +1577,11 @@ Phaser.Group.prototype = {
while (currentNode != this._container.last._iNext);
}
- if (returnType == Phaser.Group.RETURN_TOTAL)
+ if (returnType === Phaser.Group.RETURN_TOTAL)
{
return total;
}
- else if (returnType == Phaser.Group.RETURN_CHILD)
+ else if (returnType === Phaser.Group.RETURN_CHILD)
{
return null;
}
@@ -1565,7 +1636,7 @@ Phaser.Group.prototype = {
* Call this function to find out how many members of the group are alive.
*
* @method Phaser.Group#countLiving
- * @return {number} The number of children flagged as alive. Returns -1 if Group is empty.
+ * @return {number} The number of children flagged as alive.
*/
countLiving: function () {
@@ -1577,7 +1648,7 @@ Phaser.Group.prototype = {
* Call this function to find out how many members of the group are dead.
*
* @method Phaser.Group#countDead
- * @return {number} The number of children flagged as dead. Returns -1 if Group is empty.
+ * @return {number} The number of children flagged as dead.
*/
countDead: function () {
@@ -1721,11 +1792,31 @@ Phaser.Group.prototype = {
* Destroys this Group. Removes all children, then removes the container from the display list and nulls references.
*
* @method Phaser.Group#destroy
+ * @param {boolean} [destroyChildren=false] - Should every child of this Group have its destroy method called?
*/
- destroy: function () {
+ destroy: function (destroyChildren) {
- this.removeAll();
+ if (typeof destroyChildren === 'undefined') { destroyChildren = false; }
+ if (destroyChildren)
+ {
+ if (this._container.children.length > 0)
+ {
+ do
+ {
+ if (this._container.children[0].group)
+ {
+ this._container.children[0].destroy();
+ }
+ }
+ while (this._container.children.length > 0);
+ }
+ }
+ else
+ {
+ this.removeAll();
+ }
+
this._container.parent.removeChild(this._container);
this._container = null;
@@ -1778,130 +1869,52 @@ Phaser.Group.prototype = {
return true;
- },
-
- /**
- * Dumps out a list of Group children and their index positions to the browser console. Useful for group debugging.
- *
- * @method Phaser.Group#dump
- * @param {boolean} [full=false] - If full the dump will include the entire display list, start from the Stage. Otherwise it will only include this container.
- */
- dump: function (full) {
-
- if (typeof full == 'undefined')
- {
- full = false;
- }
-
- var spacing = 20;
- var output = "\n" + Phaser.Utils.pad('Node', spacing) + "|" + Phaser.Utils.pad('Next', spacing) + "|" + Phaser.Utils.pad('Previous', spacing) + "|" + Phaser.Utils.pad('First', spacing) + "|" + Phaser.Utils.pad('Last', spacing);
-
- console.log(output);
-
- var output = Phaser.Utils.pad('----------', spacing) + "|" + Phaser.Utils.pad('----------', spacing) + "|" + Phaser.Utils.pad('----------', spacing) + "|" + Phaser.Utils.pad('----------', spacing) + "|" + Phaser.Utils.pad('----------', spacing);
- console.log(output);
-
- if (full)
- {
- var testObject = this.game.stage._stage.last._iNext;
- var displayObject = this.game.stage._stage;
- }
- else
- {
- var testObject = this._container.last._iNext;
- var displayObject = this._container;
- }
-
- do
- {
- var name = displayObject.name || '*';
-
- if (this.cursor == displayObject)
- {
- var name = '> ' + name;
- }
-
- var nameNext = '-';
- var namePrev = '-';
- var nameFirst = '-';
- var nameLast = '-';
-
- if (displayObject._iNext)
- {
- nameNext = displayObject._iNext.name;
- }
-
- if (displayObject._iPrev)
- {
- namePrev = displayObject._iPrev.name;
- }
-
- if (displayObject.first)
- {
- nameFirst = displayObject.first.name;
- }
-
- if (displayObject.last)
- {
- nameLast = displayObject.last.name;
- }
-
- if (typeof nameNext === 'undefined')
- {
- nameNext = '-';
- }
-
- if (typeof namePrev === 'undefined')
- {
- namePrev = '-';
- }
-
- if (typeof nameFirst === 'undefined')
- {
- nameFirst = '-';
- }
-
- if (typeof nameLast === 'undefined')
- {
- nameLast = '-';
- }
-
- var output = Phaser.Utils.pad(name, spacing) + "|" + Phaser.Utils.pad(nameNext, spacing) + "|" + Phaser.Utils.pad(namePrev, spacing) + "|" + Phaser.Utils.pad(nameFirst, spacing) + "|" + Phaser.Utils.pad(nameLast, spacing);
- console.log(output);
-
- displayObject = displayObject._iNext;
-
- }
- while(displayObject != testObject)
-
}
};
+Phaser.Group.prototype.constructor = Phaser.Group;
+
/**
* @name Phaser.Group#total
-* @property {number} total - The total number of children in this Group, regardless of their alive state.
+* @property {number} total - The total number of children in this Group who have a state of exists = true.
* @readonly
*/
Object.defineProperty(Phaser.Group.prototype, "total", {
get: function () {
- return this.iterate('exists', true, Phaser.Group.RETURN_TOTAL);
- // return this._container.children.length;
+
+ if (this._container)
+ {
+ return this.iterate('exists', true, Phaser.Group.RETURN_TOTAL);
+ }
+ else
+ {
+ return 0;
+ }
+
}
});
/**
* @name Phaser.Group#length
-* @property {number} length - The number of children in this Group.
+* @property {number} length - The total number of children in this Group, regardless of their exists/alive status.
* @readonly
*/
Object.defineProperty(Phaser.Group.prototype, "length", {
get: function () {
- return this.iterate('exists', true, Phaser.Group.RETURN_TOTAL);
- // return this._container.children.length;
+
+ if (this._container)
+ {
+ return this._container.children.length;
+ }
+ else
+ {
+ return 0;
+ }
+
}
});
@@ -2024,13 +2037,13 @@ Object.defineProperty(Phaser.Group.prototype, "alpha", {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Input.js.html b/docs/Input.js.html
index 8b01fbbb..962827b9 100644
--- a/docs/Input.js.html
+++ b/docs/Input.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -453,6 +447,16 @@ Phaser.Input = function (game) {
* @default
*/
this.hitContext = null;
+
+ /**
+ * @property {function} moveCallback - An optional callback that will be fired every time the activePointer receives a move event from the DOM. Set to null to disable.
+ */
+ this.moveCallback = null;
+
+ /**
+ * @property {object} moveCallbackContext - The context in which the moveCallback will be sent. Defaults to Phaser.Input but can be set to any valid JS object.
+ */
+ this.moveCallbackContext = this;
};
@@ -729,6 +733,13 @@ Phaser.Input.prototype = {
*/
mspointer: null,
+ /**
+ * The Gamepad Input manager.
+ * @property {Phaser.Gamepad} gamepad - The Gamepad Input manager.
+ * @default
+ */
+ gamepad: null,
+
/**
* A Signal that is dispatched each time a pointer is pressed down.
* @property {Phaser.Signal} onDown
@@ -778,6 +789,7 @@ Phaser.Input.prototype = {
this.keyboard = new Phaser.Keyboard(this.game);
this.touch = new Phaser.Touch(this.game);
this.mspointer = new Phaser.MSPointer(this.game);
+ this.gamepad = new Phaser.Gamepad(this.game);
this.onDown = new Phaser.Signal();
this.onUp = new Phaser.Signal();
@@ -817,6 +829,24 @@ Phaser.Input.prototype = {
this.keyboard.stop();
this.touch.stop();
this.mspointer.stop();
+ this.gamepad.stop();
+
+ this.moveCallback = null;
+
+ },
+
+ /**
+ * 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)
+ * @method Phaser.Input#setMoveCallback
+ * @param {function} callback - The callback that will be called each time the activePointer receives a DOM move event.
+ * @param {object} callbackContext - The context in which the callback will be called.
+ */
+ setMoveCallback: function (callback, callbackContext) {
+
+ this.moveCallback = callback;
+ this.moveCallbackContext = callbackContext;
},
@@ -870,6 +900,8 @@ Phaser.Input.prototype = {
this._oldPosition.copyFrom(this.position);
this.mousePointer.update();
+ if (this.gamepad.active) { this.gamepad.update(); }
+
this.pointer1.update();
this.pointer2.update();
@@ -901,6 +933,7 @@ Phaser.Input.prototype = {
this.keyboard.reset();
this.mousePointer.reset();
+ this.gamepad.reset();
for (var i = 1; i <= 10; i++)
{
@@ -911,7 +944,11 @@ Phaser.Input.prototype = {
}
this.currentPointers = 0;
- this.game.stage.canvas.style.cursor = "default";
+
+ if (this.game.canvas.style.cursor !== 'none')
+ {
+ this.game.canvas.style.cursor = 'default';
+ }
if (hard === true)
{
@@ -1108,6 +1145,8 @@ Phaser.Input.prototype = {
};
+Phaser.Input.prototype.constructor = Phaser.Input;
+
/**
* The X coordinate of the most recently active pointer. This value takes game scaling into account automatically. See Pointer.screenX/clientX for source values.
* @name Phaser.Input#x
@@ -1235,13 +1274,13 @@ Object.defineProperty(Phaser.Input.prototype, "worldY", {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/InputHandler.js.html b/docs/InputHandler.js.html
index 519c7515..592d86d6 100644
--- a/docs/InputHandler.js.html
+++ b/docs/InputHandler.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -451,36 +445,6 @@ Phaser.InputHandler = function (sprite) {
*/
this.enabled = false;
- /**
- * @property {Description} parent - Description.
- * @default
- */
- // this.parent = null;
-
- /**
- * @property {Description} next - Linked List
- * @default
- */
- // this.next = null;
-
- /**
- * @property {Description} prev - Description.
- * @default
- */
- // this.prev = null;
-
- /**
- * @property {Description} last - Description.
- * @default
- */
- // this.last = this;
-
- /**
- * @property {Description} first - Description.
- * @default
- */
- // this.first = this;
-
/**
* @property {number} priorityID - The PriorityID controls which Sprite receives an Input event first if they should overlap.
* @default
@@ -547,6 +511,18 @@ Phaser.InputHandler = function (sprite) {
*/
this.snapY = 0;
+ /**
+ * @property {number} snapOffsetX - This defines the top-left X coordinate of the snap grid.
+ * @default
+ */
+ this.snapOffsetX = 0;
+
+ /**
+ * @property {number} snapOffsetY - This defines the top-left Y coordinate of the snap grid..
+ * @default
+ */
+ this.snapOffsetY = 0;
+
/**
* @property {number} pixelPerfect - Should we use pixel perfect hit detection? Warning: expensive. Only enable if you really need it!
* @default
@@ -622,8 +598,6 @@ Phaser.InputHandler.prototype = {
*/
start: function (priority, useHandCursor) {
- console.log('InputHandler start');
-
priority = priority || 0;
if (typeof useHandCursor == 'undefined') { useHandCursor = false; }
@@ -1039,7 +1013,7 @@ Phaser.InputHandler.prototype = {
if (this.useHandCursor && this._pointerData[pointer.id].isDragged === false)
{
- this.game.stage.canvas.style.cursor = "pointer";
+ this.game.canvas.style.cursor = "pointer";
}
this.sprite.events.onInputOver.dispatch(this.sprite, pointer);
@@ -1060,7 +1034,7 @@ Phaser.InputHandler.prototype = {
if (this.useHandCursor && this._pointerData[pointer.id].isDragged === false)
{
- this.game.stage.canvas.style.cursor = "default";
+ this.game.canvas.style.cursor = "default";
}
if (this.sprite && this.sprite.events)
@@ -1121,15 +1095,18 @@ Phaser.InputHandler.prototype = {
// Only release the InputUp signal if the pointer is still over this sprite
if (this.checkPointerOver(pointer))
{
- //console.log('releasedHandler: ' + Date.now());
- this.sprite.events.onInputUp.dispatch(this.sprite, pointer);
+ // Release the inputUp signal and provide optional parameter if pointer is still over the sprite or not
+ this.sprite.events.onInputUp.dispatch(this.sprite, pointer, true);
}
else
{
+ // Release the inputUp signal and provide optional parameter if pointer is still over the sprite or not
+ this.sprite.events.onInputUp.dispatch(this.sprite, pointer, false);
+
// Pointer outside the sprite? Reset the cursor
if (this.useHandCursor)
{
- this.game.stage.canvas.style.cursor = "default";
+ this.game.canvas.style.cursor = "default";
}
}
@@ -1156,30 +1133,61 @@ Phaser.InputHandler.prototype = {
return false;
}
- if (this.allowHorizontalDrag)
+ if (this.sprite.fixedToCamera)
{
- this.sprite.x = pointer.x + this._dragPoint.x + this.dragOffset.x;
- }
+ if (this.allowHorizontalDrag)
+ {
+ this.sprite.cameraOffset.x = pointer.x + this._dragPoint.x + this.dragOffset.x;
+ }
- if (this.allowVerticalDrag)
- {
- this.sprite.y = pointer.y + this._dragPoint.y + this.dragOffset.y;
- }
+ if (this.allowVerticalDrag)
+ {
+ this.sprite.cameraOffset.y = pointer.y + this._dragPoint.y + this.dragOffset.y;
+ }
- if (this.boundsRect)
- {
- this.checkBoundsRect();
- }
+ if (this.boundsRect)
+ {
+ this.checkBoundsRect();
+ }
- if (this.boundsSprite)
- {
- this.checkBoundsSprite();
- }
+ if (this.boundsSprite)
+ {
+ this.checkBoundsSprite();
+ }
- if (this.snapOnDrag)
+ if (this.snapOnDrag)
+ {
+ this.sprite.cameraOffset.x = Math.round((this.sprite.cameraOffset.x - (this.snapOffsetX % this.snapX)) / this.snapX) * this.snapX + (this.snapOffsetX % this.snapX);
+ this.sprite.cameraOffset.y = Math.round((this.sprite.cameraOffset.y - (this.snapOffsetY % this.snapY)) / this.snapY) * this.snapY + (this.snapOffsetY % this.snapY);
+ }
+ }
+ else
{
- this.sprite.x = Math.round(this.sprite.x / this.snapX) * this.snapX;
- this.sprite.y = Math.round(this.sprite.y / this.snapY) * this.snapY;
+ if (this.allowHorizontalDrag)
+ {
+ this.sprite.x = pointer.x + this._dragPoint.x + this.dragOffset.x;
+ }
+
+ if (this.allowVerticalDrag)
+ {
+ this.sprite.y = pointer.y + this._dragPoint.y + this.dragOffset.y;
+ }
+
+ if (this.boundsRect)
+ {
+ this.checkBoundsRect();
+ }
+
+ if (this.boundsSprite)
+ {
+ this.checkBoundsSprite();
+ }
+
+ if (this.snapOnDrag)
+ {
+ this.sprite.x = Math.round((this.sprite.x - (this.snapOffsetX % this.snapX)) / this.snapX) * this.snapX + (this.snapOffsetX % this.snapX);
+ this.sprite.y = Math.round((this.sprite.y - (this.snapOffsetY % this.snapY)) / this.snapY) * this.snapY + (this.snapOffsetY % this.snapY);
+ }
}
return true;
@@ -1359,14 +1367,29 @@ Phaser.InputHandler.prototype = {
this._draggedPointerID = pointer.id;
this._pointerData[pointer.id].isDragged = true;
- if (this.dragFromCenter)
+ if (this.sprite.fixedToCamera)
{
- this.sprite.centerOn(pointer.x, pointer.y);
- this._dragPoint.setTo(this.sprite.x - pointer.x, this.sprite.y - pointer.y);
+ if (this.dragFromCenter)
+ {
+ this.sprite.centerOn(pointer.x, pointer.y);
+ this._dragPoint.setTo(this.sprite.cameraOffset.x - pointer.x, this.sprite.cameraOffset.y - pointer.y);
+ }
+ else
+ {
+ this._dragPoint.setTo(this.sprite.cameraOffset.x - pointer.x, this.sprite.cameraOffset.y - pointer.y);
+ }
}
else
{
- this._dragPoint.setTo(this.sprite.x - pointer.x, this.sprite.y - pointer.y);
+ if (this.dragFromCenter)
+ {
+ this.sprite.centerOn(pointer.x, pointer.y);
+ this._dragPoint.setTo(this.sprite.x - pointer.x, this.sprite.y - pointer.y);
+ }
+ else
+ {
+ this._dragPoint.setTo(this.sprite.x - pointer.x, this.sprite.y - pointer.y);
+ }
}
this.updateDrag(pointer);
@@ -1393,8 +1416,16 @@ Phaser.InputHandler.prototype = {
if (this.snapOnRelease)
{
- this.sprite.x = Math.round(this.sprite.x / this.snapX) * this.snapX;
- this.sprite.y = Math.round(this.sprite.y / this.snapY) * this.snapY;
+ if (this.sprite.fixedToCamera)
+ {
+ this.sprite.cameraOffset.x = Math.round((this.sprite.cameraOffset.x - (this.snapOffsetX % this.snapX)) / this.snapX) * this.snapX + (this.snapOffsetX % this.snapX);
+ this.sprite.cameraOffset.y = Math.round((this.sprite.cameraOffset.y - (this.snapOffsetY % this.snapY)) / this.snapY) * this.snapY + (this.snapOffsetY % this.snapY);
+ }
+ else
+ {
+ this.sprite.x = Math.round((this.sprite.x - (this.snapOffsetX % this.snapX)) / this.snapX) * this.snapX + (this.snapOffsetX % this.snapX);
+ this.sprite.y = Math.round((this.sprite.y - (this.snapOffsetY % this.snapY)) / this.snapY) * this.snapY + (this.snapOffsetY % this.snapY);
+ }
}
this.sprite.events.onDragStop.dispatch(this.sprite, pointer);
@@ -1431,14 +1462,20 @@ Phaser.InputHandler.prototype = {
* @param {number} snapY - The height of the grid cell to snap to.
* @param {boolean} [onDrag=true] - If true the sprite will snap to the grid while being dragged.
* @param {boolean} [onRelease=false] - If true the sprite will snap to the grid when released.
+ * @param {number} [snapOffsetX=0] - Used to offset the top-left starting point of the snap grid.
+ * @param {number} [snapOffsetX=0] - Used to offset the top-left starting point of the snap grid.
*/
- enableSnap: function (snapX, snapY, onDrag, onRelease) {
+ enableSnap: function (snapX, snapY, onDrag, onRelease, snappOffsetX, snappOffsetY) {
if (typeof onDrag == 'undefined') { onDrag = true; }
if (typeof onRelease == 'undefined') { onRelease = false; }
+ if (typeof snapOffsetX == 'undefined') { snapOffsetX = 0; }
+ if (typeof snapOffsetY == 'undefined') { snapOffsetY = 0; }
this.snapX = snapX;
this.snapY = snapY;
+ this.snapOffsetX = snapOffsetX;
+ this.snapOffsetY = snapOffsetY;
this.snapOnDrag = onDrag;
this.snapOnRelease = onRelease;
@@ -1461,22 +1498,45 @@ Phaser.InputHandler.prototype = {
*/
checkBoundsRect: function () {
- if (this.sprite.x < this.boundsRect.left)
+ if (this.sprite.fixedToCamera)
{
- this.sprite.x = this.boundsRect.x;
- }
- else if ((this.sprite.x + this.sprite.width) > this.boundsRect.right)
- {
- this.sprite.x = this.boundsRect.right - this.sprite.width;
- }
+ if (this.sprite.cameraOffset.x < this.boundsRect.left)
+ {
+ this.sprite.cameraOffset.x = this.boundsRect.cameraOffset.x;
+ }
+ else if ((this.sprite.cameraOffset.x + this.sprite.width) > this.boundsRect.right)
+ {
+ this.sprite.cameraOffset.x = this.boundsRect.right - this.sprite.width;
+ }
- if (this.sprite.y < this.boundsRect.top)
- {
- this.sprite.y = this.boundsRect.top;
+ if (this.sprite.cameraOffset.y < this.boundsRect.top)
+ {
+ this.sprite.cameraOffset.y = this.boundsRect.top;
+ }
+ else if ((this.sprite.cameraOffset.y + this.sprite.height) > this.boundsRect.bottom)
+ {
+ this.sprite.cameraOffset.y = this.boundsRect.bottom - this.sprite.height;
+ }
}
- else if ((this.sprite.y + this.sprite.height) > this.boundsRect.bottom)
+ else
{
- this.sprite.y = this.boundsRect.bottom - this.sprite.height;
+ if (this.sprite.x < this.boundsRect.left)
+ {
+ this.sprite.x = this.boundsRect.x;
+ }
+ else if ((this.sprite.x + this.sprite.width) > this.boundsRect.right)
+ {
+ this.sprite.x = this.boundsRect.right - this.sprite.width;
+ }
+
+ if (this.sprite.y < this.boundsRect.top)
+ {
+ this.sprite.y = this.boundsRect.top;
+ }
+ else if ((this.sprite.y + this.sprite.height) > this.boundsRect.bottom)
+ {
+ this.sprite.y = this.boundsRect.bottom - this.sprite.height;
+ }
}
},
@@ -1487,27 +1547,53 @@ Phaser.InputHandler.prototype = {
*/
checkBoundsSprite: function () {
- if (this.sprite.x < this.boundsSprite.x)
+ if (this.sprite.fixedToCamera && this.boundsSprite.fixedToCamera)
{
- this.sprite.x = this.boundsSprite.x;
- }
- else if ((this.sprite.x + this.sprite.width) > (this.boundsSprite.x + this.boundsSprite.width))
- {
- this.sprite.x = (this.boundsSprite.x + this.boundsSprite.width) - this.sprite.width;
- }
+ if (this.sprite.cameraOffset.x < this.boundsSprite.camerOffset.x)
+ {
+ this.sprite.cameraOffset.x = this.boundsSprite.camerOffset.x;
+ }
+ else if ((this.sprite.cameraOffset.x + this.sprite.width) > (this.boundsSprite.camerOffset.x + this.boundsSprite.width))
+ {
+ this.sprite.cameraOffset.x = (this.boundsSprite.camerOffset.x + this.boundsSprite.width) - this.sprite.width;
+ }
- if (this.sprite.y < this.boundsSprite.y)
- {
- this.sprite.y = this.boundsSprite.y;
+ if (this.sprite.cameraOffset.y < this.boundsSprite.camerOffset.y)
+ {
+ this.sprite.cameraOffset.y = this.boundsSprite.camerOffset.y;
+ }
+ else if ((this.sprite.cameraOffset.y + this.sprite.height) > (this.boundsSprite.camerOffset.y + this.boundsSprite.height))
+ {
+ this.sprite.cameraOffset.y = (this.boundsSprite.camerOffset.y + this.boundsSprite.height) - this.sprite.height;
+ }
}
- else if ((this.sprite.y + this.sprite.height) > (this.boundsSprite.y + this.boundsSprite.height))
+ else
{
- this.sprite.y = (this.boundsSprite.y + this.boundsSprite.height) - this.sprite.height;
+ if (this.sprite.x < this.boundsSprite.x)
+ {
+ this.sprite.x = this.boundsSprite.x;
+ }
+ else if ((this.sprite.x + this.sprite.width) > (this.boundsSprite.x + this.boundsSprite.width))
+ {
+ this.sprite.x = (this.boundsSprite.x + this.boundsSprite.width) - this.sprite.width;
+ }
+
+ if (this.sprite.y < this.boundsSprite.y)
+ {
+ this.sprite.y = this.boundsSprite.y;
+ }
+ else if ((this.sprite.y + this.sprite.height) > (this.boundsSprite.y + this.boundsSprite.height))
+ {
+ this.sprite.y = (this.boundsSprite.y + this.boundsSprite.height) - this.sprite.height;
+ }
}
}
-};
+};
+
+Phaser.InputHandler.prototype.constructor = Phaser.InputHandler;
+
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/IntroDocs.js.html b/docs/IntroDocs.js.html index 9efbd205..664fba12 100644 --- a/docs/IntroDocs.js.html +++ b/docs/IntroDocs.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -592,6 +586,8 @@ Phaser.Key.prototype = {
}
};
+
+Phaser.Key.prototype.constructor = Phaser.Key;
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Keyboard.js.html b/docs/Keyboard.js.html index d7d6010a..4b428a4c 100644 --- a/docs/Keyboard.js.html +++ b/docs/Keyboard.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -523,7 +517,7 @@ Phaser.Keyboard.prototype = {
* The Key object can then be polled, have events attached to it, etc.
*
* @method Phaser.Keyboard#addKey
- * @param {number} keycode - The keycode of the key, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACE_BAR
+ * @param {number} keycode - The keycode of the key, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR
* @return {Phaser.Key} The Key object which you can store locally and reference directly.
*/
addKey: function (keycode) {
@@ -540,7 +534,7 @@ Phaser.Keyboard.prototype = {
* Removes a Key object from the Keyboard manager.
*
* @method Phaser.Keyboard#removeKey
- * @param {number} keycode - The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACE_BAR
+ * @param {number} keycode - The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR
*/
removeKey: function (keycode) {
@@ -762,7 +756,7 @@ Phaser.Keyboard.prototype = {
/**
* Returns the "just pressed" state of the key. Just pressed is considered true if the key was pressed down within the duration given (default 250ms)
* @method Phaser.Keyboard#justPressed
- * @param {number} keycode - The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACE_BAR
+ * @param {number} keycode - The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR
* @param {number} [duration=250] - The duration below which the key is considered as being just pressed.
* @return {boolean} True if the key is just pressed otherwise false.
*/
@@ -781,8 +775,8 @@ Phaser.Keyboard.prototype = {
/**
* Returns the "just released" state of the Key. Just released is considered as being true if the key was released within the duration given (default 250ms)
- * @method Phaser.Keyboard#justPressed
- * @param {number} keycode - The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACE_BAR
+ * @method Phaser.Keyboard#justReleased
+ * @param {number} keycode - The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR
* @param {number} [duration=250] - The duration below which the key is considered as being just released.
* @return {boolean} True if the key is just released otherwise false.
*/
@@ -802,7 +796,7 @@ Phaser.Keyboard.prototype = {
/**
* Returns true of the key is currently pressed down. Note that it can only detect key presses on the web browser.
* @method Phaser.Keyboard#isDown
- * @param {number} keycode - The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACE_BAR
+ * @param {number} keycode - The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR
* @return {boolean} True if the key is currently down.
*/
isDown: function (keycode) {
@@ -818,6 +812,8 @@ Phaser.Keyboard.prototype = {
};
+Phaser.Keyboard.prototype.constructor = Phaser.Keyboard;
+
Phaser.Keyboard.A = "A".charCodeAt(0);
Phaser.Keyboard.B = "B".charCodeAt(0);
Phaser.Keyboard.C = "C".charCodeAt(0);
@@ -931,13 +927,13 @@ Phaser.Keyboard.NUM_LOCK = 144;
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Line.js.html b/docs/Line.js.html
new file mode 100644
index 00000000..aa41210f
--- /dev/null
+++ b/docs/Line.js.html
@@ -0,0 +1,743 @@
+
+
+
+
+
+ Phaser Source: geom/Line.js
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source: geom/Line.js
+
+
+
+ /**
+* @author Richard Davey <rich@photonstorm.com>
+* @copyright 2014 Photon Storm Ltd.
+* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
+*/
+
+/**
+* Creates a new Line object with a start and an end point.
+* @class Line
+* @classdesc Phaser - Line
+* @constructor
+* @param {number} [x1=0] - The x coordinate of the start of the line.
+* @param {number} [y1=0] - The y coordinate of the start of the line.
+* @param {number} [x2=0] - The x coordinate of the end of the line.
+* @param {number} [y2=0] - The y coordinate of the end of the line.
+* @return {Phaser.Line} This line object
+*/
+Phaser.Line = function (x1, y1, x2, y2) {
+
+ x1 = x1 || 0;
+ y1 = y1 || 0;
+ x2 = x2 || 0;
+ y2 = y2 || 0;
+
+ /**
+ * @property {Phaser.Point} start - The start point of the line.
+ */
+ this.start = new Phaser.Point(x1, y1);
+
+ /**
+ * @property {Phaser.Point} end - The end point of the line.
+ */
+ this.end = new Phaser.Point(x2, y2);
+
+};
+
+Phaser.Line.prototype = {
+
+ /**
+ * Sets the components of the Line to the specified values.
+ * @method Phaser.Line#setTo
+ * @param {number} [x1=0] - The x coordinate of the start of the line.
+ * @param {number} [y1=0] - The y coordinate of the start of the line.
+ * @param {number} [x2=0] - The x coordinate of the end of the line.
+ * @param {number} [y2=0] - The y coordinate of the end of the line.
+ * @return {Phaser.Line} This line object
+ */
+ setTo: function (x1, y1, x2, y2) {
+
+ this.start.setTo(x1, y1);
+ this.end.setTo(x2, y2);
+
+ return this;
+
+ },
+
+ /**
+ * Sets the line to match the x/y coordinates of the two given sprites.
+ * Can optionally be calculated from their center coordinates.
+ * @method Phaser.Line#fromSprite
+ * @param {Phaser.Sprite} startSprite - The coordinates of this Sprite will be set to the Line.start point.
+ * @param {Phaser.Sprite} endSprite - The coordinates of this Sprite will be set to the Line.start point.
+ * @param {boolean} [useCenter=true] - If true it will use startSprite.center.x, if false startSprite.x.
+ * @return {Phaser.Line} This line object
+ */
+ fromSprite: function (startSprite, endSprite, useCenter) {
+
+ if (typeof useCenter === 'undefined') { useCenter = true; }
+
+ if (useCenter)
+ {
+ return this.setTo(startSprite.center.x, startSprite.center.y, endSprite.center.x, endSprite.center.y);
+ }
+ else
+ {
+ return this.setTo(startSprite.x, startSprite.y, endSprite.x, endSprite.y);
+ }
+
+ },
+
+ /**
+ * Checks for intersection between this line and another Line.
+ * If asSegment is true it will check for segment intersection. If asSegment is false it will check for line intersection.
+ * Returns the intersection segment of AB and EF as a Point, or null if there is no intersection.
+ *
+ * @method Phaser.Line#intersects
+ * @param {Phaser.Line} line - The line to check against this one.
+ * @param {boolean} [asSegment=true] - If true it will check for segment intersection, otherwise full line intersection.
+ * @param {Phaser.Point} [result] - A Point object to store the result in, if not given a new one will be created.
+ * @return {Phaser.Point} The intersection segment of the two lines as a Point, or null if there is no intersection.
+ */
+ intersects: function (line, asSegment, result) {
+
+ return Phaser.Line.intersectsPoints(this.start, this.end, line.start, line.end, asSegment, result);
+
+ },
+
+ /**
+ * Tests if the given coordinates fall on this line. See pointOnSegment to test against just the line segment.
+ * @method Phaser.Line#pointOnLine
+ * @param {number} x - The line to check against this one.
+ * @param {number} y - The line to check against this one.
+ * @return {boolean} True if the point is on the line, false if not.
+ */
+ pointOnLine: function (x, y) {
+
+ return ((x - this.start.x) * (this.end.y - this.end.y) === (this.end.x - this.start.x) * (y - this.end.y));
+
+ },
+
+ /**
+ * Tests if the given coordinates fall on this line and within the segment. See pointOnLine to test against just the line.
+ * @method Phaser.Line#pointOnSegment
+ * @param {number} x - The line to check against this one.
+ * @param {number} y - The line to check against this one.
+ * @return {boolean} True if the point is on the line and segment, false if not.
+ */
+ pointOnSegment: function (x, y) {
+
+ var xMin = Math.min(this.start.x, this.end.x);
+ var xMax = Math.max(this.start.x, this.end.x);
+ var yMin = Math.min(this.start.y, this.end.y);
+ var yMax = Math.max(this.start.y, this.end.y);
+
+ return (this.pointOnLine(x, y) && (x >= xMin && x <= xMax) && (y >= yMin && y <= yMax));
+
+ }
+
+};
+
+/**
+* @name Phaser.Line#length
+* @property {number} length - Gets the length of the line segment.
+* @readonly
+*/
+Object.defineProperty(Phaser.Line.prototype, "length", {
+
+ get: function () {
+ return Math.sqrt((this.end.x - this.start.x) * (this.end.x - this.start.x) + (this.end.y - this.start.y) * (this.end.y - this.start.y));
+ }
+
+});
+
+/**
+* @name Phaser.Line#angle
+* @property {number} angle - Gets the angle of the line.
+* @readonly
+*/
+Object.defineProperty(Phaser.Line.prototype, "angle", {
+
+ get: function () {
+ return Math.atan2(this.end.x - this.start.x, this.end.y - this.start.y);
+ }
+
+});
+
+/**
+* @name Phaser.Line#slope
+* @property {number} slope - Gets the slope of the line (y/x).
+* @readonly
+*/
+Object.defineProperty(Phaser.Line.prototype, "slope", {
+
+ get: function () {
+ return (this.end.y - this.start.y) / (this.end.x - this.start.x);
+ }
+
+});
+
+/**
+* @name Phaser.Line#perpSlope
+* @property {number} perpSlope - Gets the perpendicular slope of the line (x/y).
+* @readonly
+*/
+Object.defineProperty(Phaser.Line.prototype, "perpSlope", {
+
+ get: function () {
+ return -((this.end.x - this.start.x) / (this.end.y - this.start.y));
+ }
+
+});
+
+/**
+* Checks for intersection between two lines as defined by the given start and end points.
+* If asSegment is true it will check for line segment intersection. If asSegment is false it will check for line intersection.
+* Returns the intersection segment of AB and EF as a Point, or null if there is no intersection.
+* Adapted from code by Keith Hair
+*
+* @method Phaser.Line.intersects
+* @param {Phaser.Point} a - The start of the first Line to be checked.
+* @param {Phaser.Point} b - The end of the first line to be checked.
+* @param {Phaser.Point} e - The start of the second Line to be checked.
+* @param {Phaser.Point} f - The end of the second line to be checked.
+* @param {boolean} [asSegment=true] - If true it will check for segment intersection, otherwise full line intersection.
+* @param {Phaser.Point} [result] - A Point object to store the result in, if not given a new one will be created.
+* @return {Phaser.Point} The intersection segment of the two lines as a Point, or null if there is no intersection.
+*/
+Phaser.Line.intersectsPoints = function (a, b, e, f, asSegment, result) {
+
+ if (typeof asSegment === 'undefined') { asSegment = true; }
+ if (typeof result === 'undefined') { result = new Phaser.Point(); }
+
+ var a1 = b.y - a.y;
+ var a2 = f.y - e.y;
+ var b1 = a.x - b.x;
+ var b2 = e.x - f.x;
+ var c1 = (b.x * a.y) - (a.x * b.y);
+ var c2 = (f.x * e.y) - (e.x * f.y);
+ var denom = (a1 * b2) - (a2 * b1);
+
+ if (denom === 0)
+ {
+ return null;
+ }
+
+ result.x = ((b1 * c2) - (b2 * c1)) / denom;
+ result.y = ((a2 * c1) - (a1 * c2)) / denom;
+
+ if (asSegment)
+ {
+ if (Math.pow((result.x - b.x) + (result.y - b.y), 2) > Math.pow((a.x - b.x) + (a.y - b.y), 2))
+ {
+ return null;
+ }
+
+ if (Math.pow((result.x - a.x) + (result.y - a.y), 2) > Math.pow((a.x - b.x) + (a.y - b.y), 2))
+ {
+ return null;
+ }
+
+ if (Math.pow((result.x - f.x) + (result.y - f.y), 2) > Math.pow((e.x - f.x) + (e.y - f.y), 2))
+ {
+ return null;
+ }
+
+ if (Math.pow((result.x - e.x) + (result.y - e.y), 2) > Math.pow((e.x - f.x) + (e.y - f.y), 2))
+ {
+ return null;
+ }
+ }
+
+ return result;
+
+};
+
+/**
+* Checks for intersection between two lines.
+* If asSegment is true it will check for segment intersection.
+* If asSegment is false it will check for line intersection.
+* Returns the intersection segment of AB and EF as a Point, or null if there is no intersection.
+* Adapted from code by Keith Hair
+*
+* @method Phaser.Line.intersects
+* @param {Phaser.Line} a - The first Line to be checked.
+* @param {Phaser.Line} b - The second Line to be checked.
+* @param {boolean} [asSegment=true] - If true it will check for segment intersection, otherwise full line intersection.
+* @param {Phaser.Point} [result] - A Point object to store the result in, if not given a new one will be created.
+* @return {Phaser.Point} The intersection segment of the two lines as a Point, or null if there is no intersection.
+*/
+Phaser.Line.intersects = function (a, b, asSegment, result) {
+
+ return Phaser.Line.intersectsPoints(a.start, a.end, b.start, b.end, asSegment, result);
+
+};
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/LinkedList.js.html b/docs/LinkedList.js.html
index 82354172..dce1bbe0 100644
--- a/docs/LinkedList.js.html
+++ b/docs/LinkedList.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -574,7 +568,10 @@ Phaser.LinkedList.prototype = {
}
-};
+};
+
+Phaser.LinkedList.prototype.constructor = Phaser.LinkedList;
+
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Loader.js.html b/docs/Loader.js.html index bd0e0d33..6dde3054 100644 --- a/docs/Loader.js.html +++ b/docs/Loader.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -457,7 +451,7 @@ Phaser.Loader = function (game) {
this._fileIndex = 0;
/**
- * @property {number} _progressChunk - Indicates assets loading progress. (from 0 to 100)
+ * @property {number} _progressChunk - Indicates the size of 1 file in terms of a percentage out of 100.
* @private
* @default
*/
@@ -482,15 +476,21 @@ Phaser.Loader = function (game) {
this.hasLoaded = false;
/**
- * @property {number} progress - The Load progress percentage value (from 0 to 100)
+ * @property {number} progress - The rounded load progress percentage value (from 0 to 100)
* @default
*/
this.progress = 0;
+ /**
+ * @property {number} progressFloat - The non-rounded load progress value (from 0.0 to 100.0)
+ * @default
+ */
+ this.progressFloat = 0;
+
/**
* You can optionally link a sprite to the preloader.
* If you do so the Sprite's width or height will be cropped based on the percentage loaded.
- * @property {Description} preloadSprite
+ * @property {Phaser.Sprite} preloadSprite
* @default
*/
this.preloadSprite = null;
@@ -786,6 +786,29 @@ Phaser.Loader.prototype = {
},
+ /**
+ * Add a binary file to the Loader. It will be loaded via xhr with a responseType of "arraybuffer". You can specify an optional callback to process the file after load.
+ * When the callback is called it will be passed 2 parameters: the key of the file and the file data.
+ * WARNING: If you specify a callback, the file data will be set to whatever your callback returns. So always return the data object, even if you didn't modify it.
+ *
+ * @method Phaser.Loader#binary
+ * @param {string} key - Unique asset key of the binary file.
+ * @param {string} url - URL of the binary file.
+ * @param {function} [callback] - Optional callback that will be passed the file after loading, so you can perform additional processing on it.
+ * @param {function} [callbackContext] - The context under which the callback will be applied. If not specified it will use the callback itself as the context.
+ * @return {Phaser.Loader} This Loader instance.
+ */
+ binary: function (key, url, callback, callbackContext) {
+
+ if (typeof callback === 'undefined') { callback = false; }
+ if (callback !== false && typeof callbackContext === 'undefined') { callbackContext = callback; }
+
+ this.addToFileList('binary', key, url, { callback: callback, callbackContext: callbackContext });
+
+ return this;
+
+ },
+
/**
* Add a new sprite sheet to the loader.
*
@@ -795,38 +818,17 @@ Phaser.Loader.prototype = {
* @param {number} frameWidth - Width of each single frame.
* @param {number} frameHeight - Height of each single frame.
* @param {number} [frameMax=-1] - How many frames in this sprite sheet. If not specified it will divide the whole image into frames.
+ * @param {number} [margin=0] - If the frames have been drawn with a margin, specify the amount here.
+ * @param {number} [spacing=0] - If the frames have been drawn with spacing between them, specify the amount here.
* @return {Phaser.Loader} This Loader instance.
*/
- spritesheet: function (key, url, frameWidth, frameHeight, frameMax) {
+ spritesheet: function (key, url, frameWidth, frameHeight, frameMax, margin, spacing) {
if (typeof frameMax === "undefined") { frameMax = -1; }
+ if (typeof margin === "undefined") { margin = 0; }
+ if (typeof spacing === "undefined") { spacing = 0; }
- this.addToFileList('spritesheet', key, url, { frameWidth: frameWidth, frameHeight: frameHeight, frameMax: frameMax });
-
- return this;
-
- },
-
- /**
- * Add a new tile set to the loader. These are used in the rendering of tile maps.
- *
- * @method Phaser.Loader#tileset
- * @param {string} key - Unique asset key of the tileset file.
- * @param {string} url - URL of the tileset.
- * @param {number} tileWidth - Width of each single tile in pixels.
- * @param {number} tileHeight - Height of each single tile in pixels.
- * @param {number} [tileMax=-1] - How many tiles in this tileset. If not specified it will divide the whole image into tiles.
- * @param {number} [tileMargin=0] - If the tiles have been drawn with a margin, specify the amount here.
- * @param {number} [tileSpacing=0] - If the tiles have been drawn with spacing between them, specify the amount here.
- * @return {Phaser.Loader} This Loader instance.
- */
- tileset: function (key, url, tileWidth, tileHeight, tileMax, tileMargin, tileSpacing) {
-
- if (typeof tileMax === "undefined") { tileMax = -1; }
- if (typeof tileMargin === "undefined") { tileMargin = 0; }
- if (typeof tileSpacing === "undefined") { tileSpacing = 0; }
-
- this.addToFileList('tileset', key, url, { tileWidth: tileWidth, tileHeight: tileHeight, tileMax: tileMax, tileMargin: tileMargin, tileSpacing: tileSpacing });
+ this.addToFileList('spritesheet', key, url, { frameWidth: frameWidth, frameHeight: frameHeight, frameMax: frameMax, margin: margin, spacing: spacing });
return this;
@@ -1134,6 +1136,7 @@ Phaser.Loader.prototype = {
}
this.progress = 0;
+ this.progressFloat = 0;
this.hasLoaded = false;
this.isLoading = true;
@@ -1148,6 +1151,7 @@ Phaser.Loader.prototype = {
else
{
this.progress = 100;
+ this.progressFloat = 100;
this.hasLoaded = true;
this.onLoadComplete.dispatch();
}
@@ -1178,7 +1182,6 @@ Phaser.Loader.prototype = {
case 'spritesheet':
case 'textureatlas':
case 'bitmapfont':
- case 'tileset':
file.data = new Image();
file.data.name = file.key;
file.data.onload = function () {
@@ -1269,6 +1272,7 @@ Phaser.Loader.prototype = {
break;
case 'text':
+ case 'script':
this._xhr.open("GET", this.baseURL + file.url, true);
this._xhr.responseType = "text";
this._xhr.onload = function () {
@@ -1280,10 +1284,9 @@ Phaser.Loader.prototype = {
this._xhr.send();
break;
- case 'script':
-
+ case 'binary':
this._xhr.open("GET", this.baseURL + file.url, true);
- this._xhr.responseType = "text";
+ this._xhr.responseType = "arraybuffer";
this._xhr.onload = function () {
return _this.fileComplete(_this._fileIndex);
};
@@ -1356,7 +1359,6 @@ Phaser.Loader.prototype = {
console.warn('Phaser.Loader fileComplete invalid index ' + index);
return;
}
-
var file = this._fileList[index];
file.loaded = true;
@@ -1373,12 +1375,7 @@ Phaser.Loader.prototype = {
case 'spritesheet':
- this.game.cache.addSpriteSheet(file.key, file.url, file.data, file.frameWidth, file.frameHeight, file.frameMax);
- break;
-
- case 'tileset':
-
- this.game.cache.addTileset(file.key, file.url, file.data, file.tileWidth, file.tileHeight, file.tileMax, file.tileMargin, file.tileSpacing);
+ this.game.cache.addSpriteSheet(file.key, file.url, file.data, file.frameWidth, file.frameHeight, file.frameMax, file.margin, file.spacing);
break;
case 'textureatlas':
@@ -1461,6 +1458,7 @@ Phaser.Loader.prototype = {
if (buffer)
{
that.game.cache.decodedSound(key, buffer);
+ that.game.sound.onSoundDecode.dispatch(key, that.game.cache.getSound(key));
}
});
}
@@ -1481,10 +1479,24 @@ Phaser.Loader.prototype = {
file.data = document.createElement('script');
file.data.language = 'javascript';
file.data.type = 'text/javascript';
- file.data.defer = true;
+ file.data.defer = false;
file.data.text = this._xhr.responseText;
document.head.appendChild(file.data);
break;
+
+ case 'binary':
+ if (file.callback)
+ {
+ file.data = file.callback.call(file.callbackContext, file.key, this._xhr.response);
+ }
+ else
+ {
+ file.data = this._xhr.response;
+ }
+
+ this.game.cache.addBinary(file.key, file.data);
+
+ break;
}
if (loadNext)
@@ -1630,7 +1642,8 @@ Phaser.Loader.prototype = {
*/
nextFile: function (previousIndex, success) {
- this.progress = Math.round(this.progress + this._progressChunk);
+ this.progressFloat += this._progressChunk;
+ this.progress = Math.round(this.progressFloat);
if (this.progress > 100)
{
@@ -1713,6 +1726,8 @@ Phaser.Loader.prototype = {
}
};
+
+Phaser.Loader.prototype.constructor = Phaser.Loader;
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/LoaderParser.js.html b/docs/LoaderParser.js.html index eefdaba6..bd280b4c 100644 --- a/docs/LoaderParser.js.html +++ b/docs/LoaderParser.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -518,13 +512,13 @@ Phaser.LoaderParser = {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/MSPointer.js.html b/docs/MSPointer.js.html
index 88f18043..014729ff 100644
--- a/docs/MSPointer.js.html
+++ b/docs/MSPointer.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -588,7 +582,10 @@ Phaser.MSPointer.prototype = {
}
-};
+};
+
+Phaser.MSPointer.prototype.constructor = Phaser.MSPointer;
+
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Math.js.html b/docs/Math.js.html index 087509fe..166ea58e 100644 --- a/docs/Math.js.html +++ b/docs/Math.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -750,7 +744,7 @@ Phaser.Math = {
},
/**
- * Find the angle of a segment from (x1, y1) -> (x2, y2 ).
+ * Find the angle of a segment from (x1, y1) -> (x2, y2).
* @method Phaser.Math#angleBetween
* @param {number} x1
* @param {number} y1
@@ -763,24 +757,58 @@ Phaser.Math = {
},
/**
- * Set an angle within the bounds of -π toπ.
- * @method Phaser.Math#normalizeAngle
- * @param {number} angle
- * @param {boolean} radians - True if angle size is expressed in radians.
- * @return {number}
+ * Reverses an angle.
+ * @method Phaser.Math#reverseAngle
+ * @param {number} angleRad - The angle to reverse, in radians.
+ * @return {number} Returns the reverse angle, in radians.
*/
- normalizeAngle: function (angle, radians) {
+ reverseAngle: function (angleRad) {
+ return this.normalizeAngle(angleRad + Math.PI, true);
+ },
- if (typeof radians === "undefined") { radians = true; }
+ /**
+ * Normalizes an angle to the [0,2pi) range.
+ * @method Phaser.Math#normalizeAngle
+ * @param {number} angleRad - The angle to normalize, in radians.
+ * @return {number} Returns the angle, fit within the [0,2pi] range, in radians.
+ */
+ normalizeAngle: function (angleRad) {
- var rd = (radians) ? Math.PI : 180;
- return this.wrap(angle, -rd, rd);
+ angleRad = angleRad % (2 * Math.PI);
+ return angleRad >= 0 ? angleRad : angleRad + 2 * Math.PI;
},
/**
- * Closest angle between two angles from a1 to a2
- * absolute value the return for exact angle
+ * Normalizes a latitude to the [-90,90] range. Latitudes above 90 or below -90 are capped, not wrapped.
+ * @method Phaser.Math#normalizeLatitude
+ * @param {number} lat - The latitude to normalize, in degrees.
+ * @return {number} Returns the latitude, fit within the [-90,90] range.
+ */
+ normalizeLatitude: function (lat) {
+ return Math.max(-90, Math.min(90, lat));
+ },
+
+ /**
+ * Normalizes a longitude to the [-180,180] range. Longitudes above 180 or below -180 are wrapped.
+ * @method Phaser.Math#normalizeLongitude
+ * @param {number} lng - The longitude to normalize, in degrees.
+ * @return {number} Returns the longitude, fit within the [-180,180] range.
+ */
+ normalizeLongitude: function (lng) {
+
+ if (lng % 360 == 180)
+ {
+ return 180;
+ }
+
+ lng = lng % 360;
+ return lng < -180 ? lng + 360 : lng > 180 ? lng - 360 : lng;
+
+ },
+
+ /**
+ * Closest angle between two angles from a1 to a2 absolute value the return for exact angle
* @method Phaser.Math#nearestAngleBetween
* @param {number} a1
* @param {number} a2
@@ -934,13 +962,13 @@ Phaser.Math = {
/**
* Ensures that the value always stays between min and max, by wrapping the value around.
- * <p>max should be larger than min, or the function will return 0</p>
+ * max should be larger than min, or the function will return 0.
*
* @method Phaser.Math#wrap
- * @param value The value to wrap
- * @param min The minimum the value is allowed to be
- * @param max The maximum the value is allowed to be
- * @return {number} The wrapped value
+ * @param {number} value - The value to wrap.
+ * @param {number} min - The minimum the value is allowed to be.
+ * @param {number} max - The maximum the value is allowed to be.
+ * @return {number} The wrapped value.
*/
wrap: function (value, min, max) {
@@ -1049,7 +1077,7 @@ Phaser.Math = {
},
/**
- * Significantly faster version of Math.min
+ * Updated version of Math.min that can be passed either an array of numbers or the numbers as parameters.
* See http://jsperf.com/math-s-min-max-vs-homemade/5
*
* @method Phaser.Math#min
@@ -1057,15 +1085,113 @@ Phaser.Math = {
*/
min: function () {
- for (var i =1 , min = 0, len = arguments.length; i < len; i++)
+ if (arguments.length === 1 && typeof arguments[0] === 'object')
{
- if (arguments[i] < arguments[min])
+ var data = arguments[0];
+ }
+ else
+ {
+ var data = arguments;
+ }
+
+ for (var i = 1, min = 0, len = data.length; i < len; i++)
+ {
+ if (data[i] < data[min])
{
min = i;
}
}
- return arguments[min];
+ return data[min];
+
+ },
+
+ /**
+ * Updated version of Math.max that can be passed either an array of numbers or the numbers as parameters.
+ *
+ * @method Phaser.Math#max
+ * @return {number} The largest value from those given.
+ */
+ max: function () {
+
+ if (arguments.length === 1 && typeof arguments[0] === 'object')
+ {
+ var data = arguments[0];
+ }
+ else
+ {
+ var data = arguments;
+ }
+
+ for (var i = 1, max = 0, len = data.length; i < len; i++)
+ {
+ if (data[i] > data[max])
+ {
+ max = i;
+ }
+ }
+
+ return data[max];
+
+ },
+
+ /**
+ * Updated version of Math.min that can be passed a property and either an array of objects or the objects as parameters.
+ * It will find the lowest matching property value from the given objects.
+ *
+ * @method Phaser.Math#minProperty
+ * @return {number} The lowest value from those given.
+ */
+ minProperty: function (property) {
+
+ if (arguments.length === 2 && typeof arguments[1] === 'object')
+ {
+ var data = arguments[1];
+ }
+ else
+ {
+ var data = arguments.slice(1);
+ }
+
+ for (var i = 1, min = 0, len = data.length; i < len; i++)
+ {
+ if (data[i][property] < data[min][property])
+ {
+ min = i;
+ }
+ }
+
+ return data[min][property];
+
+ },
+
+ /**
+ * Updated version of Math.max that can be passed a property and either an array of objects or the objects as parameters.
+ * It will find the largest matching property value from the given objects.
+ *
+ * @method Phaser.Math#maxProperty
+ * @return {number} The largest value from those given.
+ */
+ maxProperty: function (property) {
+
+ if (arguments.length === 2 && typeof arguments[1] === 'object')
+ {
+ var data = arguments[1];
+ }
+ else
+ {
+ var data = arguments.slice(1);
+ }
+
+ for (var i = 1, max = 0, len = data.length; i < len; i++)
+ {
+ if (data[i][property] > data[max][property])
+ {
+ max = i;
+ }
+ }
+
+ return data[max][property];
},
@@ -1111,7 +1237,7 @@ Phaser.Math = {
},
/**
- * Description.
+ * A Linear Interpolation Method, mostly used by Phaser.Tween.
* @method Phaser.Math#linearInterpolation
* @param {number} v
* @param {number} k
@@ -1138,7 +1264,7 @@ Phaser.Math = {
},
/**
- * Description.
+ * A Bezier Interpolation Method, mostly used by Phaser.Tween.
* @method Phaser.Math#bezierInterpolation
* @param {number} v
* @param {number} k
@@ -1159,7 +1285,7 @@ Phaser.Math = {
},
/**
- * Description.
+ * A Catmull Rom Interpolation Method, mostly used by Phaser.Tween.
* @method Phaser.Math#catmullRomInterpolation
* @param {number} v
* @param {number} k
@@ -1394,7 +1520,7 @@ Phaser.Math = {
* @param {number} y1
* @param {number} x2
* @param {number} y2
- * @return {number} The distance between this Point object and the destination Point object.
+ * @return {number} The distance between the two sets of coordinates.
*/
distance: function (x1, y1, x2, y2) {
@@ -1405,6 +1531,25 @@ Phaser.Math = {
},
+ /**
+ * Returns the distance between the two given set of coordinates at the power given.
+ *
+ * @method Phaser.Math#distancePow
+ * @param {number} x1
+ * @param {number} y1
+ * @param {number} x2
+ * @param {number} y2
+ * @param {number} [pow=2]
+ * @return {number} The distance between the two sets of coordinates.
+ */
+ distancePow: function (x1, y1, x2, y2, pow) {
+
+ if (typeof pow === 'undefined') { pow = 2; }
+
+ return Math.sqrt(Math.pow(x2 - x1, pow) + Math.pow(y2 - y1, pow));
+
+ },
+
/**
* Returns the rounded distance between the two given set of coordinates.
*
@@ -1604,13 +1749,13 @@ Phaser.Math = {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Mouse.js.html b/docs/Mouse.js.html
index 4dbbdc0f..c1518e11 100644
--- a/docs/Mouse.js.html
+++ b/docs/Mouse.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -491,7 +485,8 @@ Phaser.Mouse = function (game) {
this.pointerLock = new Phaser.Signal();
/**
- * @property {MouseEvent} event - The browser mouse event.
+ * @property {MouseEvent} event - The browser mouse DOM event. Will be set to null if no mouse event has ever been received.
+ * @default
*/
this.event = null;
@@ -749,6 +744,8 @@ Phaser.Mouse.prototype = {
}
};
+
+Phaser.Mouse.prototype.constructor = Phaser.Mouse;
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Net.js.html b/docs/Net.js.html index 8494000a..b9b79823 100644 --- a/docs/Net.js.html +++ b/docs/Net.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -551,8 +545,8 @@ Phaser.Net.prototype = {
var output = {};
var keyValues = location.search.substring(1).split('&');
- for (var i in keyValues) {
-
+ for (var i in keyValues)
+ {
var key = keyValues[i].split('=');
if (key.length > 1)
@@ -585,6 +579,8 @@ Phaser.Net.prototype = {
}
};
+
+Phaser.Net.prototype.constructor = Phaser.Net;
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Particles.js.html b/docs/Particles.js.html index 501ff851..89d16184 100644 --- a/docs/Particles.js.html +++ b/docs/Particles.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -499,7 +493,10 @@ Phaser.Particles.prototype = {
}
-};
+};
+
+Phaser.Particles.prototype.constructor = Phaser.Particles;
+
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Animation.html b/docs/Phaser.Animation.html index c2b32417..3ea9c67e 100644 --- a/docs/Phaser.Animation.html +++ b/docs/Phaser.Animation.html @@ -90,6 +90,10 @@ Device +
loopedkillOnCompleteThe loop state of the Animation.
Should the parent of this Animation be killed when the animation completes?
- false
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:26 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:25 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.AnimationManager.html b/docs/Phaser.AnimationManager.html index 344ada58..4609bb4a 100644 --- a/docs/Phaser.AnimationManager.html +++ b/docs/Phaser.AnimationManager.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:26 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:25 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.AnimationParser.html b/docs/Phaser.AnimationParser.html index 97906828..ca5b0c11 100644 --- a/docs/Phaser.AnimationParser.html +++ b/docs/Phaser.AnimationParser.html @@ -90,6 +90,10 @@ Device +
<static> spriteSheet(game, key, frameWidth, frameHeight, frameMax) → {Phaser.FrameData}
+<static> spriteSheet(game, key, frameWidth, frameHeight, frameMax, margin, spacing) → {Phaser.FrameData}
margin+ + + + + +
If the frames have been drawn with a margin, specify the amount here.
spacing+ + + + + +
If the frames have been drawn with spacing between them, specify the amount here.
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:26 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:25 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.BitmapData.html b/docs/Phaser.BitmapData.html index e561604f..b1f396be 100644 --- a/docs/Phaser.BitmapData.html +++ b/docs/Phaser.BitmapData.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:26 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:25 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.BitmapText.html b/docs/Phaser.BitmapText.html index 069b9624..46ef4655 100644 --- a/docs/Phaser.BitmapText.html +++ b/docs/Phaser.BitmapText.html @@ -90,6 +90,10 @@ Device +
renderable
- - --
-
-
-
- Source: -
- - - - - - - -
Properties:
- --
-
-
| Name | - - -Type | - - - - - -Description | -
|---|---|---|
renderable |
-
-
- - - -boolean - - - - | - - - - - -A renderable object will be rendered to the context each frame. |
-
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:27 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:25 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Button.html b/docs/Phaser.Button.html index 6b04cc28..ac34735f 100644 --- a/docs/Phaser.Button.html +++ b/docs/Phaser.Button.html @@ -90,6 +90,10 @@ Device +
new Button(game, x, y, key, callback, callbackContext, overFrame, outFrame, downFrame)
+new Button(game, x, y, key, callback, callbackContext, overFrame, outFrame, downFrame, upFrame)
Current game instance.
X position of the Button.
Y position of the Button.
The image key as defined in the Game.Cache to use as the texture for this Button.
The function to call when this Button is pressed.
The context in which the callback will be called (usually 'this').
This is the frame or frameName that will be set when this button is in an over state. Give either a number to use a frame ID or a string for a frame name.
This is the frame or frameName that will be set when this button is in an out state. Give either a number to use a frame ID or a string for a frame name.
This is the frame or frameName that will be set when this button is in a down state. Give either a number to use a frame ID or a string for a frame name.
upFrame+ + + + + +
This is the frame or frameName that will be set when this button is in an up state. Give either a number to use a frame ID or a string for a frame name.
-
@@ -943,13 +1019,13 @@
When the Button is clicked you can optionally force the state to "out".
+When the Button is touched / clicked and then released you can force it to enter a state of "out" instead of "up".
- true
- false
-
-
<protected> onInputOverHandler(pointer)
+clearFrames()
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Clears all of the frames set on this Button.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
<protected> onInputOverHandler(sprite, pointer)
@@ -2453,6 +2598,29 @@
+ - Source:
- @@ -2531,7 +2699,7 @@
-
-
<protected> onInputOverHandler(pointer)
+<protected> onInputOverHandler(sprite, pointer)
@@ -2571,6 +2739,29 @@
- Source:
- @@ -2649,7 +2840,7 @@
-
-
<protected> onInputOverHandler(pointer)
+<protected> onInputOverHandler(sprite, pointer)
@@ -2691,13 +2882,13 @@
- Source: -
- - - - - - - - -
-
-
<protected> onInputOverHandler(pointer)
- - -
- -
-
-
- -- - - - - - - -
Internal function that handles input events.
-Parameters:
- - -- -
@@ -3224,7 +3496,7 @@ exactly like setting them in the constructor.- - - - - -Name - - -Type - - - - - -Description -@@ -2880,6 +2976,147 @@ + + + + + + +- +
+<protected> onInputOverHandler(sprite, pointer)
+ + +- + + +
@@ -2893,7 +3130,7 @@++ + + + + + + +Internal function that handles input events.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +sprite+ + +Phaser.Button + + + + + + + + + +The Button that the event occured on.
+ + + + + +pointer+ + +Phaser.Pointer + + + + + + + + + +The Pointer that activated the Button.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
-@@ -3018,7 +3255,7 @@The Sound to be played when a Pointer clicks on this Button.
+The Sound to be played when a Pointer presses down on this Button.
- Source:
- @@ -3046,7 +3283,7 @@
- -
@@ -3054,8 +3291,7 @@setFrames(overFrame, outFrame, downFrame)
+setFrames(overFrame, outFrame, downFrame, upFrame)
-@@ -3196,6 +3432,42 @@ exactly like setting them in the constructor.Used to manually set the frames that will be used for the different states of the button -exactly like setting them in the constructor.
+Used to manually set the frames that will be used for the different states of the Button.
+ + + +upFrame+ + +string +| + +number + + + + + + ++ + <optional> + + + + +
+ + + + + +This is the frame or frameName that will be set when this button is in an up state. Give either a number to use a frame ID or a string for a frame name.
- +
- Source:
- @@ -3385,7 +3657,7 @@ exactly like setting them in the constructor.
- Source:
- @@ -3546,7 +3818,7 @@ exactly like setting them in the constructor.
- Source:
- @@ -3909,7 +4181,125 @@ Call this function with no parameters at all to reset all sounds on this Button.
- Source:
- + + + + + + + +
spriteThe Button that the event occured on.
pointerspriteThe Button that the event occured on.
pointerpointerspriteThe Pointer that activated the Button.
The Button that the event occured on.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
<protected> setState(newState)
+ + +
+
+
+
+
+
+
+
+
+ Internal function that handles Button state changes.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
newState |
+
+
+ + + +number + + + + | + + + + + +The new State of the Button. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- @@ -3945,7 +4335,7 @@ Call this function with no parameters at all to reset all sounds on this Button.
- Source:
- @@ -4115,13 +4505,13 @@ Call this function with no parameters at all to reset all sounds on this Button. - Phaser Copyright © 2012-2013 Photon Storm Ltd. + Phaser Copyright © 2012-2014 Photon Storm Ltd.
-
@@ -4070,7 +4460,7 @@ Call this function with no parameters at all to reset all sounds on this Button.
The Sound to be played when a Pointer clicks on this Button.
+The Sound to be played when a Pointer has pressed down and is released from this Button.
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:27 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:26 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Cache.html b/docs/Phaser.Cache.html index 48d2c327..ac9a8804 100644 --- a/docs/Phaser.Cache.html +++ b/docs/Phaser.Cache.html @@ -90,6 +90,10 @@ Device +
A game only has one instance of a Cache and it is used to store all externally loaded assets such -as images, sounds and data files as a result of Loader calls. Cache items use string based keys for look-up.
A game only has one instance of a Cache and it is used to store all externally loaded assets such as images, sounds and data files as a result of Loader calls. Cached items use string based keys for look-up.
-
+
-
+
addBinary(key, binaryData)
+ + +
+ -
+
+
+ ++ + + + + + + +
Add a binary object in to the cache.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +key+ + +string + + + + + + + + + +Asset key for this binary data.
+ + + + + +binaryData+ + +object + + + + + + + + + +The binary object to be addded to the cache.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + loader/Cache.js, line 95 +
+
+
+
+
+
+
+
+
+
+
+
-
addBitmapData(key, bitmapData) → {Phaser.BitmapData}
@@ -896,7 +1030,7 @@ as images, sounds and data files as a result of Loader calls. Cache items use st- Source:
- @@ -1106,7 +1240,7 @@ as images, sounds and data files as a result of Loader calls. Cache items use st
- Source:
- @@ -1270,7 +1404,7 @@ as images, sounds and data files as a result of Loader calls. Cache items use st
- Source:
- @@ -1339,7 +1473,7 @@ as images, sounds and data files as a result of Loader calls. Cache items use st
- Source:
- @@ -1503,7 +1637,7 @@ as images, sounds and data files as a result of Loader calls. Cache items use st
- Source:
- @@ -1572,7 +1706,7 @@ as images, sounds and data files as a result of Loader calls. Cache items use st
- Source:
- @@ -1713,7 +1847,7 @@ as images, sounds and data files as a result of Loader calls. Cache items use st
- Source:
- @@ -1923,7 +2057,7 @@ as images, sounds and data files as a result of Loader calls. Cache items use st
- Source:
- @@ -1951,7 +2085,7 @@ as images, sounds and data files as a result of Loader calls. Cache items use st
-
-
addSpriteSheet(key, url, data, frameWidth, frameHeight, frameMax)
+addSpriteSheet(key, url, data, frameWidth, frameHeight, frameMax, margin, spacing)
@@ -1981,8 +2115,12 @@ as images, sounds and data files as a result of Loader calls. Cache items use st
- Source:
- @@ -2320,7 +2612,7 @@ as images, sounds and data files as a result of Loader calls. Cache items use st
- Source:
- @@ -2530,7 +2822,7 @@ as images, sounds and data files as a result of Loader calls. Cache items use st
- Source:
- @@ -2662,7 +2954,7 @@ as images, sounds and data files as a result of Loader calls. Cache items use st -
- Source:
- - loader/Cache.js, line 172 -
-
-
-
-
-
-
-
-
The unique key by which you will reference this object.
URL of this sprite sheet file.
Extra sprite sheet data.
Width of the sprite sheet.
Height of the sprite sheet.
+ + + + +
How many frames stored in the sprite sheet.
How many frames stored in the sprite sheet. If -1 then it divides the whole sheet evenly.
margin+ + + + + +
If the frames have been drawn with a margin, specify the amount here.
spacing+ + + + + +
If the frames have been drawn with spacing between them, specify the amount here.
The tilemap data object.
The tilemap data object (either a CSV or JSON file).
addTileset(key, url, data, tileWidth, tileHeight, tileMax, tileMargin, tileSpacing)
- - -
-
-
-
-
-
-
-
-
- Add a new tile set in to the cache.
-Parameters:
- - -| Name | - - -Type | - - -Argument | - - - -Default | - - -Description | -
|---|---|---|---|---|
key |
-
-
- - - -string - - - - | - - -- - - - - - | - - - -- - | - - -The unique key by which you will reference this object. |
-
url |
-
-
- - - -string - - - - | - - -- - - - - - | - - - -- - | - - -URL of this tile set file. |
-
data |
-
-
- - - -object - - - - | - - -- - - - - - | - - - -- - | - - -Extra tile set data. |
-
tileWidth |
-
-
- - - -number - - - - | - - -- - - - - - | - - - -- - | - - -Width of the sprite sheet. |
-
tileHeight |
-
-
- - - -number - - - - | - - -- - - - - - | - - - -- - | - - -Height of the sprite sheet. |
-
tileMax |
-
-
- - - -number - - - - | - - -- - - - - - | - - - -- - | - - -How many tiles stored in the sprite sheet. |
-
tileMargin |
-
-
- - - -number - - - - | - - -
-
- <optional> - - - - - - |
-
-
-
- - - 0 - - | - - -If the tiles have been drawn with a margin, specify the amount here. |
-
tileSpacing |
-
-
- - - -number - - - - | - - -
-
- <optional> - - - - - - |
-
-
-
- - - 0 - - | - - -If the tiles have been drawn with spacing between them, specify the amount here. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- @@ -3190,7 +3095,7 @@ as images, sounds and data files as a result of Loader calls. Cache items use st -
- Source:
- @@ -3386,7 +3291,7 @@ as images, sounds and data files as a result of Loader calls. Cache items use st
- Source:
- @@ -3455,7 +3360,7 @@ as images, sounds and data files as a result of Loader calls. Cache items use st
- Source:
- @@ -3478,6 +3383,147 @@ as images, sounds and data files as a result of Loader calls. Cache items use st +
Asset key of the image you want.
Asset key of the image to check is in the Cache.
getBinary(key) → {object}
+ + +
+
+
+
+
+
+
+
+
+ Get binary data by key.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Asset key of the binary data object to retrieve from the Cache. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + loader/Cache.js, line 705 +
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The binary data object.
+-
+
- + Type + +
- + +object + + + +
Asset key of the BitmapData object you want.
Asset key of the BitmapData object to retrieve from the Cache.
Asset key of the canvas you want.
Asset key of the canvas to retrieve from the Cache.
-
@@ -3823,7 +3869,7 @@ as images, sounds and data files as a result of Loader calls. Cache items use st
- The canvas you want.
+The canvas object.
Asset key of the frame data you want.
Asset key of the frame data to retrieve from the Cache.
-
@@ -3964,7 +4010,7 @@ as images, sounds and data files as a result of Loader calls. Cache items use st
- The frame data you want.
+The frame data.
Asset key of the frame data you want.
Asset key of the frame data to retrieve from the Cache.
-
@@ -4105,7 +4151,7 @@ as images, sounds and data files as a result of Loader calls. Cache items use st
- The frame data you want.
+The frame object.
Asset key of the frame data you want.
Asset key of the frame data to retrieve from the Cache.
-
@@ -4246,7 +4292,7 @@ as images, sounds and data files as a result of Loader calls. Cache items use st
- The frame data you want.
+The frame object.
Asset key of the frame data you want.
Asset key of the frame data to retrieve from the Cache.
-
@@ -4387,7 +4433,7 @@ as images, sounds and data files as a result of Loader calls. Cache items use st
- The frame data you want.
+The frame data.
Asset key of the image you want.
Asset key of the image to retrieve from the Cache.
-
@@ -4470,7 +4516,7 @@ as images, sounds and data files as a result of Loader calls. Cache items use st
The image data you want.
+The image data.
getImageKeys() → {Array}
+getImageKeys() → {Array}
getKeys(array) → {Array}
+getKeys(array) → {Array}
Asset key of the sound you want.
Asset key of the sound to retrieve from the Cache.
-
@@ -4903,7 +4949,7 @@ Normally you don't call this directly but instead use getImageKeys, getSoundKeys
- The sound you want.
+The sound object.
Asset key of the sound you want.
Asset key of the sound to retrieve from the Cache.
-
@@ -4986,7 +5032,7 @@ Normally you don't call this directly but instead use getImageKeys, getSoundKeys
The sound data you want.
+The sound data.
getSoundKeys() → {Array}
+getSoundKeys() → {Array}
Asset key of the text data you want.
Asset key of the text data to retrieve from the Cache.
-
@@ -5219,7 +5265,7 @@ Normally you don't call this directly but instead use getImageKeys, getSoundKeys
The text data you want.
+The text data.
getTextKeys() → {Array}
+getTextKeys() → {Array}
Asset key of the RenderTexture you want.
Asset key of the RenderTexture to retrieve from the Cache.
-
@@ -5460,7 +5506,7 @@ Normally you don't call this directly but instead use getImageKeys, getSoundKeys
The RenderTexture you want.
+The RenderTexture object.
-
@@ -5510,7 +5556,7 @@ Normally you don't call this directly but instead use getImageKeys, getSoundKeys
- Get a single frame by key. You'd only do this to get the default Frame created for a non-atlas/spritesheet image.
+Get a single texture frame by key. You'd only do this to get the default Frame created for a non-atlas/spritesheet image.
Asset key of the frame data you want.
Asset key of the frame to retrieve from the Cache.
-
@@ -5651,7 +5697,7 @@ Normally you don't call this directly but instead use getImageKeys, getSoundKeys
- The frame data you want.
+The frame data.
Asset key of the tilemap you want.
Asset key of the tilemap data to retrieve from the Cache.
-
@@ -5729,288 +5775,6 @@ Normally you don't call this directly but instead use getImageKeys, getSoundKeys
-
-
-
-
-The tilemap data. The tileset image is in the data property, the map data in mapData.
+The raw tilemap data in CSV or JSON format.
getTileset(key) → {Phaser.Tileset}
- - -
-
-
-
-
-
-
-
-
- Get tile set image data by key.
-Parameters:
- - -| Name | - - -Type | - - - - - -Description | -
|---|---|---|
key |
-
-
- - - -string - - - - | - - - - - -Asset key of the image you want. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - loader/Cache.js, line 495 -
-
-
-
-
-
-
-
-
Returns:
- - -
-
-
-
-
-The tileset data. The tileset image is in the data property, the tile data in tileData.
--
-
- - Type - -
- - -Phaser.Tileset - - - -
getTileSetImage(key) → {object}
- - -
-
-
-
-
-
-
-
-
- Get tile set image data by key.
-Parameters:
- - -| Name | - - -Type | - - - - - -Description | -
|---|---|---|
key |
-
-
- - - -string - - - - | - - - - - -Asset key of the image you want. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - loader/Cache.js, line 477 -
-
-
-
-
-
-
-
-
Returns:
- - -
-
-
-
-
-The image data you want.
--
-
- - Type - -
- - -object - - - -
Asset key of the sound you want.
Asset key of the sound in the Cache.
Asset key of the sound you want.
Asset key of the sound in the Cache.
-
@@ -6647,7 +6411,7 @@ Normally you don't call this directly but instead use getImageKeys, getSoundKeys
Description.
+Fires the onSoundUnlock event when the sound has completed reloading.
-
@@ -7237,7 +7001,7 @@ Normally you don't call this directly but instead use getImageKeys, getSoundKeys
Description.
+Updates the sound object in the cache.
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:27 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:26 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Camera.html b/docs/Phaser.Camera.html index c999006b..9c78271a 100644 --- a/docs/Phaser.Camera.html +++ b/docs/Phaser.Camera.html @@ -90,6 +90,10 @@ Device +
displayObject
+ + +-
+
+
+
- Source: +
- + core/Camera.js, line 92 +
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
displayObject |
+
+
+ + + +PIXI.DisplayObject + + + + | + + + + + +The display object to which all game objects are added. Set by World.boot |
+
Camera view. The view into the world we wish to render (by default the game dimensions). The x/y values are in world coordinates, not screen coordinates, the width/height is how many pixels to render. -Objects outside of this view are not rendered (unless set to ignore the Camera, i.e. UI?).
+Objects outside of this view are not rendered if set to camera cull. @@ -2062,7 +2158,7 @@ Objects outside of this view are not rendered (unless set to ignore the Camera,- - core/Camera.js, line 119 + core/Camera.js, line 122 +
setBoundsToWorld()
+ + +
+
+
+
+
+
+
+
+
+
+
+Update the Camera bounds to match the game world.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- @@ -3003,7 +3168,7 @@ without having to use game.camera.x and game.camera.y.
- Source:
- @@ -3144,7 +3309,7 @@ without having to use game.camera.x and game.camera.y.
- Source:
- @@ -3213,7 +3378,7 @@ without having to use game.camera.x and game.camera.y.
- Source:
- @@ -3258,13 +3423,13 @@ without having to use game.camera.x and game.camera.y. - Phaser Copyright © 2012-2013 Photon Storm Ltd. + Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:27 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:26 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Canvas.html b/docs/Phaser.Canvas.html index 71bd9952..06f8a7ad 100644 --- a/docs/Phaser.Canvas.html +++ b/docs/Phaser.Canvas.html @@ -90,6 +90,10 @@ Device +
-
@@ -523,7 +517,7 @@
The Canvas class handles everything related to the <canvas> tag as a DOM Element, like styles, offset, aspect ratio
+The Canvas class handles everything related to creating the canvas DOM tag that Phaser will use, including styles, offset and aspect ratio.
-
-
<static> addToDOM(canvas, parent, overflowHidden) → {HTMLCanvasElement}
+<static> addToDOM(canvas, parent, overflowHidden) → {HTMLCanvasElement}
@@ -554,8 +548,12 @@ If no parent is given it will be added as a child of the document.body.
- Source:
- @@ -714,7 +752,7 @@ If no parent is given it will be added as a child of the document.body.
-
-
<static> create(width, height) → {HTMLCanvasElement}
+<static> create(width, height, id) → {HTMLCanvasElement}
@@ -722,7 +760,7 @@ If no parent is given it will be added as a child of the document.body.
- Source:
- @@ -1152,7 +1265,7 @@ If no parent is given it will be added as a child of the document.body.
- Source:
- @@ -1338,7 +1451,7 @@ If no parent is given it will be added as a child of the document.body.
- Source:
- @@ -1480,7 +1593,7 @@ Note that if this doesn't given the desired result then see the CanvasUtils.setS
- Source:
- @@ -1622,7 +1735,7 @@ Note that if this doesn't given the desired result then see the setSmoothingEnab
- Source:
- @@ -1790,7 +1903,7 @@ patchy on earlier browsers, especially on mobile.
- Source:
- @@ -1974,7 +2087,7 @@ patchy on earlier browsers, especially on mobile.
- Source:
- @@ -2253,7 +2366,7 @@ patchy on earlier browsers, especially on mobile.
- Source:
- @@ -2437,7 +2550,7 @@ patchy on earlier browsers, especially on mobile.
- Source:
- @@ -2505,13 +2618,13 @@ patchy on earlier browsers, especially on mobile. - Phaser Copyright © 2012-2013 Photon Storm Ltd. + Phaser Copyright © 2012-2014 Photon Storm Ltd.
The canvas to set the touch action on.
The DOM element to add the canvas to. Defaults to ''.
The DOM element to add the canvas to.
+ + + + +
If set to true it will add the overflow='hidden' style to the parent DOM element.
-
@@ -744,8 +782,12 @@ If no parent is given it will be added as a child of the document.body.
Creates the <canvas> tag
+Creates a canvas DOM element. The element is not automatically added to the document.
+ + + + +
The desired width.
The width of the canvas element.
+ + + + +
The desired height.
The height of the canvas element..
id+ + + + + +
If given this will be set as the ID of the canvas element, otherwise no ID will be set.
-
@@ -968,7 +1081,7 @@ If no parent is given it will be added as a child of the document.body.
The newly created <canvas> tag.
+The newly created canvas element.
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:27 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:26 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Circle.html b/docs/Phaser.Circle.html index 36d2d5a0..9f4ff06b 100644 --- a/docs/Phaser.Circle.html +++ b/docs/Phaser.Circle.html @@ -90,6 +90,10 @@ Device +
The x coordinate of the center of the circle.
The y coordinate of the center of the circle.
The diameter of the circle.
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:27 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:26 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Color.html b/docs/Phaser.Color.html index 51379fd7..8db79737 100644 --- a/docs/Phaser.Color.html +++ b/docs/Phaser.Color.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:27 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:26 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.DOMSprite.html b/docs/Phaser.DOMSprite.html new file mode 100644 index 00000000..c7f3269d --- /dev/null +++ b/docs/Phaser.DOMSprite.html @@ -0,0 +1,1476 @@ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/Phaser.Device.html b/docs/Phaser.Device.html
index 033bb1ac..7d231d36 100644
--- a/docs/Phaser.Device.html
+++ b/docs/Phaser.Device.html
@@ -90,6 +90,10 @@
Device
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Class: DOMSprite
++ Phaser. + + DOMSprite +
+ +Phaser.DOMSprite
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ new DOMSprite(game, id, x, y, text, style)
+ + +
+
+
+
+
+
+
+
+
+ Create a new DOMSprite.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
game |
+
+
+ + + +Phaser.Game + + + + | + + + + + +Current game instance. |
+
id |
+
+
+ + + +string + + + + | + + + + + +DOM ID. |
+
x |
+
+
+ + + +number + + + + | + + + + + +X position of the new text object. |
+
y |
+
+
+ + + +number + + + + | + + + + + +Y position of the new text object. |
+
text |
+
+
+ + + +string + + + + | + + + + + +The actual text that will be written. |
+
style |
+
+
+ + + +object + + + + | + + + + + +The style object containing style attributes like font, font size , |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Members
+ +-
+
+
-
+
alive
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Default Value: +
- true
+
+
+
+ - Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +alive+ + +boolean + + + + + + + + + +This is a handy little var your game can use to determine if an object is alive or not, it doesn't effect rendering.
+
+
+
+ -
+
exists
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Default Value: +
- true
+
+
+
+ - Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +exists+ + +boolean + + + + + + + + + +If exists = false then the Text isn't updated by the core game loop.
+
+
+
+ -
+
game
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +game+ + +Phaser.Game + + + + + + + + + +A reference to the currently running Game.
+
+
+
+ -
+
group
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +group+ + +Phaser.Group + + + + + + + + + +The parent Group of this Text object.
+
+
+
+ -
+
name
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +name+ + +string + + + + + + + + + +The user defined name given to this object.
+
+
+
+ -
+
type
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +type+ + +number + + + + + + + + + +The const type of this object.
+
+
+
+ -
+
visible
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Default Value: +
- true
+
+
+
+ - Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +visible+ + +boolean + + + + + + + + + +Sets the visible state of this DOMSprite.
+
+
+
+
+
+ +
ejecta
+ + +-
+
+
+
- Default Value: +
- false
+
+
+
+ - Source: +
- + system/Device.js, line 47 +
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
ejecta |
+
+
+ + + +boolean + + + + | + + + + + +Is the game running under Ejecta? |
+
quirksMode
+ + +-
+
+
+
- Default Value: +
- false
+
+
+
+ - Source: +
- @@ -4188,7 +4392,112 @@
- Source:
- + + + + + + + +
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
quirksMode |
+
+
+ + + +boolean + + + + | + + + + + +Is the browser running in strict mode (false) or quirks mode? (true) |
+
silk
+ + +-
+
+
+
- Default Value: +
- false
+
+
+
+ - Source: +
- @@ -4293,7 +4602,217 @@
- Source:
- + + + + + + + +
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
silk |
+
+
+ + + +boolean + + + + | + + + + + +Set to true if running in the Silk browser (as used on the Amazon Kindle) |
+
trident
+ + +-
+
+
+
- Default Value: +
- false
+
+
+
+ - Source: +
- + system/Device.js, line 201 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
trident |
+
+
+ + + +boolean + + + + | + + + + + +Set to true if running a Trident version of Internet Explorer (IE11+) |
+
tridentVersion
+ + +-
+
+
+
- Default Value: +
- 0
+
+
+
+ - Source: +
- @@ -4398,7 +4917,112 @@
- Source:
- + + + + + + + +
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
tridentVersion |
+
+
+ + + +number + + + + | + + + + + +If running in Internet Explorer 11 this will contain the major version number. See http://msdn.microsoft.com/en-us/library/ie/ms537503(v=vs.85).aspx |
+
vibration
+ + +-
+
+
+
- Default Value: +
- false
+
+
+
+ - Source: +
- @@ -4503,7 +5127,7 @@
- Source:
- @@ -4608,7 +5232,7 @@
- Source:
- @@ -4713,7 +5337,7 @@
- Source:
- @@ -4818,7 +5442,7 @@
- Source:
- @@ -4923,7 +5547,7 @@
- Source:
- @@ -5028,7 +5652,7 @@
- Source:
- @@ -5133,7 +5757,7 @@
- Source:
- @@ -5247,7 +5871,7 @@
- Source:
- @@ -5339,7 +5963,7 @@
- Source:
- @@ -5407,13 +6031,13 @@ - Phaser Copyright © 2012-2013 Photon Storm Ltd. + Phaser Copyright © 2012-2014 Photon Storm Ltd.
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
vibration |
+
+
+ + + +boolean + + + + | + + + + + +Does the device support the Vibration API? |
+
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:27 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:27 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Easing.Back.html b/docs/Phaser.Easing.Back.html index 227caf6e..5cd5ceb8 100644 --- a/docs/Phaser.Easing.Back.html +++ b/docs/Phaser.Easing.Back.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:28 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:27 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Easing.Bounce.html b/docs/Phaser.Easing.Bounce.html index eefc3a87..559da0c6 100644 --- a/docs/Phaser.Easing.Bounce.html +++ b/docs/Phaser.Easing.Bounce.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:28 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:27 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Easing.Circular.html b/docs/Phaser.Easing.Circular.html index d8de3fde..423e8058 100644 --- a/docs/Phaser.Easing.Circular.html +++ b/docs/Phaser.Easing.Circular.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:28 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:27 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Easing.Cubic.html b/docs/Phaser.Easing.Cubic.html index 029e55f0..56b6e2f3 100644 --- a/docs/Phaser.Easing.Cubic.html +++ b/docs/Phaser.Easing.Cubic.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:28 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:27 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Easing.Elastic.html b/docs/Phaser.Easing.Elastic.html index a2032e2a..445528fa 100644 --- a/docs/Phaser.Easing.Elastic.html +++ b/docs/Phaser.Easing.Elastic.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:28 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:27 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Easing.Exponential.html b/docs/Phaser.Easing.Exponential.html index d0f95ae5..2bec6a2d 100644 --- a/docs/Phaser.Easing.Exponential.html +++ b/docs/Phaser.Easing.Exponential.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:28 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:28 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Easing.Linear.html b/docs/Phaser.Easing.Linear.html index 897f16f3..efd870b1 100644 --- a/docs/Phaser.Easing.Linear.html +++ b/docs/Phaser.Easing.Linear.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:28 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:28 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Easing.Quadratic.html b/docs/Phaser.Easing.Quadratic.html index 9293bc3b..97dd1fb8 100644 --- a/docs/Phaser.Easing.Quadratic.html +++ b/docs/Phaser.Easing.Quadratic.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:28 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:28 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Easing.Quartic.html b/docs/Phaser.Easing.Quartic.html index f0710356..d605c617 100644 --- a/docs/Phaser.Easing.Quartic.html +++ b/docs/Phaser.Easing.Quartic.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:28 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:28 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Easing.Quintic.html b/docs/Phaser.Easing.Quintic.html index 38b69a8d..cae49a2f 100644 --- a/docs/Phaser.Easing.Quintic.html +++ b/docs/Phaser.Easing.Quintic.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:29 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:28 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Easing.Sinusoidal.html b/docs/Phaser.Easing.Sinusoidal.html index 9f27d626..876ace73 100644 --- a/docs/Phaser.Easing.Sinusoidal.html +++ b/docs/Phaser.Easing.Sinusoidal.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:29 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:28 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Easing.html b/docs/Phaser.Easing.html index 9b823c61..76cf08c7 100644 --- a/docs/Phaser.Easing.html +++ b/docs/Phaser.Easing.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:28 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:27 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Events.html b/docs/Phaser.Events.html index 56989c5d..a3c813c2 100644 --- a/docs/Phaser.Events.html +++ b/docs/Phaser.Events.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:29 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:28 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Filter.html b/docs/Phaser.Filter.html index f5ba4e84..20026212 100644 --- a/docs/Phaser.Filter.html +++ b/docs/Phaser.Filter.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:29 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:28 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Frame.html b/docs/Phaser.Frame.html index 743e23ef..a7dd759c 100644 --- a/docs/Phaser.Frame.html +++ b/docs/Phaser.Frame.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:29 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:28 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.FrameData.html b/docs/Phaser.FrameData.html index 6a39c33a..e8a64653 100644 --- a/docs/Phaser.FrameData.html +++ b/docs/Phaser.FrameData.html @@ -90,6 +90,10 @@ Device +
getFrameIndexes(frames, useNumericIndex, output) → {Array}
+getFrameIndexes(frames, useNumericIndex, output) → {Array}
getFrameRange(start, end, output) → {Array}
+getFrameRange(start, end, output) → {Array}
getFrames(frames, useNumericIndex, output) → {Array}
+getFrames(frames, useNumericIndex, output) → {Array}
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:29 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:28 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Game.html b/docs/Phaser.Game.html index 906478dd..5290e6ce 100644 --- a/docs/Phaser.Game.html +++ b/docs/Phaser.Game.html @@ -90,6 +90,10 @@ Device +
The Games DOM parent.
The DOM element into which this games canvas will be injected. Either a DOM ID (string) or the element itself.
Description.
The default state object. A object consisting of Phaser.State functions (preload, create, update, render) or null.
- true
- - core/Game.js, line 210 + core/Game.js, line 209 +
config
+ + +-
+
+
+
- Source: +
- @@ -1439,7 +1541,7 @@ providing quick access to common functions and handling the boot process.
- Source:
- @@ -1544,7 +1646,7 @@ providing quick access to common functions and handling the boot process.
- Source:
- @@ -1649,7 +1751,7 @@ providing quick access to common functions and handling the boot process.
- Source:
- @@ -1747,11 +1849,14 @@ providing quick access to common functions and handling the boot process. +
- Default Value: +
- 600
+
- Source:
- @@ -1853,7 +1958,7 @@ providing quick access to common functions and handling the boot process.
- Source:
- @@ -1958,7 +2063,7 @@ providing quick access to common functions and handling the boot process.
- Source:
- @@ -2063,7 +2168,7 @@ providing quick access to common functions and handling the boot process.
- Source:
- @@ -2168,7 +2273,7 @@ providing quick access to common functions and handling the boot process.
- Source:
- @@ -2273,7 +2378,7 @@ providing quick access to common functions and handling the boot process.
- Source:
- @@ -2378,7 +2483,7 @@ providing quick access to common functions and handling the boot process.
- Source:
- @@ -2483,7 +2588,7 @@ providing quick access to common functions and handling the boot process.
- Source:
- @@ -2585,7 +2690,7 @@ providing quick access to common functions and handling the boot process.
- Source:
- @@ -2690,7 +2795,7 @@ providing quick access to common functions and handling the boot process.
- Source:
- @@ -2797,7 +2902,112 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
- Source:
- - core/Game.js, line 496 + core/Game.js, line 707 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
config |
+
+
+ + + +object + + + + | + + + + + +The Phaser.Game configuration object. |
+
<readonly> pendingStep
+ + +-
+
+
+
- Default Value: +
- false
+
+
+
+ - Source: +
- @@ -2902,7 +3112,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
- Source:
- @@ -3007,7 +3217,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
- Source:
- @@ -3105,14 +3315,11 @@ When a game is paused the onPause event is dispatched. When it is resumed the on -
- Default Value: -
- null
-
- Source:
- @@ -3214,7 +3421,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
- Source:
- @@ -3319,7 +3526,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
- Source:
- @@ -3424,7 +3631,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
- Source:
- @@ -3529,7 +3736,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
- Source:
- @@ -3631,7 +3838,217 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
- Source:
- - core/Game.js, line 77 + core/Game.js, line 81 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
stepping |
+
+
+ + + +boolean + + + + | + + + + + +An internal property used by enableStep, but also useful to query from your own game objects. |
+
<readonly> stepCount
+ + +-
+
+
+
- Default Value: +
- 0
+
+
+
+ - Source: +
- + core/Game.js, line 248 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
stepCount |
+
+
+ + + +number + + + + | + + + + + +When stepping is enabled this contains the current step cycle. |
+
<readonly> stepping
+ + +-
+
+
+
- Default Value: +
- false
+
+
+
+ - Source: +
- @@ -3736,7 +4153,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
- Source:
- @@ -3834,11 +4251,14 @@ When a game is paused the onPause event is dispatched. When it is resumed the on +
- Default Value: +
- false
+
- Source:
- @@ -3943,7 +4363,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
- Source:
- @@ -4041,11 +4461,14 @@ When a game is paused the onPause event is dispatched. When it is resumed the on +
- Default Value: +
- 800
+
- Source:
- @@ -4150,7 +4573,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
- Source:
- @@ -4215,7 +4638,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
- Source:
- @@ -4284,7 +4707,146 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
- Source:
- - core/Game.js, line 469 + core/Game.js, line 678 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
stepping |
+
+
+ + + +boolean + + + + | + + + + + +Enable core loop stepping with Game.enableStep(). |
+
disableStep()
+ + +
+
+
+
+
+
+
+
+
+
+
+Disables core game loop stepping.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + core/Game.js, line 653 +
+
+
+
+
+
+
+
+
enableStep()
+ + +
+
+
+
+
+
+
+
+
+
+
+Enable core game loop stepping. When enabled you must call game.step() directly (perhaps via a DOM button?) +Calling step will advance the game loop by one frame. This is extremely useful to hard to track down errors!
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- @@ -4353,7 +4915,145 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
- Source:
- - core/Game.js, line 408 + core/Game.js, line 571 +
+
+
+
+
+
+
+
+
<protected> parseConfig()
+ + +
+
+
+
+
+
+
+
+
+
+
+Parses a Game configuration object.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + core/Game.js, line 313 +
+
+
+
+
+
+
+
+
<protected> parseDimension()
+ + +
+
+
+
+
+
+
+
+
+
+
+Get dimension.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- @@ -4422,7 +5122,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
- Source:
- @@ -4491,7 +5191,77 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
- Source:
- - core/Game.js, line 321 + core/Game.js, line 476 +
+
+
+
+
+
+
+
+
step()
+ + +
+
+
+
+
+
+
+
+
+
+
+When stepping is enabled you must call this function directly (perhaps via a DOM button?) to advance the game loop by one frame. +This is extremely useful to hard to track down errors! Use the internal stepCount property to monitor progress.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- @@ -4609,7 +5379,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
- Source:
- @@ -4654,13 +5424,13 @@ When a game is paused the onPause event is dispatched. When it is resumed the on - Phaser Copyright © 2012-2013 Photon Storm Ltd. + Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:29 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:29 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.GameObjectFactory.html b/docs/Phaser.GameObjectFactory.html index f0dbb6f0..336b5ec6 100644 --- a/docs/Phaser.GameObjectFactory.html +++ b/docs/Phaser.GameObjectFactory.html @@ -90,6 +90,10 @@ Device +
-
@@ -1005,7 +999,7 @@
Creates a new instance of the Sound class.
+Creates a new Sound object.
-
@@ -1205,7 +1199,7 @@
A BitmapData object which can be manipulated and drawn to like a traditional Canvas object and used to texture Sprites.
+Experimental: A BitmapData object which can be manipulated and drawn to like a traditional Canvas object and used to texture Sprites.
bitmapText(x, y, text, style) → {Phaser.BitmapText}
+bitmapText(x, y, text, style, group) → {Phaser.BitmapText}
-
-
- Create a new <code>BitmapText</code>. +
- Create a new BitmapText object.
group+ + + + + +
Optional Group to add the object to. If not specified it will be added to the World group.
button(x, y, key, callback, callbackContext, overFrame, outFrame, downFrame) → {Phaser.Button}
+button(x, y, key, callback, callbackContext, overFrame, outFrame, downFrame, upFrame, group) → {Phaser.Button}
-
@@ -1782,6 +1843,75 @@
+
+ Creates a new <code>Button</code> object.
+Creates a new Button object.
upFrame+ + + + + +
This is the frame or frameName that will be set when this button is in an up state. Give either a number to use a frame ID or a string for a frame name.
group+ + + + + +
Optional Group to add the object to. If not specified it will be added to the World group.
-
@@ -2095,7 +2226,7 @@
Create a new Sprite with specific position and sprite sheet key that will automatically be added as a child of the given parent.
+DEPRECATED - will be removed in Phaser 1.2 +Create a new Sprite with specific position and sprite sheet key that will automatically be added as a child of the given parent.
graphics(x, y) → {Phaser.Graphics}
+graphics(x, y, group) → {Phaser.Graphics}
-
@@ -2722,6 +2853,8 @@ at set intervals, and fixes their positions and velocities accorindgly.
Creates a new <code>Graphics</code> object.
+Creates a new Graphics object.
group+ + + + + +
Optional Group to add the object to. If not specified it will be added to the World group.
sprite(x, y, key, frame) → {Phaser.Sprite}
+sound(key, volume, loop, connect) → {Phaser.Sound}
+ + +
+
+
+
+
+
+
+
+
+ Creates a new Sound object.
+Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + + + | + + + ++ + | + + +The Game.cache key of the sound that this object will use. |
+
volume |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + 1 + + | + + +The volume at which the sound will be played. |
+
loop |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + false + + | + + +Whether or not the sound will loop. |
+
connect |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + true + + | + + +Controls if the created Sound object will connect to the master gainNode of the SoundManager when running under WebAudio. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + +
+
+
+
+
+The newly created text object.
+-
+
- + Type + +
- + +Phaser.Sound + + + +
sprite(x, y, key, frame, group) → {Phaser.Sprite}
group+ + + + + +
Optional Group to add the object to. If not specified it will be added to the World group.
text(x, y, text, style) → {Phaser.Text}
+text(x, y, text, style, group) → {Phaser.Text}
-
@@ -3524,6 +4013,8 @@ at set intervals, and fixes their positions and velocities accorindgly.
Creates a new <code>Text</code>.
+Creates a new Text object.
group+ + + + + +
Optional Group to add the object to. If not specified it will be added to the World group.
tilemap(key) → {Phaser.Tilemap}
+tilemap(key, tilesets) → {Phaser.Tilemap}
Asset key for the JSON file.
Asset key for the JSON or CSV map data in the cache.
tilesetsAn object mapping Cache.tileset keys with the tileset names in the JSON file. If a string is provided that will be used.
tilemapLayer(x, y, width, height) → {Phaser.TilemapLayer}
+tileSprite(x, y, width, height, key, group) → {Phaser.TileSprite}
-
@@ -3875,6 +4457,8 @@ at set intervals, and fixes their positions and velocities accorindgly.
Creates a new Tilemap Layer object.
+Creates a new TileSprite object.
X position of the new tilemapLayer.
yY position of the new tilemapLayer.
widththe width of the tilemapLayer.
heightthe height of the tilemapLayer.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Returns:
- - -
-
-
-
-
-The newly created tilemaplayer object.
--
-
- - Type - -
- - -Phaser.TilemapLayer - - - -
tileset(key) → {Phaser.Tileset}
- - -
-
-
-
-
-
-
-
-
- Creates a new Tileset object.
-Parameters:
- - -| Name | - - -Type | - - - - - -Description | -
|---|---|---|
key |
-
-
- - - -string - - - - | - - - - - -The image key as defined in the Game.Cache to use as the tileset. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Returns:
- - -
-
-
-
-
-The newly created tileset object.
--
-
- - Type - -
- - -Phaser.Tileset - - - -
tileSprite(x, y, width, height, key, frame) → {Phaser.TileSprite}
- - -
-
-
-
-
-
-
-
-
- Creates a new <code>TileSprite</code>.
-Parameters:
- - -| Name | - - -Type | - - - - - -Description | -|||
|---|---|---|---|---|---|
x |
-
-
- - - -number - - - - | - + @@ -4274,6 +4515,14 @@ at set intervals, and fixes their positions and velocities accorindgly. ++ + + + + + | + @@ -4297,6 +4546,14 @@ at set intervals, and fixes their positions and velocities accorindgly. ++ + + + + + | + @@ -4320,6 +4577,14 @@ at set intervals, and fixes their positions and velocities accorindgly. ++ + + + + + | + @@ -4349,6 +4614,14 @@ at set intervals, and fixes their positions and velocities accorindgly. ++ + + + + + | + @@ -4359,26 +4632,33 @@ at set intervals, and fixes their positions and velocities accorindgly.
frame |
+ group |
-string -| - -number +Phaser.Group | +
+
+ <optional> + + + + + + |
+
- If this Sprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index. |
+ Optional Group to add the object to. If not specified it will be added to the World group. |
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
game |
+
+
+ + + +Phaser.Game + + + + | + + + + + +A reference to the currently running game. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + input/Gamepad.js, line 21 +
+
+
+
+
+
+
+
+
Members
+ +-
+
+
-
+
<readonly> active
+ + +
+ -
+
+ ++ + + + + +
If the gamepad input is active or not - if not active it should not be updated from Input.js
+-
+
+
+
- Source: +
- + input/Gamepad.js, line 427 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +active+ + +boolean + + + + + + + + + +If the gamepad input is active or not.
+
+
+
+ -
+
callbackContext
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + input/Gamepad.js, line 91 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +callbackContext+ + +Object + + + + + + + + + +The context under which the callbacks are run.
+
+
+
+ -
+
disabled
+ + +
+ -
+
+ ++ + + + + +
You can disable all Gamepad Input by setting disabled to true. While true all new input related events will be ignored.
+-
+
+
+
- Default Value: +
- false
+
+
+
+ - Source: +
- + input/Gamepad.js, line 63 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +disabled+ + +boolean + + + + + + + + + +The disabled state of the Gamepad.
+
+
+
+ -
+
game
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + input/Gamepad.js, line 26 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +game+ + +Phaser.Game + + + + + + + + + +Local reference to game.
+
+
+
+ -
+
onAxisCallback
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + input/Gamepad.js, line 116 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +onAxisCallback+ + +function + + + + + + + + + +This callback is invoked every time any gamepad axis is changed.
+
+
+
+ -
+
onConnectCallback
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + input/Gamepad.js, line 96 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +onConnectCallback+ + +function + + + + + + + + + +This callback is invoked every time any gamepad is connected
+
+
+
+ -
+
onDisconnectCallback
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + input/Gamepad.js, line 101 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +onDisconnectCallback+ + +function + + + + + + + + + +This callback is invoked every time any gamepad is disconnected
+
+
+
+ -
+
onDownCallback
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + input/Gamepad.js, line 106 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +onDownCallback+ + +function + + + + + + + + + +This callback is invoked every time any gamepad button is pressed down.
+
+
+
+ -
+
onFloatCallback
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + input/Gamepad.js, line 121 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +onFloatCallback+ + +function + + + + + + + + + +This callback is invoked every time any gamepad button is changed to a value where value > 0 and value < 1.
+
+
+
+ -
+
onUpCallback
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + input/Gamepad.js, line 111 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +onUpCallback+ + +function + + + + + + + + + +This callback is invoked every time any gamepad button is released.
+
+
+
+ -
+
<readonly> pad1
+ + +
+ -
+
+ ++ + + + + +
Gamepad #1
+-
+
+
+
- Source: +
- + input/Gamepad.js, line 469 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +pad1+ + +boolean + + + + + + + + + +Gamepad #1;
+
+
+
+ -
+
<readonly> pad2
+ + +
+ -
+
+ ++ + + + + +
Gamepad #2
+-
+
+
+
- Source: +
- + input/Gamepad.js, line 483 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +pad2+ + +boolean + + + + + + + + + +Gamepad #2
+
+
+
+ -
+
<readonly> pad3
+ + +
+ -
+
+ ++ + + + + +
Gamepad #3
+-
+
+
+
- Source: +
- + input/Gamepad.js, line 497 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +pad3+ + +boolean + + + + + + + + + +Gamepad #3
+
+
+
+ -
+
<readonly> pad4
+ + +
+ -
+
+ ++ + + + + +
Gamepad #4
+-
+
+
+
- Source: +
- + input/Gamepad.js, line 511 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +pad4+ + +boolean + + + + + + + + + +Gamepad #4
+
+
+
+ -
+
<readonly> padsConnected
+ + +
+ -
+
+ ++ + + + + +
How many live gamepads are currently connected.
+-
+
+
+
- Source: +
- + input/Gamepad.js, line 455 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +padsConnected+ + +boolean + + + + + + + + + +How many live gamepads are currently connected.
+
+
+
+ -
+
<readonly> supported
+ + +
+ -
+
+ ++ + + + + +
Whether or not gamepads are supported in current browser.
+-
+
+
+
- Source: +
- + input/Gamepad.js, line 441 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +supported+ + +boolean + + + + + + + + + +Whether or not gamepads are supported in current browser.
+
+
Methods
+ +-
+
+
-
+
addCallbacks(context, callbacks)
+ + +
+ -
+
+
+ ++ + + + + + + +
Add callbacks to the main Gamepad handler to handle connect/disconnect/button down/button up/axis change/float value buttons
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +context+ + +Object + + + + + + + + + +The context under which the callbacks are run.
+ + + + + +callbacks+ + +Object + + + + + + + + + +Object that takes six different callback methods: +onConnectCallback, onDisconnectCallback, onDownCallback, onUpCallback, onAxisCallback, onFloatCallback
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + input/Gamepad.js, line 138 +
+
+
+
+
+
+
+
+
+
+
+
+ -
+
addCallbacks(context, callbacks)
+ + +
+ -
+
+
+ ++ + + + + + + +
Add callbacks to the this Gamepad to handle connect/disconnect/button down/button up/axis change/float value buttons
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +context+ + +Object + + + + + + + + + +The context under which the callbacks are run.
+ + + + + +callbacks+ + +Object + + + + + + + + + +Object that takes six different callbak methods: +onConnectCallback, onDisconnectCallback, onDownCallback, onUpCallback, onAxisCallback, onFloatCallback
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
isDown(buttonCode) → {boolean}
+ + +
+ -
+
+
+ ++ + + + + + + +
Returns true if the button is currently pressed down, on ANY gamepad.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +buttonCode+ + +number + + + + + + + + + +The buttonCode of the button to check for.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + input/Gamepad.js, line 404 +
+
+
+
+
+
+
+
+
Returns:
+ + +++ + + +True if a button is currently down.
+-
+
- + Type + +
- + +boolean + + + +
+
+
+
+ -
+
justPressed(buttonCode, duration) → {boolean}
+ + +
+ -
+
+
+ ++ + + + + + + +
Returns the "just pressed" state of a button from ANY gamepad connected. Just pressed is considered true if the button was pressed down within the duration given (default 250ms).
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + +Argument + + + +Default + + +Description ++ + + + + +buttonCode+ + +number + + + + + + ++ + + + + + + + + ++ + + + +The buttonCode of the button to check for.
+ + + + + +duration+ + +number + + + + + + ++ + <optional> + + + +
+ + + + + ++ + 250 + + + + +The duration below which the button is considered as being just pressed.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + input/Gamepad.js, line 362 +
+
+
+
+
+
+
+
+
Returns:
+ + +++ + + +True if the button is just pressed otherwise false.
+-
+
- + Type + +
- + +boolean + + + +
+
+
+
+ -
+
justPressed(buttonCode, duration) → {boolean}
+ + +
+ -
+
+
+ ++ + + + + + + +
Returns the "just released" state of a button from ANY gamepad connected. Just released is considered as being true if the button was released within the duration given (default 250ms).
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + +Argument + + + +Default + + +Description ++ + + + + +buttonCode+ + +number + + + + + + ++ + + + + + + + + ++ + + + +The buttonCode of the button to check for.
+ + + + + +duration+ + +number + + + + + + ++ + <optional> + + + +
+ + + + + ++ + 250 + + + + +The duration below which the button is considered as being just released.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + input/Gamepad.js, line 383 +
+
+
+
+
+
+
+
+
Returns:
+ + +++ + + +True if the button is just released otherwise false.
+-
+
- + Type + +
- + +boolean + + + +
+
+
+
+ -
+
reset()
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Reset all buttons/axes of all gamepads
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + input/Gamepad.js, line 347 +
+
+
+
+
+
+
+
+
+
+
+
+ -
+
setDeadZones()
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Sets the deadZone variable for all four gamepads
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + input/Gamepad.js, line 320 +
+
+
+
+
+
+
+
+
+
+
+
+ -
+
start()
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Starts the Gamepad event handling. +This MUST be called manually before Phaser will start polling the Gamepad API.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + input/Gamepad.js, line 159 +
+
+
+
+
+
+
+
+
+
+
+
+ -
+
stop()
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Stops the Gamepad event handling.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + input/Gamepad.js, line 333 +
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/Phaser.Graphics.html b/docs/Phaser.Graphics.html
index 8d98e7fc..75ae9f33 100644
--- a/docs/Phaser.Graphics.html
+++ b/docs/Phaser.Graphics.html
@@ -90,6 +90,10 @@
Device
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Class: GamepadButton
++ Phaser. + + GamepadButton +
+ +If you need more fine-grained control over the handling of specific buttons you can create and use Phaser.GamepadButton objects.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ new GamepadButton(game, buttoncode)
+ + +Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
game |
+
+
+ + + +Phaser.Game + + + + | + + + + + +Current game instance. |
+
buttoncode |
+
+
+ + + +number + + + + | + + + + + +The button code this GamepadButton is responsible for. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Members
+ +-
+
+
-
+
buttonCode
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +buttonCode+ + +number + + + + + + + + + +The buttoncode of this button.
+
+
+
+ -
+
duration
+ + +
+ -
+
+ ++ + + + + +
If the button is down this value holds the duration of that button press and is constantly updated. +If the button is up it holds the duration of the previous down session.
+-
+
+
+
- Default Value: +
- 0
+
+
+
+ - Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +duration+ + +number + + + + + + + + + +The number of milliseconds this button has been held down for.
+
+
+
+ -
+
game
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +game+ + +Phaser.Game + + + + + + + + + +A reference to the currently running game.
+
+
+
+ -
+
isDown
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Default Value: +
- false
+
+
+
+ - Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +isDown+ + +boolean + + + + + + + + + +The "down" state of the button.
+
+
+
+ -
+
isUp
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Default Value: +
- false
+
+
+
+ - Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +isUp+ + +boolean + + + + + + + + + +The "up" state of the button.
+
+
+
+ -
+
onDown
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +onDown+ + +Phaser.Signal + + + + + + + + + +This Signal is dispatched every time this GamepadButton is pressed down. It is only dispatched once (until the button is released again).
+
+
+
+ -
+
onFloat
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +onFloat+ + +Phaser.Signal + + + + + + + + + +This Signal is dispatched every time this GamepadButton changes floating value (between (but not exactly) 0 and 1)
+
+
+
+ -
+
onUp
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +onUp+ + +Phaser.Signal + + + + + + + + + +This Signal is dispatched every time this GamepadButton is pressed down. It is only dispatched once (until the button is released again).
+
+
+
+ -
+
repeats
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Default Value: +
- 0
+
+
+
+ - Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +repeats+ + +number + + + + + + + + + +If a button is held down this holds down the number of times the button has 'repeated'.
+
+
+
+ -
+
timeDown
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Default Value: +
- 0
+
+
+
+ - Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +timeDown+ + +number + + + + + + + + + +The timestamp when the button was last pressed down.
+
+
+
+ -
+
timeUp
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Default Value: +
- 0
+
+
+
+ - Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +timeUp+ + +number + + + + + + + + + +The timestamp when the button was last released.
+
+
+
+ -
+
value
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Default Value: +
- 0
+
+
+
+ - Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +value+ + +number + + + + + + + + + +Button value. Mainly useful for checking analog buttons (like shoulder triggers)
+
+
Methods
+ +-
+
+
-
+
justPressed(duration) → {boolean}
+ + +
+ -
+
+
+ ++ + + + + + + +
Returns the "just pressed" state of this button. Just pressed is considered true if the button was pressed down within the duration given (default 250ms).
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + +Argument + + + +Default + + +Description ++ + + + + +duration+ + +number + + + + + + ++ + <optional> + + + +
+ + + + + ++ + 250 + + + + +The duration below which the button is considered as being just pressed.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + +++ + + +True if the button is just pressed otherwise false.
+-
+
- + Type + +
- + +boolean + + + +
+
+
+
+ -
+
justPressed(duration) → {boolean}
+ + +
+ -
+
+
+ ++ + + + + + + +
Returns the "just released" state of this button. Just released is considered as being true if the button was released within the duration given (default 250ms).
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + +Argument + + + +Default + + +Description ++ + + + + +duration+ + +number + + + + + + ++ + <optional> + + + +
+ + + + + ++ + 250 + + + + +The duration below which the button is considered as being just released.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + +++ + + +True if the button is just pressed otherwise false.
+-
+
- + Type + +
- + +boolean + + + +
+
+
+
+ -
+
<protected> processButtonDown(value)
+ + +
+ -
+
+
+ ++ + + + + + + +
Called automatically by Phaser.SinglePad.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +value+ + +Object + + + + + + + + + +Button value
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
<protected> processButtonFloat(value)
+ + +
+ -
+
+
+ ++ + + + + + + +
Called automatically by Phaser.Gamepad.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +value+ + +Object + + + + + + + + + +Button value
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
<protected> processButtonUp(value)
+ + +
+ -
+
+
+ ++ + + + + + + +
Called automatically by Phaser.SinglePad.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +value+ + +Object + + + + + + + + + +Button value
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+
+
+ +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:29 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:29 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Group.html b/docs/Phaser.Group.html index 4d4e8b21..79bcc812 100644 --- a/docs/Phaser.Group.html +++ b/docs/Phaser.Group.html @@ -90,6 +90,10 @@ Device +
The parent Group or DisplayObjectContainer that will hold this group, if any.
The parent Group or DisplayObjectContainer that will hold this group, if any. If undefined it will use game.world.
- - core/Group.js, line 122 + core/Group.js, line 140 +
alive
+ + +-
+
+
+
- Default Value: +
- true
+
+
+
+ - Source: +
- @@ -1085,7 +1184,7 @@
- Source:
- @@ -1192,7 +1291,7 @@ This will have no impact on the rotation value of its children, but it will upda
- Source:
- @@ -1299,7 +1398,7 @@ The cursor is set to the first child added to the Group and doesn't change unles
- Source:
- @@ -1404,7 +1503,7 @@ The cursor is set to the first child added to the Group and doesn't change unles
- Source:
- @@ -1506,7 +1605,109 @@ The cursor is set to the first child added to the Group and doesn't change unles
- Source:
- - core/Group.js, line 32 + core/Group.js, line 22 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
alive |
+
+
+ + + +boolean + + + + | + + + + + +The alive property is useful for Groups that are children of other Groups and need to be included/excluded in checks like forEachAlive. |
+
group
+ + +-
+
+
+
- Source: +
- @@ -1579,7 +1780,7 @@ The cursor is set to the first child added to the Group and doesn't change unles -
- Source:
- @@ -1710,7 +1911,109 @@ The cursor is set to the first child added to the Group and doesn't change unles
- Source:
- - core/Group.js, line 37 + core/Group.js, line 32 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
group |
+
+
+ + + +Phaser.Group + + + + | + + + + + +The parent Group of this Group, if a child of another. |
+
The number of children in this Group.
The total number of children in this Group, regardless of their exists/alive status.
pivot
+ + +-
+
+
+
- Source: +
- @@ -1817,7 +2120,7 @@ This will have no impact on the rotation value of its children, but it will upda
- Source:
- @@ -1890,7 +2193,7 @@ This will have no impact on the rotation value of its children, but it will upda -
- Source:
- @@ -1992,7 +2295,7 @@ This will have no impact on the rotation value of its children, but it will upda -
- Source:
- @@ -2123,7 +2426,7 @@ This will have no impact on the rotation value of its children, but it will upda
- Source:
- @@ -2225,7 +2528,7 @@ This will have no impact on the rotation value of its children, but it will upda
- Source:
- @@ -2332,7 +2635,7 @@ This will have no impact on the x/y coordinates of its children, but it will upd
- Source:
- @@ -2439,7 +2742,7 @@ This will have no impact on the x/y coordinates of its children, but it will upd
- Source:
- @@ -2555,7 +2858,7 @@ that then see the addAt method.
- Source:
- @@ -2775,7 +3078,7 @@ Group.addAll('x', 10) will add 10 to the child.x value.
- Source:
- @@ -2917,7 +3220,7 @@ The child is added to the Group at the location specified by the index value, th
- Source:
- @@ -3058,7 +3361,7 @@ The child is added to the Group at the location specified by the index value, th
- Source:
- @@ -3218,12 +3521,12 @@ After the method parameter and context you can add as many extra parameters as y
- Source:
- @@ -3485,7 +3788,7 @@ After the existsValue parameter you can add as many parameters as you like, whic
- Source:
- @@ -3521,7 +3824,7 @@ After the existsValue parameter you can add as many parameters as you like, whic
- Source:
- - core/Group.js, line 768 + core/Group.js, line 843 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
pivot |
+
+
+ + + +Phaser.Point + + + + | + + + + + +The pivot point of the Group container. |
+
Replaces the PIXI.Point with a slightly more flexible one.
The scane of the Group container.
The total number of children in this Group, regardless of their alive state.
The total number of children in this Group who have a state of exists = true.
A string containing the context under which the method will be executed. Leave to '' to default to the child.
A string containing the context under which the method will be executed. Set to null to default to the child.
-
@@ -3649,7 +3952,76 @@ After the existsValue parameter you can add as many parameters as you like, whic
Calls a function on all of the children that have exists=true in this Group.
+Returns a reference to a function that exists on a child of the Group based on the given callback array.
childTest()
+ + +
+
+
+
+
+
+
+
+
+
+
+Internal test.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- @@ -3718,7 +4090,7 @@ After the existsValue parameter you can add as many parameters as you like, whic
- Source:
- @@ -3743,7 +4115,7 @@ After the existsValue parameter you can add as many parameters as you like, whic
- Source:
- @@ -3835,7 +4207,7 @@ After the existsValue parameter you can add as many parameters as you like, whic
- Source:
- @@ -4390,7 +4762,7 @@ and will be positioned at 0, 0 (relative to the Group.x/y)
- Source:
- @@ -4418,7 +4790,7 @@ and will be positioned at 0, 0 (relative to the Group.x/y)
-
-
destroy()
+destroy(destroyChildren)
@@ -4435,6 +4807,75 @@ and will be positioned at 0, 0 (relative to the Group.x/y)
+ - Source:
- @@ -4647,145 +5088,7 @@ Group.divideAll('x', 2) will half the child.x value.
- Source:
- - core/Group.js, line 720 -
-
-
-
-
-
-
-
-
-
@@ -3810,7 +4182,7 @@ After the existsValue parameter you can add as many parameters as you like, whic
The number of children flagged as dead. Returns -1 if Group is empty.
+The number of children flagged as dead.
-
@@ -4117,7 +4489,7 @@ Useful if you don't need to create the Sprite instances before-hand.
The number of children flagged as alive. Returns -1 if Group is empty.
+The number of children flagged as alive.
Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
destroyChildren |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + false + + | + + +Should every child of this Group have its destroy method called? |
+
-
@@ -4459,7 +4900,7 @@ and will be positioned at 0, 0 (relative to the Group.x/y)
dump(full)
- - -
-
-
-
-
-
-
-
-
- Dumps out a list of Group children and their index positions to the browser console. Useful for group debugging.
-Parameters:
- - -| Name | - - -Type | - - -Argument | - - - -Default | - - -Description | -
|---|---|---|---|---|
full |
-
-
- - - -boolean - - - - | - - -
-
- <optional> - - - - - - |
-
-
-
- - - false - - | - - -If full the dump will include the entire display list, start from the Stage. Otherwise it will only include this container. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- @@ -4823,7 +5126,8 @@ Group.divideAll('x', 2) will half the child.x value.
- Source:
- @@ -5094,7 +5398,7 @@ For example: Group.forEachAlive(causeDamage, this, 500)
- Source:
- @@ -5237,7 +5541,7 @@ For example: Group.forEachAlive(causeDamage, this, 500)
- Source:
- @@ -5380,7 +5684,7 @@ For example: Group.forEachDead(bringToLife, this)
- Source:
- @@ -5498,7 +5802,7 @@ For example: Group.forEachDead(bringToLife, this)
- Source:
- @@ -5591,7 +5895,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
- Source:
- @@ -5684,7 +5988,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
- Source:
- @@ -5825,7 +6129,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
- Source:
- @@ -5966,7 +6270,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
- Source:
- @@ -6130,7 +6434,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
- Source:
- @@ -6181,7 +6485,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
-
-
iterate(key, value, returnType, callback, callbackContext)
+iterate(key, value, returnType, callback, callbackContext) → {any}
@@ -6435,7 +6739,7 @@ You can add as many callback parameters as you like, which will all be passed to
- Source:
- @@ -6456,6 +6760,29 @@ You can add as many callback parameters as you like, which will all be passed to +
- + Type + +
- + +any + + + +
Allows you to call your own function on each member of this Group. You must pass the callback and context in which it will run. After the checkExists parameter you can add as many parameters as you like, which will all be passed to the callback along with the child. -For example: Group.forEach(awardBonusGold, this, true, 100, 500)
+For example: Group.forEach(awardBonusGold, this, true, 100, 500) +Note: Currently this will skip any children which are Groups themselves.Returns:
+ + +
+
+
+
+
+Returns either a numeric total (if RETURN_TOTAL was specified) or the child object.
+-
+
- - core/Group.js, line 534 + core/Group.js, line 583 +
set(child, key, value, checkAlive, checkVisible, operation)
+ + +
+
+
+
+
+
+
+
+
+ This function allows you to quickly set a property on a single child of this Group to a new value. +The operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.
+Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
child |
+
+
+ + + +Phaser.Sprite + + + + | + + ++ + + + + + | + + + ++ + | + + +The child to set the property on. |
+
key |
+
+
+ + + +string + + + + | + + ++ + + + + + | + + + ++ + | + + +The property, as a string, to be set. For example: 'body.velocity.x' |
+
value |
+
+
+ + + +* + + + + | + + ++ + + + + + | + + + ++ + | + + +The value that will be set. |
+
checkAlive |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + false + + | + + +If set then the child will only be updated if alive=true. |
+
checkVisible |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + false + + | + + +If set then the child will only be updated if visible=true. |
+
operation |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + 0 + + | + + +Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- @@ -7541,7 +8190,7 @@ The operation parameter controls how the new value is assigned to the property,
- Source:
- @@ -7784,7 +8433,7 @@ The operation parameter controls how the new value is assigned to the property,
- Source:
- @@ -7962,7 +8611,7 @@ For example to depth sort Sprites for Zelda-style game you might call
- Source:
- @@ -8150,7 +8799,7 @@ Group.subAll('x', 10) will minus 10 from the child.x value.
- Source:
- @@ -8292,7 +8941,7 @@ You cannot swap a child with itself, or swap un-parented children, doing so will
- Source:
- @@ -8338,6 +8987,75 @@ You cannot swap a child with itself, or swap un-parented children, doing so will +
grou
swapIndex()
+ + +
+
+
+
+
+
+
+
+
+
+
+Internal test.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + core/Group.js, line 409 +
+
+
+
+
+
+
+
+
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:30 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:29 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Input.html b/docs/Phaser.Input.html index 524d8463..66d143c8 100644 --- a/docs/Phaser.Input.html +++ b/docs/Phaser.Input.html @@ -90,6 +90,10 @@ Device +
gamepad
+ + +
+
+
+
+
+
+
+The Gamepad Input manager.
+-
+
+
+
- Default Value: +
- null
+
+
+
+ - Source: +
- + input/Input.js, line 324 +
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
gamepad |
+
+
+ + + +Phaser.Gamepad + + + + | + + + + + +The Gamepad Input manager. |
+
- - input/Input.js, line 279 + input/Input.js, line 289 +
moveCallback
+ + +-
+
+
+
- Source: +
- + input/Input.js, line 37 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
moveCallback |
+
+
+ + + +function + + + + | + + + + + +An optional callback that will be fired every time the activePointer receives a move event from the DOM. Set to null to disable. |
+
moveCallbackContext
+ + +-
+
+
+
- Source: +
- @@ -2571,7 +2878,7 @@ For lots of games it's useful to set this to 1.
- Source:
- @@ -2677,7 +2984,7 @@ For lots of games it's useful to set this to 1.
- Source:
- @@ -2786,7 +3093,7 @@ For lots of games it's useful to set this to 1.
- Source:
- @@ -2895,7 +3202,7 @@ For lots of games it's useful to set this to 1.
- Source:
- @@ -3004,7 +3311,7 @@ For lots of games it's useful to set this to 1.
- Source:
- @@ -3113,7 +3420,7 @@ For lots of games it's useful to set this to 1.
- Source:
- @@ -3219,7 +3526,7 @@ For lots of games it's useful to set this to 1.
- Source:
- @@ -3325,7 +3632,7 @@ For lots of games it's useful to set this to 1.
- Source:
- @@ -3431,7 +3738,7 @@ For lots of games it's useful to set this to 1.
- Source:
- @@ -3537,7 +3844,7 @@ For lots of games it's useful to set this to 1.
- Source:
- @@ -3643,7 +3950,7 @@ For lots of games it's useful to set this to 1.
- Source:
- @@ -3749,7 +4056,7 @@ For lots of games it's useful to set this to 1.
- Source:
- @@ -3855,7 +4162,7 @@ For lots of games it's useful to set this to 1.
- Source:
- @@ -3961,7 +4268,7 @@ For lots of games it's useful to set this to 1.
- Source:
- @@ -4067,7 +4374,7 @@ For lots of games it's useful to set this to 1.
- Source:
- @@ -4173,7 +4480,7 @@ For lots of games it's useful to set this to 1.
- Source:
- @@ -4275,7 +4582,7 @@ For lots of games it's useful to set this to 1.
- Source:
- @@ -4385,7 +4692,7 @@ A value of 0 means every single frame (60fps), a value of 1 means every other fr
- Source:
- @@ -4490,7 +4797,7 @@ A value of 0 means every single frame (60fps), a value of 1 means every other fr
- Source:
- @@ -4600,7 +4907,7 @@ If the Pointer is tracking one event every 100ms, then a trackLimit of 100 would
- Source:
- @@ -4711,7 +5018,7 @@ The history is updated at the rate specified in Input.pollRate
- Source:
- @@ -4820,7 +5127,7 @@ The history is updated at the rate specified in Input.pollRate
- Source:
- @@ -4927,7 +5234,7 @@ In an un-scaled game the values will be x: 1 and y: 1.
- Source:
- @@ -5033,7 +5340,7 @@ In an un-scaled game the values will be x: 1 and y: 1.
- Source:
- @@ -5142,7 +5449,7 @@ In an un-scaled game the values will be x: 1 and y: 1.
- Source:
- @@ -5248,7 +5555,7 @@ In an un-scaled game the values will be x: 1 and y: 1.
- Source:
- @@ -5354,7 +5661,7 @@ In an un-scaled game the values will be x: 1 and y: 1.
- Source:
- @@ -5463,7 +5770,7 @@ In an un-scaled game the values will be x: 1 and y: 1.
- Source:
- @@ -5569,7 +5876,7 @@ In an un-scaled game the values will be x: 1 and y: 1.
- Source:
- @@ -5675,7 +5982,7 @@ In an un-scaled game the values will be x: 1 and y: 1.
- Source:
- @@ -5781,7 +6088,7 @@ In an un-scaled game the values will be x: 1 and y: 1.
- Source:
- @@ -5887,7 +6194,7 @@ In an un-scaled game the values will be x: 1 and y: 1.
- Source:
- @@ -5953,7 +6260,7 @@ If you need more then use this to create a new one, up to a maximum of 10.
- Source:
- @@ -6045,7 +6352,7 @@ If you need more then use this to create a new one, up to a maximum of 10.
- Source:
- @@ -6114,7 +6421,7 @@ If you need more then use this to create a new one, up to a maximum of 10.
- Source:
- @@ -6232,7 +6539,7 @@ If you need more then use this to create a new one, up to a maximum of 10.
- Source:
- @@ -6373,7 +6680,7 @@ If you need more then use this to create a new one, up to a maximum of 10.
- Source:
- @@ -6514,7 +6821,7 @@ If you need more then use this to create a new one, up to a maximum of 10.
- Source:
- @@ -6655,7 +6962,150 @@ If you need more then use this to create a new one, up to a maximum of 10.
- Source:
- - input/Input.js, line 511 + input/Input.js, line 554 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
moveCallbackContext |
+
+
+ + + +object + + + + | + + + + + +The context in which the moveCallback will be sent. Defaults to Phaser.Input but can be set to any valid JS object. |
+
setMoveCallback(callback, callbackContext)
+ + +
+
+
+
+
+
+
+
+
+ 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)
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
callback |
+
+
+ + + +function + + + + | + + + + + +The callback that will be called each time the activePointer receives a DOM move event. |
+
callbackContext |
+
+
+ + + +object + + + + | + + + + + +The context in which the callback will be called. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- @@ -6773,7 +7223,7 @@ If you need more then use this to create a new one, up to a maximum of 10.
- Source:
- @@ -6914,7 +7364,7 @@ If you need more then use this to create a new one, up to a maximum of 10.
- Source:
- @@ -7006,7 +7456,7 @@ If you need more then use this to create a new one, up to a maximum of 10.
- Source:
- @@ -7124,7 +7574,7 @@ If you need more then use this to create a new one, up to a maximum of 10.
- Source:
- @@ -7192,13 +7642,13 @@ If you need more then use this to create a new one, up to a maximum of 10. - Phaser Copyright © 2012-2013 Photon Storm Ltd. + Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:30 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:30 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.InputHandler.html b/docs/Phaser.InputHandler.html index 07ac1b8b..d9e43038 100644 --- a/docs/Phaser.InputHandler.html +++ b/docs/Phaser.InputHandler.html @@ -90,6 +90,10 @@ Device +
snapOffsetX
+ + +-
+
+
+
- Default Value: +
- 0
+
+
+
- Source:
- input/InputHandler.js, line 101 @@ -2035,6 +2134,111 @@ For example if you had a stack of 6 sprites with the same priority IDs and one c +
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
snapOffsetX |
+
+
+ + + +number + + + + | + + + + + +This defines the top-left X coordinate of the snap grid. |
+
snapOffsetY
+ + +-
+
+
+
- Default Value: +
- 0
+
+
+
+ - Source: +
- + + + + + + +
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
snapOffsetY |
+
+
+ + + +number + + + + | + + + + + +This defines the top-left Y coordinate of the snap grid.. |
+
enableSnap(snapX, snapY, onDrag, onRelease)
+enableSnap(snapX, snapY, onDrag, onRelease, snapOffsetX, snapOffsetX)
snapOffsetX+ + + + + +
Used to offset the top-left starting point of the snap grid.
snapOffsetX+ + + + + +
Used to offset the top-left starting point of the snap grid.
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:30 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:30 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Key.html b/docs/Phaser.Key.html index 0c7e96ca..1f8e66e1 100644 --- a/docs/Phaser.Key.html +++ b/docs/Phaser.Key.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:30 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:30 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Keyboard.html b/docs/Phaser.Keyboard.html index 3d97273c..3e720486 100644 --- a/docs/Phaser.Keyboard.html +++ b/docs/Phaser.Keyboard.html @@ -90,6 +90,10 @@ Device +
The keycode of the key, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACE_BAR
The keycode of the key, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR
The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACE_BAR
The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR
The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACE_BAR
The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR
justPressed(keycode, duration) → {boolean}
+justReleased(keycode, duration) → {boolean}
The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACE_BAR
The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR
The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACE_BAR
The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACEBAR
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:30 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:30 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Line.html b/docs/Phaser.Line.html new file mode 100644 index 00000000..5f974cbf --- /dev/null +++ b/docs/Phaser.Line.html @@ -0,0 +1,3100 @@ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/Phaser.LinkedList.html b/docs/Phaser.LinkedList.html
index 20f03dc3..8f1018e0 100644
--- a/docs/Phaser.LinkedList.html
+++ b/docs/Phaser.LinkedList.html
@@ -90,6 +90,10 @@
Device
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Class: Line
++ Phaser. + + Line +
+ +Phaser - Line
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ new Line(x1, y1, x2, y2) → {Phaser.Line}
+ + +
+
+
+
+
+
+
+
+
+ Creates a new Line object with a start and an end point.
+Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
x1 |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + 0 + + | + + +The x coordinate of the start of the line. |
+
y1 |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + 0 + + | + + +The y coordinate of the start of the line. |
+
x2 |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + 0 + + | + + +The x coordinate of the end of the line. |
+
y2 |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + 0 + + | + + +The y coordinate of the end of the line. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + geom/Line.js, line 18 +
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+This line object
+-
+
- + Type + +
- + +Phaser.Line + + + +
Members
+ +-
+
+
-
+
<readonly> angle
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + geom/Line.js, line 144 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +angle+ + +number + + + + + + + + + +Gets the angle of the line.
+
+
+
+ -
+
end
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + geom/Line.js, line 33 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +end+ + +Phaser.Point + + + + + + + + + +The end point of the line.
+
+
+
+ -
+
<readonly> length
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + geom/Line.js, line 131 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +length+ + +number + + + + + + + + + +Gets the length of the line segment.
+
+
+
+ -
+
<readonly> perpSlope
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + geom/Line.js, line 170 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +perpSlope+ + +number + + + + + + + + + +Gets the perpendicular slope of the line (x/y).
+
+
+
+ -
+
<readonly> slope
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + geom/Line.js, line 157 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +slope+ + +number + + + + + + + + + +Gets the slope of the line (y/x).
+
+
+
+ -
+
start
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + geom/Line.js, line 28 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +start+ + +Phaser.Point + + + + + + + + + +The start point of the line.
+
+
Methods
+ +-
+
+
-
+
<static> intersects(a, b, e, f, asSegment, result) → {Phaser.Point}
+ + +
+ -
+
+
+ ++ + + + + + + +
Checks for intersection between two lines as defined by the given start and end points. +If asSegment is true it will check for line segment intersection. If asSegment is false it will check for line intersection. +Returns the intersection segment of AB and EF as a Point, or null if there is no intersection. +Adapted from code by Keith Hair
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + +Argument + + + +Default + + +Description ++ + + + + +a+ + +Phaser.Point + + + + + + ++ + + + + + + + + ++ + + + +The start of the first Line to be checked.
+ + + + + +b+ + +Phaser.Point + + + + + + ++ + + + + + + + + ++ + + + +The end of the first line to be checked.
+ + + + + +e+ + +Phaser.Point + + + + + + ++ + + + + + + + + ++ + + + +The start of the second Line to be checked.
+ + + + + +f+ + +Phaser.Point + + + + + + ++ + + + + + + + + ++ + + + +The end of the second line to be checked.
+ + + + + +asSegment+ + +boolean + + + + + + ++ + <optional> + + + +
+ + + + + ++ + true + + + + +If true it will check for segment intersection, otherwise full line intersection.
+ + + + + +result+ + +Phaser.Point + + + + + + ++ + <optional> + + + +
+ + + + + ++ + + + +A Point object to store the result in, if not given a new one will be created.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + geom/Line.js, line 183 +
+
+
+
+
+
+
+
+
Returns:
+ + +++ + + +The intersection segment of the two lines as a Point, or null if there is no intersection.
+-
+
- + Type + +
- + +Phaser.Point + + + +
+
+
+
+ -
+
<static> intersects(a, b, asSegment, result) → {Phaser.Point}
+ + +
+ -
+
+
+ ++ + + + + + + +
Checks for intersection between two lines. +If asSegment is true it will check for segment intersection. +If asSegment is false it will check for line intersection. +Returns the intersection segment of AB and EF as a Point, or null if there is no intersection. +Adapted from code by Keith Hair
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + +Argument + + + +Default + + +Description ++ + + + + +a+ + +Phaser.Line + + + + + + ++ + + + + + + + + ++ + + + +The first Line to be checked.
+ + + + + +b+ + +Phaser.Line + + + + + + ++ + + + + + + + + ++ + + + +The second Line to be checked.
+ + + + + +asSegment+ + +boolean + + + + + + ++ + <optional> + + + +
+ + + + + ++ + true + + + + +If true it will check for segment intersection, otherwise full line intersection.
+ + + + + +result+ + +Phaser.Point + + + + + + ++ + <optional> + + + +
+ + + + + ++ + + + +A Point object to store the result in, if not given a new one will be created.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + geom/Line.js, line 246 +
+
+
+
+
+
+
+
+
Returns:
+ + +++ + + +The intersection segment of the two lines as a Point, or null if there is no intersection.
+-
+
- + Type + +
- + +Phaser.Point + + + +
+
+
+
+ -
+
fromSprite(startSprite, endSprite, useCenter) → {Phaser.Line}
+ + +
+ -
+
+
+ ++ + + + + + + +
Sets the line to match the x/y coordinates of the two given sprites. +Can optionally be calculated from their center coordinates.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + +Argument + + + +Default + + +Description ++ + + + + +startSprite+ + +Phaser.Sprite + + + + + + ++ + + + + + + + + ++ + + + +The coordinates of this Sprite will be set to the Line.start point.
+ + + + + +endSprite+ + +Phaser.Sprite + + + + + + ++ + + + + + + + + ++ + + + +The coordinates of this Sprite will be set to the Line.start point.
+ + + + + +useCenter+ + +boolean + + + + + + ++ + <optional> + + + +
+ + + + + ++ + true + + + + +If true it will use startSprite.center.x, if false startSprite.x.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + geom/Line.js, line 57 +
+
+
+
+
+
+
+
+
Returns:
+ + +++ + + +This line object
+-
+
- + Type + +
- + +Phaser.Line + + + +
+
+
+
+ -
+
intersects(line, asSegment, result) → {Phaser.Point}
+ + +
+ -
+
+
+ ++ + + + + + + +
Checks for intersection between this line and another Line. +If asSegment is true it will check for segment intersection. If asSegment is false it will check for line intersection. +Returns the intersection segment of AB and EF as a Point, or null if there is no intersection.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + +Argument + + + +Default + + +Description ++ + + + + +line+ + +Phaser.Line + + + + + + ++ + + + + + + + + ++ + + + +The line to check against this one.
+ + + + + +asSegment+ + +boolean + + + + + + ++ + <optional> + + + +
+ + + + + ++ + true + + + + +If true it will check for segment intersection, otherwise full line intersection.
+ + + + + +result+ + +Phaser.Point + + + + + + ++ + <optional> + + + +
+ + + + + ++ + + + +A Point object to store the result in, if not given a new one will be created.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + geom/Line.js, line 81 +
+
+
+
+
+
+
+
+
Returns:
+ + +++ + + +The intersection segment of the two lines as a Point, or null if there is no intersection.
+-
+
- + Type + +
- + +Phaser.Point + + + +
+
+
+
+ -
+
pointOnLine(x, y) → {boolean}
+ + +
+ -
+
+
+ ++ + + + + + + +
Tests if the given coordinates fall on this line. See pointOnSegment to test against just the line segment.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +x+ + +number + + + + + + + + + +The line to check against this one.
+ + + + + +y+ + +number + + + + + + + + + +The line to check against this one.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + geom/Line.js, line 98 +
+
+
+
+
+
+
+
+
Returns:
+ + +++ + + +True if the point is on the line, false if not.
+-
+
- + Type + +
- + +boolean + + + +
+
+
+
+ -
+
pointOnSegment(x, y) → {boolean}
+ + +
+ -
+
+
+ ++ + + + + + + +
Tests if the given coordinates fall on this line and within the segment. See pointOnLine to test against just the line.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +x+ + +number + + + + + + + + + +The line to check against this one.
+ + + + + +y+ + +number + + + + + + + + + +The line to check against this one.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + geom/Line.js, line 111 +
+
+
+
+
+
+
+
+
Returns:
+ + +++ + + +True if the point is on the line and segment, false if not.
+-
+
- + Type + +
- + +boolean + + + +
+
+
+
+ -
+
setTo(x1, y1, x2, y2) → {Phaser.Line}
+ + +
+ -
+
+
+ ++ + + + + + + +
Sets the components of the Line to the specified values.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + +Argument + + + +Default + + +Description ++ + + + + +x1+ + +number + + + + + + ++ + <optional> + + + +
+ + + + + ++ + 0 + + + + +The x coordinate of the start of the line.
+ + + + + +y1+ + +number + + + + + + ++ + <optional> + + + +
+ + + + + ++ + 0 + + + + +The y coordinate of the start of the line.
+ + + + + +x2+ + +number + + + + + + ++ + <optional> + + + +
+ + + + + ++ + 0 + + + + +The x coordinate of the end of the line.
+ + + + + +y2+ + +number + + + + + + ++ + <optional> + + + +
+ + + + + ++ + 0 + + + + +The y coordinate of the end of the line.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + geom/Line.js, line 39 +
+
+
+
+
+
+
+
+
Returns:
+ + +++ + + +This line object
+-
+
- + Type + +
- + +Phaser.Line + + + +
+
+
+
+
+
+ +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:30 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:30 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Loader.html b/docs/Phaser.Loader.html index 77f5cf83..eca96ed4 100644 --- a/docs/Phaser.Loader.html +++ b/docs/Phaser.Loader.html @@ -90,6 +90,10 @@ Device +
The Load progress percentage value (from 0 to 100)
The rounded load progress percentage value (from 0 to 100)
progressFloat
+ + +-
+
+
+
- Default Value: +
- 0
+
+
+
+ - Source: +
- + loader/Loader.js, line 71 +
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
progressFloat |
+
+
+ + + +number + + + + | + + + + + +The non-rounded load progress value (from 0.0 to 100.0) |
+
Returns:
+ + +
+
+
+
+
+This Loader instance.
+-
+
- + Type + +
- + +Phaser.Loader + + + +
binary(key, url, callback, callbackContext) → {Phaser.Loader}
+ + +
+
+
+
+
+
+
+
+
+ Add a binary file to the Loader. It will be loaded via xhr with a responseType of "arraybuffer". You can specify an optional callback to process the file after load. +When the callback is called it will be passed 2 parameters: the key of the file and the file data. +WARNING: If you specify a callback, the file data will be set to whatever your callback returns. So always return the data object, even if you didn't modify it.
+Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + + + | + + + + +Unique asset key of the binary file. |
+
url |
+
+
+ + + +string + + + + | + + ++ + + + + + | + + + + +URL of the binary file. |
+
callback |
+
+
+ + + +function + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+
+ Optional callback that will be passed the file after loading, so you can perform additional processing on it. |
+
callbackContext |
+
+
+ + + +function + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+
+ The context under which the callback will be applied. If not specified it will use the callback itself as the context. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- @@ -3505,7 +3854,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
- Source:
- @@ -3669,7 +4018,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
- Source:
- @@ -3810,7 +4159,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
- Source:
- @@ -3928,7 +4277,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
- Source:
- @@ -4046,7 +4395,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
- Source:
- @@ -4164,7 +4513,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
- Source:
- @@ -4305,7 +4654,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
- Source:
- @@ -4536,7 +4885,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
- Source:
- @@ -4677,7 +5026,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
- Source:
- @@ -4746,7 +5095,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
- Source:
- @@ -4887,7 +5236,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
- Source:
- @@ -5074,7 +5423,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
- Source:
- @@ -5143,7 +5492,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
- Source:
- @@ -5284,7 +5633,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
- Source:
- @@ -5482,7 +5831,7 @@ This allows you to easily make loading bars for games.
- Source:
- @@ -5510,7 +5859,7 @@ This allows you to easily make loading bars for games.
-
-
spritesheet(key, url, frameWidth, frameHeight, frameMax) → {Phaser.Loader}
+spritesheet(key, url, frameWidth, frameHeight, frameMax, margin, spacing) → {Phaser.Loader}
@@ -5732,6 +6081,84 @@ This allows you to easily make loading bars for games.
+
+ - Source:
- @@ -5852,7 +6279,7 @@ This allows you to easily make loading bars for games.
- Source:
- @@ -6060,7 +6487,7 @@ This allows you to easily make loading bars for games.
- Source:
- @@ -6330,386 +6757,7 @@ This allows you to easily make loading bars for games.
- Source:
- - loader/Loader.js, line 431 -
-
-
-
-
-
-
-
-
margin+ + + + + +
If the frames have been drawn with a margin, specify the amount here.
spacing+ + + + + +
If the frames have been drawn with spacing between them, specify the amount here.
Returns:
- - -
-
-
-
-
-This Loader instance.
--
-
- - Type - -
- - -Phaser.Loader - - - -
tileset(key, url, tileWidth, tileHeight, tileMax, tileMargin, tileSpacing) → {Phaser.Loader}
- - -
-
-
-
-
-
-
-
-
- Add a new tile set to the loader. These are used in the rendering of tile maps.
-Parameters:
- - -| Name | - - -Type | - - -Argument | - - - -Default | - - -Description | -
|---|---|---|---|---|
key |
-
-
- - - -string - - - - | - - -- - - - - - | - - - -- - | - - -Unique asset key of the tileset file. |
-
url |
-
-
- - - -string - - - - | - - -- - - - - - | - - - -- - | - - -URL of the tileset. |
-
tileWidth |
-
-
- - - -number - - - - | - - -- - - - - - | - - - -- - | - - -Width of each single tile in pixels. |
-
tileHeight |
-
-
- - - -number - - - - | - - -- - - - - - | - - - -- - | - - -Height of each single tile in pixels. |
-
tileMax |
-
-
- - - -number - - - - | - - -
-
- <optional> - - - - - - |
-
-
-
- - - -1 - - | - - -How many tiles in this tileset. If not specified it will divide the whole image into tiles. |
-
tileMargin |
-
-
- - - -number - - - - | - - -
-
- <optional> - - - - - - |
-
-
-
- - - 0 - - | - - -If the tiles have been drawn with a margin, specify the amount here. |
-
tileSpacing |
-
-
- - - -number - - - - | - - -
-
- <optional> - - - - - - |
-
-
-
- - - 0 - - | - - -If the tiles have been drawn with spacing between them, specify the amount here. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- @@ -6801,7 +6849,7 @@ This allows you to easily make loading bars for games.
- Source:
- @@ -6893,7 +6941,7 @@ This allows you to easily make loading bars for games.
- Source:
- @@ -7034,7 +7082,7 @@ This allows you to easily make loading bars for games.
- Source:
- @@ -7079,13 +7127,13 @@ This allows you to easily make loading bars for games. - Phaser Copyright © 2012-2013 Photon Storm Ltd. + Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:30 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:30 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.LoaderParser.html b/docs/Phaser.LoaderParser.html index 01765371..e5052246 100644 --- a/docs/Phaser.LoaderParser.html +++ b/docs/Phaser.LoaderParser.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:31 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:31 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.MSPointer.html b/docs/Phaser.MSPointer.html index b3a18ed0..1726c1aa 100644 --- a/docs/Phaser.MSPointer.html +++ b/docs/Phaser.MSPointer.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:31 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:31 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Math.html b/docs/Phaser.Math.html index 155a841e..41f67fbc 100644 --- a/docs/Phaser.Math.html +++ b/docs/Phaser.Math.html @@ -90,6 +90,10 @@ Device +
-
@@ -865,7 +859,7 @@
Find the angle of a segment from (x1, y1) -> (x2, y2 ).
+Find the angle of a segment from (x1, y1) -> (x2, y2).
-
@@ -1277,7 +1271,7 @@
Description.
+A Bezier Interpolation Method, mostly used by Phaser.Tween.
-
@@ -1666,7 +1660,7 @@
Description.
+A Catmull Rom Interpolation Method, mostly used by Phaser.Tween.
-
+
+
+
+The distance between this Point object and the destination Point object.
+The distance between the two sets of coordinates.
+-
+
- + Type + +
- + +number + + + +
distancePow(x1, y1, x2, y2, pow) → {number}
+ + +
+
+
+
+
+
+
+
+
+ Returns the distance between the two given set of coordinates at the power given.
+Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
x1 |
+
+
+ + + +number + + + + | + + ++ + + + + + | + + + ++ + | + + ++ |
y1 |
+
+
+ + + +number + + + + | + + ++ + + + + + | + + + ++ + | + + ++ |
x2 |
+
+
+ + + +number + + + + | + + ++ + + + + + | + + + ++ + | + + ++ |
y2 |
+
+
+ + + +number + + + + | + + ++ + + + + + | + + + ++ + | + + ++ |
pow |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + 2 + + | + + ++ |
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + math/Math.js, line 1117 +
+
+
+
+
+
+
+
+
Returns:
+ + +
+
@@ -3135,7 +3430,7 @@ Clamp value to range <a, b>
The distance between the two sets of coordinates.
-
@@ -5565,7 +5860,7 @@ Will return null if random selection is missing, or array has no entries.
Description.
+A Linear Interpolation Method, mostly used by Phaser.Tween.
max() → {number}
+ + +
+
+
+
+
+
+
+
+
+
+
+Updated version of Math.max that can be passed either an array of numbers or the numbers as parameters.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + math/Math.js, line 692 +
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The largest value from those given.
+-
+
- + Type + +
- + +number + + + +
maxProperty() → {number}
+ + +
+
+
+
+
+
+
+
+
+
+
+Updated version of Math.max that can be passed a property and either an array of objects or the objects as parameters. +It will find the largest matching property value from the given objects.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + math/Math.js, line 751 +
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The largest value from those given.
+-
+
- + Type + +
- + +number + + + +
-
@@ -6182,7 +6662,100 @@ See http://jsperf.com/m
Significantly faster version of Math.min +
Updated version of Math.min that can be passed either an array of numbers or the numbers as parameters. See http://jsperf.com/math-s-min-max-vs-homemade/5
- - math/Math.js, line 628 + math/Math.js, line 662 +
Returns:
+ + +
+
+
+
+
+The lowest value from those given.
+-
+
- + Type + +
- + +number + + + +
minProperty() → {number}
+ + +
+
+
+
+
+
+
+
+
+
+
+Updated version of Math.min that can be passed a property and either an array of objects or the objects as parameters. +It will find the lowest matching property value from the given objects.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- @@ -6369,7 +6942,7 @@ See http://jsperf.com/m
- Source:
- @@ -6428,8 +7001,7 @@ See http://jsperf.com/m
- Source:
- @@ -6604,7 +7176,7 @@ absolute value the return for exact angle
-
-
normalizeAngle(angle, radians) → {number}
+normalizeAngle(angleRad) → {number}
@@ -6612,7 +7184,7 @@ absolute value the return for exact angle
- Source:
- @@ -6741,6 +7290,292 @@ absolute value the return for exact angle
- + Type + +
- + +number + + + +
-
@@ -6557,7 +7129,7 @@ absolute value the return for exact angle
Closest angle between two angles from a1 to a2 -absolute value the return for exact angle
+Closest angle between two angles from a1 to a2 absolute value the return for exact angle
-
@@ -6646,7 +7218,7 @@ absolute value the return for exact angle
Set an angle within the bounds of -π toπ.
+Normalizes an angle to the [0,2pi) range.
angleangleRadradiansTrue if angle size is expressed in radians.
The angle to normalize, in radians.
Returns:
+
+
+
+
+
+Returns the angle, fit within the [0,2pi] range, in radians.
+-
+
normalizeLatitude(lat) → {number}
+ + +
+
+
+
+
+
+
+
+
+ Normalizes a latitude to the [-90,90] range. Latitudes above 90 or below -90 are capped, not wrapped.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
lat |
+
+
+ + + +number + + + + | + + + + + +The latitude to normalize, in degrees. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + math/Math.js, line 365 +
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+Returns the latitude, fit within the [-90,90] range.
+-
+
- + Type + +
- + +number + + + +
normalizeLongitude(lng) → {number}
+ + +
+
+
+
+
+
+
+
+
+ Normalizes a longitude to the [-180,180] range. Longitudes above 180 or below -180 are wrapped.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
lng |
+
+
+ + + +number + + + + | + + + + + +The longitude to normalize, in degrees. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + math/Math.js, line 375 +
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
Returns the longitude, fit within the [-180,180] range.
+-
@@ -6877,7 +7712,7 @@ absolute value the return for exact angle
- Source:
- @@ -7038,7 +7873,7 @@ absolute value the return for exact angle
- Source:
- @@ -7126,7 +7961,7 @@ absolute value the return for exact angle
- Source:
- @@ -7172,6 +8007,147 @@ absolute value the return for exact angle +
reverseAngle(angleRad) → {number}
+ + +
+
+
+
+
+
+
+
+
+ Reverses an angle.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
angleRad |
+
+
+ + + +number + + + + | + + + + + +The angle to reverse, in radians. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + math/Math.js, line 342 +
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+Returns the reverse angle, in radians.
+-
+
- + Type + +
- + +number + + + +
sinCosGenerator(length, sinAmplitude, cosAmplitude, frequency) → {Array}
+sinCosGenerator(length, sinAmplitude, cosAmplitude, frequency) → {Array}
-
@@ -9708,13 +10684,18 @@ you should get the results via getSinTable() and getCosTable(). This generator i
Ensures that the value always stays between min and max, by wrapping the value around.
-<p>max should be larger than min, or the function will return 0</p>
+Ensures that the value always stays between min and max, by wrapping the value around. +max should be larger than min, or the function will return 0.
The value to wrap
The value to wrap.
The minimum the value is allowed to be
The minimum the value is allowed to be.
The maximum the value is allowed to be
The maximum the value is allowed to be.
-
@@ -9924,7 +10915,7 @@ Should be called whenever the angle is updated on the Sprite to stop it from goi
The wrapped value
+The wrapped value.
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:31 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:31 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Mouse.html b/docs/Phaser.Mouse.html index f4b01f6c..03806212 100644 --- a/docs/Phaser.Mouse.html +++ b/docs/Phaser.Mouse.html @@ -90,6 +90,10 @@ Device +
The browser mouse event.
The browser mouse DOM event. Will be set to null if no mouse event has ever been received.
- null
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:31 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:31 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Net.html b/docs/Phaser.Net.html index 2bda1c19..5c69959d 100644 --- a/docs/Phaser.Net.html +++ b/docs/Phaser.Net.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:31 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:31 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Particles.Arcade.Emitter.html b/docs/Phaser.Particles.Arcade.Emitter.html index 31518443..bc65c282 100644 --- a/docs/Phaser.Particles.Arcade.Emitter.html +++ b/docs/Phaser.Particles.Arcade.Emitter.html @@ -90,6 +90,10 @@ Device +
alive
+ + +-
+
+
+
- Inherited From: +
- + + + + + + + + + + + +
- Default Value: +
- true
+
+
+
+ - Source: +
- + core/Group.js, line 77 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
alive |
+
+
+ + + +boolean + + + + | + + + + + +The alive property is useful for Groups that are children of other Groups and need to be included/excluded in checks like forEachAlive. |
+
alpha
@@ -799,7 +903,7 @@ at set intervals, and fixes their positions and velocities accorindgly.Source:
-
-
@@ -988,7 +1088,7 @@ This will have no impact on the rotation value of its children, but it will upda
- The angular drag component of particles launched from the emitter if they are rotating.
-The angular drag component of particles launched from the emitter if they are rotating.
-
-
@@ -1199,7 +1295,7 @@ This will have no impact on the rotation value of its children, but it will upda
- How much each particle should bounce on each axis. 1 = full bounce, 0 = no bounce.
-How much each particle should bounce on each axis. 1 = full bounce, 0 = no bounce.
-
-
@@ -1633,7 +1725,7 @@ Emitter.emitX and Emitter.emitY control the emission location relative to the x/
- Determines whether the emitter is being updated by the core game loop.
-Determines whether the emitter is being updated by the core game loop.
-
-
@@ -1742,7 +1830,7 @@ Emitter.emitX and Emitter.emitY control the emission location relative to the x/
- How often a particle is emitted in ms (if emitter is started with Explode === false).
-How often a particle is emitted in ms (if emitter is started with Explode === false).
-
-
@@ -1958,7 +2042,7 @@ Emitter.emitX and Emitter.emitY control the emission location relative to the x/
- Sets the <code>gravity.y</code> of each particle to this value on launch.
-Sets the body.gravity.y of each particle sprite to this value on launch.
- 2
- 100
group
+ + +-
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- @@ -2197,7 +2388,7 @@ Emitter.emitX and Emitter.emitY control the emission location relative to the x/
- Source:
- @@ -2270,7 +2461,7 @@ Emitter.emitX and Emitter.emitY control the emission location relative to the x/ -
- Source:
- @@ -2328,11 +2519,6 @@ Emitter.emitX and Emitter.emitY control the emission location relative to the x/
-
- -- @@ -2382,7 +2568,7 @@ Set lifespan to 'zero' for particles to live forever. -
How long each particle lives once it is emitted in ms. Default is 2 seconds. -Set lifespan to 'zero' for particles to live forever.
-+ How long each particle lives once it is emitted in ms. Default is 2 seconds. Set lifespan to 'zero' for particles to live forever.
- Source:
- @@ -2438,10 +2624,6 @@ Set lifespan to 'zero' for particles to live forever.
-
- -- @@ -2520,7 +2702,7 @@ Set lifespan to 'zero' for particles to live forever.
The total number of particles in this emitter.
- - Source:
- @@ -2544,11 +2726,6 @@ Set lifespan to 'zero' for particles to live forever.
-
- -- @@ -2598,7 +2775,7 @@ The default value is 1. -
The maximum possible scale of a particle. -The default value is 1.
-+ The maximum possible scale of a particle.
- Source:
- @@ -2654,11 +2831,6 @@ The default value is 1.
-
- -- @@ -2708,7 +2880,7 @@ The default value is (100,100). -
The maximum possible velocity of a particle. -The default value is (100,100).
-+ The maximum possible velocity of a particle.
- Source:
- @@ -2761,10 +2933,6 @@ The default value is (100,100).
-
- -- @@ -2814,7 +2982,7 @@ The default value is (100,100). -
The maximum possible angular velocity of a particle. The default value is 360.
-+ The maximum possible angular velocity of a particle.
- Source:
- @@ -2870,11 +3038,6 @@ The default value is (100,100).
-
- -- @@ -2924,7 +3087,7 @@ The default value is 1. -
The minimum possible scale of a particle. -The default value is 1.
-+ The minimum possible scale of a particle.
- Source:
- @@ -2980,11 +3143,6 @@ The default value is 1.
-
- -- @@ -3034,7 +3192,7 @@ The default value is (-100,-100). -
The minimum possible velocity of a particle. -The default value is (-100,-100).
-+ The minimum possible velocity of a particle.
- Source:
- @@ -3087,10 +3245,6 @@ The default value is (-100,-100).
-
- -- @@ -3140,7 +3294,7 @@ The default value is (-100,-100). -
The minimum possible angular velocity of a particle. The default value is -360.
-+ The minimum possible angular velocity of a particle.
- Source:
- @@ -3271,7 +3425,7 @@ The default value is (-100,-100).
- Source:
- @@ -3295,11 +3449,6 @@ The default value is (-100,-100).
-
- -- @@ -3349,7 +3498,7 @@ It is totally safe to directly toggle this. -
Determines whether the emitter is currently emitting particles. -It is totally safe to directly toggle this.
-+ Determines whether the emitter is currently emitting particles. It is totally safe to directly toggle this.
- Source:
- @@ -3405,10 +3554,6 @@ It is totally safe to directly toggle this.
-
- -- @@ -3448,7 +3593,7 @@ It is totally safe to directly toggle this.
Set your own particle class type here.
--Description +any @@ -3458,7 +3603,7 @@ It is totally safe to directly toggle this. - + For emitting your own particle class types.
- Source:
- @@ -3508,16 +3653,12 @@ It is totally safe to directly toggle this.
-
-
particleDrag
+particleFriction
-
- -- @@ -3551,13 +3692,13 @@ It is totally safe to directly toggle this.
The X and Y drag component of particles launched from the emitter.
-- @@ -3592,11 +3733,121 @@ It is totally safe to directly toggle this. +particleDragparticleFriction-Phaser.Point +number @@ -3567,7 +3708,7 @@ It is totally safe to directly toggle this. - + The friction component of particles launched from the emitter.
- Default Value: +
- 0
+
- Source:
- + + + + + + + +
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
group |
+
+
+ + + +Phaser.Group + + + + | + + + + + +The parent Group of this Group, if a child of another. |
+
The number of children in this Group.
The total number of children in this Group, regardless of their exists/alive status.
pivot
+ + +-
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- @@ -3698,7 +3949,7 @@ It is totally safe to directly toggle this.
- Source:
- @@ -3810,7 +4061,7 @@ This will have no impact on the rotation value of its children, but it will upda
- Source:
- @@ -3883,7 +4134,7 @@ This will have no impact on the rotation value of its children, but it will upda -
- Source:
- @@ -4019,7 +4270,7 @@ This will have no impact on the rotation value of its children, but it will upda
- Source:
- @@ -4092,7 +4343,7 @@ This will have no impact on the rotation value of its children, but it will upda -
- Source:
- @@ -4144,7 +4395,7 @@ This will have no impact on the rotation value of its children, but it will upda
-
-
type
+<protected> type
@@ -4189,7 +4440,7 @@ This will have no impact on the rotation value of its children, but it will upda
- Source:
- @@ -4541,7 +4792,7 @@ This will have no impact on the rotation value of its children, but it will upda
- Source:
- @@ -4748,7 +4999,7 @@ This will have no impact on the rotation value of its children, but it will upda
- Source:
- @@ -4974,7 +5225,7 @@ that then see the addAt method.
- Source:
- @@ -5199,7 +5450,7 @@ Group.addAll('x', 10) will add 10 to the child.x value.
- Source:
- @@ -5346,7 +5597,7 @@ The child is added to the Group at the location specified by the index value, th
- Source:
- @@ -5405,7 +5656,7 @@ The child is added to the Group at the location specified by the index value, th
- Source:
- @@ -5610,7 +5864,7 @@ The child is added to the Group at the location specified by the index value, th
- Source:
- @@ -5770,12 +6024,12 @@ After the method parameter and context you can add as many extra parameters as y
- Source:
- @@ -6047,7 +6301,7 @@ After the existsValue parameter you can add as many parameters as you like, whic
- Source:
- @@ -6083,7 +6337,7 @@ After the existsValue parameter you can add as many parameters as you like, whic
- Source:
- - core/Group.js, line 768 + core/Group.js, line 843 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
pivot |
+
+
+ + + +Phaser.Point + + + + | + + + + + +The pivot point of the Group container. |
+
Replaces the PIXI.Point with a slightly more flexible one.
The scane of the Group container.
The total number of children in this Group, regardless of their alive state.
The total number of children in this Group who have a state of exists = true.
Description.
Internal Phaser Type value.
-
@@ -5446,6 +5697,9 @@ The child is added to the Group at the location specified by the index value, th
object
+|
+
+Phaser.Sprite
@@ -5455,7 +5709,7 @@ The child is added to the Group at the location specified by the index value, th
- Change the emitter's midpoint to match the midpoint of a <code>Object</code>.
+Change the emitters center to match the center of any object with a center property, such as a Sprite.
The <code>Object</code> that you want to sync up with.
The object that you wish to match the center with.
A string containing the context under which the method will be executed. Leave to '' to default to the child.
A string containing the context under which the method will be executed. Set to null to default to the child.
-
@@ -6216,7 +6470,81 @@ After the existsValue parameter you can add as many parameters as you like, whic
Calls a function on all of the children that have exists=true in this Group.
+Returns a reference to a function that exists on a child of the Group based on the given callback array.
childTest()
+ + +
+
+
+
+
+
+
+
+
+
+
+Internal test.
+-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- @@ -6290,7 +6618,7 @@ After the existsValue parameter you can add as many parameters as you like, whic
- Source:
- @@ -6315,7 +6643,7 @@ After the existsValue parameter you can add as many parameters as you like, whic
- Source:
- @@ -6412,7 +6740,7 @@ After the existsValue parameter you can add as many parameters as you like, whic
- Source:
- @@ -6977,7 +7305,7 @@ and will be positioned at 0, 0 (relative to the Group.x/y)
- Source:
- @@ -7005,7 +7333,7 @@ and will be positioned at 0, 0 (relative to the Group.x/y)
-
-
destroy()
+destroy(destroyChildren)
@@ -7022,6 +7350,75 @@ and will be positioned at 0, 0 (relative to the Group.x/y)
+ - Source:
- @@ -7244,150 +7641,7 @@ Group.divideAll('x', 2) will half the child.x value.
- Source:
- - core/Group.js, line 720 -
-
-
-
-
-
-
-
-
-
@@ -6387,7 +6715,7 @@ After the existsValue parameter you can add as many parameters as you like, whic
The number of children flagged as dead. Returns -1 if Group is empty.
+The number of children flagged as dead.
-
@@ -6699,7 +7027,7 @@ Useful if you don't need to create the Sprite instances before-hand.
The number of children flagged as alive. Returns -1 if Group is empty.
+The number of children flagged as alive.
Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
destroyChildren |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + false + + | + + +Should every child of this Group have its destroy method called? |
+
-
@@ -7051,7 +7448,7 @@ and will be positioned at 0, 0 (relative to the Group.x/y)
dump(full)
- - -
-
-
-
-
-
-
-
-
- Dumps out a list of Group children and their index positions to the browser console. Useful for group debugging.
-Parameters:
- - -| Name | - - -Type | - - -Argument | - - - -Default | - - -Description | -
|---|---|---|---|---|
full |
-
-
- - - -boolean - - - - | - - -
-
- <optional> - - - - - - |
-
-
-
- - - false - - | - - -If full the dump will include the entire display list, start from the Stage. Otherwise it will only include this container. |
-
-
-
-
-
-
-
-
-
-
- Inherited From: -
- - - - - - - - - - - - - - -
- Source: -
- @@ -7456,7 +7710,7 @@ Group.divideAll('x', 2) will half the child.x value.
- Source:
- @@ -7494,7 +7748,8 @@ Group.divideAll('x', 2) will half the child.x value.
- Source:
- @@ -7775,7 +8030,7 @@ For example: Group.forEachAlive(causeDamage, this, 500)
- Source:
- @@ -7923,7 +8178,7 @@ For example: Group.forEachAlive(causeDamage, this, 500)
- Source:
- @@ -8071,7 +8326,7 @@ For example: Group.forEachDead(bringToLife, this)
- Source:
- @@ -8194,7 +8449,7 @@ For example: Group.forEachDead(bringToLife, this)
- Source:
- @@ -8292,7 +8547,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
- Source:
- @@ -8390,7 +8645,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
- Source:
- @@ -8536,7 +8791,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
- Source:
- @@ -8682,7 +8937,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
- Source:
- @@ -8851,7 +9106,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
- Source:
- @@ -8902,7 +9157,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
-
-
iterate(key, value, returnType, callback, callbackContext)
+iterate(key, value, returnType, callback, callbackContext) → {any}
@@ -9161,7 +9416,7 @@ You can add as many callback parameters as you like, which will all be passed to
- Source:
- @@ -9182,6 +9437,29 @@ You can add as many callback parameters as you like, which will all be passed to +
- + Type + +
- + +any + + + +
Allows you to call your own function on each member of this Group. You must pass the callback and context in which it will run. After the checkExists parameter you can add as many parameters as you like, which will all be passed to the callback along with the child. -For example: Group.forEach(awardBonusGold, this, true, 100, 500)
+For example: Group.forEach(awardBonusGold, this, true, 100, 500) +Note: Currently this will skip any children which are Groups themselves.Returns:
+ + +
+
+
+
+
+Returns either a numeric total (if RETURN_TOTAL was specified) or the child object.
+-
+
makeParticles(keys, frames, quantity, collide, collideWorldBounds)
+makeParticles(keys, frames, quantity, collide, collideWorldBounds) → {Phaser.Particles.Arcade.Emitter}
Description.
A string or an array of strings that the particle sprites will use as their texture. If an array one is picked at random.
Description.
A frame number, or array of frames that the sprite will use. If an array one is picked at random.
The number of particles to generate when using the "create from image" option.
The number of particles to generate.
+ + + + +
Description.
Sets the checkCollision.none flag on the particle sprites body.
+ + + + +
Description.
A particle can be set to collide against the World bounds automatically and rebound back into the World if this is set to true. Otherwise it will leave the World.
-
+This Emitter instance (nice for chaining stuff together, if you're into that).
+This Emitter instance.
-
+
- + Type + +
- + +Phaser.Particles.Arcade.Emitter + + + +
-
@@ -10375,7 +10742,334 @@ In practice, this is most often called by <code>Object.reset()</code>
Handy for bringing game objects "back to life". Just sets alive and exists back to true. -In practice, this is most often called by <code>Object.reset()</code>.
+Handy for bringing game objects "back to life". Just sets alive and exists back to true.
set(child, key, value, checkAlive, checkVisible, operation)
+ + +
+
+
+
+
+
+
+
+
+ This function allows you to quickly set a property on a single child of this Group to a new value. +The operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.
+Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
child |
+
+
+ + + +Phaser.Sprite + + + + | + + ++ + + + + + | + + + ++ + | + + +The child to set the property on. |
+
key |
+
+
+ + + +string + + + + | + + ++ + + + + + | + + + ++ + | + + +The property, as a string, to be set. For example: 'body.velocity.x' |
+
value |
+
+
+ + + +* + + + + | + + ++ + + + + + | + + + ++ + | + + +The value that will be set. |
+
checkAlive |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + false + + | + + +If set then the child will only be updated if alive=true. |
+
checkVisible |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + false + + | + + +If set then the child will only be updated if visible=true. |
+
operation |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + 0 + + | + + +Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it. |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + Phaser.Group#set +
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source: +
- @@ -10667,7 +11361,7 @@ The operation parameter controls how the new value is assigned to the property,
- Source:
- @@ -10915,7 +11609,7 @@ The operation parameter controls how the new value is assigned to the property,
- Source:
- @@ -10943,7 +11637,7 @@ The operation parameter controls how the new value is assigned to the property,
-
-
setRotation(min, max)
+setRotation(min, max)
@@ -10973,8 +11667,12 @@ The operation parameter controls how the new value is assigned to the property,
- Source:
- @@ -11197,7 +11927,7 @@ The operation parameter controls how the new value is assigned to the property,
- Source:
- @@ -11225,7 +11955,7 @@ The operation parameter controls how the new value is assigned to the property,
-
-
setXSpeed(min, max)
+setXSpeed(min, max)
@@ -11255,8 +11985,12 @@ The operation parameter controls how the new value is assigned to the property,
- Source:
- @@ -11366,7 +12132,7 @@ The operation parameter controls how the new value is assigned to the property,
-
-
setYSpeed(min, max)
+setYSpeed(min, max)
@@ -11396,8 +12162,12 @@ The operation parameter controls how the new value is assigned to the property,
- Source:
- @@ -11662,7 +12464,7 @@ For example to depth sort Sprites for Zelda-style game you might call
- Source:
- @@ -11690,7 +12492,7 @@ For example to depth sort Sprites for Zelda-style game you might call
-
-
start(explode, lifespan, frequency, quantity)
+start(explode, lifespan, frequency, quantity)
@@ -11720,8 +12522,12 @@ For example to depth sort Sprites for Zelda-style game you might call - Source:
- @@ -12042,7 +12912,7 @@ Group.subAll('x', 10) will minus 10 from the child.x value.
- Source:
- @@ -12189,7 +13059,7 @@ You cannot swap a child with itself, or swap un-parented children, doing so will
- Source:
- @@ -12235,6 +13105,80 @@ You cannot swap a child with itself, or swap un-parented children, doing so will +
+ + + + +
The minimum value for this range.
+ + + + +
The maximum value for this range.
+ + + + +
The minimum value for this range.
+ + + + +
The maximum value for this range.
+ + + + +
The minimum value for this range.
+ + + + +
The maximum value for this range.
grou
grou
grou
Type
+ Argument
+
+ Default
+
Description
@@ -11745,7 +12551,23 @@ For example to depth sort Sprites for Zelda-style game you might call grou
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ true
+
+
Whether the particles should all burst out at once.
grou
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ 0
+
+
How long each particle lives once emitted. 0 = forever.
grou
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ 250
+
+
Ignored if Explode is set to true. Frequency is how often to emit a particle in ms.
grou
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+ 0
+
+
How many particles to launch. 0 = "all of the particles".
grou
swapIndex()
+ + +
+
+
+
+
+
+
+
+
+
+
+Internal test.
+-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 409 +
+
+
+
+
+
+
+
+
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:31 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:31 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Particles.html b/docs/Phaser.Particles.html index aeae5dca..293c88e1 100644 --- a/docs/Phaser.Particles.html +++ b/docs/Phaser.Particles.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:31 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:31 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Physics.Arcade.Body.html b/docs/Phaser.Physics.Arcade.Body.html index 10e22248..fb9cd106 100644 --- a/docs/Phaser.Physics.Arcade.Body.html +++ b/docs/Phaser.Physics.Arcade.Body.html @@ -90,6 +90,10 @@ Device +
-
@@ -529,7 +524,7 @@ the Sprite itself. For example you can set the velocity, acceleration, bounce va
The Physics Body is linked to a single Sprite. All physics operations should be performed against the body rather than -the Sprite itself. For example you can set the velocity, acceleration, bounce values etc all on the Body.
+The Physics Body is linked to a single Sprite and defines properties that determine how the physics body is simulated. +These properties affect how the body reacts to forces, what forces it generates on itself (to simulate friction), and how it reacts to collisions in the scene. In most cases, the properties are used to simulate physical effects. +Each body also has its own property values that determine exactly how it reacts to forces and collisions in the scene.
The velocity in pixels per second sq. of the Body.
The acceleration in pixels per second sq. of the Body.
allowCollision
- - -
-
-
-
-
-
-
-Set the allowCollision properties to control which directions collision is processed for this Body. -For example allowCollision.up = false means it won't collide when the collision happened while moving up.
--
-
-
-
- Source: -
- @@ -837,7 +725,7 @@ For example allowCollision.up = false means it won't collide when the collision -
- Source:
- @@ -942,7 +830,7 @@ For example allowCollision.up = false means it won't collide when the collision -
- Source:
- + + + + + + + +
Properties:
- --
-
-
| Name | - - -Type | - - - - - -Description | -
|---|---|---|
allowCollision |
-
-
- - - -object - - - - | - - - - - -An object containing allowed collision. |
-
Allow this Body to be influenced by the global Gravity?
Allow this Body to be influenced by the global Gravity value? Note: It will always be influenced by the local gravity if set.
Allow this Body to be rotated? (via angularVelocity, etc)
Allow angular rotation? This will cause the Sprite to be rotated via angularVelocity, etc.
angle
+ + +-
+
+
+
- Source: +
- @@ -1047,7 +1037,7 @@ For example allowCollision.up = false means it won't collide when the collision -
- Source:
- @@ -1152,7 +1142,7 @@ For example allowCollision.up = false means it won't collide when the collision -
- Source:
- @@ -1257,7 +1247,7 @@ For example allowCollision.up = false means it won't collide when the collision -
- Source:
- @@ -1307,7 +1297,114 @@ For example allowCollision.up = false means it won't collide when the collision
-
-
bottom
+blocked
+ + +
+ -
+
+ ++ + + + + +
This object is populated with boolean values when the Body collides with the World bounds or a Tile. +For example if blocked.up is true then the Body cannot move up.
+-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +blocked+ + +object + + + + + + + + + +An object containing on which faces this Body is blocked from moving, if any.
+
+
+
+ -
+
<readonly> bottom
@@ -1362,7 +1459,7 @@ For example allowCollision.up = false means it won't collide when the collision
- - Source:
- @@ -1464,7 +1561,7 @@ For example allowCollision.up = false means it won't collide when the collision -
- Source:
- @@ -1511,7 +1608,114 @@ For example allowCollision.up = false means it won't collide when the collision
-
-
center
+checkCollision
+ + +
+ -
+
+ ++ + + + + +
Set the checkCollision properties to control which directions collision is processed for this Body. +For example checkCollision.up = false means it won't collide when the collision happened while moving up.
+-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +checkCollision+ + +object + + + + + + + + + +An object containing allowed collision.
+
+
+
+ -
+
collideCallback
@@ -1550,13 +1754,13 @@ For example allowCollision.up = false means it won't collide when the collision
- Default Value: +
- null
+
- Source:
- + + + + + + + +
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
angle |
+
+
+ + + +number + + + + | + + + + + +The angle of the Body based on its velocity in radians. |
+
The angular acceleration in pixels per second sq. of the Body.
The angular acceleration of the Body.
The angular drag applied to the rotation of the Body.
angularDrag is used to calculate friction on the body as it rotates.
The angular velocity in pixels per second sq. of the Body.
The angular velocity of the Body.
The bottom value of this Body (same as Body.y + Body.height)
The bottom-most point of this Body.
The elasticitiy of the Body when colliding. bounce.x/y = 1 means full rebound, bounce.x/y = 0.5 means 50% rebound velocity.
The elasticitiy of the Body when colliding. This property determines how much energy a body maintains during a collision, i.e. its bounciness.
centercollideCallbackThe center coordinate of the Physics Body.
If set this callback will be fired whenever this Body is hit (on any face). It will send three parameters, the face it hit on, this Body and the Body that hit it.
collideCallbackContext
+ + +-
+
+
+
- Default Value: +
- null
+
+
+
+ - Source: +
- @@ -1701,7 +2013,7 @@ For example allowCollision.up = false means it won't collide when the collision
- Source:
- @@ -1719,17 +2031,12 @@ For example allowCollision.up = false means it won't collide when the collision
-
-
customSeparateX
+<protected> contacts
-
- -- @@ -1763,13 +2070,13 @@ Used in combination with your own collision processHandler you can create whatev
This flag allows you to disable the custom x separation that takes place by Physics.Arcade.separate. -Used in combination with your own collision processHandler you can create whatever type of collision response you need.
-- + + + + +customSeparateXcontacts-boolean +array.<Phaser.Physics.Arcade.Body> @@ -1779,7 +2086,109 @@ Used in combination with your own collision processHandler you can create whatev - Use a custom separation system or the built-in one?
Used to store references to bodies this Body is in contact with.
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
collideCallbackContext |
+
+
+ + + +object + + + + | + + + + + +The context in which the collideCallback is called. |
+
customSeparateCallback
+ + +-
+
+
+
- Default Value: -
- false
+ - null
- Source:
- @@ -1829,17 +2238,12 @@ Used in combination with your own collision processHandler you can create whatev
-
-
customSeparateY
+customSeparateContext
-
- -- @@ -1873,13 +2277,13 @@ Used in combination with your own collision processHandler you can create whatev
This flag allows you to disable the custom y separation that takes place by Physics.Arcade.separate. -Used in combination with your own collision processHandler you can create whatever type of collision response you need.
-- @@ -1915,221 +2319,13 @@ Used in combination with your own collision processHandler you can create whatevcustomSeparateYcustomSeparateContext-boolean +object @@ -1889,7 +2293,7 @@ Used in combination with your own collision processHandler you can create whatev - Use a custom separation system or the built-in one?
The context in which the customSeparateCallback is called.
- Default Value: -
- false
+ - null
- Source:
- - - - - - - - - - - - - - - - -
-
-
drag
- - -
- -
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Properties:
- --
-
-
- -
-- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -drag- - -Phaser.Point - - - - - - - - - -The drag applied to the motion of the Body.
-
-
-
- -
-
embedded
- - -
- -
-
- -- - - - - -
If a body is overlapping with another body, but neither of them are moving (maybe they spawned on-top of each other?) this is set to true.
--
-
-
-
- Source: -
- @@ -2231,7 +2427,7 @@ Used in combination with your own collision processHandler you can create whatev
- Source:
- @@ -2333,7 +2529,7 @@ Used in combination with your own collision processHandler you can create whatev
- Source:
- @@ -2406,7 +2602,7 @@ Used in combination with your own collision processHandler you can create whatev -
- Source:
- @@ -2453,7 +2649,7 @@ Used in combination with your own collision processHandler you can create whatev
-
-
halfHeight
+<readonly> height
@@ -2492,7 +2688,7 @@ Used in combination with your own collision processHandler you can create whatev
- Source:
- - - - - - - - -
Properties:
- --
-
-
- -
-- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -embedded- - -boolean - - - - - - - - - -Body embed value.
A private Gravity setting for the Body.
The gravity applied to the motion of the Body. This works in addition to any gravity set on the world.
- @@ -2537,410 +2733,7 @@ Used in combination with your own collision processHandler you can create whatevhalfHeightheight@@ -2508,7 +2704,7 @@ Used in combination with your own collision processHandler you can create whatev - The calculated height / 2 of the physics body.
The current height of the Body, taking into account the point rotation.
-
-
-
- -
-
halfWidth
- - -
- -
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Properties:
- --
-
-
- -
-- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -halfWidth- - -number - - - - - - - - - -The calculated width / 2 of the physics body.
-
-
-
- -
-
height
- - -
- -
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Properties:
- --
-
-
- -
-- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -.numInternal- - - - - - - -ID cache
-
-
-
- -
-
hullX
- - -
- -
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Properties:
- --
-
-
- -
-- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -hullX- - -Phaser.Rectangle - - - - - - - - - -The dynamically calculated hull used during collision.
-
-
-
- -
-
hullY
- - -
- -
-
-
-
-
-
-
-
-
-
-
- Source: -
- @@ -3013,7 +2806,7 @@ Used in combination with your own collision processHandler you can create whatev -
- Source:
- + + + + + + + +
Properties:
- --
-
-
- -
-- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -hullY- - -Phaser.Rectangle - - - - - - - - - -The dynamically calculated hull used during collision.
An immovable Body will not receive any impacts from other bodies.
An immovable Body will not receive any impacts or exchanges of velocity from other bodies.
+
+
+
+ -
+
<readonly> left
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +left+ + +number + + + + + + + + + +The left-most point of this Body.
+
+
+
+ -
+
linearDamping
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Default Value: +
- 0.0
+
+
+
+ - Source: +
- @@ -3118,7 +3118,7 @@ Used in combination with your own collision processHandler you can create whatev -
- Source:
- @@ -3223,7 +3223,7 @@ Used in combination with your own collision processHandler you can create whatev -
- Source:
- @@ -3328,7 +3328,7 @@ Used in combination with your own collision processHandler you can create whatev -
- Source:
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +linearDamping+ + +number + + + + + + + + + +linearDamping is used to calculate friction on the body as it moves through the world. For example, this might be used to simulate air or water friction.
The mass of the Body.
The mass property determines how forces affect the body, as well as how much momentum the body has when it is involved in a collision.
The maximum angular velocity in pixels per second sq. that the Body can reach.
The maximum angular velocity that the Body can reach.
The maximum velocity in pixels per second sq. that the Body can reach.
The maximum velocity that the Body can reach.
+
+
+
+ -
+
minVelocity
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- @@ -3430,7 +3532,7 @@ Used in combination with your own collision processHandler you can create whatev -
- Source:
- @@ -3564,7 +3666,7 @@ Used in combination with your own collision processHandler you can create whatev
- Source:
- @@ -3582,16 +3684,12 @@ Used in combination with your own collision processHandler you can create whatev
-
-
overlapX
+<protected> overlapX
-
- -- @@ -3641,7 +3739,7 @@ Used in combination with your own collision processHandler you can create whatev -
When this body collides with another, the amount of overlap is stored here.
-The amount of horizontal overlap during the collision.
Mostly used internally to store the overlap values from Tile seperation.
- Source:
- @@ -3688,16 +3786,12 @@ Used in combination with your own collision processHandler you can create whatev
-
-
overlapY
+<protected> overlapY
-
- -- @@ -3747,7 +3841,7 @@ Used in combination with your own collision processHandler you can create whatev -
When this body collides with another, the amount of overlap is stored here.
-The amount of vertical overlap during the collision.
Mostly used internally to store the overlap values from Tile seperation.
- Source:
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +minVelocity+ + +Phaser.Point + + + + + + + + + +When a body rebounds off another body or a wall the minVelocity is checked. If the new velocity is lower than minVelocity the body is stopped.
Set to true to allow the Physics system to move this Body, other false to move it manually.
Set to true to allow the Physics system (such as velocity) to move this Body, or false to move it manually.
+
+
+
+ -
+
polygon
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- @@ -3878,7 +4074,7 @@ Used in combination with your own collision processHandler you can create whatev
- Source:
- @@ -3980,7 +4176,7 @@ Used in combination with your own collision processHandler you can create whatev
- Source:
- @@ -4082,7 +4278,7 @@ Used in combination with your own collision processHandler you can create whatev
- Source:
- @@ -4100,7 +4296,7 @@ Used in combination with your own collision processHandler you can create whatev
-
-
<protected> quadTreeIDs
+rebound
@@ -4139,13 +4335,13 @@ Used in combination with your own collision processHandler you can create whatev
- Default Value: +
- true
+
- Source:
- @@ -4202,109 +4401,7 @@ Used in combination with your own collision processHandler you can create whatev
-
-
<protected> quadTreeIndex
- - -
- -
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Properties:
- --
-
-
- -
-- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -quadTreeIndex- - -number - - - - - - - - - -Internal ID cache.
-
-
-
- -
-
right
+<readonly> right
@@ -4359,7 +4456,7 @@ Used in combination with your own collision processHandler you can create whatev
- - Source:
- @@ -4461,7 +4558,7 @@ Used in combination with your own collision processHandler you can create whatev -
- Source:
- @@ -4511,7 +4608,7 @@ Used in combination with your own collision processHandler you can create whatev
-
-
<readonly> screenX
+shape
@@ -4550,7 +4647,115 @@ Used in combination with your own collision processHandler you can create whatev
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +polygon+ + +SAT.Polygon + + + + + + + + + +The SAT Polygons, as derived from the Shape.
- @@ -4180,11 +4376,14 @@ Used in combination with your own collision processHandler you can create whatev +quadTreeIDsrebound-Array +boolean @@ -4155,7 +4351,7 @@ Used in combination with your own collision processHandler you can create whatev - Internal ID cache.
A Body set to rebound will exchange velocity with another Body during collision. Set to false to allow this body to be 'pushed' rather than exchange velocity.
The right value of this Body (same as Body.x + Body.width)
The right-most point of this Body.
The amount the Body is rotated.
The amount the parent Sprite is rotated.
- + + +screenXshape+ + +SAT.Box +| + +SAT.Circle +| + +SAT.Polygon + + + + + + + + + +The SAT Collision shape.
+ - Source: +
- + + + + + + + +
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
customSeparateCallback |
+
+
+ + + +function + + + + | + + + + + +If set this callback will be used for Body separation instead of the built-in one. Callback should return true if separated, otherwise false. |
speed
+ + +-
+
+
+
- Source:
- - - - - - - - - - - - - - - - -
-
-
<readonly> screenY
- - -
- -
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Properties:
- --
-
-
- -
-- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -screenY- - -number - - - - - - - - - -The y position of the physics body translated to screen space.
-
-
-
- -
-
skipQuadTree
- - -
- -
-
-
-
-
-
-
-
-
-
-
- Default Value: -
- false
-
-
-
- - Source: -
- - - - - - - - -
Properties:
- --
-
-
- -
-- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -skipQuadTree- - -boolean - - - - - - - - - -If the Body is an irregular shape you can set this to true to avoid it being added to the World quad tree.
-
-
-
- -
-
<readonly> sourceHeight
- - -
- -
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Properties:
- --
-
-
- -
-- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -sourceHeight- - -number - - - - - - - - - -The un-scaled original size.
-
-
-
- -
-
<readonly> sourceWidth
- - -
- -
-
-
-
-
-
-
-
-
-
-
- Source: -
- @@ -5108,7 +4902,109 @@ Used in combination with your own collision processHandler you can create whatev
- Source:
- + + + + + + + +
Properties:
- --
-
-
- -
-- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -sourceWidth- - -number - - - - - - - - - -The un-scaled original size.
+
+
+
+ -
+
<readonly> top
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- @@ -5215,7 +5111,112 @@ touching.up = true means the collision happened to the top of this Body for exam
- Source:
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +top+ + +number + + + + + + + + + +The top-most point of this Body.
+
+
+
+ -
+
type
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- @@ -5288,7 +5289,7 @@ touching.up = true means the collision happened to the top of this Body for exam -
- Source:
- @@ -5335,113 +5336,7 @@ touching.up = true means the collision happened to the top of this Body for exam
-
-
wasTouching
- - -
- -
-
- -- - - - - -
This object is populated with previous touching values from the bodies previous collision.
--
-
-
-
- Source: -
- - - - - - - - -
Properties:
- --
-
-
- -
-- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -wasTouching- - -object - - - - - - - - - -An object containing previous touching results.
-
-
-
- -
-
width
+<readonly> width
@@ -5496,7 +5391,7 @@ touching.up = true means the collision happened to the top of this Body for exam
- - Source:
- @@ -5543,7 +5438,7 @@ touching.up = true means the collision happened to the top of this Body for exam
-
-
<readonly> x
+x
@@ -5598,7 +5493,7 @@ touching.up = true means the collision happened to the top of this Body for exam
- - Source:
- @@ -5645,7 +5540,7 @@ touching.up = true means the collision happened to the top of this Body for exam
-
-
<readonly> y
+y
@@ -5700,7 +5595,7 @@ touching.up = true means the collision happened to the top of this Body for exam
- - Source:
- @@ -5753,7 +5648,7 @@ touching.up = true means the collision happened to the top of this Body for exam
-
-
deltaAbsX() → {number}
+<protected> add(v)
@@ -5761,7 +5656,7 @@ touching.up = true means the collision happened to the top of this Body for exam
- Source:
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +type+ + +Phaser.Physics.Arcade.RECT +| + +Phaser.Physics.Arcade.CIRCLE + + + + + + + + + +The type of SAT Shape.
The velocity in pixels per second sq. of the Body.
The velocity of the Body.
The calculated width of the physics body.
The current width of the Body, taking into account the point rotation.
The x position of the physics body.
The x coordinate of this Body.
The y position of the physics body.
The y coordinate of this Body.
-@@ -5770,6 +5665,55 @@ touching.up = true means the collision happened to the top of this Body for exam +Returns the absolute delta x value.
+Adds the given Vector to this Body.
Parameters:
+ + ++ +
+ ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +v+ + +SAT.Vector + + + + + + + + + +The vector to add to this Body.
-
@@ -5794,7 +5738,125 @@ touching.up = true means the collision happened to the top of this Body for exam
+
+
+
+ -
+
addContact(body) → {boolean}
+ + +
+ -
+
+
+ ++ + + + + + + +
Adds the given Body to the contact list of this Body. Also adds this Body to the contact list of the given Body.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +body+ + +Phaser.Physics.Arcade.Body + + + + + + + + + +The Body to be added.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- @@ -5819,7 +5881,7 @@ touching.up = true means the collision happened to the top of this Body for exam
- -number +boolean @@ -5845,7 +5907,7 @@ touching.up = true means the collision happened to the top of this Body for exam
-
-
deltaAbsY() → {number}
+<protected> applyDamping()
@@ -5853,7 +5915,7 @@ touching.up = true means the collision happened to the top of this Body for exam
- Source:
- @@ -5907,29 +5969,75 @@ touching.up = true means the collision happened to the top of this Body for exam -
- - Type - -
- - -number - - - -
-@@ -5830,7 +5892,7 @@ touching.up = true means the collision happened to the top of this Body for examThe absolute delta value.
+True if the given Body was added to this contact list, false if already on it.
-@@ -5886,7 +5948,7 @@ touching.up = true means the collision happened to the top of this Body for examReturns the absolute delta y value.
+Internal method that checks the acceleration and applies damping if not set.
Returns:
- --- - - -The absolute delta value.
--
-
+
+ -
+
<protected> checkBlocked()
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Internal method that checks and potentially resets the blocked status flags.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
@@ -5945,7 +6053,7 @@ touching.up = true means the collision happened to the top of this Body for exam
- Source:
- @@ -6003,7 +6111,7 @@ touching.up = true means the collision happened to the top of this Body for exam
- Source:
- + + + + + + + + + + + + + + + + + + + +
- + Type + +
- + +number + + + +
-
+
deltaZ() → {number}
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Returns the delta z value. The amount the Body has rotated in the current step.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- @@ -6116,6 +6316,3776 @@ touching.up = true means the collision happened to the top of this Body for exam +
+
+
+
+ -
+
destroy()
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Destroys this Body and all references it holds to other objects.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
<protected> exchange(body)
+ + +
+ -
+
+
+ ++ + + + + + + +
Exchange velocity with the given Body.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +body+ + +Phaser.Physics.Arcade.Body + + + + + + + + + +The Body that collided.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
getDownwardForce() → {number}
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Gets the total force being applied on the X axis, including gravity and velocity.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + +++ + + +The total force being applied on the Y axis.
+-
+
- + Type + +
- + +number + + + +
+
+
+
+ -
+
getUpwardForce() → {number}
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Gets the total force being applied on the X axis, including gravity and velocity.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + +++ + + +The total force being applied on the X axis.
+-
+
- + Type + +
- + +number + + + +
+
+
+
+ -
+
<protected> give(body, response)
+ + +
+ -
+
+
+ ++ + + + + + + +
Separation response handler.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +body+ + +Phaser.Physics.Arcade.Body + + + + + + + + + +The Body that collided.
+ + + + + +response+ + +SAT.Response + + + + + + + + + +The SAT Response object containing the collision data.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
<protected> hitBottom(body, response)
+ + +
+ -
+
+
+ ++ + + + + + + +
Process a collision with the bottom face of this Body. +Collision and separation can be further checked by setting a collideCallback. +This callback will be sent 4 parameters: The face of collision, this Body, the colliding Body and the SAT Response. +If the callback returns true then separation, rebounds and the touching flags will all be set. +If it returns false this will be skipped and must be handled manually.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +body+ + +Phaser.Physics.Arcade.Body + + + + + + + + + +The Body that collided.
+ + + + + +response+ + +SAT.Response + + + + + + + + + +The SAT Response object containing the collision data.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
<protected> hitLeft(body, response)
+ + +
+ -
+
+
+ ++ + + + + + + +
Process a collision with the left face of this Body. +Collision and separation can be further checked by setting a collideCallback. +This callback will be sent 4 parameters: The face of collision, this Body, the colliding Body and the SAT Response. +If the callback returns true then separation, rebounds and the touching flags will all be set. +If it returns false this will be skipped and must be handled manually.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +body+ + +Phaser.Physics.Arcade.Body + + + + + + + + + +The Body that collided.
+ + + + + +response+ + +SAT.Response + + + + + + + + + +The SAT Response object containing the collision data.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
<protected> hitRight(body, response)
+ + +
+ -
+
+
+ ++ + + + + + + +
Process a collision with the right face of this Body. +Collision and separation can be further checked by setting a collideCallback. +This callback will be sent 4 parameters: The face of collision, this Body, the colliding Body and the SAT Response. +If the callback returns true then separation, rebounds and the touching flags will all be set. +If it returns false this will be skipped and must be handled manually.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +body+ + +Phaser.Physics.Arcade.Body + + + + + + + + + +The Body that collided.
+ + + + + +response+ + +SAT.Response + + + + + + + + + +The SAT Response object containing the collision data.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
<protected> hitTop(body, response)
+ + +
+ -
+
+
+ ++ + + + + + + +
Process a collision with the top face of this Body. +Collision and separation can be further checked by setting a collideCallback. +This callback will be sent 4 parameters: The face of collision, this Body, the colliding Body and the SAT Response. +If the callback returns true then separation, rebounds and the touching flags will all be set. +If it returns false this will be skipped and must be handled manually.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +body+ + +Phaser.Physics.Arcade.Body + + + + + + + + + +The Body that collided.
+ + + + + +response+ + +SAT.Response + + + + + + + + + +The SAT Response object containing the collision data.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
inContact(body) → {boolean}
+ + +
+ -
+
+
+ ++ + + + + + + +
Checks if this Body is already in contact with the given Body.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +body+ + +Phaser.Physics.Arcade.Body + + + + + + + + + +The Body to be checked.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + +++ + + +True if the given Body is already in contact with this Body.
+-
+
- + Type + +
- + +boolean + + + +
+
+
+
+ -
+
<protected> integrateVelocity()
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Internal method. Integrates velocity, global gravity and the delta timer.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
onFloor() → {boolean}
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Determines if this Body is 'on the floor', which means in contact with a Tile or World bounds, or other object that has set 'down' as blocked.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + +++ + + +True if this Body is 'on the floor', which means in contact with a Tile or World bounds, or object that has set 'down' as blocked.
+-
+
- + Type + +
- + +boolean + + + +
+
+
+
+ -
+
onWall() → {boolean}
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Determins if this Body is 'on a wall', which means horizontally in contact with a Tile or World bounds, or other object but not the ground.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + +++ + + +True if this Body is 'on a wall', which means horizontally in contact with a Tile or World bounds, or other object but not the ground.
+-
+
- + Type + +
- + +boolean + + + +
+
+
+
+ -
+
overlap(body, response) → {boolean}
+ + +
+ -
+
+
+ ++ + + + + + + +
Checks for an overlap between this Body and the given Body.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +body+ + +Phaser.Physics.Arcade.Body + + + + + + + + + +The Body that is being checked against this Body.
+ + + + + +response+ + +SAT.Response + + + + + + + + + +SAT Response handler.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + +++ + + +True if the two bodies overlap, otherwise false.
+-
+
- + Type + +
- + +boolean + + + +
+
+
+
+ -
+
<protected> postUpdate()
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Internal method. This is called directly before the sprites are sent to the renderer and after the update function has finished.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
<protected> preUpdate()
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Internal method that updates the Body position in relation to the parent Sprite.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
<protected> processRebound(body)
+ + +
+ -
+
+
+ ++ + + + + + + +
Rebound the velocity of this Body.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +body+ + +Phaser.Physics.Arcade.Body + + + + + + + + + +The Body that collided.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
<protected> reboundCheck(x, y, rebound)
+ + +
+ -
+
+
+ ++ + + + + + + +
Check if we're below minVelocity and gravity isn't trying to drag us in the opposite direction.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +x+ + +boolean + + + + + + + + + +Check the X axis?
+ + + + + +y+ + +boolean + + + + + + + + + +Check the Y axis?
+ + + + + +rebound+ + +boolean + + + + + + + + + +If true it will reverse the velocity on the given axis
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
removeContact(body) → {boolean}
+ + +
+ -
+
+
+ ++ + + + + + + +
Removes the given Body from the contact list of this Body. Also removes this Body from the contact list of the given Body.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +body+ + +Phaser.Physics.Arcade.Body + + + + + + + + + +The Body to be removed.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + +++ + + +True if the given Body was removed from this contact list, false if wasn't on it.
+-
+
- + Type + +
- + +boolean + + + +
+
+
+
+ -
+
reset(full)
+ + +
+ -
+
+
+ ++ + + + + + + +
Resets the Body motion values: velocity, acceleration, angularVelocity and angularAcceleration. +Also resets the forces to defaults: gravity, bounce, minVelocity,maxVelocity, angularDrag, maxAngular, mass, friction and checkCollision if 'full' specified.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + +Argument + + + +Default + + +Description ++ + + + + +full+ + +boolean + + + + + + ++ + <optional> + + + +
+ + + + + ++ + false + + + + +A full reset clears down settings you may have set, such as gravity, bounce and drag. A non-full reset just clears motion values.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
<protected> separate(body, response) → {boolean}
+ + +
+ -
+
+
+ ++ + + + + + + +
This separates this Body from the given Body unless a customSeparateCallback is set. +It assumes they have already been overlap checked and the resulting overlap is stored in the SAT response.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +body+ + +Phaser.Physics.Arcade.Body + + + + + + + + + +The Body to be separated from this one.
+ + + + + +response+ + +SAT.Response + + + + + + + + + +SAT Response handler.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + +++ + + +True if the bodies were separated, false if not (for example checkCollide allows them to pass through)
+-
+
- + Type + +
- + +boolean + + + +
+
+
+
+ -
+
setCircle(radius, offsetX, offsetY)
+ + +
+ -
+
+
+ ++ + + + + + + +
Sets this Body to use a circle of the given radius for all collision. +The Circle will be centered on the center of the Sprite by default, but can be adjusted via the Body.offset property and the setCircle x/y parameters.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + +Argument + + + +Default + + +Description ++ + + + + +radius+ + +number + + + + + + ++ + + + + + + + + ++ + + + +The radius of this circle (in pixels)
+ + + + + +offsetX+ + +number + + + + + + ++ + <optional> + + + +
+ + + + + ++ + 0 + + + + +The x amount the circle will be offset from the Sprites center.
+ + + + + +offsetY+ + +number + + + + + + ++ + <optional> + + + +
+ + + + + ++ + 0 + + + + +The y amount the circle will be offset from the Sprites center.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
setPolygon(points)
+ + +
+ -
+
+
+ ++ + + + + + + +
Sets this Body to use a convex polygon for collision. +The points are specified in a counter-clockwise direction and must create a convex polygon. +Use Body.translate and/or Body.offset to re-position the polygon from the Sprite origin.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +points+ + +Array.<SAT.Vector> +| + +Array.<number> +| + +SAT.Vector +| + +number + + + + + + + + + +This can be an array of Vectors that form the polygon, + a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be + all the points of the polygon e.g.
setPolygon(new SAT.Vector(), new SAT.Vector(), ...), or the + arguments passed can be flat x,y values e.g.setPolygon(x,y, x,y, x,y, ...)wherexandyare Numbers.-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
setRectangle(width, height, translateX, translateY)
+ + +
+ -
+
+
+ ++ + + + + + + +
Sets this Body to use a rectangle for all collision. +If you don't specify any parameters it will be sized to match the parent Sprites current width and height (including scale factor) and centered on the sprite.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + +Argument + + + + +Description ++ + + + + +width+ + +number + + + + + + ++ + <optional> + + + + +
+ + + + + +The width of the rectangle. If not specified it will default to the width of the parent Sprite.
+ + + + + +height+ + +number + + + + + + ++ + <optional> + + + + +
+ + + + + +The height of the rectangle. If not specified it will default to the height of the parent Sprite.
+ + + + + +translateX+ + +number + + + + + + ++ + <optional> + + + + +
+ + + + + +The x amount the rectangle will be translated from the Sprites center.
+ + + + + +translateY+ + +number + + + + + + ++ + <optional> + + + + +
+ + + + + +The y amount the rectangle will be translated from the Sprites center.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
<protected> split(body, response)
+ + +
+ -
+
+
+ ++ + + + + + + +
Split the collision response evenly between the two bodies.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +body+ + +Phaser.Physics.Arcade.Body + + + + + + + + + +The Body that collided.
+ + + + + +response+ + +SAT.Response + + + + + + + + + +The SAT Response object containing the collision data.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
<protected> sub(v)
+ + +
+ -
+
+
+ ++ + + + + + + +
Subtracts the given Vector from this Body.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +v+ + +SAT.Vector + + + + + + + + + +The vector to substract from this Body.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
<protected> take(body, response)
+ + +
+ -
+
+
+ ++ + + + + + + +
Separation response handler.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +body+ + +Phaser.Physics.Arcade.Body + + + + + + + + + +The Body that collided.
+ + + + + +response+ + +SAT.Response + + + + + + + + + +The SAT Response object containing the collision data.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
translate(x, y)
+ + +
+ -
+
+
+ ++ + + + + + + +
Used for translating rectangle and polygon bodies from the Sprite parent. Doesn't apply to Circles. +See also the Body.offset property.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +x+ + +number + + + + + + + + + +The x amount the polygon or rectangle will be translated by from the Sprite.
+ + + + + +y+ + +number + + + + + + + + + +The y amount the polygon or rectangle will be translated by from the Sprite.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
<protected> updateBounds()
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Internal method that updates the left, right, top, bottom, width and height properties.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
<protected> updateScale()
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Internal method that updates the Body scale in relation to the parent Sprite.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
@@ -6138,13 +10108,13 @@ touching.up = true means the collision happened to the top of this Body for exam
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
- + DOMSprite + +
- Easing @@ -162,6 +166,14 @@ GameObjectFactory +
- + Gamepad + + +
- + GamepadButton + +
- Graphics @@ -186,6 +198,10 @@ Keyboard +
- + Line + +
- LinkedList @@ -278,6 +294,10 @@ Signal +
- + SinglePad + +
- Sound @@ -342,6 +362,10 @@ Timer +
- + TimerEvent + +
- Touch @@ -374,36 +398,6 @@ -
- - Global - - - - @@ -579,7 +573,7 @@
-
-
bounds
+<static, constant> CIRCLE :number
@@ -587,63 +581,21 @@
+ - + +number + + + +
- Source:
- + + + + + + + +
-
+
<static, constant> POLYGON :number
+ + +
+ -
+
+
+
+
Type:
+-
+
- + +number + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+
+ -
+
<static, constant> RECT :number
+ + +
+ -
+
+
+
+
Type:
+-
+
- + +number + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- @@ -969,7 +1041,7 @@
- Source:
- @@ -1071,109 +1143,7 @@
- Source:
- - - - - - - - -
-
-
-
- -
-
OVERLAP_BIAS
- - -
- -
-
-
-
-
-
-
-
-
-
-
- Source: -
- @@ -1275,7 +1245,7 @@
- Source:
- @@ -1293,7 +1263,7 @@
-
-
quadTreeID
+worldBottom
@@ -1332,13 +1302,13 @@
- Source:
- + + + + + + + +
Properties:
- --
-
-
- -
-- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -OVERLAP_BIAS- - -number - - - - - - - - - -A value added to the delta values during collision checks.
- @@ -1377,7 +1347,415 @@quadTreeIDworldBottom-number +SAT.Box @@ -1348,7 +1318,7 @@ - The QuadTree ID.
The bottom of the physics bounds.
+
+
+
+ -
+
worldLeft
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +worldLeft+ + +SAT.Box + + + + + + + + + +The left hand side of the physics bounds.
+
+
+
+ -
+
worldPolys
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +worldPolys+ + +array.<SAT.Polygon> + + + + + + + + + +An array of the polygon data from the physics bounds.
+
+
+
+ -
+
worldRight
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +worldRight+ + +SAT.Box + + + + + + + + + +The right hand side of the physics bounds.
+
+
+
+ -
+
worldTop
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- @@ -1662,7 +2040,7 @@ Note: The display object doesn't stop moving once it reaches the destination coo
- Source:
- @@ -1976,7 +2354,7 @@ Note: The display object doesn't stop moving once it reaches the destination coo
- Source:
- @@ -2323,7 +2701,7 @@ Note: The display object doesn't stop moving once it reaches the destination coo
- Source:
- @@ -2383,7 +2761,7 @@ Note: The display object doesn't stop moving once it reaches the destination coo
- Source:
- @@ -2726,7 +3104,7 @@ One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) whi
- Source:
- @@ -2910,7 +3288,7 @@ One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) whi
- Source:
- @@ -3097,7 +3475,7 @@ One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) whi
- Source:
- @@ -3148,7 +3526,7 @@ One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) whi
-
-
<protected> checkWorldBounds()
+checkBounds(The) → {boolean}
@@ -3156,7 +3534,7 @@ One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) whi
- Source:
- @@ -3210,6 +3637,29 @@ One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) whi +
- + Type + +
- + +boolean + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +worldTop+ + +SAT.Box + + + + + + + + + +The top side of the physics bounds.
@@ -2560,7 +2938,7 @@ One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) whiGiven the rotation (in radians) and speed calculate the acceleration and return it as a Point object, or set it to the given point object. -One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) which will set the values directly to the sprites velocity and not create a new Point object.
+One way to use this is: accelerationFromRotation(rotation, 200, sprite.acceleration) which will set the values directly to the sprites acceleration and not create a new Point object.-@@ -3165,6 +3543,55 @@ One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) whi +Internal method.
+Checks the given Physics.Body against the Physics Bounds, if any are set, and separates them, setting the blocked flags on the Body as it does so.
Parameters:
+ + ++ +
+ ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +The+ + +Phaser.Physics.Arcade.Body + + + + + + + + + +Body object to be checked.
-
@@ -3189,7 +3616,7 @@ One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) whi
Returns:
+ + +++ + + +True if the body hit the bounds, otherwise false.
+-
+
@@ -3225,9 +3675,12 @@ One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) whi
- Source:
- @@ -3539,262 +3995,6 @@ The objects are also automatically separated. - - - - -
-
-
computeVelocity(axis, body, velocity, acceleration, drag, mMax) → {number}
- - -
- -
-
-
- -- - - - - - - -
A tween-like function that takes a starting velocity and some other factors and returns an altered velocity.
-Parameters:
- - -- -
- - - - -- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -axis- - -number - - - - - - - - - -1 for horizontal, 2 for vertical.
- - - - - -body- - -Phaser.Physics.Arcade.Body - - - - - - - - - -The Body object to be updated.
- - - - - -velocity- - -number - - - - - - - - - -Any component of velocity (e.g. 20).
- - - - - -acceleration- - -number - - - - - - - - - -Rate at which the velocity is changing.
- - - - - -drag- - -number - - - - - - - - - -Really kind of a deceleration, this is how much the velocity changes if Acceleration is not set.
- - - - - -mMax- - -number - - - - - - - - - -An absolute value cap for the velocity.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Returns:
- - --- - - -The altered Velocity value.
--
-
- - Type - -
- - -number - - - -
@@ -3913,7 +4113,7 @@ The objects are also automatically separated.
- Source:
- @@ -4099,7 +4299,7 @@ If you need to calculate from the center of a display object instead use the met
- Source:
- @@ -4288,7 +4488,7 @@ If you need to calculate from the center of a display object instead use the met
- Source:
- @@ -4334,6 +4534,171 @@ If you need to calculate from the center of a display object instead use the met + + + + +
-
+
intersects(a, b) → {boolean}
+ + +
+ -
+
+
+ ++ + + + + + + +
Performs a rect intersection test against the two objects. +Objects must expose properties: width, height, left, right, top, bottom.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +a+ + +object + + + + + + + + + +The first object to test.
+ + + + + +b+ + +object + + + + + + + + + +The second object to test.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + +++ + + +Returns true if the objects intersect, otherwise false.
+-
+
- + Type + +
- + +boolean + + + +
@@ -4563,7 +4928,7 @@ Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set
- Source:
- @@ -4839,7 +5204,7 @@ Note: The display object doesn't stop moving once it reaches the destination coo
- Source:
- @@ -5149,7 +5514,7 @@ Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set
- Source:
- @@ -5210,7 +5575,8 @@ Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set
- Source:
- @@ -5521,7 +5890,7 @@ Unlike collide the objects are NOT automatically separated or have any physics a
-
-
<protected> postUpdate()
+<protected> processTileSeparation(body1) → {boolean}
@@ -5529,352 +5898,7 @@ Unlike collide the objects are NOT automatically separated or have any physics a
- Source: -
- - - - - - - - -
-
-
<protected> postUpdate()
- - -
- -
-
-
- -- - - - - - - - - -
Internal method.
--
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
-
-
-
- -
-
<protected> preUpdate()
- - -
- -
-
-
- -- - - - - - - - - -
Called automatically by the core game loop.
--
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
-
-
-
- -
-
<protected> preUpdate()
- - -
- -
-
-
- -- - - - - - - - - -
Internal method.
--
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
-
-
-
- -
-
reset()
- - -
- -
-
-
- -- - - - - - - - - -
Resets all Body values (velocity, acceleration, rotation, etc)
--
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
-
-
-
- -
-
separate(body1, body2) → {boolean}
- - -
- -
-
-
- -@@ -5928,6 +5952,163 @@ Unlike collide the objects are NOT automatically separated or have any physics a +
The core separation function to separate two physics bodies.
+Internal function to process the separation of a physics body from a tile.
- Source: +
- + + + + + + + +
- + Type + +
- + +boolean + + + +
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +|
|---|---|---|---|
speed |
@@ -4566,7 +4771,7 @@ Used in combination with your own collision processHandler you can create whatev - | The x position of the physics body translated to screen space. |
+ The speed in pixels per second sq. of the Body. |
| Name | - - -Type | - - - - - -Description | -
|---|---|---|
bounds |
-
-
- - - -Phaser.Rectangle - - - - | - - - - - -The bounds inside of which the physics world exists. Defaults to match the world bounds. |
-
-
@@ -3302,7 +3755,7 @@ The objects are also automatically separated.
- Checks for collision between two game objects. The objects can be Sprites, Groups, Emitters or Tilemap Layers. -You can perform Sprite vs. Sprite, Sprite vs. Group, Group vs. Group, Sprite vs. Tilemap Layer or Group vs. Tilemap Layer collisions. -The objects are also automatically separated.
+Checks for collision between two game objects. You can perform Sprite vs. Sprite, Sprite vs. Group, Group vs. Group, Sprite vs. Tilemap Layer or Group vs. Tilemap Layer collisions. +The second parameter can be an array of objects, of differing types. +The objects are also automatically separated. If you don't require separation then use ArcadePhysics.overlap instead. +An optional processCallback can be provided. If given this function will be called when two sprites are found to be colliding. It is called before any separation takes place, +giving you the chance to perform additional checks. If the function returns true then the collision and separation is carried out. If it returns false it is skipped. +The collideCallback is an optional function that is only called if two sprites collide. If a processCallback has been set then it needs to return true for collideCallback to be called.
The first object to check. Can be an instance of Phaser.Sprite, Phaser.Group, Phaser.Particles.Emitter, or Phaser.Tilemap
The first object to check. Can be an instance of Phaser.Sprite, Phaser.Group, Phaser.Particles.Emitter, or Phaser.Tilemap.
The second object to check. Can be an instance of Phaser.Sprite, Phaser.Group, Phaser.Particles.Emitter or Phaser.Tilemap
The second object or array of objects to check. Can be Phaser.Sprite, Phaser.Group, Phaser.Particles.Emitter or Phaser.Tilemap.
An optional callback function that is called if the objects overlap. The two objects will be passed to this function in the same order in which you specified them.
An optional callback function that is called if the objects collide. The two objects will be passed to this function in the same order in which you specified them.
A callback function that lets you perform additional checks against the two objects if they overlap. If this is set then collideCallback will only be called if processCallback returns true.
A callback function that lets you perform additional checks against the two objects if they overlap. If this is set then collision will only happen if processCallback returns true. The two objects will be passed to this function in the same order in which you specified them.
Checks for overlaps between two game objects. The objects can be Sprites, Groups or Emitters. You can perform Sprite vs. Sprite, Sprite vs. Group and Group vs. Group overlap checks. -Unlike collide the objects are NOT automatically separated or have any physics applied, they merely test for overlap results.
+Unlike collide the objects are NOT automatically separated or have any physics applied, they merely test for overlap results. +The second parameter can be an array of objects, of differing types.The second object to check. Can be an instance of Phaser.Sprite, Phaser.Group or Phaser.Particles.Emitter.
The second object or array of objects to check. Can be Phaser.Sprite, Phaser.Group or Phaser.Particles.Emitter.
-
-
-
-
-
-
-
-
-
-
-Called automatically by the core game loop.
--
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+Returns true if separated, false if not.
+-
+
separate(body1, body2, processCallback, callbackContext) → {boolean}
+ + +
+
+
+
+
+
+
+
+
+ The core separation function to separate two physics bodies.
+Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
body1 |
+
+
+ + + +Phaser.Physics.Arcade.Body + + + + | + + ++ + + + + + | + + + ++ + | + + +The Body object to separate. |
+
| + + + + + | + + + ++ + | The Body object to separate. |
||
processCallback |
+
+
+ + + +function + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + null + + | + + +A callback function that lets you perform additional checks against the two objects if they overlap. If this function is set then the sprites will only be collided if it returns true. |
+
callbackContext |
+
+
+ + + +object + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + | + + +The context in which to run the process callback. |
+
-
@@ -6030,7 +6299,7 @@ Unlike collide the objects are NOT automatically separated or have any physics a
Returns true if the bodies were separated, otherwise false.
+Returns true if the bodies collided, otherwise false.
separateTile(body1, tile) → {boolean}
+separateTile(body, tile) → {boolean}
body1body
-
@@ -6194,7 +6463,7 @@ Unlike collide the objects are NOT automatically separated or have any physics a
Returns true if the bodies were separated, otherwise false.
+Returns true if the body was separated, otherwise false.
separateTileX(body1, tile) → {boolean}
+separateTiles(body, tiles) → {boolean}
-
@@ -6236,7 +6505,7 @@ Unlike collide the objects are NOT automatically separated or have any physics a
The core separation function to separate a physics body and a tile on the x axis.
+The core separation function to separate a physics body and an array of tiles.
body1bodytiletilesThe tile to collide against.
The array of tiles to collide against.
-
@@ -6358,7 +6627,7 @@ Unlike collide the objects are NOT automatically separated or have any physics a
Returns true if the bodies were separated, otherwise false.
+Returns true if the body was separated, otherwise false.
separateTileY(body1, tile) → {boolean}
+setBounds(x, y, width, height, left, right, top, bottom)
-
@@ -6388,8 +6658,12 @@ Unlike collide the objects are NOT automatically separated or have any physics a
The core separation function to separate a physics body and a tile on the x axis.
+Sets the bounds of the Physics world to match the given world pixel dimensions. +You can optionally set which 'walls' to create: left, right, top or bottom.
body1xThe Body object to separate.
The x coordinate of the top-left corner of the bounds.
tileyThe tile to collide against.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Returns:
- - -
-
-
-
-
-Returns true if the bodies were separated, otherwise false.
--
-
- - Type - -
- - -boolean - - - -
separateX(body1, body2) → {boolean}
- - -
-
-
-
-
-
-
-
-
- The core separation function to separate two physics bodies on the x axis.
-Parameters:
- - -| Name | - - -Type | - - - - - -Description | -|
|---|---|---|---|
body1 |
-
-
- - + | -Phaser.Physics.Arcade.Body - - - | - - - - - -The Body object to separate. |
-
body2 |
-
-
- - -Phaser.Physics.Arcade.Body - - - | - - - - - -The Body object to separate. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Returns:
- - -
-
-
-
-
-Returns true if the bodies were separated, otherwise false.
--
-
- - Type - -
- - -boolean - - - -
separateY(body1, body2) → {boolean}
- - -
-
-
-
-
-
-
-
-
- The core separation function to separate two physics bodies on the y axis.
-Parameters:
- - -| Name | - - -Type | - - - - - -Description | -||
|---|---|---|---|---|
body1 |
-
-
- - -Phaser.Physics.Arcade.Body - - - - | - + - -The Body object to separate. |
- ||
body2 |
-
-
- - + | -Phaser.Physics.Arcade.Body - - - - | - + - - -The Body object to separate. |
+ The y coordinate of the top-left corner of the bounds. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Returns:
- - -
-
-
-
-
-Returns true if the bodies were separated, otherwise false.
--
-
- - Type - -
- - -boolean - - - -
setSize(width, height, offsetX, offsetY)
- - -
-
-
-
-
-
-
-
-
- You can modify the size of the physics Body to be any dimension you need. -So it could be smaller or larger than the parent Sprite. You can also control the x and y offset, which -is the position of the Body relative to the top-left of the Sprite.
-Parameters:
- - -| Name | - - -Type | - - - - - -Description | -||||
|---|---|---|---|---|---|---|
| + + + + + | -The width of the Body. |
+
+ + + | + + +The width of the bounds. |
+ + + + + | -The height of the Body. |
+
+ + + | + + +The height of the bounds. |
offsetX |
+ left |
-number +boolean | +
+
+ <optional> + + + + + |
- The X offset of the Body from the Sprite position. |
+
+ + + true + + | + + +If true will create the left bounds wall. |
offsetY |
+ right |
-number +boolean | +
+
+ <optional> + + + + + |
- The Y offset of the Body from the Sprite position. |
+
+ + + true + + | + + +If true will create the right bounds wall. |
+
top |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + true + + | + + +If true will create the top bounds wall. |
+ ||
bottom |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + true + + | + + +If true will create the bottom bounds wall. |
| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
left |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + true + + | + + +If true will create the left bounds wall. |
+
right |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + true + + | + + +If true will create the right bounds wall. |
+
top |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + true + + | + + +If true will create the top bounds wall. |
+
bottom |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + true + + | + + +If true will create the bottom bounds wall. |
+
-
@@ -7080,7 +7251,7 @@ is the position of the Body relative to the top-left of the Sprite.
- Source:
- @@ -7108,7 +7279,7 @@ is the position of the Body relative to the top-left of the Sprite.
-
-
<protected> updateHulls()
+tileIntersects(body, tile) → {boolean}
@@ -7116,7 +7287,8 @@ is the position of the Body relative to the top-left of the Sprite.
- Source:
- @@ -7170,6 +7414,29 @@ is the position of the Body relative to the top-left of the Sprite. +
- + Type + +
- + +boolean + + + +
- Source:
- @@ -7481,7 +7748,7 @@ One way to use this is: velocityFromAngle(angle, 200, sprite.velocity) which wil
- Source:
- @@ -7720,7 +7987,7 @@ One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) whi
- Source:
- @@ -7790,13 +8057,13 @@ One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) whi - Phaser Copyright © 2012-2013 Photon Storm Ltd. + Phaser Copyright © 2012-2014 Photon Storm Ltd.
-
@@ -7125,6 +7297,78 @@ is the position of the Body relative to the top-left of the Sprite.
+ Internal method.
+Performs a rect intersection test against the two objects. +Objects must expose properties: width, height, left, right, top, bottom.
Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
body |
+
+
+ + + +object + + + + | + + + + + +The Body to test. |
+
tile |
+
+
+ + + +object + + + + | + + + + + +The Tile to test. |
+
-
@@ -7149,7 +7393,7 @@ is the position of the Body relative to the top-left of the Sprite.
Returns:
+ + +
+
+
+
+
+Returns true if the objects intersect, otherwise false.
+-
+
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:32 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:32 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Physics.html b/docs/Phaser.Physics.html index d52ac8e5..9379c4c4 100644 --- a/docs/Phaser.Physics.html +++ b/docs/Phaser.Physics.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:31 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:32 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Plugin.html b/docs/Phaser.Plugin.html index eda6097c..4816bc54 100644 --- a/docs/Phaser.Plugin.html +++ b/docs/Phaser.Plugin.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:32 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:32 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.PluginManager.html b/docs/Phaser.PluginManager.html index 70d82f0c..8e608895 100644 --- a/docs/Phaser.PluginManager.html +++ b/docs/Phaser.PluginManager.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:32 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:32 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Point.html b/docs/Phaser.Point.html index eac2ec37..3290f887 100644 --- a/docs/Phaser.Point.html +++ b/docs/Phaser.Point.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:32 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:32 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Pointer.html b/docs/Phaser.Pointer.html index b83546a3..260e519c 100644 --- a/docs/Phaser.Pointer.html +++ b/docs/Phaser.Pointer.html @@ -90,6 +90,10 @@ Device +
-
@@ -4354,13 +4348,13 @@ If you wish to check if the Pointer was released just once then see the Sprite.e
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Called internall by the Input Manager.
+Called by the Input Manager.
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:32 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:32 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Polygon.html b/docs/Phaser.Polygon.html index e2f43bb0..026558c8 100644 --- a/docs/Phaser.Polygon.html +++ b/docs/Phaser.Polygon.html @@ -90,6 +90,10 @@ Device +
new PIXI.Polygon(x,y, x,y, x,
-Array.<Phaser.Point>
+Array.<Phaser.Point>
|
-Array.<number>
+Array.<number>
@@ -699,13 +693,13 @@ arguments passed can be flat x,y values e.g. new PIXI.Polygon(x,y, x,y, x,
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:32 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:33 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Phaser.QuadTree.html b/docs/Phaser.QuadTree.html
index b53274fc..83f23cd6 100644
--- a/docs/Phaser.QuadTree.html
+++ b/docs/Phaser.QuadTree.html
@@ -90,6 +90,10 @@
Device
+
+ DOMSprite
+
+
Easing
@@ -162,6 +166,14 @@
GameObjectFactory
+
+ Gamepad
+
+
+
+ GamepadButton
+
+
Graphics
@@ -186,6 +198,10 @@
Keyboard
+
+ Line
+
+
LinkedList
@@ -278,6 +294,10 @@
Signal
+
+ SinglePad
+
+
Sound
@@ -342,6 +362,10 @@
Timer
+
+ TimerEvent
+
+
Touch
@@ -374,36 +398,6 @@
-
- Global
-
-
-
-
@@ -427,8 +421,9 @@
QuadTree
- A QuadTree implementation. The original code was a conversion of the Java code posted to GameDevTuts. However I've tweaked
-it massively to add node indexing, removed lots of temp. var creation and significantly increased performance as a result. Original version at https://github.com/timohausmann/quadtree-js/
+ A QuadTree implementation. The original code was a conversion of the Java code posted to GameDevTuts.
+However I've tweaked it massively to add node indexing, removed lots of temp. var creation and significantly increased performance as a result.
+Original version at https://github.com/timohausmann/quadtree-js/
@@ -439,7 +434,7 @@ it massively to add node indexing, removed lots of temp. var creation and signif
- new QuadTree(physicsManager, x, y, width, height, maxObjects, maxLevels, level)
+ new QuadTree(x, y, width, height, maxObjects, maxLevels, level)
@@ -469,8 +464,12 @@ it massively to add node indexing, removed lots of temp. var creation and signif
Type
+ Argument
+
+ Default
+
Description
@@ -479,29 +478,6 @@ it massively to add node indexing, removed lots of temp. var creation and signif
-
-
- physicsManager
-
-
-Description
-
-
-
-
-
-
-
-
-
- Description.
-
-
-
x
-Description
+number
+
+
+
+
+
+
- Description.
+
+
+
+
+ The top left coordinate of the quadtree.
@@ -533,17 +521,29 @@ it massively to add node indexing, removed lots of temp. var creation and signif
-Description
+number
+
+
+
+
+
+
- Description.
+
+
+
+
+ The top left coordinate of the quadtree.
+
+
+
+
+
- The width of your game in game pixels.
+
+
+
+
+ The width of the quadtree in pixels.
+
+
+
+
+
- The height of your game in game pixels.
+
+
+
+
+ The height of the quadtree in pixels.
+
+ <optional>
+
+
+
+
+
- Description.
+
+ 10
+
+
+
+
+ The maximum number of objects per node.
+
+ <optional>
+
+
+
+
+
- Description.
+
+ 4
+
+
+
+
+ The maximum number of levels to iterate to.
+
+ <optional>
+
+
+
+
+
- Description.
+
+ 0
+
+
+
+
+ Which level is this?
Source:
+Phaser.Rectangle
+|
+
object
@@ -865,7 +940,7 @@ Determine which node the object belongs to.
- Description.
The bounds in which to check.
Source:
/*
-Insert the object into the node. If the node
-exceeds the capacity, it will split and add all
-objects to their corresponding subnodes.
+Insert the object into the node. If the node exceeds the capacity, it will split and add all objects to their corresponding subnodes.
@@ -999,6 +1072,9 @@ objects to their corresponding subnodes.
+Phaser.Physics.Arcade.Body
+|
+
object
@@ -1009,7 +1085,7 @@ objects to their corresponding subnodes.
- Description.
The Body object to insert into the quadtree.
Source:
- retrieve(rect) → {array}
+ populate(group)
@@ -1078,7 +1154,7 @@ objects to their corresponding subnodes.
/*
-Return all objects that could collide with the given object.
+Populates this quadtree with the members of the given Group.
@@ -1112,13 +1188,13 @@ Return all objects that could collide with the given object.
- rectgroup
-object
+Phaser.Group
@@ -1128,7 +1204,7 @@ Return all objects that could collide with the given object.
- Description.
The Group to add to the quadtree.
@@ -1160,7 +1236,245 @@ Return all objects that could collide with the given object.
Source:
+ populateHandler(sprite)
+
+
+
+
+
+
+
+ /*
+Handler for the populate method.
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ sprite
+
+
+Phaser.Sprite
+
+
+
+
+
+
+
+
+
+ The Sprite to check.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ math/QuadTree.js, line 96
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ retrieve(sprite) → {array}
+
+
+
+
+
+
+
+ /*
+Return all objects that could collide with the given Sprite.
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ sprite
+
+
+Phaser.Sprite
+
+
+
+
+
+
+
+
+
+ The sprite to check against.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ - Source:
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:32 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:33 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Phaser.RandomDataGenerator.html b/docs/Phaser.RandomDataGenerator.html
index 3671e6c9..6e2c5b66 100644
--- a/docs/Phaser.RandomDataGenerator.html
+++ b/docs/Phaser.RandomDataGenerator.html
@@ -90,6 +90,10 @@
Device
+
+ DOMSprite
+
+
Easing
@@ -162,6 +166,14 @@
GameObjectFactory
+
+ Gamepad
+
+
+
+ GamepadButton
+
+
Graphics
@@ -186,6 +198,10 @@
Keyboard
+
+ Line
+
+
LinkedList
@@ -278,6 +294,10 @@
Signal
+
+ SinglePad
+
+
Sound
@@ -342,6 +362,10 @@
Timer
+
+ TimerEvent
+
+
Touch
@@ -374,36 +398,6 @@
-
- Global
-
-
-
-
@@ -1156,7 +1150,7 @@ Random number generator from
-Array
+Array
@@ -1927,7 +1921,7 @@ Random number generator from
-Array
+Array
@@ -2037,13 +2031,13 @@ Random number generator from
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:33 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:33 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Phaser.Rectangle.html b/docs/Phaser.Rectangle.html
index 7dba884f..0472e0e8 100644
--- a/docs/Phaser.Rectangle.html
+++ b/docs/Phaser.Rectangle.html
@@ -90,6 +90,10 @@
Device
+
+ DOMSprite
+
+
Easing
@@ -162,6 +166,14 @@
GameObjectFactory
+
+ Gamepad
+
+
+
+ GamepadButton
+
+
Graphics
@@ -186,6 +198,10 @@
Keyboard
+
+ Line
+
+
LinkedList
@@ -278,6 +294,10 @@
Signal
+
+ SinglePad
+
+
Sound
@@ -342,6 +362,10 @@
Timer
+
+ TimerEvent
+
+
Touch
@@ -374,36 +398,6 @@
-
- Global
-
-
-
-
@@ -752,7 +746,7 @@
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:33 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:33 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Phaser.RenderTexture.html b/docs/Phaser.RenderTexture.html
index 223d59e0..d3854fb4 100644
--- a/docs/Phaser.RenderTexture.html
+++ b/docs/Phaser.RenderTexture.html
@@ -90,6 +90,10 @@
Device
+
+ DOMSprite
+
+
Easing
@@ -162,6 +166,14 @@
GameObjectFactory
+
+ Gamepad
+
+
+
+ GamepadButton
+
+
Graphics
@@ -186,6 +198,10 @@
Keyboard
+
+ Line
+
+
LinkedList
@@ -278,6 +294,10 @@
Signal
+
+ SinglePad
+
+
Sound
@@ -342,6 +362,10 @@
Timer
+
+ TimerEvent
+
+
Touch
@@ -374,36 +398,6 @@
-
- Global
-
-
-
-
@@ -1356,6 +1350,612 @@
+ Methods
+
+
+
+-
+
render(displayObject, position, clear, renderHidden)
+
+
+
+-
+
+
+
+
This function will draw the display object to the texture. If the display object is a Group or has children it will
+draw all children as well.
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Argument
+
+
+
+ Default
+
+
+ Description
+
+
+
+
+
+
+
+
+ displayObject
+
+
+DisplayObject
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The display object to render this texture on.
+
+
+
+
+
+ position
+
+
+Phaser.Point
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Where to draw the display object.
+
+
+
+
+
+ clear
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ false
+
+
+
+
+ If true the texture will be cleared before the displayObject is drawn.
+
+
+
+
+
+ renderHidden
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ false
+
+
+
+
+ If true displayObjects that have their visible property set to false will still be rendered.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
renderXY(displayObject, x, y, clear, renderHidden)
+
+
+
+-
+
+
+
+
This function will draw the display object to the texture at the given x/y coordinates.
+If the display object is a Group or has children it will draw all children as well.
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Argument
+
+
+
+ Default
+
+
+ Description
+
+
+
+
+
+
+
+
+ displayObject
+
+
+DisplayObject
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The display object to render this texture on.
+
+
+
+
+
+ x
+
+
+number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The x coordinate to draw the display object at.
+
+
+
+
+
+ y
+
+
+number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The y coordinate to draw the display object at.
+
+
+
+
+
+ clear
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ false
+
+
+
+
+ If true the texture will be cleared before the displayObject is drawn.
+
+
+
+
+
+ renderHidden
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ false
+
+
+
+
+ If true displayObjects that have their visible property set to false will still be rendered.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
resize()
+
+
+
+-
+
+
+
+
Resizes the RenderTexture.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1374,13 +1974,13 @@
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:33 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:33 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Phaser.RequestAnimationFrame.html b/docs/Phaser.RequestAnimationFrame.html
index d22978ad..724525ad 100644
--- a/docs/Phaser.RequestAnimationFrame.html
+++ b/docs/Phaser.RequestAnimationFrame.html
@@ -90,6 +90,10 @@
Device
+
+ DOMSprite
+
+
Easing
@@ -162,6 +166,14 @@
GameObjectFactory
+
+ Gamepad
+
+
+
+ GamepadButton
+
+
Graphics
@@ -186,6 +198,10 @@
Keyboard
+
+ Line
+
+
LinkedList
@@ -278,6 +294,10 @@
Signal
+
+ SinglePad
+
+
Sound
@@ -342,6 +362,10 @@
Timer
+
+ TimerEvent
+
+
Touch
@@ -374,36 +398,6 @@
-
- Global
-
-
-
-
@@ -969,7 +963,7 @@
- Starts the requestAnimatioFrame running or setTimeout if unavailable in browser
+ Starts the requestAnimationFrame running or setTimeout if unavailable in browser
@@ -1303,13 +1297,13 @@
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:33 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:33 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Phaser.Signal.html b/docs/Phaser.Signal.html
index 795afa0f..176d68b9 100644
--- a/docs/Phaser.Signal.html
+++ b/docs/Phaser.Signal.html
@@ -90,6 +90,10 @@
Device
+
+ DOMSprite
+
+
Easing
@@ -162,6 +166,14 @@
GameObjectFactory
+
+ Gamepad
+
+
+
+ GamepadButton
+
+
Graphics
@@ -186,6 +198,10 @@
Keyboard
+
+ Line
+
+
LinkedList
@@ -278,6 +294,10 @@
Signal
+
+ SinglePad
+
+
Sound
@@ -342,6 +362,10 @@
Timer
+
+ TimerEvent
+
+
Touch
@@ -374,36 +398,6 @@
-
- Global
-
-
-
-
@@ -2288,13 +2282,13 @@ IMPORTANT: should be called only during signal dispatch, calling it before/after
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:33 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:33 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Phaser.SinglePad.html b/docs/Phaser.SinglePad.html
new file mode 100644
index 00000000..5452d373
--- /dev/null
+++ b/docs/Phaser.SinglePad.html
@@ -0,0 +1,3822 @@
+
+
+
+
+
+ Phaser Class: SinglePad
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Class: SinglePad
+
+
+
+
+ Phaser.
+
+ SinglePad
+
+
+ A single Phaser Gamepad
+
+
+
+
+
+
+
+
+
+
+ new SinglePad(game, padParent)
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ game
+
+
+Phaser.Game
+
+
+
+
+
+
+
+
+
+ Current game instance.
+
+
+
+
+
+ padParent
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The parent Phaser.Gamepad object (all gamepads reside under this)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Members
+
+
+
+-
+
_index
+
+
+
+-
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ index
+
+
+number
+
+
+
+
+
+
+
+
+
+ The gamepad index as per browsers data
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Default Value:
+ - null
- Source:
+
+
+
+
+
+
+
+
+-
+
_padParent
+
+
+
+-
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ padParent
+
+
+Phaser.Gamepad
+
+
+
+
+
+
+
+
+
+ Main Phaser Gamepad object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+-
+
callbackContext
+
+
+
+-
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ callbackContext
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The context under which the callbacks are run.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+-
+
<readonly> connected
+
+
+
+-
+
+
+
Whether or not this particular gamepad is connected or not.
+
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ connected
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ Whether or not this particular gamepad is connected or not.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+-
+
deadZone
+
+
+
+-
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ deadZone
+
+
+number
+
+
+
+
+
+
+
+
+
+ Dead zone for axis feedback - within this value you won't trigger updates.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+-
+
game
+
+
+
+-
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ game
+
+
+Phaser.Game
+
+
+
+
+
+
+
+
+
+ Local reference to game.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+-
+
<readonly> index
+
+
+
+-
+
+
+
Gamepad index as per browser data
+
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ index
+
+
+number
+
+
+
+
+
+
+
+
+
+ The gamepad index, used to identify specific gamepads in the browser
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+-
+
onAxisCallback
+
+
+
+-
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ onAxisCallback
+
+
+function
+
+
+
+
+
+
+
+
+
+ This callback is invoked every time an axis is changed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+-
+
onConnectCallback
+
+
+
+-
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ onConnectCallback
+
+
+function
+
+
+
+
+
+
+
+
+
+ This callback is invoked every time this gamepad is connected
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+-
+
onDisconnectCallback
+
+
+
+-
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ onDisconnectCallback
+
+
+function
+
+
+
+
+
+
+
+
+
+ This callback is invoked every time this gamepad is disconnected
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+-
+
onDownCallback
+
+
+
+-
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ onDownCallback
+
+
+function
+
+
+
+
+
+
+
+
+
+ This callback is invoked every time a button is pressed down.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+-
+
onFloatCallback
+
+
+
+-
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ onFloatCallback
+
+
+function
+
+
+
+
+
+
+
+
+
+ This callback is invoked every time a button is changed to a value where value > 0 and value < 1.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+-
+
onUpCallback
+
+
+
+-
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ onUpCallback
+
+
+function
+
+
+
+
+
+
+
+
+
+ This callback is invoked every time a gamepad button is released.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+-
+
addButton(buttonCode) → {Phaser.GamepadButton}
+
+
+
+-
+
+
+
+
If you need more fine-grained control over a Key you can create a new Phaser.Key object via this method.
+The Key object can then be polled, have events attached to it, etc.
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ buttonCode
+
+
+number
+
+
+
+
+
+
+
+
+
+ The buttonCode of the button, i.e. Phaser.Gamepad.BUTTON_0 or Phaser.Gamepad.BUTTON_1
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+
+
+
+ The GamepadButton object which you can store locally and reference directly.
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Phaser.GamepadButton
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
buttonValue(buttonCode) → {boolean}
+
+
+
+-
+
+
+
+
Returns the value of a gamepad button. Intended mainly for cases when you have floating button values, for example
+analog trigger buttons on the XBOX 360 controller
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ buttonCode
+
+
+number
+
+
+
+
+
+
+
+
+
+ The buttonCode of the button to check.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+
+
+
+ Button value if available otherwise false.
+
+
+
+
+
+ -
+ Type
+
+ -
+
+boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
connect(rawPad)
+
+
+
+-
+
+
+
+
Gamepad connect function, should be called by Phaser.Gamepad
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ rawPad
+
+
+Object
+
+
+
+
+
+
+
+
+
+ The raw gamepad object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
disconnect()
+
+
+
+-
+
+
+
+
Gamepad disconnect function, should be called by Phaser.Gamepad
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
isDown(axisCode) → {number}
+
+
+
+-
+
+
+
+
Returns value of requested axis
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ axisCode
+
+
+number
+
+
+
+
+
+
+
+
+
+ The index of the axis to check
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+
+
+
+ Axis value if available otherwise false
+
+
+
+
+
+ -
+ Type
+
+ -
+
+number
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
isDown(buttonCode) → {boolean}
+
+
+
+-
+
+
+
+
Returns true if the button is currently pressed down.
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ buttonCode
+
+
+number
+
+
+
+
+
+
+
+
+
+ The buttonCode of the key to check.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+
+
+
+ True if the key is currently down.
+
+
+
+
+
+ -
+ Type
+
+ -
+
+boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
justPressed(buttonCode, duration) → {boolean}
+
+
+
+-
+
+
+
+
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).
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Argument
+
+
+
+ Default
+
+
+ Description
+
+
+
+
+
+
+
+
+ buttonCode
+
+
+number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The buttonCode of the button to check for.
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ 250
+
+
+
+
+ The duration below which the button is considered as being just released.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+
+
+
+ True if the button is just released otherwise false.
+
+
+
+
+
+ -
+ Type
+
+ -
+
+boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
justPressed(buttonCode, duration) → {boolean}
+
+
+
+-
+
+
+
+
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).
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Argument
+
+
+
+ Default
+
+
+ Description
+
+
+
+
+
+
+
+
+ buttonCode
+
+
+number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The buttonCode of the button to check for.
+
+
+
+
+
+ duration
+
+
+number
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ 250
+
+
+
+
+ The duration below which the button is considered as being just pressed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+
+
+
+ True if the button is just pressed otherwise false.
+
+
+
+
+
+ -
+ Type
+
+ -
+
+boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
pollStatus()
+
+
+
+-
+
+
+
+
Main update function, should be called by Phaser.Gamepad
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
processAxisChange(axisState)
+
+
+
+-
+
+
+
+
Handles changes in axis
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ axisState
+
+
+Object
+
+
+
+
+
+
+
+
+
+ State of the relevant axis
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
processButtonDown(buttonCode, value)
+
+
+
+-
+
+
+
+
Handles button down press
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ buttonCode
+
+
+number
+
+
+
+
+
+
+
+
+
+ Which buttonCode of this button
+
+
+
+
+
+ value
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Button value
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
processButtonFloat(buttonCode, value)
+
+
+
+-
+
+
+
+
Handles buttons with floating values (like analog buttons that acts almost like an axis but still registers like a button)
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ buttonCode
+
+
+number
+
+
+
+
+
+
+
+
+
+ Which buttonCode of this button
+
+
+
+
+
+ value
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Button value (will range somewhere between 0 and 1, but not specifically 0 or 1.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
processButtonUp(buttonCode, value)
+
+
+
+-
+
+
+
+
Handles button release
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ buttonCode
+
+
+number
+
+
+
+
+
+
+
+
+
+ Which buttonCode of this button
+
+
+
+
+
+ value
+
+
+Object
+
+
+
+
+
+
+
+
+
+ Button value
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+-
+
reset()
+
+
+
+-
+
+
+
+
Reset all buttons/axes of this gamepad
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/Phaser.Sound.html b/docs/Phaser.Sound.html
index df0232b4..c8bf2e3f 100644
--- a/docs/Phaser.Sound.html
+++ b/docs/Phaser.Sound.html
@@ -90,6 +90,10 @@
Device
+
+ DOMSprite
+
+
Easing
@@ -162,6 +166,14 @@
GameObjectFactory
+
+ Gamepad
+
+
+
+ GamepadButton
+
+
Graphics
@@ -186,6 +198,10 @@
Keyboard
+
+ Line
+
+
LinkedList
@@ -278,6 +294,10 @@
Signal
+
+ SinglePad
+
+
Sound
@@ -342,6 +362,10 @@
Timer
+
+ TimerEvent
+
+
Touch
@@ -374,36 +398,6 @@
-
- Global
-
-
-
-
@@ -1503,7 +1497,7 @@
Source:
Source:
Source:
Source:
Source:
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:33 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:34 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Phaser.SoundManager.html b/docs/Phaser.SoundManager.html
index 98fb3406..4c50e2f2 100644
--- a/docs/Phaser.SoundManager.html
+++ b/docs/Phaser.SoundManager.html
@@ -90,6 +90,10 @@
Device
+
+ DOMSprite
+
+
Easing
@@ -162,6 +166,14 @@
GameObjectFactory
+
+ Gamepad
+
+
+
+ GamepadButton
+
+
Graphics
@@ -186,6 +198,10 @@
Keyboard
+
+ Line
+
+
LinkedList
@@ -278,6 +294,10 @@
Signal
+
+ SinglePad
+
+
Sound
@@ -342,6 +362,10 @@
Timer
+
+ TimerEvent
+
+
Touch
@@ -374,36 +398,6 @@
-
- Global
-
-
-
-
@@ -1075,7 +1069,7 @@ Note: On Firefox 25+ on Linux if you have media.gstreamer disabled in about:conf
Source:
Source:
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:33 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:34 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Phaser.Sprite.html b/docs/Phaser.Sprite.html
index 0f01f12b..8338ac67 100644
--- a/docs/Phaser.Sprite.html
+++ b/docs/Phaser.Sprite.html
@@ -90,6 +90,10 @@
Device
+
+ DOMSprite
+
+
Easing
@@ -162,6 +166,14 @@
GameObjectFactory
+
+ Gamepad
+
+
+
+ GamepadButton
+
+
Graphics
@@ -186,6 +198,10 @@
Keyboard
+
+ Line
+
+
LinkedList
@@ -278,6 +294,10 @@
Signal
+
+ SinglePad
+
+
Sound
@@ -342,6 +362,10 @@
Timer
+
+ TimerEvent
+
+
Touch
@@ -374,36 +398,6 @@
-
- Global
-
-
-
-
@@ -979,7 +973,7 @@ If you wish to work in radians instead of degrees use the property Sprite.rotati
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
+ debug
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ debug
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ Handy flag to use with Game.enableStep
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Default Value:
+ - false
- Source:
+
+
+
+
+
+
+
+
+
+ <readonly> deltaX
+
+
+
+
+
+
+ Returns the delta x value. The difference between Sprite.x now and in the previous step.
+
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ deltaX
+
+
+number
+
+
+
+
+
+
+
+
+
+ The delta value. Positive if the motion was to the right, negative if to the left.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+ <readonly> deltaY
+
+
+
+
+
+
+ Returns the delta x value. The difference between Sprite.y now and in the previous step.
+
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ deltaY
+
+
+number
+
+
+
+
+
+
+
+
+
+ The delta value. Positive if the motion was downwards, negative if upwards.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
@@ -2439,7 +2750,7 @@ The crop is only applied if you have set Sprite.cropEnabled to true.
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
+ <readonly> worldCenterX
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ worldCenterX
+
+
+number
+
+
+
+
+
+
+
+
+
+ The center of the Sprite in world coordinates.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+ <readonly> worldCenterY
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ worldCenterY
+
+
+number
+
+
+
+
+
+
+
+
+
+ The center of the Sprite in world coordinates.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
@@ -5199,7 +5714,7 @@ bought to the top of that Group, not the entire display list.
Source:
Source:
Source:
Source:
- getLocalPosition(p, x, y, sx, sy) → {Phaser.Point}
+ getLocalPosition(p, x, y) → {Phaser.Point}
@@ -5765,53 +6280,7 @@ Mostly only used internally.
- x coordinate within the Sprite to translate.
-
- sx
-
-
-number
-
-
-
-
-
-
-
-
-
- Scale factor to be applied.
-
-
-
-
-
- sy
-
-
-number
-
-
-
-
-
-
-
-
-
- Scale factor to be applied.
y coordinate within the Sprite to translate.
@@ -5843,7 +6312,7 @@ Mostly only used internally.
Source:
- getLocalUnmodifiedPosition(p, x, y) → {Phaser.Point}
+ getLocalUnmodifiedPosition(p, gx, gy) → {Phaser.Point}
@@ -5960,7 +6429,7 @@ Mostly only used internally by the Input Manager, but also useful for custom hit
- xgx
@@ -5983,7 +6452,7 @@ Mostly only used internally by the Input Manager, but also useful for custom hit
- ygy
@@ -5999,7 +6468,7 @@ Mostly only used internally by the Input Manager, but also useful for custom hit
- x coordinate within the Sprite to translate.
y coordinate within the Sprite to translate.
@@ -6031,7 +6500,7 @@ Mostly only used internally by the Input Manager, but also useful for custom hit
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:33 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:34 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Phaser.Stage.html b/docs/Phaser.Stage.html
index 02c2381b..bace5b63 100644
--- a/docs/Phaser.Stage.html
+++ b/docs/Phaser.Stage.html
@@ -90,6 +90,10 @@
Device
+
+ DOMSprite
+
+
Easing
@@ -162,6 +166,14 @@
GameObjectFactory
+
+ Gamepad
+
+
+
+ GamepadButton
+
+
Graphics
@@ -186,6 +198,10 @@
Keyboard
+
+ Line
+
+
LinkedList
@@ -278,6 +294,10 @@
Signal
+
+ SinglePad
+
+
Sound
@@ -342,6 +362,10 @@
Timer
+
+ TimerEvent
+
+
Touch
@@ -374,36 +398,6 @@
-
- Global
-
-
-
-
@@ -703,7 +697,7 @@ focus handling, game resizing, scaling and the pause, boot and orientation scree
Source:
Source:
Reference to the newly created <canvas> element.
Reference to the newly created canvas element.
Source:
Source:
-
- core/Stage.js, line 75
+ core/Stage.js, line 89
+
+ disableVisibilityChange
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ disableVisibilityChange
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ By default if the browser tab loses focus the game will pause. You can stop that behaviour by setting this property to true.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Default Value:
+ - false
- Source:
+ -
+ core/Stage.js, line 77
+
+
+
+
+
+
+
+
+
+ display
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ display
+
+
+PIXI.Stage
+
+
+
+
+
+
+
+
+
+ The Pixi Stage which is hooked to the renderer.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ - Source:
- Source:
- Source:
+-
+
<protected> parseConfig()
+
+
+
+-
+
+
+
+
Parses a Game configuration object.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ core/Stage.js, line 105
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
update()
@@ -1491,7 +1761,7 @@ focus handling, game resizing, scaling and the pause, boot and orientation scree
- Source:
- Source:
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:34 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:34 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Phaser.StageScaleMode.html b/docs/Phaser.StageScaleMode.html
index 33c6baa3..72ea2c10 100644
--- a/docs/Phaser.StageScaleMode.html
+++ b/docs/Phaser.StageScaleMode.html
@@ -90,6 +90,10 @@
Device
+
+ DOMSprite
+
+
Easing
@@ -162,6 +166,14 @@
GameObjectFactory
+
+ Gamepad
+
+
+
+ GamepadButton
+
+
Graphics
@@ -186,6 +198,10 @@
Keyboard
+
+ Line
+
+
LinkedList
@@ -278,6 +294,10 @@
Signal
+
+ SinglePad
+
+
Sound
@@ -342,6 +362,10 @@
Timer
+
+ TimerEvent
+
+
Touch
@@ -374,36 +398,6 @@
-
- Global
-
-
-
-
@@ -2016,7 +2010,7 @@
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:34 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:34 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Phaser.State.html b/docs/Phaser.State.html
index 4abb2f28..d0a995ce 100644
--- a/docs/Phaser.State.html
+++ b/docs/Phaser.State.html
@@ -90,6 +90,10 @@
Device
+
+ DOMSprite
+
+
Easing
@@ -162,6 +166,14 @@
GameObjectFactory
+
+ Gamepad
+
+
+
+ GamepadButton
+
+
Graphics
@@ -186,6 +198,10 @@
Keyboard
+
+ Line
+
+
LinkedList
@@ -278,6 +294,10 @@
Signal
+
+ SinglePad
+
+
Sound
@@ -342,6 +362,10 @@
Timer
+
+ TimerEvent
+
+
Touch
@@ -374,36 +398,6 @@
-
- Global
-
-
-
-
@@ -2568,13 +2562,13 @@ If you need to use the loader, you may need to use them here.
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:34 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:34 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Phaser.StateManager.html b/docs/Phaser.StateManager.html
index 5443e918..bd5daaaf 100644
--- a/docs/Phaser.StateManager.html
+++ b/docs/Phaser.StateManager.html
@@ -90,6 +90,10 @@
Device
+
+ DOMSprite
+
+
Easing
@@ -162,6 +166,14 @@
GameObjectFactory
+
+ Gamepad
+
+
+
+ GamepadButton
+
+
Graphics
@@ -186,6 +198,10 @@
Keyboard
+
+ Line
+
+
LinkedList
@@ -278,6 +294,10 @@
Signal
+
+ SinglePad
+
+
Sound
@@ -342,6 +362,10 @@
Timer
+
+ TimerEvent
+
+
Touch
@@ -374,36 +398,6 @@
-
- Global
-
-
-
-
@@ -2134,7 +2128,8 @@
- Description.
+ Checks i a given phaser state is valid.
+State must exist and have at least one callback function registered..
@@ -2308,7 +2303,7 @@
Source:
+ getCurrentState()
+
+
+
+
+
+
+
+ Gets the current State.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+
+
+
+ Phaser.State
+
+
+
+
+
+
+
+
@@ -2426,7 +2501,7 @@
Source:
Source:
Source:
Source:
Source:
Source:
- <protected> setCurrentState(key)
-
-
-
-
-
-
-
- Sets the current State. Should not be called directly (use StateManager.start)
-
-
-
-
-
-
-
-
- Parameters:
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- key
-
-
-string
-
-
-
-
-
-
-
-
-
- State key.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Source:
- - Source:
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:34 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:34 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Phaser.Text.html b/docs/Phaser.Text.html
index 7fe0b27d..ea84a034 100644
--- a/docs/Phaser.Text.html
+++ b/docs/Phaser.Text.html
@@ -90,6 +90,10 @@
Device
+
+ DOMSprite
+
+
Easing
@@ -162,6 +166,14 @@
GameObjectFactory
+
+ Gamepad
+
+
+
+ GamepadButton
+
+
Graphics
@@ -186,6 +198,10 @@
Keyboard
+
+ Line
+
+
LinkedList
@@ -278,6 +294,10 @@
Signal
+
+ SinglePad
+
+
Sound
@@ -342,6 +362,10 @@
Timer
+
+ TimerEvent
+
+
Touch
@@ -374,36 +398,6 @@
-
- Global
-
-
-
-
@@ -446,7 +440,7 @@
- Create a new <code>Text</code>.
+ Create a new Text object.
@@ -968,7 +962,109 @@ If you wish to work in radians instead of degrees use the property Sprite.rotati
Source:
+ cameraOffset
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ cameraOffset
+
+
+Phaser.Point
+
+
+
+
+
+
+
+
+
+ If this object is fixed to the camera then use this Point to specify how far away from the Camera x/y it's rendered.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ - Source:
+
+
+
+
+
+
+
+
+ fixedToCamera
+
+
+
+
+
+
+ An object that is fixed to the camera ignores the position of any ancestors in the display list and uses its x/y coordinates as offsets from the top left of the camera.
+
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ fixedToCamera
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ Fixes this object to the Camera.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Default Value:
+ - false
- Source:
+
@@ -1285,7 +1490,7 @@ If you wish to work in radians instead of degrees use the property Sprite.rotati
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:34 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:35 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Phaser.Tile.html b/docs/Phaser.Tile.html
index 699e5fa3..c6710c82 100644
--- a/docs/Phaser.Tile.html
+++ b/docs/Phaser.Tile.html
@@ -90,6 +90,10 @@
Device
+
+ DOMSprite
+
+
Easing
@@ -162,6 +166,14 @@
GameObjectFactory
+
+ Gamepad
+
+
+
+ GamepadButton
+
+
Graphics
@@ -186,6 +198,10 @@
Keyboard
+
+ Line
+
+
LinkedList
@@ -278,6 +294,10 @@
Signal
+
+ SinglePad
+
+
Sound
@@ -342,6 +362,10 @@
Timer
+
+ TimerEvent
+
+
Touch
@@ -374,36 +398,6 @@
-
- Global
-
-
-
-
@@ -427,7 +421,7 @@
Tile
- A Tile is a single representation of a tile within a Tilemap.
+ A Tile is a representation of a single tile within the Tilemap.
@@ -438,7 +432,7 @@
- new Tile(tileset, index, x, y, width, height)
+ new Tile(layer, index, x, y, width, height)
@@ -446,7 +440,7 @@
- Create a new Tile object. Tiles live inside of Tilesets and are rendered via TilemapLayers.
+ Create a new Tile object.
@@ -480,13 +474,13 @@
- tilesetlayer
-Phaser.Tileset
+object
@@ -496,7 +490,7 @@
- The tileset this tile belongs to.
The layer in the Tilemap data that this tile belongs to.
@@ -686,6 +680,108 @@
+-
+
alpha
+
+
+
+-
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ alpha
+
+
+number
+
+
+
+
+
+
+
+
+
+ The alpha value at which this tile is drawn to the canvas.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ tilemap/Tile.js, line 55
+
+
+
+
+
+
+
+
-
<readonly> bottom
@@ -771,7 +867,316 @@
- Source:
+
+
+
+
+
+
+
+
+ callback
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ callback
+
+
+function
+
+
+
+
+
+
+
+
+
+ Tile collision callback.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Default Value:
+ - null
- Source:
+ -
+ tilemap/Tile.js, line 126
+
+
+
+
+
+
+
+
+
+ callbackContext
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ callbackContext
+
+
+object
+
+
+
+
+
+
+
+
+
+ The context in which the collision callback will be called.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ tilemap/Tile.js, line 132
+
+
+
+
+
+
+
+
+
+ <readonly> canCollide
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ canCollide
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ True if this tile can collide or has a collision callback.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ - Source:
- Source:
- Source:
- Source:
+
+
+
+
+
+
+
+
+ collides
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ collides
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ Does this tile collide at all?
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ - Source:
-
-
collisionCallback
+ faceBottom
@@ -1353,7 +1860,7 @@
- collisionCallbackfaceBottom
@@ -1369,7 +1876,7 @@
- Tilemap collision callback.
Is the bottom of this tile an interesting edge?
@@ -1394,14 +1901,11 @@
- - Default Value:
- - null
- Source:
-
-
collisionCallbackContext
+ faceLeft
@@ -1458,7 +1962,7 @@
- collisionCallbackfaceLeft
@@ -1474,7 +1978,7 @@
- Tilemap collision callback.
Is the left of this tile an interesting edge?
@@ -1503,7 +2007,211 @@
- Source:
+
+
+
+
+
+
+
+
+ faceRight
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ faceRight
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ Is the right of this tile an interesting edge?
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ -
+ tilemap/Tile.js, line 85
+
+
+
+
+
+
+
+
+
+ faceTop
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ faceTop
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ Is the top of this tile an interesting edge?
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ - Source:
The index of this tile within the tileset.
The index of this tile within the map data corresponding to the tileset.
-
-
mass
+ layer
@@ -1764,13 +2472,13 @@
- masslayer
-number
+object
@@ -1780,7 +2488,7 @@
- The virtual mass of the tile.
The layer in the Tilemap data that this tile belongs to.
@@ -1805,14 +2513,215 @@
- - Default Value:
- - 1.0
- Source:
+ -
+ tilemap/Tile.js, line 25
+
+
+
+
+
+
+
+
+
+ <readonly> left
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ left
+
+
+number
+
+
+
+
+
+
+
+
+
+ The x value.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source:
+
+
+
+
+
+
+
+
+ properties
+
+
+
+
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ properties
+
+
+object
+
+
+
+
+
+
+
+
+
+ Tile specific properties.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ - Source:
-
-
separateX
+ scanned
@@ -1971,7 +2880,7 @@
- separateXscanned
@@ -1987,7 +2896,7 @@
- Enable separation at x-axis.
Has this tile been walked / turned into a poly?
@@ -2012,14 +2921,11 @@
- - Default Value:
- - true
- Source:
-
-
separateY
+ <readonly> top
@@ -2076,13 +2982,13 @@
- separateYtop
-boolean
+number
@@ -2092,112 +2998,7 @@
- Enable separation at y-axis.
-
-
-
- - true
- - tilemap/Tile.js, line 100 -
tileset
- - --
-
-
-
- Source:
- @@ -2328,7 +3129,7 @@
- Source:
- @@ -2401,7 +3202,7 @@ -
- Source:
- @@ -2503,7 +3304,7 @@ -
- Source:
- @@ -2555,6 +3356,124 @@
-
+
copy(tile)
+ + +
+ -
+
+
+ ++ + + + + + + +
Copies the tile data and properties from the given tile to this tile.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +tile+ + +Phaser.Tile + + + + + + + + + +The tile to copy from.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + tilemap/Tile.js, line 205 +
+
+
+
+
+
+
+
+
+
+
+
-
destroy()
@@ -2597,7 +3516,7 @@- Source:
- @@ -2666,7 +3585,7 @@
- Source:
- @@ -2853,7 +3772,7 @@
- Source:
- @@ -2889,7 +3808,8 @@
- Source:
- @@ -3039,13 +3959,13 @@ - Phaser Copyright © 2012-2013 Photon Storm Ltd. + Phaser Copyright © 2012-2014 Photon Storm Ltd.
- + DOMSprite + +
- Easing @@ -162,6 +166,14 @@ GameObjectFactory +
- + Gamepad + + +
- + GamepadButton + +
- Graphics @@ -186,6 +198,10 @@ Keyboard +
- + Line + +
- LinkedList @@ -278,6 +294,10 @@ Signal +
- + SinglePad + +
- Sound @@ -342,6 +362,10 @@ Timer +
- + TimerEvent + +
- Touch @@ -374,36 +398,6 @@ -
- - Global - - - - @@ -438,7 +432,7 @@
-
-
new TileSprite(game, x, y, width, height, key, frame)
+new TileSprite(game, x, y, width, height, key)
@@ -621,32 +615,6 @@
-
- - Source:
- @@ -1025,11 +993,6 @@ If you wish to work in radians instead of degrees use the property Sprite.rotati -
- Inherited From: -
- - @@ -1044,7 +1007,7 @@ If you wish to work in radians instead of degrees use the property Sprite.rotati
- Source:
- @@ -1373,7 +1336,7 @@ A culled sprite has its renderable property set to 'false'.
- Source:
- @@ -1480,7 +1443,7 @@ A culled sprite has its renderable property set to 'false'.
- Source:
- @@ -1587,7 +1550,7 @@ A culled sprite has its renderable property set to 'false'.
- Source:
- @@ -1700,7 +1663,7 @@ It's used for Camera culling and physics body alignment.
- Source:
- @@ -1807,7 +1770,7 @@ It's used for Camera culling and physics body alignment.
- Source:
- @@ -1914,7 +1877,7 @@ It's used for Camera culling and physics body alignment.
- Source:
- @@ -2026,7 +1989,7 @@ The crop is only applied if you have set Sprite.cropEnabled to true.
- Source:
- @@ -2136,7 +2099,7 @@ The crop is only applied if you have set Sprite.cropEnabled to true.
- Source:
- @@ -2252,6 +2215,338 @@ The crop is only applied if you have set Sprite.cropEnabled to true. +
Properties:
- --
-
-
| Name | - - -Type | - - - - - -Description | -|
|---|---|---|---|
tileset |
-
-
- - - -Phaser.Tileset - - - - | - - - - - -The tileset this tile belongs to. |
+ The y value. |
The top-left corner of the tile within the tileset. |
+ The x map coordinate of this tile. |
@@ -2430,7 +3231,7 @@
The top-left corner of the tile within the tileset. |
+ The y map coordinate of this tile. |
@@ -2532,7 +3333,7 @@
frame |
-
-
- - - -string -| - -number - - - - | - - - - - -If this Sprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index. |
-
debug
+ + +-
+
+
+
- Inherited From: +
- + + + + + + + + + + + +
- Default Value: +
- false
+
+
+
+ - Source: +
- + + + + + + + +
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
debug |
+
+
+ + + +boolean + + + + | + + + + + +Handy flag to use with Game.enableStep |
+
<readonly> deltaX
+ + +
+
+
+
+
+
+
+Returns the delta x value. The difference between Sprite.x now and in the previous step.
+-
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
deltaX |
+
+
+ + + +number + + + + | + + + + + +The delta value. Positive if the motion was to the right, negative if to the left. |
+
<readonly> deltaY
+ + +
+
+
+
+
+
+
+Returns the delta x value. The difference between Sprite.y now and in the previous step.
+-
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + + +
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
deltaY |
+
+
+ + + +number + + + + | + + + + + +The delta value. Positive if the motion was downwards, negative if upwards. |
+
<readonly> worldCenterX
+ + +-
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
worldCenterX |
+
+
+ + + +number + + + + | + + + + + +The center of the Sprite in world coordinates. |
+
<readonly> worldCenterY
+ + +-
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + + + + + + +
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
worldCenterY |
+
+
+ + + +number + + + + | + + + + + +The center of the Sprite in world coordinates. |
+
getLocalPosition(p, x, y, sx, sy) → {Phaser.Point}
+getLocalPosition(p, x, y) → {Phaser.Point}
x coordinate within the Sprite to translate.
sxScale factor to be applied.
syScale factor to be applied.
y coordinate within the Sprite to translate.
getLocalUnmodifiedPosition(p, x, y) → {Phaser.Point}
+getLocalUnmodifiedPosition(p, gx, gy) → {Phaser.Point}
xgxygyx coordinate within the Sprite to translate.
y coordinate within the Sprite to translate.
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:35 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:35 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Tilemap.html b/docs/Phaser.Tilemap.html index 2d0976e6..feae7e2e 100644 --- a/docs/Phaser.Tilemap.html +++ b/docs/Phaser.Tilemap.html @@ -90,6 +90,10 @@ Device +
dirty
- - --
-
-
-
- Source: -
- @@ -1135,6 +1027,210 @@ A map may have multiple layers. You can perform operations on the map data such +
Properties:
- --
-
-
| Name | - - -Type | - - - - - -Description | -
|---|---|---|
dirty |
-
-
- - - -boolean - - - - | - - - - - -Internal rendering related flag. |
-
images
+ + +-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
images |
+
+
+ + + +array + + + + | + + + + + +An array of Tiled Image Layers. |
+
key
+ + +-
+
+
+
- Source: +
- + + + + + + +
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +The key of this map data in the Phaser.Cache. |
+
An array of Tilemap layers.
An array of Tilemap layer data.
objects
+ + +-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
objects |
+
+
+ + + +array + + + + | + + + + + +An array of Tiled Object Layers. |
+
tiles
+ + +-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
tiles |
+
+
+ + + +array + + + + | + + + + + +The super array of Tiles. |
+
tilesets
+ + +-
+
+
+
- Source: +
- @@ -1252,7 +1654,7 @@ A map may have multiple layers. You can perform operations on the map data such
-
-
calculateIndexes()
+addTilesetImage(tileset, key)
@@ -1260,7 +1662,8 @@ A map may have multiple layers. You can perform operations on the map data such
- Source:
- @@ -1496,6 +1991,12 @@ A map may have multiple layers. You can perform operations on the map data such number +| + +string +| + +Phaser.TilemapLayer @@ -1515,7 +2016,7 @@ A map may have multiple layers. You can perform operations on the map data such -
- Source:
- @@ -1734,7 +2235,7 @@ A map may have multiple layers. You can perform operations on the map data such
- Source:
- @@ -1803,7 +2304,7 @@ A map may have multiple layers. You can perform operations on the map data such
- Source:
- @@ -1872,7 +2373,7 @@ A map may have multiple layers. You can perform operations on the map data such
- Source:
- @@ -1908,7 +2409,7 @@ A map may have multiple layers. You can perform operations on the map data such
- Source:
- @@ -2193,7 +2700,7 @@ A map may have multiple layers. You can perform operations on the map data such
- Source:
- @@ -2501,7 +3014,7 @@ A map may have multiple layers. You can perform operations on the map data such
-
-
getTile(x, y, layer) → {number}
+getTile(x, y, layer) → {Phaser.Tile}
@@ -2614,6 +3127,12 @@ A map may have multiple layers. You can perform operations on the map data such
number
+|
+
+string
+|
+
+Phaser.TilemapLayer
@@ -2633,7 +3152,7 @@ A map may have multiple layers. You can perform operations on the map data such
- - Source:
- @@ -2690,7 +3209,7 @@ A map may have multiple layers. You can perform operations on the map data such
- -number +Phaser.Tile @@ -2716,7 +3235,7 @@ A map may have multiple layers. You can perform operations on the map data such
-
-
getTileWorldXY(x, y, layer) → {number}
+getTileWorldXY(x, y, layer) → {Phaser.Tile}
@@ -2829,6 +3348,12 @@ A map may have multiple layers. You can perform operations on the map data such
number
+|
+
+string
+|
+
+Phaser.TilemapLayer
@@ -2848,7 +3373,7 @@ A map may have multiple layers. You can perform operations on the map data such
- - Source:
- @@ -2905,7 +3430,7 @@ A map may have multiple layers. You can perform operations on the map data such
- -number +Phaser.Tile @@ -2931,7 +3456,7 @@ A map may have multiple layers. You can perform operations on the map data such
-
-
paste(x, y, tileblock, layer)
+paste(x, y, tileblock, layer)
@@ -2961,6 +3486,8 @@ A map may have multiple layers. You can perform operations on the map data such
- Source:
- @@ -3118,7 +3685,7 @@ A map may have multiple layers. You can perform operations on the map data such
-
-
putTile(index, x, y, layer)
+putTile(tile, x, y, layer)
@@ -3162,12 +3729,15 @@ A map may have multiple layers. You can perform operations on the map data such
- Source:
- @@ -3341,7 +3917,7 @@ A map may have multiple layers. You can perform operations on the map data such
-
-
putTileWorldXY(index, x, y, tileWidth, tileHeight, layer)
+putTileWorldXY(tile, x, y, tileWidth, tileHeight, layer)
@@ -3385,12 +3961,15 @@ A map may have multiple layers. You can perform operations on the map data such
- Source:
- @@ -3626,7 +4211,7 @@ A map may have multiple layers. You can perform operations on the map data such
-
-
random(tileA, tileB, x, y, width, height, layer)
+random(x, y, width, height, layer)
@@ -3668,68 +4253,6 @@ A map may have multiple layers. You can perform operations on the map data such
- - Source:
- @@ -3983,7 +4512,7 @@ A map may have multiple layers. You can perform operations on the map data such
- Source:
- @@ -4011,7 +4540,7 @@ A map may have multiple layers. You can perform operations on the map data such
-
-
replace(tileA, tileB, x, y, width, height, layer)
+replace(source, dest, x, y, width, height, layer)
@@ -4019,7 +4548,7 @@ A map may have multiple layers. You can perform operations on the map data such
- Source:
- @@ -4376,6 +4911,12 @@ A map may have multiple layers. You can perform operations on the map data such number +| + +string +| + +Phaser.TilemapLayer @@ -4385,7 +4926,7 @@ A map may have multiple layers. You can perform operations on the map data such -
- Source:
- @@ -4445,7 +4986,7 @@ A map may have multiple layers. You can perform operations on the map data such
-
-
shuffle(tileA, tileB, x, y, width, height, layer)
+shuffle(x, y, width, height, layer)
@@ -4462,6 +5003,266 @@ A map may have multiple layers. You can perform operations on the map data such
+ - Source: +
- + + + + + + + +
-
+
swapTile(tileA, tileB, x, y, width, height, layer)
+ + +
+ -
+
+
+ ++ + + + + + +
Scans the given area for tiles with an index matching tileA and swaps them with tileB.
+Parameters:
@@ -4682,6 +5483,12 @@ A map may have multiple layers. You can perform operations on the map data such number +| + +string +| + +Phaser.TilemapLayer @@ -4701,7 +5508,7 @@ A map may have multiple layers. You can perform operations on the map data such -The Tilemap Layer to operate on.
The layer to operate on.
- Source:
- - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
swapHandler(value, index)
- - -
- -
-
-
- -- - - - - - - -
Internal function that handles the swapping of tiles.
-Parameters:
- - -- -
- - - - -- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -value- - -number - - - - - - - - - -- - - - - - -index- - -number - - - - - - - - - -- -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
-
-
-
- -
-
swapTile(tileA, tileB, x, y, width, height)
- - -
- -
-
-
- -- - - - - - - -
Swap tiles with 2 kinds of indexes.
-Parameters:
- - -- -
- - - - -- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -tileA- - -number - - - - - - - - - -First tile index.
- - - - - -tileB- - -number - - - - - - - - - -Second tile index.
- - - - - -x- - -number - - - - - - - - - -X position of the top left of the area to operate one, given in tiles, not pixels.
- - - - - -y- - -number - - - - - - - - - -Y position of the top left of the area to operate one, given in tiles, not pixels.
- - - - - -width- - -number - - - - - - - - - -The width in tiles of the area to operate on.
- - - - - -height- - -number - - - - - - - - - -The height in tiles of the area to operate on.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- @@ -5152,13 +5585,13 @@ A map may have multiple layers. You can perform operations on the map data such - Phaser Copyright © 2012-2013 Photon Storm Ltd. + Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:34 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:35 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.TilemapLayer.html b/docs/Phaser.TilemapLayer.html index 074bbadf..6324e83e 100644 --- a/docs/Phaser.TilemapLayer.html +++ b/docs/Phaser.TilemapLayer.html @@ -90,6 +90,10 @@ Device +- + DOMSprite +
+- Easing
@@ -162,6 +166,14 @@ GameObjectFactory +- + Gamepad +
+ +- + GamepadButton +
+- Graphics
@@ -186,6 +198,10 @@ Keyboard +- + Line +
+- LinkedList
@@ -278,6 +294,10 @@ Signal +- + SinglePad +
+- Sound
@@ -342,6 +362,10 @@ Timer +- + TimerEvent +
+- Touch
@@ -374,36 +398,6 @@ -- - Global - - -
- @@ -438,7 +432,7 @@ -
-
new TilemapLayer(game, x, y, renderWidth, renderHeight, tileset, tilemap, layer)
+new TilemapLayer(game, tilemap, index, width, height)
@@ -501,124 +495,6 @@
- - Source:
- @@ -820,7 +742,109 @@
- Source:
- + + + + + + + + + + + + + + + +
-
+
cameraOffset
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- @@ -893,7 +917,7 @@ -
- Source:
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +cameraOffset+ + +Phaser.Point + + + + + + + + + +If this object is fixed to the camera then use this Point to specify how far away from the Camera x/y it's rendered.
The canvas to which this BitmapData draws.
The canvas to which this TilemapLayer draws.
+
+
+
+ -
+
collisionHeight
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +collisionHeight+ + +number + + + + + + + + + +The height of the collision tiles.
+
+
+
+ -
+
collisionWidth
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- @@ -1024,7 +1252,637 @@
- Source:
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +collisionWidth+ + +number + + + + + + + + + +The width of the collision tiles.
+
+
+
+ -
+
debug
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Default Value: +
- false
+
+
+
+ - Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +debug+ + +boolean + + + + + + + + + +If set to true the collideable tile edges path will be rendered. Only works when game is running in Phaser.CANVAS mode.
+
+
+
+ -
+
debugAlpha
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Default Value: +
- 0.5
+
+
+
+ - Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +debugAlpha+ + +number + + + + + + + + + +If debug is true then the tileset is rendered with this alpha level, to make the tile edges clearer.
+
+
+
+ -
+
debugCallbackColor
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Default Value: +
- "rgba(255, 0, 0, 1)"
+
+
+
+ - Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +debugCallbackColor+ + +string + + + + + + + + + +If debug is true this is the color used to outline the edges of tiles that have collision callbacks. Provide in hex or rgb/rgba string format.
+
+
+
+ -
+
debugColor
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Default Value: +
- "rgba(0, 255, 0, 1)"
+
+
+
+ - Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +debugColor+ + +string + + + + + + + + + +If debug is true this is the color used to outline the edges of collidable tiles. Provide in hex or rgb/rgba string format.
+
+
+
+ -
+
debugFill
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Default Value: +
- false
+
+
+
+ - Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +debugFill+ + +boolean + + + + + + + + + +If true the debug tiles are filled with debugFillColor AND stroked around.
+
+
+
+ -
+
debugFillColor
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Default Value: +
- "rgba(0, 255, 0, 0.2)"
+
+
+
+ - Source: +
- @@ -1126,7 +1984,7 @@
- Source:
- @@ -1151,7 +2009,7 @@
-
-@@ -1203,7 +2061,7 @@ -
A layer that is fixed to the camera ignores the position of any ancestors in the display list and uses its x/y coordinates as offsets from the top left of the camera.
+An object that is fixed to the camera ignores the position of any ancestors in the display list and uses its x/y coordinates as offsets from the top left of the camera.
Fixes this layer to the Camera.
Fixes this object to the Camera.
- Source:
- @@ -1337,109 +2195,7 @@
- Source:
- - - - - - - - -
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +debugFillColor+ + +string + + + + + + + + + +If debugFill is true this is the color used to fill the tiles. Provide in hex or rgb/rgba string format.
-
-
-
- -
-
<readonly> heightInPixels
- - -
- -
-
-
-
-
-
-
-
-
-
-
- Source: -
- @@ -1512,7 +2268,7 @@ -
- Source:
- @@ -1604,7 +2360,7 @@
- Source:
- @@ -1661,7 +2417,7 @@
-
-
renderHeight
+map
@@ -1700,13 +2456,13 @@
- Source:
- @@ -1763,7 +2519,7 @@
-
-
renderWidth
+name
@@ -1802,13 +2558,13 @@
- Source:
- @@ -1954,7 +2710,7 @@ half as quickly as the 'normal' camera-locked layers do)
- Source:
- @@ -2061,7 +2817,7 @@ half as quickly as the 'normal' camera-locked layers do)
- Source:
- @@ -2163,7 +2919,7 @@ half as quickly as the 'normal' camera-locked layers do)
- Source:
- @@ -2265,7 +3021,7 @@ half as quickly as the 'normal' camera-locked layers do)
- Source:
- @@ -2367,7 +3123,7 @@ half as quickly as the 'normal' camera-locked layers do)
- Source:
- @@ -2469,7 +3225,7 @@ half as quickly as the 'normal' camera-locked layers do)
- Source:
- @@ -2487,7 +3243,7 @@ half as quickly as the 'normal' camera-locked layers do)
-
-
tileHeight
+tileColor
@@ -2526,13 +3282,13 @@ half as quickly as the 'normal' camera-locked layers do)
- Source: -
- - - - - - - - -
Properties:
- --
-
-
- -
-- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -heightInPixels- - -number - - - - - - - - - -Do NOT recommend changing after the map is loaded!
+ The index of this layer within the Tilemap.
-number +object @@ -1614,7 +2370,7 @@ - Tilemap layer index.
The layer object within the Tilemap that this layer represents.
- @@ -1745,7 +2501,7 @@renderHeightmap-number +Phaser.Tilemap @@ -1716,7 +2472,7 @@ - The height of the area being rendered.
The Tilemap to which this layer is bound.
- @@ -1847,7 +2603,7 @@renderWidthname-number +string @@ -1818,7 +2574,7 @@ - The width of the area being rendered.
The name of the layer.
- @@ -2567,521 +3323,14 @@ half as quickly as the 'normal' camera-locked layers do) - - -tileHeighttileColor-number +string @@ -2542,7 +3298,7 @@ half as quickly as the 'normal' camera-locked layers do) -The height of a single tile in pixels.
If no tileset is given the tiles will be rendered as rectangles in this color. Provide in hex or rgb/rgba string format.
-
-
-
- -
-
tilemap
- - -
- -
-
-
-
-
-
-
-
-
-
-
- Default Value: +
- "rgb(255, 255, 255)"
- Source:
- - - - - - - - -
Properties:
- --
-
-
- -
-- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -tilemap- - -Phaser.Tilemap - - - - - - - - - -The Tilemap to which this layer is bound.
-
-
-
- -
-
tileMargin
- - -
- -
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Properties:
- --
-
-
- -
-- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -tileMargin- - -number - - - - - - - - - -The margin around the tiles.
-
-
-
- -
-
tileset
- - -
- -
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Properties:
- --
-
-
- -
-- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -tileset- - -Phaser.Tileset - - - - - - - - - -The tile set used for rendering.
-
-
-
- -
-
tileSpacing
- - -
- -
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Properties:
- --
-
-
- -
-- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -tileSpacing- - -number - - - - - - - - - -The spacing around the tiles.
-
-
-
- -
-
tileWidth
- - -
- -
-
-
-
-
-
-
-
-
-
-
- Source: -
- @@ -3183,109 +3432,7 @@ half as quickly as the 'normal' camera-locked layers do)
- Source:
- - - - - - - - -
Properties:
- --
-
-
- -
-- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -tileWidth- - -number - - - - - - - - - -The width of a single tile in pixels.
-
-
-
- -
-
<readonly> widthInPixels
- - -
- -
-
-
-
-
-
-
-
-
-
-
- Source: -
- @@ -3309,7 +3456,7 @@ half as quickly as the 'normal' camera-locked layers do)
-
-
deltaAbsX() → {number}
+getTiles(x, y, width, height, collides) → {array}
@@ -3317,375 +3464,7 @@ half as quickly as the 'normal' camera-locked layers do)
- Source: -
- - - - - - - - -
- - Type - -
- - -number - - - -
Properties:
- --
-
-
- -
-- - - - - - - -Name - - -Type - - - - - -Description -- - - - - -widthInPixels- - -number - - - - - - - - - -Do NOT recommend changing after the map is loaded!
-- - - - - - - - - -Returns the absolute delta x value.
--
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Returns:
- - --- - - -Absolute delta X value
--
-
-
-
-
- -
-
deltaAbsY() → {number}
- - -
- -
-
-
- -- - - - - - - - - -
Returns the absolute delta y value.
--
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Returns:
- - --- - - -Absolute delta Y value
--
-
- - Type - -
- - -number - - - -
-
-
-
- -
-
deltaX() → {number}
- - -
- -
-
-
- -- - - - - - - - - -
Returns the delta x value.
--
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Returns:
- - --- - - -Delta X value
--
-
- - Type - -
- - -number - - - -
-
-
-
- -
-
deltaY() → {number}
- - -
- -
-
-
- -- - - - - - - - - -
Returns the delta y value.
--
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
Returns:
- - --- - - -Delta Y value
--
-
- - Type - -
- - -number - - - -
-
-
-
- -
-
getTiles(x, y, width, height, collides) → {array}
- - -
- -
-
-
- -@@ -3707,8 +3486,12 @@ half as quickly as the 'normal' camera-locked layers do)
Get the tiles within the given area.
+Get all tiles that exist within the given area, defined by the top-left corner, width and height. Values given are in pixels, not tiles.
Type +Argument + +Default +Description @@ -3732,10 +3515,22 @@ half as quickly as the 'normal' camera-locked layers do) ++ + + + + -X position of the top left of the area to copy (given in tiles, not pixels)
+ + + + +X position of the top left corner.
+ + + + + -Y position of the top left of the area to copy (given in tiles, not pixels)
+ + + + +Y position of the top left corner.
+ + + + + -The width of the area to copy (given in tiles, not pixels)
+ + + + +Width of the area to get.
+ + + + + -The height of the area to copy (given in tiles, not pixels)
+ + + + +Height of the area to get.
+ + <optional> + + + +
+ + + + ++ + false + + If true only return tiles that collide on one or more faces.
- Source:
- @@ -4000,7 +3847,7 @@ half as quickly as the 'normal' camera-locked layers do)
- Source:
- @@ -4051,7 +3898,7 @@ half as quickly as the 'normal' camera-locked layers do)
-
-
getTileXY(x, y) → {Phaser.Tile}
+getTileXY(x, y, point) → {Phaser.Point|object}
@@ -4136,6 +3983,32 @@ half as quickly as the 'normal' camera-locked layers do)
+
+ - Source:
- @@ -4189,7 +4062,7 @@ half as quickly as the 'normal' camera-locked layers do)
- -Phaser.Tile +Phaser.Point +| + +object @@ -4305,7 +4181,7 @@ half as quickly as the 'normal' camera-locked layers do)
- Source:
- @@ -4351,6 +4227,75 @@ half as quickly as the 'normal' camera-locked layers do) +
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
tilesets |
+
+
+ + + +array + + + + | + + + + + +An array of Tilesets. |
+
-
@@ -1269,6 +1672,98 @@ A map may have multiple layers. You can perform operations on the map data such
+ Internal function that calculates the tile indexes for the map data.
+Adds an image to the map to be used as a tileset. A single map may use multiple tilesets. +Note that the tileset name can be found in the JSON file exported from Tiled, or in the Tiled editor.
Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
tileset |
+
+
+ + + +string + + + + | + + ++ + + + + + | + + + + +The name of the tileset as specified in the map data. |
+
key |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+
+ The key of the Phaser.Cache image used for this tileset. If not specified it will look for an image with a key matching the tileset parameter. |
+
-
@@ -1293,7 +1788,7 @@ A map may have multiple layers. You can perform operations on the map data such
The Tilemap Layer to operate on.
The layer to copy the tiles from.
-
@@ -1968,7 +2469,7 @@ A map may have multiple layers. You can perform operations on the map data such
- Fill a block with a specific tile index.
+Fills the given area with the specified tile.
Index of tiles you want to fill with.
The index of the tile that the area will be filled with.
The Tilemap Layer to operate on.
The layer to operate on.
-
@@ -2422,6 +2929,12 @@ A map may have multiple layers. You can perform operations on the map data such
number
+|
+
+string
+|
+
+Phaser.TilemapLayer
@@ -2441,7 +2954,7 @@ A map may have multiple layers. You can perform operations on the map data such
- For each tile in the given area (defined by x/y and width/height) run the given callback.
+For each tile in the given area defined by x/y and width/height run the given callback.
The Tilemap Layer to operate on.
The layer to operate on.
The Tilemap Layer to operate on.
The layer to get the tile from.
-
@@ -2701,7 +3220,7 @@ A map may have multiple layers. You can perform operations on the map data such
The index of the tile at the given coordinates.
+The tile at the given coordinates.
The Tilemap Layer to operate on.
The layer to get the tile from.
-
@@ -2916,7 +3441,7 @@ A map may have multiple layers. You can perform operations on the map data such
The index of the tile at the given coordinates.
+The tile at the given coordinates.
+ + + + + +
The Tilemap Layer to operate on.
The layer to paste the tiles into.
indextileThe index of this tile to set.
The index of this tile to set or a Phaser.Tile object.
The Tilemap Layer to operate on.
The layer to modify.
indextileThe index of the tile to put into the layer.
The index of this tile to set or a Phaser.Tile object.
The Tilemap Layer to operate on.
The layer to modify.
tileAFirst tile index.
tileBSecond tile index.
xThe Tilemap Layer to operate on.
The layer to operate on.
-
@@ -4055,7 +4584,7 @@ A map may have multiple layers. You can perform operations on the map data such
Replaces one type of tile with another in the given area (defined by x/y and width/height).
+Scans the given area for tiles with an index matching source and updates their index to match dest.
tileAsourceFirst tile index.
The tile index value to scan for.
tileBdestSecond tile index.
The tile index value to replace found tiles with.
The Tilemap Layer to operate on.
The layer to operate on.
Sets the current layer to the given index.
The layer to set as current.
Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
x |
+
+
+ + + +number + + + + | + + ++ + + + + + | + + + + +X position of the top left of the area to operate one, given in tiles, not pixels. |
+
y |
+
+
+ + + +number + + + + | + + ++ + + + + + | + + + + +Y position of the top left of the area to operate one, given in tiles, not pixels. |
+
width |
+
+
+ + + +number + + + + | + + ++ + + + + + | + + + + +The width in tiles of the area to operate on. |
+
height |
+
+
+ + + +number + + + + | + + ++ + + + + + | + + + + +The height in tiles of the area to operate on. |
+
layer |
+
+
+ + + +number +| + +string +| + +Phaser.TilemapLayer + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+
+ The layer to operate on. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
xThe x coordinate of this layer.
yThe y coordinate of this layer.
renderWidthWidth of the layer.
renderHeightHeight of the layer.
tilesetThe tile set used for rendering.
tilemaplayerindexThe layer index within the map.
The layer index within the map that this TilemapLayer represents.
widthWidth of the renderable area of the layer.
heightHeight of the renderable area of the layer.
pointThe Point object to set the x and y values on.
-
@@ -4200,7 +4073,10 @@ half as quickly as the 'normal' camera-locked layers do)
The tile with specific properties.
+A Point object with its x and y properties set.
postUpdate()
+ + +
+
+
+
+
+
+
+
+
+
+
+Automatically called by World.postUpdate. Handles cache updates.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
renderDebug()
+ + +
+
+
+
+
+
+
+
+
+
+
+Renders a collision debug overlay on-top of the canvas. Called automatically by render when debug = true.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- @@ -4466,217 +4480,7 @@ half as quickly as the 'normal' camera-locked layers do)
- Source:
- - - - - - - - -
update()
- - -
-
-
-
-
-
-
-
-
-
-
-Automatically called by World.preUpdate. Handles cache updates.
--
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
updateMapData(tilemap, layer)
- - -
-
-
-
-
-
-
-
-
- Updates the Tilemap data.
-Parameters:
- - -| Name | - - -Type | - - - - - -Description | -
|---|---|---|
tilemap |
-
-
- - - -Phaser.Tilemap - - - - | - - - - - -The tilemap to which this layer belongs. |
-
layer |
-
-
- - - -number - - - - | - - - - - -The layer index within the map. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- @@ -4745,128 +4549,7 @@ half as quickly as the 'normal' camera-locked layers do)
- Source:
- - - - - - - - -
updateTileset(tileset)
- - -
-
-
-
-
-
-
-
-
- Updates the Tileset data.
-Parameters:
- - -| Name | - - -Type | - - - - - -Description | -
|---|---|---|
tileset |
-
-
- - - -Phaser.Tileset -| - -string - - - - | - - - - - -The tileset to use for this layer. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- @@ -4911,13 +4594,13 @@ half as quickly as the 'normal' camera-locked layers do) - Phaser Copyright © 2012-2013 Photon Storm Ltd. + Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:34 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:35 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.TilemapParser.html b/docs/Phaser.TilemapParser.html index 71bfaf31..8da89b64 100644 --- a/docs/Phaser.TilemapParser.html +++ b/docs/Phaser.TilemapParser.html @@ -90,6 +90,10 @@ Device +
-
-
<static> parse(game, data, format) → {Phaser.Tileset}
+<static> parse(game, key) → {object}
@@ -588,30 +582,7 @@
- Source:
- @@ -684,7 +655,7 @@
- -Phaser.Tileset +object @@ -800,7 +771,7 @@
- Source:
- @@ -851,7 +822,7 @@
-
-
<static> parseJSON(json-) → {object}
+<static> parseJSON(json) → {object}
@@ -893,7 +864,7 @@
- Source:
- @@ -966,7 +937,7 @@
-
-
<static> tileset(game, key, tileWidth, tileHeight, tileMax, tileMargin, tileSpacing) → {Phaser.Tileset}
+<static> tileset(game, key, tileWidth, tileHeight, tileMargin, tileSpacing, rows, columns, total) → {Phaser.Tileset}
@@ -1022,8 +993,12 @@
dataformatkeyThe key of the tilemap in the Cache.
-
@@ -695,7 +666,7 @@
Generated Tileset object.
+The parsed map object.
json-jsonThe Tiled JSON data.
The JSON map data.
-
@@ -992,7 +963,7 @@
Generated map data.
+Generated and parsed map data.
Game reference to the currently running game.
The Cache key of this tileset.
Width of each single tile in pixels.
tileMaxHeight of each single tile in pixels.
+ + + + +
If the tiles have been drawn with a margin, specify the amount here.
+ + + + +
If the tiles have been drawn with spacing between them, specify the amount here.
rows+ + + + + +
How many tiles are placed horizontally in each row? If -1 it will calculate rows by dividing the image width by tileWidth.
columns+ + + + + +
How many tiles are placed vertically in each column? If -1 it will calculate columns by dividing the image height by tileHeight.
total+ + + + + +
The maximum number of tiles to extract from the image. If -1 it will extract rows * columns worth. You can also set a value lower than the actual number of tiles.
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:35 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:35 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Tileset.html b/docs/Phaser.Tileset.html index cd4e1e56..2a1cd745 100644 --- a/docs/Phaser.Tileset.html +++ b/docs/Phaser.Tileset.html @@ -90,6 +90,10 @@ Device +
new Tileset(image, key, tileWidth, tileHeight, tileMargin, tileSpacing)
+new Tileset(name, firstgid, width, height, margin, spacing, properties)
-
@@ -468,8 +463,6 @@
A Tile set is a combination of an image containing the tiles and collision data per tile.
+A Tile set is a combination of an image containing the tiles and collision data per tile. +You should not normally instantiate this class directly.
imageThe Image object from the Cache.
keynameThe key of the tileset in the cache.
The name of the tileset in the map data.
tileWidthfirstgidThe width of the tile in pixels.
The Tiled firstgid value.
tileHeightwidthThe height of the tile in pixels.
Width of each tile in pixels.
tileMarginheight- - - - - -
The margin around the tiles in the sheet.
Height of each tile in pixels.
tileSpacingmargin- - + +
The amount of margin around the tilesheet.
spacingThe spacing between the tiles in the sheet.
The amount of spacing between each tile in the sheet.
propertiesTileset properties.
-
+
-
+
columns
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +columns+ + +number + + + + + + + + + +The number of columns in the tile sheet.
+
+
+
+ -
+
firstgid
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Default Value: +
- firstgid
+
+
+
+ - Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +firstgid+ + +number + + + + + + + + + +The Tiled firstgid value.
+
+
+
-
image
@@ -796,7 +967,7 @@ -The image used for rendering.
The image used for rendering. This is a reference to the image stored in Phaser.Cache.
- Source:
- @@ -843,7 +1014,7 @@
-
-
key
+name
@@ -882,7 +1053,7 @@
- Source:
- @@ -945,7 +1116,7 @@
-
-
margin
+properties
@@ -984,13 +1155,13 @@
- Source:
- @@ -1047,7 +1218,7 @@
-
-
spacing
+rows
@@ -1086,7 +1257,7 @@
- Source:
- @@ -1251,7 +1422,7 @@
-
-
tiles
+tileMargin
@@ -1290,13 +1461,13 @@
- Source:
- + + + + + + + +
keynameThe cache ID.
The name of the Tileset.
tileMarginpropertiesThe margin around the tiles in the sheet.
Tileset specific properties (typically defined in the Tiled editor).
tileSpacingrowsThe margin around the tiles in the sheet.
The number of rows in the tile sheet.
tilestileMarginAn array of the tile collision data.
The margin around the tiles in the sheet.
tileSpacing
+ + +-
+
+
+
- Source: +
- @@ -1455,7 +1728,7 @@
-
-
<readonly> total
+total
@@ -1510,7 +1783,7 @@
- - Source:
- @@ -1563,7 +1836,7 @@
-
-
addTile(tile)
+<protected> calculateFaces(layer)
@@ -1571,7 +1844,7 @@
- Source: -
- - - - - - - - -
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
tileSpacing |
+
+
+ + + +number + + + + | + + + + + +The margin around the tiles in the sheet. |
+
The total number of tiles in this Tileset.
The total number of tiles in the tilesheet.
-
@@ -1605,125 +1878,7 @@
Adds a Tile into this set.
+Internal function.
tileThe tile to add to this set.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
canCollide(index) → {boolean}
- - -
-
-
-
-
-
-
-
-
- Checks if the tile at the given index can collide.
-Parameters:
- - -| Name | - - -Type | - - - - - -Description | -||
|---|---|---|---|---|
index |
+ layer |
@@ -1739,7 +1894,7 @@ - | The index of the tile within the set. |
+ The index of the TilemapLayer to operate on. |
| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
name |
+
+
+ + + +string + + + + | + + ++ + + + + + | + + + ++ + | + + +The name of the Object Group to create Sprites from. |
+
gid |
+
+
+ + + +number + + + + | + + ++ + + + + + | + + + ++ + | + + +The layer array index value, or if a string is given the layer name, within the map data that this TilemapLayer represents. |
+
key |
+
+
+ + + +string + + + + | + + ++ + + + + + | + + + ++ + | + + +The Game.cache key of the image that this Sprite will use. |
+
frame |
+
+
+ + + +number +| + +string + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + | + + +If the Sprite image contains multiple frames you can specify which one to use here. |
+
exists |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + true + + | + + +The default exists state of the Sprite. |
+
autoCull |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + true + + | + + +The default autoCull state of the Sprite. Sprites that are autoCulled are culled from the camera if out of its range. |
+
group |
+
+
+ + + +Phaser.Group + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + | + + +Optional Group to add the Sprite to. If not specified it will be added to the World group. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
createLayer(layer, width, height, group) → {Phaser.TilemapLayer}
+ + +
+
+
+
+
+
+
+
+
+ Creates a new TilemapLayer object. By default TilemapLayers are fixed to the camera.
+Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
layer |
+
+
+ + + +number +| + +string + + + + | + + ++ + + + + + | + + + + +The layer array index value, or if a string is given the layer name, within the map data that this TilemapLayer represents. |
+
width |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+
+ The rendered width of the layer, should never be wider than Game.width. If not given it will be set to Game.width. |
+
height |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+
+ The rendered height of the layer, should never be wider than Game.height. If not given it will be set to Game.height. |
+
group |
+
+
+ + + +Phaser.Group + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+
+ Optional Group to add the object to. If not specified it will be added to the World group. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + +
+
+
+
+
+The TilemapLayer object. This is an extension of Phaser.Sprite and can be moved around the display list accordingly.
+-
+
- + Type + +
- + +Phaser.TilemapLayer + + + +
getImageIndex(name) → {number}
+ + +
+
+
+
+
+
+
+
+
+ Gets the image index based on its name.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
name |
+
+
+ + + +string + + + + | + + + + + +The name of the image to get. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + +
+
+
+
+
+The index of the image in this tilemap, or null if not found.
+-
+
- + Type + +
- + +number + + + +
<protected> getIndex(location, name) → {number}
+ + +
+
+
+
+
+
+
+
+
+ Gets the layer index based on the layers name.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
location |
+
+
+ + + +array + + + + | + + + + + +The local array to search. |
+
name |
+
+
+ + + +string + + + + | + + + + + +The name of the array element to get. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + +
+
+
+
+
+The index of the element in the array, or null if not found.
+-
+
- + Type + +
- + +number + + + +
<protected> getLayer(layer) → {number}
+ + +
+
+
+
+
+
+
+
+
+ Gets the TilemapLayer index as used in the setCollision calls.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
layer |
+
+
+ + + +number +| + +string +| + +Phaser.TilemapLayer + + + + | + + + + + +The layer to operate on. If not given will default to this.currentLayer. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + +
+
+
+
+
+The TilemapLayer index.
+-
+
- + Type + +
- + +number + + + +
getLayerIndex(name) → {number}
+ + +
+
+
+
+
+
+
+
+
+ Gets the layer index based on its name.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
name |
+
+
+ + + +string + + + + | + + + + + +The name of the layer to get. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + +
+
+
+
+
+The index of the layer in this tilemap, or null if not found.
+-
+
- + Type + +
- + +number + + + +
getObjectIndex(name) → {number}
+ + +
+
+
+
+
+
+
+
+
+ Gets the object index based on its name.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
name |
+
+
+ + + +string + + + + | + + + + + +The name of the object to get. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + +
+
+
+
+
+The index of the object in this tilemap, or null if not found.
+-
+
- + Type + +
- + +number + + + +
getTile(index) → {object}
-
@@ -2089,7 +3578,7 @@
The tile.
+The tile object. + getTile: function (index) {
+ return this.tiles[index];
+
+},setCollision(index, left, right, up, down)
+getTileAbove(layer, x, y)
-
+
+
+
+
+
+
+
+ Sets collision values on a tile in the set.
+Gets the tile above the tile coordinates given. +Mostly used as an internal function by calculateFaces.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
layer |
+
+
+ + + +number + + + + | + + + + + +The local layer index to get the tile from. Can be determined by Tilemap.getLayer(). |
+
x |
+
+
+ + + +number + + + + | + + + + + +The x coordinate to get the tile from. In tiles, not pixels. |
+
y |
+
+
+ + + +number + + + + | + + + + + +The y coordinate to get the tile from. In tiles, not pixels. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
getTileBelow(layer, x, y)
+ + +
+
+
+
+
+
+
+
+
+ Gets the tile below the tile coordinates given. +Mostly used as an internal function by calculateFaces.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
layer |
+
+
+ + + +number + + + + | + + + + + +The local layer index to get the tile from. Can be determined by Tilemap.getLayer(). |
+
x |
+
+
+ + + +number + + + + | + + + + + +The x coordinate to get the tile from. In tiles, not pixels. |
+
y |
+
+
+ + + +number + + + + | + + + + + +The y coordinate to get the tile from. In tiles, not pixels. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
getTileLeft(layer, x, y)
+ + +
+
+
+
+
+
+
+
+
+ Gets the tile to the left of the tile coordinates given. +Mostly used as an internal function by calculateFaces.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
layer |
+
+
+ + + +number + + + + | + + + + + +The local layer index to get the tile from. Can be determined by Tilemap.getLayer(). |
+
x |
+
+
+ + + +number + + + + | + + + + + +The x coordinate to get the tile from. In tiles, not pixels. |
+
y |
+
+
+ + + +number + + + + | + + + + + +The y coordinate to get the tile from. In tiles, not pixels. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
getTileRight(layer, x, y)
+ + +
+
+
+
+
+
+
+
+
+ Gets the tile to the right of the tile coordinates given. +Mostly used as an internal function by calculateFaces.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
layer |
+
+
+ + + +number + + + + | + + + + + +The local layer index to get the tile from. Can be determined by Tilemap.getLayer(). |
+
x |
+
+
+ + + +number + + + + | + + + + + +The x coordinate to get the tile from. In tiles, not pixels. |
+
y |
+
+
+ + + +number + + + + | + + + + + +The y coordinate to get the tile from. In tiles, not pixels. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
getTilesetIndex(name) → {number}
+ + +
+
+
+
+
+
+
+
+
+ Gets the tileset index based on its name.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
name |
+
+
+ + + +string + + + + | + + + + + +The name of the tileset to get. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + +
+
+
+
+
+The index of the tileset in this tilemap, or null if not found.
+-
+
- + Type + +
- + +number + + + +
getTileX(index) → {object}
+ + +
+
@@ -2166,98 +4456,6 @@
-
- Gets a Tile from this set.
leftShould the tile collide on the left?
rightShould the tile collide on the right?
upShould the tile collide on the top?
downShould the tile collide on the bottom?
Returns:
+ + +
+
+
+
+
+The tile object. + getTileX: function (index) {
+ return this.tiles[index][0];
+
+},-
+
- + Type + +
- + +object + + + +
setCollisionRange(start, stop, left, right, up, down)
+getTileY(index) → {object}
-
@@ -2356,7 +4581,7 @@
Sets collision values on a range of tiles in the set.
+Gets a Tile from this set.
startindexThe index to start setting the collision data on.
stopThe index to stop setting the collision data on.
leftShould the tile collide on the left?
rightShould the tile collide on the right?
upShould the tile collide on the top?
downShould the tile collide on the bottom?
The index of the tile within the set.
Returns:
+ + +
+
+
+
+
+The tile object. + getTileY: function (index) {
+ return this.tiles[index][1];
+
+},-
+
- + Type + +
- + +object + + + +
setCollision(indexes, collides, layer)
+ + +
+
+
+
+
+
+
+
+
+ Sets collision the given tile or tiles. You can pass in either a single numeric index or an array of indexes: [ 2, 3, 15, 20].
+The collides parameter controls if collision will be enabled (true) or disabled (false).
Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
indexes |
+
+
+ + + +number +| + +array + + + + | + + ++ + + + + + | + + + ++ + | + + +Either a single tile index, or an array of tile IDs to be checked for collision. |
+
collides |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + true + + | + + +If true it will enable collision. If false it will clear collision. |
+
layer |
+
+
+ + + +number +| + +string +| + +Phaser.TilemapLayer + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + | + + +The layer to operate on. If not given will default to this.currentLayer. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
setCollisionBetween(start, stop, collides, layer)
+ + +
+
+
+
+
+
+
+
+
+ Sets collision on a range of tiles where the tile IDs increment sequentially.
+Calling this with a start value of 10 and a stop value of 14 would set collision for tiles 10, 11, 12, 13 and 14.
+The collides parameter controls if collision will be enabled (true) or disabled (false).
Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
start |
+
+
+ + + +number + + + + | + + ++ + + + + + | + + + ++ + | + + +The first index of the tile to be set for collision. |
+
stop |
+
+
+ + + +number + + + + | + + ++ + + + + + | + + + ++ + | + + +The last index of the tile to be set for collision. |
+
collides |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + true + + | + + +If true it will enable collision. If false it will clear collision. |
+
layer |
+
+
+ + + +number +| + +string +| + +Phaser.TilemapLayer + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + | + + +The layer to operate on. If not given will default to this.currentLayer. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
setCollisionByExclusion(indexes, collides, layer)
+ + +
+
+
+
+
+
+
+
+
+ Sets collision on all tiles in the given layer, except for the IDs of those in the given array.
+The collides parameter controls if collision will be enabled (true) or disabled (false).
Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
indexes |
+
+
+ + + +array + + + + | + + ++ + + + + + | + + + ++ + | + + +An array of the tile IDs to not be counted for collision. |
+
collides |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + true + + | + + +If true it will enable collision. If false it will clear collision. |
+
layer |
+
+
+ + + +number +| + +string +| + +Phaser.TilemapLayer + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + | + + +The layer to operate on. If not given will default to this.currentLayer. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
<protected> setCollisionByIndex(index, collides, layer, recalculate)
+ + +
+
+
+
+
+
+
+
+
+ Sets collision values on a tile in the set. +You shouldn't usually call this method directly, instead use setCollision, setCollisionBetween or setCollisionByExclusion.
+Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
index |
+
+
+ + + +number + + + + | + + ++ + + + + + | + + + ++ + | + + +The index of the tile on the layer. |
+
collides |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + true + + | + + +If true it will enable collision on the tile. If false it will clear collision values from the tile. |
+
layer |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + | + + +The layer to operate on. If not given will default to this.currentLayer. |
+
recalculate |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + true + + | + + +Recalculates the tile faces after the update. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- @@ -2682,7 +5759,565 @@
- Source:
- + + + + + + + +
setTileIndexCallback(indexes, callback, callbackContext, layer)
+ + +
+
+
+
+
+
+
+
+
+ Sets a global collision callback for the given tile index within the layer. This will affect all tiles on this layer that have the same index. +If a callback is already set for the tile index it will be replaced. Set the callback to null to remove it. +If you want to set a callback for a tile at a specific location on the map then see setTileLocationCallback.
+Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
indexes |
+
+
+ + + +number +| + +array + + + + | + + ++ + + + + + | + + + + +Either a single tile index, or an array of tile indexes to have a collision callback set for. |
+
callback |
+
+
+ + + +function + + + + | + + ++ + + + + + | + + + + +The callback that will be invoked when the tile is collided with. |
+
callbackContext |
+
+
+ + + +object + + + + | + + ++ + + + + + | + + + + +The context under which the callback is called. |
+
layer |
+
+
+ + + +number +| + +string +| + +Phaser.TilemapLayer + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+
+ The layer to operate on. If not given will default to this.currentLayer. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
setTileLocationCallback(x, y, width, height, callback, callbackContext, layer)
+ + +
+
+
+
+
+
+
+
+
+ Sets a global collision callback for the given tile index within the layer. This will affect all tiles on this layer that have the same index. +If a callback is already set for the tile index it will be replaced. Set the callback to null to remove it. +If you want to set a callback for a tile at a specific location on the map then see setTileLocationCallback.
+Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
x |
+
+
+ + + +number + + + + | + + ++ + + + + + | + + + + +X position of the top left of the area to copy (given in tiles, not pixels) |
+
y |
+
+
+ + + +number + + + + | + + ++ + + + + + | + + + + +Y position of the top left of the area to copy (given in tiles, not pixels) |
+
width |
+
+
+ + + +number + + + + | + + ++ + + + + + | + + + + +The width of the area to copy (given in tiles, not pixels) |
+
height |
+
+
+ + + +number + + + + | + + ++ + + + + + | + + + + +The height of the area to copy (given in tiles, not pixels) |
+
callback |
+
+
+ + + +function + + + + | + + ++ + + + + + | + + + + +The callback that will be invoked when the tile is collided with. |
+
callbackContext |
+
+
+ + + +object + + + + | + + ++ + + + + + | + + + + +The context under which the callback is called. |
+
layer |
+
+
+ + + +number +| + +string +| + +Phaser.TilemapLayer + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+
+ The layer to operate on. If not given will default to this.currentLayer. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- @@ -2727,13 +6362,13 @@ - Phaser Copyright © 2012-2013 Photon Storm Ltd. + Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:35 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:35 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Time.html b/docs/Phaser.Time.html index 137d9d1e..8daece68 100644 --- a/docs/Phaser.Time.html +++ b/docs/Phaser.Time.html @@ -90,6 +90,10 @@ Device +
-
-
elapsed
+<protected> elapsed
@@ -627,7 +621,7 @@
- - Source:
- @@ -674,7 +668,109 @@
-
-
fps
+events
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + time/Time.js, line 101 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +events+ + +Phaser.Timer + + + + + + + + + +This is a Phaser.Timer object bound to the master clock to which you can add timed events.
+
+
+
+ -
+
<protected> fps
@@ -758,7 +854,7 @@
- Source:
- @@ -860,7 +956,7 @@
- Source:
- @@ -962,7 +1058,7 @@
- Source:
- @@ -1064,7 +1160,7 @@
- Source:
- @@ -1268,7 +1364,7 @@
- Source:
- @@ -1370,7 +1466,7 @@
- Source:
- @@ -1475,7 +1571,7 @@
- Source:
- @@ -1493,7 +1589,7 @@
-
-
now
+<protected> now
@@ -1577,7 +1673,7 @@
- Source:
- @@ -1595,7 +1691,7 @@
-
-
pausedTime
+<protected> pausedTime
@@ -1679,7 +1775,7 @@
- Source:
- @@ -1781,7 +1877,7 @@
- Source:
- @@ -1883,7 +1979,7 @@
- Source:
- @@ -1901,7 +1997,7 @@
-
-
time
+<protected> time
@@ -1956,7 +2052,7 @@
- - Source:
- @@ -2087,7 +2183,7 @@
- Source:
- @@ -2110,6 +2206,232 @@
-
+
boot()
+ + +
+ -
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + time/Time.js, line 153 +
+
+
+
+
+
+
+
+
+
+
+
+ -
+
create(autoDestroy) → {Phaser.Timer}
+ + +
+ -
+
+
+ ++ + + + + + + +
Creates a new stand-alone Phaser.Timer object.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + +Argument + + + +Default + + +Description ++ + + + + +autoDestroy+ + +boolean + + + + + + ++ + <optional> + + + +
+ + + + + ++ + true + + + + +A Timer that is set to automatically destroy itself will do so after all of its events have been dispatched (assuming no looping events).
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + time/Time.js, line 162 +
+
+
+
+
+
+
+
+
Returns:
+ + +++ + + +The Timer object that was created.
+-
+
- + Type + +
- + +Phaser.Timer + + + +
+
+
+
-
elapsedSecondsSince(since) → {number}
@@ -2201,7 +2523,7 @@- Source:
- @@ -2342,7 +2664,7 @@
- Source:
- @@ -2388,6 +2710,75 @@ +
Elapsed time since the last frame.
Elapsed time since the last frame (in ms).
Game time counter.
Game time counter. If you need a value for in-game calculation please use Phaser.Time.now instead.
-
+
removeAll()
+ + +
+
+
+
+
+
+
+
+
+
+
+Remove all Timer objects, regardless of their state.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + time/Time.js, line 180 +
+
+
+
+
+
+
+
+
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:35 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:36 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Timer.html b/docs/Phaser.Timer.html index fce8ebce..0457fc84 100644 --- a/docs/Phaser.Timer.html +++ b/docs/Phaser.Timer.html @@ -90,6 +90,10 @@ Device +
A Timer
A Timer is a way to create small re-usable or disposable objects that do nothing but wait for a specific moment in time, and then dispatch an event.
new Timer(game)
+new Timer(game, autoDestroy)
-
@@ -468,8 +464,12 @@
Timer constructor.
+A Timer is a way to create small re-usable or disposable objects that do nothing but wait for a specific moment in time, and then dispatch an event. +You can add as many events to a Timer as you like, each with their own delays. A Timer uses milliseconds as its unit of time. There are 1000 ms in 1 second. +So if you want to fire an event every quarter of a second you'd need to set the delay to 250.
A reference to the currently running game.
autoDestroy+ + + + + +
A Timer that is set to automatically destroy itself will do so after all of its events have been dispatched (assuming no looping events).
-
+
-
+
<static, constant> HALF :number
+ + +
+ -
+
+
+
+
Type:
+-
+
- + +number + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + time/Timer.js, line 118 +
+
+
+
+
+
+
+
+
+
+
+
+ -
+
<static, constant> MINUTE :number
+ + +
+ -
+
+
+
+
Type:
+-
+
- + +number + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + time/Timer.js, line 106 +
+
+
+
+
+
+
+
+
+
+
+
+ -
+
<static, constant> QUARTER :number
+ + +
+ -
+
+
+
+
Type:
+-
+
- + +number + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + time/Timer.js, line 124 +
+
+
+
+
+
+
+
+
+
+
+
+ -
+
<static, constant> SECOND :number
+ + +
+ -
+
+
+
+
Type:
+-
+
- + +number + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + time/Timer.js, line 112 +
+
+
+
+
+
+
+
+
+
+
+
+ -
+
autoDestroy
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + time/Timer.js, line 36 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +autoDestroy+ + +boolean + + + + + + + + + +A Timer that is set to automatically destroy itself will do so after all of its events have been dispatched (assuming no looping events).
+
+
+
+ -
+
<readonly> duration
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + time/Timer.js, line 426 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +duration+ + +number + + + + + + + + + +The duration in ms remaining until the next event will occur.
+
+
+
+ -
+
events
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + time/Timer.js, line 48 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +events+ + +array.<Phaser.TimerEvent> + + + + + + + + + +An array holding all of this timers Phaser.TimerEvent objects. Use the methods add, repeat and loop to populate it.
+
+
+
+ -
+
<readonly> expired
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Default Value: +
- false
+
+
+
+ - Source: +
- + time/Timer.js, line 43 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +expired+ + +boolean + + + + + + + + + +An expired Timer is one in which all of its events have been dispatched and none are pending.
+
+
+
-
game
@@ -656,7 +1358,829 @@- Source:
- - time/Timer.js, line 20 + time/Timer.js, line 25 +
+
+
+
+
+
+
+
+
<readonly> length
+ + +-
+
+
+
- Source: +
- + time/Timer.js, line 448 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
length |
+
+
+ + + +number + + + + | + + + + + +The number of pending events in the queue. |
+
<readonly> ms
+ + +-
+
+
+
- Source: +
- + time/Timer.js, line 461 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
ms |
+
+
+ + + +number + + + + | + + + + + +The duration in milliseconds that this Timer has been running for. |
+
<readonly> next
+ + +-
+
+
+
- Source: +
- + time/Timer.js, line 413 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
next |
+
+
+ + + +number + + + + | + + + + + +The time at which the next event will occur. |
+
<protected, readonly> nextTick
+ + +-
+
+
+
- Source: +
- + time/Timer.js, line 60 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
nextTick |
+
+
+ + + +number + + + + | + + + + + +The time the next tick will occur. |
+
onComplete
+ + +-
+
+
+
- Source: +
- + time/Timer.js, line 53 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
onComplete |
+
+
+ + + +Phaser.Signal + + + + | + + + + + +This signal will be dispatched when this Timer has completed, meaning there are no more events in the queue. |
+
<readonly> paused
+ + +-
+
+
+
- Default Value: +
- false
+
+
+
+ - Source: +
- + time/Timer.js, line 67 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
paused |
+
+
+ + + +boolean + + + + | + + + + + +The paused state of the Timer. You can pause the timer by calling Timer.pause() and Timer.resume() or by the game pausing. |
+
running
+ + +-
+
+
+
- Default Value: +
- false
+
+
+
+ - Source: +
- + time/Timer.js, line 31 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
running |
+
+
+ + + +boolean + + + + | + + + + + +True if the Timer is actively running. Do not switch this boolean, if you wish to pause the timer then use Timer.pause() instead. |
+
<readonly> seconds
+ + +-
+
+
+
- Source: +
- @@ -675,6 +2199,1529 @@ +
-
+
add(delay, callback, callbackContext, arguments) → {Phaser.TimerEvent}
+ + +
+ -
+
+
+ ++ + + + + + + +
Adds a new Event to this Timer. The event will fire after the given amount of 'delay' in milliseconds has passed, once the Timer has started running. +Call Timer.start() once you have added all of the Events you require for this Timer. The delay is in relation to when the Timer starts, not the time it was added. +If the Timer is already running the delay will be calculated based on the timers current time.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + +Argument + + + + +Description ++ + + + + +delay+ + +number + + + + + + ++ + + + + + + + + + +The number of milliseconds that should elapse before the Timer will call the given callback.
+ + + + + +callback+ + +function + + + + + + ++ + + + + + + + + + +The callback that will be called when the Timer event occurs.
+ + + + + +callbackContext+ + +object + + + + + + ++ + + + + + + + + + +The context in which the callback will be called.
+ + + + + +arguments+ + +* + + + + + + ++ + + + + + <repeatable> + + + + +
+ +The values to be sent to your callback function when it is called.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + time/Timer.js, line 161 +
+
+
+
+
+
+
+
+
Returns:
+ + +++ + + +The Phaser.TimerEvent object that was created.
+-
+
- + Type + +
- + +Phaser.TimerEvent + + + +
+
+
+
+ -
+
destroy()
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Destroys this Timer. Events are not dispatched.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + time/Timer.js, line 399 +
+
+
+
+
+
+
+
+
+
+
+
+ -
+
loop(delay, callback, callbackContext, arguments) → {Phaser.TimerEvent}
+ + +
+ -
+
+
+ ++ + + + + + + +
Adds a new looped Event to this Timer that will repeat forever or until the Timer is stopped. +The event will fire after the given amount of 'delay' milliseconds has passed once the Timer has started running. +Call Timer.start() once you have added all of the Events you require for this Timer. The delay is in relation to when the Timer starts, not the time it was added. +If the Timer is already running the delay will be calculated based on the timers current time.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + +Argument + + + + +Description ++ + + + + +delay+ + +number + + + + + + ++ + + + + + + + + + +The number of milliseconds that should elapse before the Timer will call the given callback.
+ + + + + +callback+ + +function + + + + + + ++ + + + + + + + + + +The callback that will be called when the Timer event occurs.
+ + + + + +callbackContext+ + +object + + + + + + ++ + + + + + + + + + +The context in which the callback will be called.
+ + + + + +arguments+ + +* + + + + + + ++ + + + + + <repeatable> + + + + +
+ +The values to be sent to your callback function when it is called.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + time/Timer.js, line 197 +
+
+
+
+
+
+
+
+
Returns:
+ + +++ + + +The Phaser.TimerEvent object that was created.
+-
+
- + Type + +
- + +Phaser.TimerEvent + + + +
+
+
+
+ -
+
order()
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Orders the events on this Timer so they are in tick order. This is called automatically when new events are created.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + time/Timer.js, line 257 +
+
+
+
+
+
+
+
+
+
+
+
+ -
+
pause()
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Pauses the Timer and all events in the queue.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + time/Timer.js, line 368 +
+
+
+
+
+
+
+
+
+
+
+
+ -
+
remove(event)
+ + +
+ -
+
+
+ ++ + + + + + + +
Removes a pending TimerEvent from the queue.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +event+ + +Phaser.TimerEvent + + + + + + + + + +The event to remove from the queue.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + time/Timer.js, line 237 +
+
+
+
+
+
+
+
+
+
+
+
+ -
+
repeat(delay, repeatCount, callback, callbackContext, arguments) → {Phaser.TimerEvent}
+ + +
+ -
+
+
+ ++ + + + + + + +
Adds a new Event to this Timer that will repeat for the given number of iterations. +The event will fire after the given amount of 'delay' milliseconds has passed once the Timer has started running. +Call Timer.start() once you have added all of the Events you require for this Timer. The delay is in relation to when the Timer starts, not the time it was added. +If the Timer is already running the delay will be calculated based on the timers current time.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + +Argument + + + + +Description ++ + + + + +delay+ + +number + + + + + + ++ + + + + + + + + + +The number of milliseconds that should elapse before the Timer will call the given callback.
+ + + + + +repeatCount+ + +number + + + + + + ++ + + + + + + + + + +The number of times the event will repeat.
+ + + + + +callback+ + +function + + + + + + ++ + + + + + + + + + +The callback that will be called when the Timer event occurs.
+ + + + + +callbackContext+ + +object + + + + + + ++ + + + + + + + + + +The context in which the callback will be called.
+ + + + + +arguments+ + +* + + + + + + ++ + + + + + <repeatable> + + + + +
+ +The values to be sent to your callback function when it is called.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + time/Timer.js, line 178 +
+
+
+
+
+
+
+
+
Returns:
+ + +++ + + +The Phaser.TimerEvent object that was created.
+-
+
- + Type + +
- + +Phaser.TimerEvent + + + +
+
+
+
+ -
+
resume()
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Resumes the Timer and updates all pending events.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + time/Timer.js, line 380 +
+
+
+
+
+
+
+
+
+
+
+
+ -
+
<protected> sortHandler()
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Sort handler used by Phaser.Timer.order.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + time/Timer.js, line 273 +
+
+
+
+
+
+
+
+
+
+
+
+ -
+
start()
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Starts this Timer running.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + time/Timer.js, line 215 +
+
+
+
+
+
+
+
+
+
+
+
+ -
+
stop()
+ + +
+ -
+
+
+ ++ + + + + + + + + +
Stops this Timer from running. Does not cause it to be destroyed if autoDestroy is set to true.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + time/Timer.js, line 226 +
+
+
+
+
+
+
+
+
+
+
+
+ -
+
<protected> update(time) → {boolean}
+ + +
+ -
+
+
+ ++ + + + + + + +
The main Timer update event, called automatically by the Game clock.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +time+ + +number + + + + + + + + + +The time from the core game clock.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + time/Timer.js, line 293 +
+
+
+
+
+
+
+
+
Returns:
+ + +++ + + +True if there are still events waiting to be dispatched, otherwise false if this Timer can be destroyed.
+-
+
- + Type + +
- + +boolean + + + +
+
+ -
+
new TimerEvent(timer, delay, tick, repeatCount, loop, callback, callbackContext, arguments)
+ + +
+ -
+
+
+ ++ + + + + + + +
A TimerEvent is a single event that is processed by a Phaser.Timer. It consists of a delay, which is a value in milliseconds after which the event will fire. +It can call a specific callback, passing in optional parameters.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +timer+ + +Phaser.Timer + + + + + + + + + +The Timer object that this TimerEvent belongs to.
+ + + + + +delay+ + +number + + + + + + + + + +The delay in ms at which this TimerEvent fires.
+ + + + + +tick+ + +number + + + + + + + + + +The tick is the next game clock time that this event will fire at.
+ + + + + +repeatCount+ + +number + + + + + + + + + +If this TimerEvent repeats it will do so this many times.
+ + + + + +loop+ + +boolean + + + + + + + + + +True if this TimerEvent loops, otherwise false.
+ + + + + +callback+ + +function + + + + + + + + + +The callback that will be called when the TimerEvent occurs.
+ + + + + +callbackContext+ + +object + + + + + + + + + +The context in which the callback will be called.
+ + + + + +arguments+ + +array + + + + + + + + + +The values to be passed to the callback.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
+
+
+ -
+
args
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +arguments+ + +array + + + + + + + + + +The values to be passed to the callback.
+
+
+
+ -
+
callback
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +callback+ + +function + + + + + + + + + +The callback that will be called when the TimerEvent occurs.
+
+
+
+ -
+
callbackContext
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +callbackContext+ + +object + + + + + + + + + +The context in which the callback will be called.
+
+
+
+ -
+
delay
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +delay+ + +number + + + + + + + + + +The delay in ms at which this TimerEvent fires.
+
+
+
+ -
+
loop
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +loop+ + +boolean + + + + + + + + + +True if this TimerEvent loops, otherwise false.
+
+
+
+ -
+
repeatCount
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +repeatCount+ + +number + + + + + + + + + +If this TimerEvent repeats it will do so this many times.
+
+
+
+ -
+
tick
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +tick+ + +number + + + + + + + + + +The tick is the next game clock time that this event will fire at.
+
+
+
+ -
+
timer
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + + + + + + + +
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +timer+ + +Phaser.Timer + + + + + + + + + +The Timer object that this TimerEvent belongs to.
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
seconds |
+
+
+ + + +number + + + + | + + + + + +The duration in seconds that this Timer has been running for. |
+
Methods
+ +-
+
+
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:35 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:36 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.TimerEvent.html b/docs/Phaser.TimerEvent.html new file mode 100644 index 00000000..ca35f0e0 --- /dev/null +++ b/docs/Phaser.TimerEvent.html @@ -0,0 +1,1616 @@ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/Phaser.Touch.html b/docs/Phaser.Touch.html
index f91cd182..0bcca464 100644
--- a/docs/Phaser.Touch.html
+++ b/docs/Phaser.Touch.html
@@ -90,6 +90,10 @@
Device
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Class: TimerEvent
++ Phaser. + + TimerEvent +
+ +A TimerEvent is a single event that is processed by a Phaser.Timer. It consists of a delay, which is a value in milliseconds after which the event will fire.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Members
+ +-
+
+
+
+
+
+ +
The browser touch event.
The browser touch DOM event. Will be set to null if no touch event has ever been received.
- null
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:35 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:36 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Tween.html b/docs/Phaser.Tween.html index c5c498ce..1730684c 100644 --- a/docs/Phaser.Tween.html +++ b/docs/Phaser.Tween.html @@ -90,6 +90,10 @@ Device +
Description.
If the tween is running this is set to true, otherwise false. Tweens that are in a delayed state, waiting to start, are considered as being running.
Description.
The onComplete event is fired when the Tween completes. Does not fire if the Tween is set to loop.
- - tween/Tween.js, line 168 + tween/Tween.js, line 167 +
onLoop
+ + +-
+
+
+
- Source: +
- @@ -960,7 +1056,7 @@ Create a new <code>Tween</code>. -
- Source:
- @@ -1094,7 +1190,7 @@ Create a new <code>Tween</code>.
- Source:
- @@ -1160,7 +1256,7 @@ You can pass as many tweens as you like to this function, they will each be chai
- Source:
- @@ -1301,7 +1397,7 @@ You can pass as many tweens as you like to this function, they will each be chai
- Source:
- @@ -1442,7 +1538,7 @@ You can pass as many tweens as you like to this function, they will each be chai
- Source:
- @@ -1501,7 +1597,8 @@ You can pass as many tweens as you like to this function, they will each be chai
- Source:
- @@ -1681,289 +1778,7 @@ game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)
- Source:
- - tween/Tween.js, line 393 -
-
-
-
-
-
-
-
-
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
onLoop |
+
+
+ + + +Phaser.Signal + + + + | + + + + + +The onLoop event is fired if the Tween loops. |
+
Description.
The onStart event is fired when the Tween begins.
-
@@ -1583,7 +1680,7 @@ You can pass as many tweens as you like to this function, they will each be chai
Set interpolation function the tween will use, by default it uses Phaser.Math.linearInterpolation.
+Set interpolation function the tween will use, by default it uses Phaser.Math.linearInterpolation. +Also available: Phaser.Math.bezierInterpolation and Phaser.Math.catmullRomInterpolation.
Returns:
- - -
-
-
-
-
-Itself.
--
-
- - Type - -
- - -Phaser.Tween - - - -
onCompleteCallback(callback) → {Phaser.Tween}
- - -
-
-
-
-
-
-
-
-
- Sets a callback to be fired when the tween completes. Note: callback will be called in the context of the global scope.
-Parameters:
- - -| Name | - - -Type | - - - - - -Description | -
|---|---|---|
callback |
-
-
- - - -function - - - - | - - - - - -The callback to invoke on completion. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - tween/Tween.js, line 440 -
-
-
-
-
-
-
-
-
Returns:
- - -
-
-
-
-
-Itself.
--
-
- - Type - -
- - -Phaser.Tween - - - -
onStartCallback(callback) → {Phaser.Tween}
- - -
-
-
-
-
-
-
-
-
- Sets a callback to be fired when the tween starts. Note: callback will be called in the context of the global scope.
-Parameters:
- - -| Name | - - -Type | - - - - - -Description | -
|---|---|---|
callback |
-
-
- - - -function - - - - | - - - - - -The callback to invoke on start. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- @@ -2104,7 +1919,7 @@ game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)
- Source:
- @@ -2196,7 +2011,7 @@ game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)
- Source:
- @@ -2314,7 +2129,7 @@ game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)
- Source:
- @@ -2406,7 +2221,7 @@ game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)
- Source:
- @@ -2475,7 +2290,7 @@ game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)
- Source:
- @@ -2567,7 +2382,7 @@ game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)
- Source:
- @@ -2618,7 +2433,7 @@ game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)
-
-
to(properties, duration, ease, autoStart, delay, repeat, yoyo) → {Phaser.Tween}
+to(properties, duration, ease, autoStart, delay, repeat, yoyo) → {Phaser.Tween}
@@ -2648,8 +2463,12 @@ game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)
- Source:
- @@ -2871,7 +2798,7 @@ game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)
- Source:
- @@ -3129,7 +3056,7 @@ Used in combination with repeat you can create endless loops.
- Source:
- @@ -3197,13 +3124,13 @@ Used in combination with repeat you can create endless loops. - Phaser Copyright © 2012-2013 Photon Storm Ltd. + Phaser Copyright © 2012-2014 Photon Storm Ltd.
Properties you want to tween.
+ + + + +
Duration of this tween.
Duration of this tween in ms.
+ + + + +
Easing function.
Easing function. If not set it will default to Phaser.Easing.Linear.None.
+ + + + +
Whether this tween will start automatically or not.
+ + + + +
Delay before this tween will start, defaults to 0 (no delay).
Delay before this tween will start, defaults to 0 (no delay). Value given is in ms.
+ + + + +
Should the tween automatically restart once complete? (ignores any chained tweens).
+ + + + +
Description.
A tween that yoyos will reverse itself when it completes.
-
@@ -2987,7 +2914,7 @@ game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)
Itself.
+This Tween object.
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:35 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:36 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.TweenManager.html b/docs/Phaser.TweenManager.html index c78babfb..93737650 100644 --- a/docs/Phaser.TweenManager.html +++ b/docs/Phaser.TweenManager.html @@ -90,6 +90,10 @@ Device +
REVISION
- - -
-
-
-
-
-
-
-Version number of this library.
--
-
-
-
- Default Value: -
- "11dev"
-
-
-
- - Source: -
- - - - - - - -
Properties:
- --
-
-
| Name | - - -Type | - - - - - -Description | -
|---|---|---|
REVISION |
-
-
- - - -string - - - - | - - - - - -- |
-
@@ -1468,7 +1353,7 @@ Please see https://github.com/sole/tw
Remove all tween objects.
+Remove all tweens running and in the queue. Doesn't call any of the tween onComplete events.
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:35 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:36 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Utils.Debug.html b/docs/Phaser.Utils.Debug.html index 0159e5d0..f4c4033c 100644 --- a/docs/Phaser.Utils.Debug.html +++ b/docs/Phaser.Utils.Debug.html @@ -90,6 +90,10 @@ Device +
-
+
-
+
columnWidth
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Source: +
- + utils/Debug.js, line 36 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +columnWidth+ + +number + + + + + + + + + +The spacing between columns.
+
+
+
-
context
@@ -762,7 +858,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL- Source:
- @@ -867,7 +963,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
- Source:
- @@ -972,7 +1068,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
- Source:
- @@ -1281,7 +1377,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
- Source:
- @@ -1383,7 +1479,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
- Source:
- @@ -1407,7 +1503,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
-
-
line(text, x, y)
+line(text, x, y)
@@ -1437,6 +1533,8 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
- Source:
- - utils/Debug.js, line 109 + utils/Debug.js, line 116 +
+
+
+
+
+
+
+
+
+ + + + + +
+ + + + + +
renderBodyInfo(sprite, x, y, color)
+ + +
+
+
+
+
+
+
+
+
+ Render Sprite Body Physics Data as text.
+Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
sprite |
+
+
+ + + +Phaser.Sprite + + + + | + + ++ + + + + + | + + + ++ + | + + +The sprite to be rendered. |
+
x |
+
+
+ + + +number + + + + | + + ++ + + + + + | + + + ++ + | + + +X position of the debug info to be rendered. |
+
y |
+
+
+ + + +number + + + + | + + ++ + + + + + | + + + ++ + | + + +Y position of the debug info to be rendered. |
+
color |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + 'rgb(255,255,255)' + + | + + +color of the debug info to be rendered. (format is css color string). |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- @@ -1786,7 +2155,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
- Source:
- @@ -1947,7 +2316,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
- Source:
- @@ -2155,7 +2524,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
- Source:
- @@ -2183,7 +2552,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
-
-
renderLocalTransformInfo(sprite, x, y, color)
+renderLine(line, color)
@@ -2191,7 +2560,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
- Source: +
- + utils/Debug.js, line 552 +
+
+
+
+
+
+
+
+
-
@@ -2229,13 +2598,13 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
Render the Local Transform information of the given Sprite.
+Renders a Line object in the given color.
spritelineDescription.
The Line to render.
color+ + + + + +
color of the debug info to be rendered. (format is css color string).
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
renderLineInfo(line, x, y, color)
+ + +
+
+
+
+
+
+
+
+
+ Renders Line information in the given color.
+Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
line |
+
+
+ + + +Phaser.Line + + + + | + + ++ + + + + + | + + + ++ + | + + +The Line to render. |
| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
body |
+
+
+ + + +array + + + + | + + ++ + + + + + | + + + ++ + | + + ++ |
color |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + 'rgb(255,255,255)' + + | + + +The color the polygon is stroked in. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- @@ -2590,7 +3301,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
- Source:
- @@ -2751,7 +3462,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
- Source:
- @@ -3041,7 +3752,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
- Source:
- @@ -3284,7 +3995,176 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
- Source:
- - utils/Debug.js, line 599 + utils/Debug.js, line 603 +
+
+
+
+
+
+
+
+
renderPolygon(polygon, color)
+ + +Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
polygon |
+
+
+ + + +array + + + + | + + ++ + + + + + | + + + ++ + | + + ++ |
color |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + 'rgb(255,255,255)' + + | + + +The color the polygon is stroked in. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- @@ -3425,7 +4305,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
- Source:
- @@ -3586,7 +4466,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
- Source:
- @@ -3829,168 +4709,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
- Source:
- - utils/Debug.js, line 245 -
-
-
-
-
-
-
-
-
renderSpriteBody(sprite, color)
- - -
-
-
-
-
-
-
-
-
- Renders just the Sprite.body bounds.
-Parameters:
- - -| Name | - - -Type | - - -Argument | - - - - -Description | -
|---|---|---|---|
sprite |
-
-
- - - -Phaser.Sprite - - - - | - - -- - - - - - | - - - - -Description. |
-
color |
-
-
- - - -string - - - - | - - -
-
- <optional> - - - - - - |
-
-
-
-
- Color of the debug info to be rendered (format is css color string). |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- @@ -4200,7 +4919,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
- Source:
- @@ -4228,7 +4947,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
-
-
renderSpriteCollision(sprite, x, y, color)
+renderSpriteBounds(sprite, color, fill)
@@ -4236,7 +4955,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
-
@@ -4302,7 +5021,217 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
- Render Sprite collision.
+Renders just the full Sprite bounds.
The sprite to be rendered.
Description.
color+ + + + + +
Color of the debug info to be rendered (format is css color string).
fill+ + + + + +
If false the bounds outline is rendered, if true the whole rectangle is rendered.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + utils/Debug.js, line 662 +
+
+
+
+
+
+
+
+
renderSpriteCoords(line, x, y, color)
+ + +
+
+
+
+
+
+
+
+
+ Renders the sprite coordinates in local, positional and world space.
+Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +|||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
line |
+
+
+ + + +Phaser.Sprite + + + + | + + ++ + + + + + | + + + ++ + | + + +The sprite to inspect. |
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
text |
+
+
+ + + +string + + + + | + + + + + +The text to render. You can have as many columns of text as you want, just pass them as additional parameters. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + utils/Debug.js, line 145 +
+
+
+
+
+
+
+
+
start(x, y, color, columnWidth)
+ + +
+
@@ -5506,41 +6553,6 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
- Internal method that resets and starts the debug output values.
spriteDescription.
x+ @@ -5568,10 +6582,12 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
X position of the debug info to be rendered.
The X value the debug info will start from.
+ @@ -5603,10 +6621,12 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
Y position of the debug info to be rendered.
The Y value the debug info will start from.
color of the debug info to be rendered. (format is css color string).
The color the debug text will drawn in.
columnWidth+ + + + + +
The spacing between columns.
- - utils/Debug.js, line 489 -
start(x, y, color)
- - -
-
-
-
-
-
-
-
-
- Internal method that resets and starts the debug output values.
-Parameters:
- - -| Name | - - -Type | - - - - - -Description | -
|---|---|---|
x |
-
-
- - - -number - - - - | - - - - - -The X value the debug info will start from. |
-
y |
-
-
- - - -number - - - - | - - - - - -The Y value the debug info will start from. |
-
color |
-
-
- - - -string - - - - | - - - - - -The color the debug info will drawn in. |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- @@ -5910,7 +6805,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
- Source:
- @@ -5955,13 +6850,13 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL - Phaser Copyright © 2012-2013 Photon Storm Ltd. + Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:36 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:36 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.Utils.html b/docs/Phaser.Utils.html index 9297b0dc..840f9c11 100644 --- a/docs/Phaser.Utils.html +++ b/docs/Phaser.Utils.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:35 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:36 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.World.html b/docs/Phaser.World.html index 47136911..2328e0fa 100644 --- a/docs/Phaser.World.html +++ b/docs/Phaser.World.html @@ -90,6 +90,10 @@ Device +
Extends
+ +-
+
- Phaser.Group +
-
+
-
+
alive
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Inherited From: +
- + + + + + + + + + + + +
- Default Value: +
- true
+
+
+
+ - Source: +
- + core/Group.js, line 77 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +alive+ + +boolean + + + + + + + + + +The alive property is useful for Groups that are children of other Groups and need to be included/excluded in checks like forEachAlive.
+
+
+
+ -
+
alpha
+ + +
+ -
+
+
+
+
+
+
-
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 1593 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +alpha+ + +number + + + + + + + + + +The alpha value of the Group container.
+
+
+
+ -
+
angle
+ + +
+ -
+
+ ++ + + + + +
The angle of rotation of the Group container. This will adjust the Group container itself by modifying its rotation. +This will have no impact on the rotation value of its children, but it will update their worldTransform and on-screen position.
+-
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 1541 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
+ +
++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +angle+ + +number + + + + + + + + + +The angle of rotation given in degrees, where 0 degrees = to the right.
+
+
+
-
bounds
@@ -666,7 +995,7 @@ So if you want to make a game in which the world itself will rotate you should a- Source:
- @@ -768,7 +1097,7 @@ So if you want to make a game in which the world itself will rotate you should a
- Source:
- @@ -870,7 +1199,7 @@ So if you want to make a game in which the world itself will rotate you should a
- Source:
- @@ -972,7 +1301,7 @@ So if you want to make a game in which the world itself will rotate you should a
- Source:
- @@ -1074,7 +1403,443 @@ So if you want to make a game in which the world itself will rotate you should a
- Source:
- - core/World.js, line 44 + core/World.js, line 40 +
+
+
+
+
+
+
+
+
cursor
+ + +
+
+
+
+
+
+
+The cursor is a simple way to iterate through the objects in a Group using the Group.next and Group.previous functions. +The cursor is set to the first child added to the Group and doesn't change unless you call next, previous or set it directly with Group.cursor.
+-
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 108 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
cursor |
+
+
+ + + +any + + + + | + + + + + +The current display object that the Group cursor is pointing to. |
+
exists
+ + +-
+
+
+
- Inherited From: +
- + + + + + + + + + + + +
- Default Value: +
- true
+
+
+
+ - Source: +
- + core/Group.js, line 83 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
exists |
+
+
+ + + +boolean + + + + | + + + + + +If exists is true the the Group is updated, otherwise it is skipped. |
+
game
+ + +-
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 22 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
game |
+
+
+ + + +Phaser.Game + + + + | + + + + + +A reference to the currently running Game. |
+
group
+ + +-
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- @@ -1176,7 +1941,328 @@ So if you want to make a game in which the world itself will rotate you should a
- Source:
- - core/World.js, line 186 + core/World.js, line 244 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
group |
+
+
+ + + +Phaser.Group + + + + | + + + + + +The parent Group of this Group, if a child of another. |
+
<readonly> length
+ + +-
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 1483 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
length |
+
+
+ + + +number + + + + | + + + + + +The total number of children in this Group, regardless of their exists/alive status. |
+
name
+ + +-
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 32 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
name |
+
+
+ + + +string + + + + | + + + + + +A name for this Group. Not used internally but useful for debugging. |
+
pivot
+ + +-
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- @@ -1278,7 +2364,7 @@ So if you want to make a game in which the world itself will rotate you should a
- Source:
- @@ -1380,7 +2466,119 @@ So if you want to make a game in which the world itself will rotate you should a
- Source:
- - core/World.js, line 250 + core/World.js, line 308 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
pivot |
+
+
+ + + +Phaser.Point + + + + | + + + + + +The pivot point of the Group container. |
+
rotation
+ + +
+
+
+
+
+
+
+The angle of rotation of the Group container. This will adjust the Group container itself by modifying its rotation. +This will have no impact on the rotation value of its children, but it will update their worldTransform and on-screen position.
+-
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- @@ -1453,7 +2651,7 @@ So if you want to make a game in which the world itself will rotate you should a -
- Inherited From: +
- + @@ -1482,7 +2685,221 @@ So if you want to make a game in which the world itself will rotate you should a
- Source:
- - core/World.js, line 25 + core/Group.js, line 96 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
rotation |
+
+
+ + + +number + + + + | + + + + + +The angle of rotation given in radians. |
+
Replaces the PIXI.Point with a slightly more flexible one.
The scane of the Group container.
<readonly> total
+ + +-
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 1461 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
total |
+
+
+ + + +number + + + + | + + + + + +The total number of children in this Group who have a state of exists = true. |
+
<protected> type
+ + +-
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- @@ -1584,7 +3001,7 @@ So if you want to make a game in which the world itself will rotate you should a
- Source:
- @@ -1686,7 +3103,231 @@ So if you want to make a game in which the world itself will rotate you should a
- Source:
- - core/World.js, line 170 + core/World.js, line 228 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
type |
+
+
+ + + +number + + + + | + + + + + +Internal Phaser Type value. |
+
x
+ + +
+
+
+
+
+
+
+The x coordinate of the Group container. You can adjust the Group container itself by modifying its coordinates. +This will have no impact on the x/y coordinates of its children, but it will update their worldTransform and on-screen position.
+-
+
+
+
- Inherited From: +
- + Phaser.Group#x +
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source: +
- + core/Group.js, line 1505 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
x |
+
+
+ + + +number + + + + | + + + + + +The x coordinate of the Group container. |
+
y
+ + +
+
+
+
+
+
+
+The y coordinate of the Group container. You can adjust the Group container itself by modifying its coordinates. +This will have no impact on the x/y coordinates of its children, but it will update their worldTransform and on-screen position.
+-
+
+
+
- Inherited From: +
- + Phaser.Group#y +
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source: +
- @@ -1709,6 +3350,526 @@ So if you want to make a game in which the world itself will rotate you should a
-
+
add(child) → {*}
+ + +
+ -
+
+
+ ++ + + + + + + +
Adds an existing object to this Group. The object can be an instance of Phaser.Sprite, Phaser.Button or any other display object. +The child is automatically added to the top of the Group, so renders on-top of everything else within the Group. If you need to control +that then see the addAt method.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +child+ + +* + + + + + + + + + +An instance of Phaser.Sprite, Phaser.Button or any other display object..
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + Phaser.Group#add +
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source: +
- + core/Group.js, line 144 +
+
+
+
+
+
+ - See: +
- + + + + + +
Returns:
+ + +++ + + +The child that was added to the Group.
+-
+
- + Type + +
- + +* + + + +
+
+
+
+ -
+
addAll(property, amount, checkAlive, checkVisible)
+ + +
+ -
+
+
+ ++ + + + + + + +
Adds the amount to the given property on all children in this Group. +Group.addAll('x', 10) will add 10 to the child.x value.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +property+ + +string + + + + + + + + + +The property to increment, for example 'body.velocity.x' or 'angle'.
+ + + + + +amount+ + +number + + + + + + + + + +The amount to increment the property by. If child.x = 10 then addAll('x', 40) would make child.x = 50.
+ + + + + +checkAlive+ + +boolean + + + + + + + + + +If true the property will only be changed if the child is alive.
+ + + + + +checkVisible+ + +boolean + + + + + + + + + +If true the property will only be changed if the child is visible.
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 747 +
+
+
+
+
+
+
+
+
+
+
+
+ -
+
addAt(child, index) → {*}
+ + +
+ -
+
+
+ ++ + + + + + + +
Adds an existing object to this Group. The object can be an instance of Phaser.Sprite, Phaser.Button or any other display object. +The child is added to the Group at the location specified by the index value, this allows you to control child ordering.
+Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +child+ + +* + + + + + + + + + +An instance of Phaser.Sprite, Phaser.Button or any other display object..
+ + + + + +index+ + +number + + + + + + + + + +The index within the Group to insert the child to.
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 191 +
+
+
+
+
+
+
+
+
Returns:
+ + +++ + + +The child that was added to the Group.
+-
+
- + Type + +
- + +* + + + +
+
+
+
-
<protected> boot()
@@ -1751,7 +3912,1571 @@ So if you want to make a game in which the world itself will rotate you should a- Source:
- - core/World.js, line 51 + core/World.js, line 47 +
+
+
+
+
+
+
+
+
Properties:
+ +-
+
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
y |
+
+
+ + + +number + + + + | + + + + + +The y coordinate of the Group container. |
+
-
+
bringToTop(child) → {*}
+ + +
+
+
+
+
+
+
+
+
+ Brings the given child to the top of this Group so it renders above all other children.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
child |
+
+
+ + + +* + + + + | + + + + + +The child to bring to the top of this Group. |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 551 +
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The child that was moved.
+-
+
- + Type + +
- + +* + + + +
callAll(method, context, parameter)
+ + +
+
+
+
+
+
+
+
+
+ Calls a function on all of the children regardless if they are dead or alive (see callAllExists if you need control over that) +After the method parameter and context you can add as many extra parameters as you like, which will all be passed to the child.
+Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
method |
+
+
+ + + +string + + + + | + + ++ + + + + + | + + + ++ + | + + +A string containing the name of the function that will be called. The function must exist on the child. |
+
context |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + null + + | + + +A string containing the context under which the method will be executed. Set to null to default to the child. |
+
parameter |
+
+
+ + + +* + + + + | + + +
+
+
+
+
+
+ <repeatable> + + |
+
+
+
+ + + | + + +Additional parameters that will be passed to the method. |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 896 +
+
+
+
+
+
+
+
+
callAllExists(callback, existsValue, parameter)
+ + +
+
+
+
+
+
+
+
+
+ Calls a function on all of the children that have exists=true in this Group. +After the existsValue parameter you can add as many parameters as you like, which will all be passed to the child callback.
+Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
callback |
+
+
+ + + +function + + + + | + + ++ + + + + + | + + + + +The function that exists on the children that will be called. |
+
existsValue |
+
+
+ + + +boolean + + + + | + + ++ + + + + + | + + + + +Only children with exists=existsValue will be called. |
+
parameter |
+
+
+ + + +* + + + + | + + +
+
+
+
+
+
+ <repeatable> + + |
+
+
+
+
+ Additional parameters that will be passed to the callback. |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 811 +
+
+
+
+
+
+
+
+
<protected> callbackFromArray(child, callback, length)
+ + +
+
+
+
+
+
+
+
+
+ Returns a reference to a function that exists on a child of the Group based on the given callback array.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
child |
+
+
+ + + +object + + + + | + + + + + +The object to inspect. |
+
callback |
+
+
+ + + +array + + + + | + + + + + +The array of function names. |
+
length |
+
+
+ + + +number + + + + | + + + + + +The size of the array (pre-calculated in callAll). |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 843 +
+
+
+
+
+
+
+
+
childTest()
+ + +
+
+
+
+
+
+
+
+
+
+
+Internal test.
+-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 376 +
+
+
+
+
+
+
+
+
countDead() → {number}
+ + +
+
+
+
+
+
+
+
+
+
+
+Call this function to find out how many members of the group are dead.
+-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 1230 +
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The number of children flagged as dead.
+-
+
- + Type + +
- + +number + + + +
countLiving() → {number}
+ + +
+
+
+
+
+
+
+
+
+
+
+Call this function to find out how many members of the group are alive.
+-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 1218 +
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The number of children flagged as alive.
+-
+
- + Type + +
- + +number + + + +
create(x, y, key, frame, exists) → {Phaser.Sprite}
+ + +
+
+
+
+
+
+
+
+
+ Automatically creates a new Phaser.Sprite object and adds it to the top of this Group. +Useful if you don't need to create the Sprite instances before-hand.
+Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
x |
+
+
+ + + +number + + + + | + + ++ + + + + + | + + + ++ + | + + +The x coordinate to display the newly created Sprite at. The value is in relation to the Group.x point. |
+
y |
+
+
+ + + +number + + + + | + + ++ + + + + + | + + + ++ + | + + +The y coordinate to display the newly created Sprite at. The value is in relation to the Group.y point. |
+
key |
+
+
+ + + +string + + + + | + + ++ + + + + + | + + + ++ + | + + +The Game.cache key of the image that this Sprite will use. |
+
frame |
+
+
+ + + +number +| + +string + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + | + + +If the Sprite image contains multiple frames you can specify which one to use here. |
+
exists |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + true + + | + + +The default exists state of the Sprite. |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 249 +
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The child that was created.
+-
+
- + Type + +
- + +Phaser.Sprite + + + +
createMultiple(quantity, key, frame, exists)
+ + +
+
+
+
+
+
+
+
+
+ Automatically creates multiple Phaser.Sprite objects and adds them to the top of this Group. +Useful if you need to quickly generate a pool of identical sprites, such as bullets. By default the sprites will be set to not exist +and will be positioned at 0, 0 (relative to the Group.x/y)
+Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
quantity |
+
+
+ + + +number + + + + | + + ++ + + + + + | + + + ++ + | + + +The number of Sprites to create. |
+
key |
+
+
+ + + +string + + + + | + + ++ + + + + + | + + + ++ + | + + +The Game.cache key of the image that this Sprite will use. |
+
frame |
+
+
+ + + +number +| + +string + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + | + + +If the Sprite image contains multiple frames you can specify which one to use here. |
+
exists |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + false + + | + + +The default exists state of the Sprite. |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- @@ -1820,7 +5545,2196 @@ So if you want to make a game in which the world itself will rotate you should a
- Source:
- - core/World.js, line 155 + core/World.js, line 213 +
+
+
+
+
+
+
+
+
divideAll(property, amount, checkAlive, checkVisible)
+ + +
+
+
+
+
+
+
+
+
+ Divides the given property by the amount on all children in this Group. +Group.divideAll('x', 2) will half the child.x value.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
property |
+
+
+ + + +string + + + + | + + + + + +The property to divide, for example 'body.velocity.x' or 'angle'. |
+
amount |
+
+
+ + + +number + + + + | + + + + + +The amount to divide the property by. If child.x = 100 then divideAll('x', 2) would make child.x = 50. |
+
checkAlive |
+
+
+ + + +boolean + + + + | + + + + + +If true the property will only be changed if the child is alive. |
+
checkVisible |
+
+
+ + + +boolean + + + + | + + + + + +If true the property will only be changed if the child is visible. |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 795 +
+
+
+
+
+
+
+
+
forEach(callback, callbackContext, checkExists)
+ + +
+
+
+
+
+
+
+
+
+ Allows you to call your own function on each member of this Group. You must pass the callback and context in which it will run. +After the checkExists parameter you can add as many parameters as you like, which will all be passed to the callback along with the child. +For example: Group.forEach(awardBonusGold, this, true, 100, 500) +Note: Currently this will skip any children which are Groups themselves.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
callback |
+
+
+ + + +function + + + + | + + + + + +The function that will be called. Each child of the Group will be passed to it as its first parameter. |
+
callbackContext |
+
+
+ + + +Object + + + + | + + + + + +The context in which the function should be called (usually 'this'). |
+
checkExists |
+
+
+ + + +boolean + + + + | + + + + + +If set only children with exists=true will be passed to the callback, otherwise all children will be passed. |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 965 +
+
+
+
+
+
+
+
+
forEachAlive(callback, callbackContext)
+ + +
+
+
+
+
+
+
+
+
+ Allows you to call your own function on each alive member of this Group (where child.alive=true). You must pass the callback and context in which it will run. +You can add as many parameters as you like, which will all be passed to the callback along with the child. +For example: Group.forEachAlive(causeDamage, this, 500)
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
callback |
+
+
+ + + +function + + + + | + + + + + +The function that will be called. Each child of the Group will be passed to it as its first parameter. |
+
callbackContext |
+
+
+ + + +Object + + + + | + + + + + +The context in which the function should be called (usually 'this'). |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 1006 +
+
+
+
+
+
+
+
+
forEachAlive(callback, callbackContext)
+ + +
+
+
+
+
+
+
+
+
+ Allows you to call your own function on each alive member of this Group (where child.alive=true). You must pass the callback and context in which it will run. +You can add as many parameters as you like, which will all be passed to the callback along with the child. +For example: Group.forEachAlive(causeDamage, this, 500)
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
callback |
+
+
+ + + +function + + + + | + + + + + +The function that will be called. Each child of the Group will be passed to it as its first parameter. |
+
callbackContext |
+
+
+ + + +Object + + + + | + + + + + +The context in which the function should be called (usually 'this'). |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 1024 +
+
+
+
+
+
+
+
+
forEachDead(callback, callbackContext)
+ + +
+
+
+
+
+
+
+
+
+ Allows you to call your own function on each dead member of this Group (where alive=false). You must pass the callback and context in which it will run. +You can add as many parameters as you like, which will all be passed to the callback along with the child. +For example: Group.forEachDead(bringToLife, this)
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
callback |
+
+
+ + + +function + + + + | + + + + + +The function that will be called. Each child of the Group will be passed to it as its first parameter. |
+
callbackContext |
+
+
+ + + +Object + + + + | + + + + + +The context in which the function should be called (usually 'this'). |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 1042 +
+
+
+
+
+
+
+
+
getAt(index) → {*}
+ + +
+
+
+
+
+
+
+
+
+ Returns the child found at the given index within this Group.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
index |
+
+
+ + + +number + + + + | + + + + + +The index to return the child from. |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 236 +
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The child that was found at the given index.
+-
+
- + Type + +
- + +* + + + +
getFirstAlive() → {Any}
+ + +
+
+
+
+
+
+
+
+
+
+
+Call this function to retrieve the first object with alive === true in the group. +This is handy for checking if everything has been wiped out, or choosing a squad leader, etc.
+-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 1192 +
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The first alive child, or null if none found.
+-
+
- + Type + +
- + +Any + + + +
getFirstDead() → {Any}
+ + +
+
+
+
+
+
+
+
+
+
+
+Call this function to retrieve the first object with alive === false in the group. +This is handy for checking if everything has been wiped out, or choosing a squad leader, etc.
+-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 1205 +
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The first dead child, or null if none found.
+-
+
- + Type + +
- + +Any + + + +
getFirstExists(state) → {Any}
+ + +
+
+
+
+
+
+
+
+
+ Call this function to retrieve the first object with exists == (the given state) in the Group.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
state |
+
+
+ + + +boolean + + + + | + + + + + +True or false. |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 1174 +
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The first child, or null if none found.
+-
+
- + Type + +
- + +Any + + + +
getIndex(child) → {number}
+ + +
+
+
+
+
+
+
+
+
+ Get the index position of the given child in this Group.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
child |
+
+
+ + + +* + + + + | + + + + + +The child to get the index for. |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 570 +
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The index of the child or -1 if it's not a member of this Group.
+-
+
- + Type + +
- + +number + + + +
getRandom(startIndex, length) → {Any}
+ + +
+
+
+
+
+
+
+
+
+ Returns a member at random from the group.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
startIndex |
+
+
+ + + +number + + + + | + + + + + +Optional offset off the front of the array. Default value is 0, or the beginning of the array. |
+
length |
+
+
+ + + +number + + + + | + + + + + +Optional restriction on the number of values you want to randomly select from. |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 1242 +
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+A random child of this Group.
+-
+
- + Type + +
- + +Any + + + +
iterate(key, value, returnType, callback, callbackContext) → {any}
+ + +
+
+
+
+
+
+
+
+
+ Iterates over the children of the Group. When a child has a property matching key that equals the given value, it is considered as a match. +Matched children can be sent to the optional callback, or simply returned or counted. +You can add as many callback parameters as you like, which will all be passed to the callback along with the child, after the callbackContext parameter.
+Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + + + | + + + ++ + | + + +The child property to check, i.e. 'exists', 'alive', 'health' |
+
value |
+
+
+ + + +any + + + + | + + ++ + + + + + | + + + ++ + | + + +If child.key === this value it will be considered a match. Note that a strict comparison is used. |
+
returnType |
+
+
+ + + +number + + + + | + + ++ + + + + + | + + + ++ + | + + +How to return the data from this method. Either Phaser.Group.RETURN_NONE, Phaser.Group.RETURN_TOTAL or Phaser.Group.RETURN_CHILD. |
+
callback |
+
+
+ + + +function + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + null + + | + + +Optional function that will be called on each matching child. Each child of the Group will be passed to it as its first parameter. |
+
callbackContext |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + | + + +The context in which the function should be called (usually 'this'). |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 1109 +
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+Returns either a numeric total (if RETURN_TOTAL was specified) or the child object.
+-
+
- + Type + +
- + +any + + + +
multiplyAll(property, amount, checkAlive, checkVisible)
+ + +
+
+
+
+
+
+
+
+
+ Multiplies the given property by the amount on all children in this Group. +Group.multiplyAll('x', 2) will x2 the child.x value.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
property |
+
+
+ + + +string + + + + | + + + + + +The property to multiply, for example 'body.velocity.x' or 'angle'. |
+
amount |
+
+
+ + + +number + + + + | + + + + + +The amount to multiply the property by. If child.x = 10 then multiplyAll('x', 2) would make child.x = 20. |
+
checkAlive |
+
+
+ + + +boolean + + + + | + + + + + +If true the property will only be changed if the child is alive. |
+
checkVisible |
+
+
+ + + +boolean + + + + | + + + + + +If true the property will only be changed if the child is visible. |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 779 +
+
+
+
+
+
+
+
+
next()
+ + +
+
+
+
+
+
+
+
+
+
+
+Advances the Group cursor to the next object in the Group. If it's at the end of the Group it wraps around to the first object.
+-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- @@ -1856,7 +7770,10 @@ So if you want to make a game in which the world itself will rotate you should a
- Source:
- - core/World.js, line 110 + core/World.js, line 125 +
+
+
+
+
+
+
+
+
-
@@ -1889,7 +7806,1213 @@ So if you want to make a game in which the world itself will rotate you should a
This is called automatically every frame, and is where main logic happens.
+This is called automatically before the renderer runs and after the plugins have updated. +In postUpdate this is where all the final physics calculatations and object positioning happens. +The objects are processed in the order of the display list. +The only exception to this is if the camera is following an object, in which case that is updated first.
previous()
+ + +
+
+
+
+
+
+
+
+
+
+
+Moves the Group cursor to the previous object in the Group. If it's at the start of the Group it wraps around to the last object.
+-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 354 +
+
+
+
+
+
+
+
+
remove(child) → {boolean}
+ + +
+
+
+
+
+
+
+
+
+ Removes the given child from this Group and sets its group property to null.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
child |
+
+
+ + + +Any + + + + | + + + + + +The child to remove. |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 1264 +
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+true if the child was removed from this Group, otherwise false.
+-
+
- + Type + +
- + +boolean + + + +
removeAll()
+ + +
+
+
+
+
+
+
+
+
+
+
+Removes all children from this Group, setting all group properties to null. +The Group container remains on the display list.
+-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 1307 +
+
+
+
+
+
+
+
+
removeBetween(startIndex, endIndex)
+ + +
+
+
+
+
+
+
+
+
+ Removes all children from this Group whos index falls beteen the given startIndex and endIndex values.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
startIndex |
+
+
+ + + +number + + + + | + + + + + +The index to start removing children from. |
+
endIndex |
+
+
+ + + +number + + + + | + + + + + +The index to stop removing children from. Must be higher than startIndex and less than the length of the Group. |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 1334 +
+
+
+
+
+
+
+
+
replace(oldChild, newChild)
+ + +
+
+
+
+
+
+
+
+
+ Replaces a child of this Group with the given newChild. The newChild cannot be a member of this Group.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
oldChild |
+
+
+ + + +* + + + + | + + + + + +The child in this Group that will be replaced. |
+
newChild |
+
+
+ + + +* + + + + | + + + + + +The child to be inserted into this group. |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 583 +
+
+
+
+
+
+
+
+
set(child, key, value, checkAlive, checkVisible, operation)
+ + +
+
+
+
+
+
+
+
+
+ This function allows you to quickly set a property on a single child of this Group to a new value. +The operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.
+Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
child |
+
+
+ + + +Phaser.Sprite + + + + | + + ++ + + + + + | + + + ++ + | + + +The child to set the property on. |
+
key |
+
+
+ + + +string + + + + | + + ++ + + + + + | + + + ++ + | + + +The property, as a string, to be set. For example: 'body.velocity.x' |
+
value |
+
+
+ + + +* + + + + | + + ++ + + + + + | + + + ++ + | + + +The value that will be set. |
+
checkAlive |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + false + + | + + +If set then the child will only be updated if alive=true. |
+
checkVisible |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + false + + | + + +If set then the child will only be updated if visible=true. |
+
operation |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + 0 + + | + + +Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it. |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + Phaser.Group#set +
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source: +
- + core/Group.js, line 683 +
+
+
+
+
+
+
+
+
setAll(key, value, checkAlive, checkVisible, operation)
+ + +
+
+
+
+
+
+
+
+
+ This function allows you to quickly set the same property across all children of this Group to a new value. +The operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.
+Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + + + | + + + ++ + | + + +The property, as a string, to be set. For example: 'body.velocity.x' |
+
value |
+
+
+ + + +* + + + + | + + ++ + + + + + | + + + ++ + | + + +The value that will be set. |
+
checkAlive |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + false + + | + + +If set then only children with alive=true will be updated. |
+
checkVisible |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + false + + | + + +If set then only children with visible=true will be updated. |
+
operation |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + 0 + + | + + +Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it. |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- @@ -1925,8 +9048,7 @@ So if you want to make a game in which the world itself will rotate you should a
- Source:
- - core/World.js, line 135 + core/World.js, line 180 +
+
+
+
+
+
+
+
+
-
@@ -2022,7 +9144,7 @@ If you need to adjust the bounds of the world
- Updates the size of this world. Note that this doesn't modify the world x/y coordinates, just the width and height. -If you need to adjust the bounds of the world
+Updates the size of this world. Note that this doesn't modify the world x/y coordinates, just the width and height.
New width of the world.
New width of the world. Can never be smaller than the Game.width.
New height of the world.
New height of the world. Can never be smaller than the Game.height.
setProperty(child, key, value, operation)
+ + +
+
+
+
+
+
+
+
+
+ Sets the given property to the given value on the child. The operation controls the assignment of the value.
+Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
child |
+
+
+ + + +* + + + + | + + ++ + + + + + | + + + ++ + | + + +The child to set the property value on. |
+
key |
+
+
+ + + +array + + + + | + + ++ + + + + + | + + + ++ + | + + +An array of strings that make up the property that will be set. |
+
value |
+
+
+ + + +* + + + + | + + ++ + + + + + | + + + ++ + | + + +The value that will be set. |
+
operation |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + 0 + + | + + +Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it. |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 621 +
+
+
+
+
+
+
+
+
sort(index, order)
+ + +
+
+
+
+
+
+
+
+
+ Call this function to sort the group according to a particular value and order.
+For example to depth sort Sprites for Zelda-style game you might call group.sort('y', Phaser.Group.SORT_ASCENDING) at the bottom of your State.update().
Parameters:
+ + +| Name | + + +Type | + + +Argument | + + + +Default | + + +Description | +
|---|---|---|---|---|
index |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + 'y' + + | + + +The |
+
order |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + Phaser.Group.SORT_ASCENDING + + | + + +The |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 1060 +
+
+
+
+
+
+
+
+
subAll(property, amount, checkAlive, checkVisible)
+ + +
+
+
+
+
+
+
+
+
+ Subtracts the amount from the given property on all children in this Group. +Group.subAll('x', 10) will minus 10 from the child.x value.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
property |
+
+
+ + + +string + + + + | + + + + + +The property to decrement, for example 'body.velocity.x' or 'angle'. |
+
amount |
+
+
+ + + +number + + + + | + + + + + +The amount to subtract from the property. If child.x = 50 then subAll('x', 40) would make child.x = 10. |
+
checkAlive |
+
+
+ + + +boolean + + + + | + + + + + +If true the property will only be changed if the child is alive. |
+
checkVisible |
+
+
+ + + +boolean + + + + | + + + + + +If true the property will only be changed if the child is visible. |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 763 +
+
+
+
+
+
+
+
+
swap(child1, child2) → {boolean}
+ + +
+
+
+
+
+
+
+
+
+ Swaps the position of two children in this Group. Both children must be in this Group. +You cannot swap a child with itself, or swap un-parented children, doing so will return false.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
child1 |
+
+
+ + + +* + + + + | + + + + + +The first child to swap. |
+
child2 |
+
+
+ + + +* + + + + | + + + + + +The second child to swap. |
+
-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- + core/Group.js, line 423 +
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+True if the swap was successful, otherwise false.
+-
+
- + Type + +
- + +boolean + + + +
swapIndex()
+ + +
+
+
+
+
+
+
+
+
+
+
+Internal test.
+-
+
+
+
+
+
+
+
+
- Inherited From: +
- + + + + + + + + + + + + + +
- Source: +
- @@ -2113,7 +10103,8 @@ If you need to adjust the bounds of the world
- Source:
- - core/World.js, line 67 + core/World.js, line 63 +
+
+
+
+
+
+
+
+
-
@@ -2146,7 +10137,77 @@ If you need to adjust the bounds of the world
This is called automatically every frame, and is where main logic happens.
+This is called automatically after the plugins preUpdate and before the State.update. +Most objects have preUpdate methods and it's where initial movement, drawing and calculations are done.
update()
+ + +
+
+
+
+
+
+
+
+
+
+
+This is called automatically after the State.update, but before particles or plugins update. +Most objects won't have an update method set unless explicitly given one.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- @@ -2191,13 +10252,13 @@ If you need to adjust the bounds of the world - Phaser Copyright © 2012-2013 Photon Storm Ltd. + Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:36 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:37 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.html b/docs/Phaser.html index 59718ca0..ecf95de5 100644 --- a/docs/Phaser.html +++ b/docs/Phaser.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:26 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:25 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Phaser.js.html b/docs/Phaser.js.html index 6736abc8..0c5ebf0e 100644 --- a/docs/Phaser.js.html +++ b/docs/Phaser.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -433,7 +427,7 @@
var Phaser = Phaser || {
VERSION: '<%= version %>',
- DEV_VERSION: '1.1.3',
+ DEV_VERSION: '1.1.4',
GAMES: [],
AUTO: 0,
@@ -462,7 +456,10 @@ var Phaser = Phaser || {
LEFT: 1,
RIGHT: 2,
UP: 3,
- DOWN: 4
+ DOWN: 4,
+
+ CANVAS_PX_ROUND: false,
+ CANVAS_CLEAR_RECT: true
};
@@ -485,13 +482,13 @@ PIXI.InteractionManager = function (dummy) {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Plugin.js.html b/docs/Plugin.js.html
index 9b26cad5..8302d705 100644
--- a/docs/Plugin.js.html
+++ b/docs/Plugin.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -542,6 +536,8 @@ Phaser.Plugin.prototype = {
}
};
+
+Phaser.Plugin.prototype.constructor = Phaser.Plugin;
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/PluginManager.js.html b/docs/PluginManager.js.html index 5fad2dfe..b2bd4a46 100644 --- a/docs/PluginManager.js.html +++ b/docs/PluginManager.js.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Point.js.html b/docs/Point.js.html index 41c1972f..34a3fe53 100644 --- a/docs/Point.js.html +++ b/docs/Point.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -711,6 +705,8 @@ Phaser.Point.prototype = {
};
+Phaser.Point.prototype.constructor = Phaser.Point;
+
/**
* Adds the coordinates of two points together to create a new point.
* @method Phaser.Point.add
@@ -866,13 +862,13 @@ Phaser.Point.rotate = function (a, x, y, angle, asDegrees, distance) {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Pointer.js.html b/docs/Pointer.js.html
index 769805ec..12357a84 100644
--- a/docs/Pointer.js.html
+++ b/docs/Pointer.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -630,7 +624,7 @@ Phaser.Pointer.prototype = {
}
// Fix to stop rogue browser plugins from blocking the visibility state event
- if (this.game.paused === true && this.game.stage.scale.incorrectOrientation === false)
+ if (this.game.stage.disableVisibilityChange === false && this.game.paused && this.game.stage.scale.incorrectOrientation === false)
{
this.game.paused = false;
return this;
@@ -680,7 +674,7 @@ Phaser.Pointer.prototype = {
},
/**
- * Called internall by the Input Manager.
+ * Called by the Input Manager.
* @method Phaser.Pointer#update
*/
update: function () {
@@ -759,12 +753,17 @@ Phaser.Pointer.prototype = {
this.game.input.circle.y = this.game.input.y;
}
- // If the game is paused we don't process any target objects
+ // If the game is paused we don't process any target objects or callbacks
if (this.game.paused)
{
return this;
}
+ if (this.game.input.moveCallback)
+ {
+ this.game.input.moveCallback.call(this.game.input.moveCallbackContext, this, this.x, this.y);
+ }
+
// Easy out if we're dragging something and it still exists
if (this.targetObject !== null && this.targetObject.isDragged === true)
{
@@ -1006,6 +1005,8 @@ Phaser.Pointer.prototype = {
};
+Phaser.Pointer.prototype.constructor = Phaser.Pointer;
+
/**
* How long the Pointer has been depressed on the touchscreen. If not currently down it returns -1.
* @name Phaser.Pointer#duration
@@ -1073,13 +1074,13 @@ Object.defineProperty(Phaser.Pointer.prototype, "worldY", {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Polygon.js.html b/docs/Polygon.js.html
index f6b45bb7..2a9440c0 100644
--- a/docs/Polygon.js.html
+++ b/docs/Polygon.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -465,13 +459,13 @@ Phaser.Polygon.prototype.constructor = Phaser.Polygon;
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/QuadTree.js.html b/docs/QuadTree.js.html index c1774604..856ca076 100644 --- a/docs/QuadTree.js.html +++ b/docs/QuadTree.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
- * Javascript QuadTree
- * @version 1.0
- * @author Timo Hausmann
- *
- * @version 1.2, September 4th 2013
- * @author Richard Davey
- * The original code was a conversion of the Java code posted to GameDevTuts. However I've tweaked
- * it massively to add node indexing, removed lots of temp. var creation and significantly
- * increased performance as a result.
- *
- * Original version at https://github.com/timohausmann/quadtree-js/
- */
+* Javascript QuadTree
+* @version 1.0
+* @author Timo Hausmann
+*
+* @version 1.2, September 4th 2013
+* @author Richard Davey
+* The original code was a conversion of the Java code posted to GameDevTuts. However I've tweaked
+* it massively to add node indexing, removed lots of temp. var creation and significantly
+* increased performance as a result.
+*
+* Original version at https://github.com/timohausmann/quadtree-js/
+*/
/**
* @copyright © 2012 Timo Hausmann
@@ -465,27 +459,23 @@
*/
/**
- * QuadTree Constructor
- *
- * @class Phaser.QuadTree
- * @classdesc A QuadTree implementation. The original code was a conversion of the Java code posted to GameDevTuts. However I've tweaked
- * it massively to add node indexing, removed lots of temp. var creation and significantly increased performance as a result. Original version at https://github.com/timohausmann/quadtree-js/
- * @constructor
- * @param {Description} physicsManager - Description.
- * @param {Description} x - Description.
- * @param {Description} y - Description.
- * @param {number} width - The width of your game in game pixels.
- * @param {number} height - The height of your game in game pixels.
- * @param {number} maxObjects - Description.
- * @param {number} maxLevels - Description.
- * @param {number} level - Description.
- */
-Phaser.QuadTree = function (physicsManager, x, y, width, height, maxObjects, maxLevels, level) {
+* QuadTree Constructor
+*
+* @class Phaser.QuadTree
+* @classdesc A QuadTree implementation. The original code was a conversion of the Java code posted to GameDevTuts.
+* However I've tweaked it massively to add node indexing, removed lots of temp. var creation and significantly increased performance as a result.
+* Original version at https://github.com/timohausmann/quadtree-js/
+* @constructor
+* @param {number} x - The top left coordinate of the quadtree.
+* @param {number} y - The top left coordinate of the quadtree.
+* @param {number} width - The width of the quadtree in pixels.
+* @param {number} height - The height of the quadtree in pixels.
+* @param {number} [maxObjects=10] - The maximum number of objects per node.
+* @param {number} [maxLevels=4] - The maximum number of levels to iterate to.
+* @param {number} [level=0] - Which level is this?
+*/
+Phaser.QuadTree = function (x, y, width, height, maxObjects, maxLevels, level) {
- this.physicsManager = physicsManager;
- this.ID = physicsManager.quadTreeID;
- physicsManager.quadTreeID++;
-
this.maxObjects = maxObjects || 10;
this.maxLevels = maxLevels || 4;
this.level = level || 0;
@@ -509,35 +499,60 @@ Phaser.QuadTree = function (physicsManager, x, y, width, height, maxObjects, max
Phaser.QuadTree.prototype = {
/*
- * Split the node into 4 subnodes
+ * Populates this quadtree with the members of the given Group.
*
- * @method Phaser.QuadTree#split
+ * @method Phaser.QuadTree#populate
+ * @param {Phaser.Group} group - The Group to add to the quadtree.
*/
- split: function() {
+ populate: function (group) {
- this.level++;
-
- // top right node
- this.nodes[0] = new Phaser.QuadTree(this.physicsManager, this.bounds.right, this.bounds.y, this.bounds.subWidth, this.bounds.subHeight, this.maxObjects, this.maxLevels, this.level);
-
- // top left node
- this.nodes[1] = new Phaser.QuadTree(this.physicsManager, this.bounds.x, this.bounds.y, this.bounds.subWidth, this.bounds.subHeight, this.maxObjects, this.maxLevels, this.level);
-
- // bottom left node
- this.nodes[2] = new Phaser.QuadTree(this.physicsManager, this.bounds.x, this.bounds.bottom, this.bounds.subWidth, this.bounds.subHeight, this.maxObjects, this.maxLevels, this.level);
-
- // bottom right node
- this.nodes[3] = new Phaser.QuadTree(this.physicsManager, this.bounds.right, this.bounds.bottom, this.bounds.subWidth, this.bounds.subHeight, this.maxObjects, this.maxLevels, this.level);
+ group.forEach(this.populateHandler, this, true);
},
/*
- * Insert the object into the node. If the node
- * exceeds the capacity, it will split and add all
- * objects to their corresponding subnodes.
+ * Handler for the populate method.
+ *
+ * @method Phaser.QuadTree#populateHandler
+ * @param {Phaser.Sprite} sprite - The Sprite to check.
+ */
+ populateHandler: function (sprite) {
+
+ if (sprite.body && sprite.body.checkCollision.none === false && sprite.alive)
+ {
+ this.insert(sprite.body);
+ }
+
+ },
+
+ /*
+ * Split the node into 4 subnodes
+ *
+ * @method Phaser.QuadTree#split
+ */
+ split: function () {
+
+ this.level++;
+
+ // top right node
+ this.nodes[0] = new Phaser.QuadTree(this.bounds.right, this.bounds.y, this.bounds.subWidth, this.bounds.subHeight, this.maxObjects, this.maxLevels, this.level);
+
+ // top left node
+ this.nodes[1] = new Phaser.QuadTree(this.bounds.x, this.bounds.y, this.bounds.subWidth, this.bounds.subHeight, this.maxObjects, this.maxLevels, this.level);
+
+ // bottom left node
+ this.nodes[2] = new Phaser.QuadTree(this.bounds.x, this.bounds.bottom, this.bounds.subWidth, this.bounds.subHeight, this.maxObjects, this.maxLevels, this.level);
+
+ // bottom right node
+ this.nodes[3] = new Phaser.QuadTree(this.bounds.right, this.bounds.bottom, this.bounds.subWidth, this.bounds.subHeight, this.maxObjects, this.maxLevels, this.level);
+
+ },
+
+ /*
+ * Insert the object into the node. If the node exceeds the capacity, it will split and add all objects to their corresponding subnodes.
*
* @method Phaser.QuadTree#insert
- * @param {object} body - Description.
+ * @param {Phaser.Physics.Arcade.Body|object} body - The Body object to insert into the quadtree.
*/
insert: function (body) {
@@ -589,7 +604,7 @@ Phaser.QuadTree.prototype = {
* Determine which node the object belongs to.
*
* @method Phaser.QuadTree#getIndex
- * @param {object} rect - Description.
+ * @param {Phaser.Rectangle|object} rect - The bounds in which to check.
* @return {number} index - Index of the subnode (0-3), or -1 if rect cannot completely fit within a subnode and is part of the parent node.
*/
getIndex: function (rect) {
@@ -629,12 +644,12 @@ Phaser.QuadTree.prototype = {
},
- /*
- * Return all objects that could collide with the given object.
+ /*
+ * Return all objects that could collide with the given Sprite.
*
* @method Phaser.QuadTree#retrieve
- * @param {object} rect - Description.
- * @Return {array} - Array with all detected objects.
+ * @param {Phaser.Sprite} sprite - The sprite to check against.
+ * @return {array} - Array with all detected objects.
*/
retrieve: function (sprite) {
@@ -643,7 +658,7 @@ Phaser.QuadTree.prototype = {
sprite.body.quadTreeIndex = this.getIndex(sprite.body);
// Temp store for the node IDs this sprite is in, we can use this for fast elimination later
- sprite.body.quadTreeIDs.push(this.ID);
+ // sprite.body.quadTreeIDs.push(this.ID);
if (this.nodes[0])
{
@@ -676,7 +691,6 @@ Phaser.QuadTree.prototype = {
for (var i = 0, len = this.nodes.length; i < len; i++)
{
- // if (typeof this.nodes[i] !== 'undefined')
if (this.nodes[i])
{
this.nodes[i].clear();
@@ -686,6 +700,8 @@ Phaser.QuadTree.prototype = {
}
};
+
+Phaser.QuadTree.prototype.constructor = Phaser.QuadTree;
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/RandomDataGenerator.js.html b/docs/RandomDataGenerator.js.html index 5e49be91..20d38246 100644 --- a/docs/RandomDataGenerator.js.html +++ b/docs/RandomDataGenerator.js.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Rectangle.js.html b/docs/Rectangle.js.html index f9559709..4b5a9635 100644 --- a/docs/Rectangle.js.html +++ b/docs/Rectangle.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -689,6 +683,8 @@ Phaser.Rectangle.prototype = {
};
+Phaser.Rectangle.prototype.constructor = Phaser.Rectangle;
+
/**
* @name Phaser.Rectangle#halfWidth
* @property {number} halfWidth - Half of the width of the Rectangle.
@@ -1067,12 +1063,12 @@ Phaser.Rectangle.intersection = function (a, b, out) {
*/
Phaser.Rectangle.intersects = function (a, b) {
- return (a.x < b.right && b.x < a.right && a.y < b.bottom && b.y < a.bottom);
+ if (a.width <= 0 || a.height <= 0 || b.width <= 0 || b.height <= 0)
+ {
+ return false;
+ }
- // return (a.x <= b.right && b.x <= a.right && a.y <= b.bottom && b.y <= a.bottom);
-
- // return (a.left <= b.right && b.left <= a.right && a.top <= b.bottom && b.top <= a.bottom);
- // return !(a.x > b.right + tolerance || a.right < b.x - tolerance || a.y > b.bottom + tolerance || a.bottom < b.y - tolerance);
+ return !(a.right < b.x || a.bottom < b.y || a.x > b.right || a.y > b.bottom);
};
@@ -1124,13 +1120,13 @@ Phaser.Rectangle.union = function (a, b, out) {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/RenderTexture.js.html b/docs/RenderTexture.js.html
index ef4b643d..b85fcadd 100644
--- a/docs/RenderTexture.js.html
+++ b/docs/RenderTexture.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -494,16 +488,19 @@ Phaser.RenderTexture.prototype.constructor = PIXI.RenderTexture;
/**
* This function will draw the display object to the texture. If the display object is a Group or has children it will
* draw all children as well.
-*
-* @method render
+*
+* @method Phaser.RenderTexture#render
+* @memberof Phaser.RenderTexture
* @param {DisplayObject} displayObject - The display object to render this texture on.
* @param {Phaser.Point} [position] - Where to draw the display object.
* @param {boolean} [clear=false] - If true the texture will be cleared before the displayObject is drawn.
+* @param {boolean} [renderHidden=false] - If true displayObjects that have their visible property set to false will still be rendered.
*/
-Phaser.RenderTexture.prototype.render = function(displayObject, position, clear) {
+Phaser.RenderTexture.prototype.render = function(displayObject, position, clear, renderHidden) {
if (typeof position === 'undefined') { position = false; }
if (typeof clear === 'undefined') { clear = false; }
+ if (typeof renderHidden === 'undefined') { renderHidden = false; }
if (displayObject instanceof Phaser.Group)
{
@@ -512,11 +509,11 @@ Phaser.RenderTexture.prototype.render = function(displayObject, position, clear)
if (PIXI.gl)
{
- this.renderWebGL(displayObject, position, clear);
+ this.renderWebGL(displayObject, position, clear, renderHidden);
}
else
{
- this.renderCanvas(displayObject, position, clear);
+ this.renderCanvas(displayObject, position, clear, renderHidden);
}
}
@@ -525,29 +522,32 @@ Phaser.RenderTexture.prototype.render = function(displayObject, position, clear)
* This function will draw the display object to the texture at the given x/y coordinates.
* If the display object is a Group or has children it will draw all children as well.
*
-* @method renderXY
+* @method Phaser.RenderTexture#renderXY
+* @memberof Phaser.RenderTexture
* @param {DisplayObject} displayObject - The display object to render this texture on.
* @param {number} x - The x coordinate to draw the display object at.
* @param {number} y - The y coordinate to draw the display object at.
* @param {boolean} [clear=false] - If true the texture will be cleared before the displayObject is drawn.
+* @param {boolean} [renderHidden=false] - If true displayObjects that have their visible property set to false will still be rendered.
*/
-Phaser.RenderTexture.prototype.renderXY = function(displayObject, x, y, clear) {
+Phaser.RenderTexture.prototype.renderXY = function(displayObject, x, y, clear, renderHidden) {
this._tempPoint.x = x;
this._tempPoint.y = y;
- this.render(displayObject, this._tempPoint, clear);
+ this.render(displayObject, this._tempPoint, clear, renderHidden);
}
/**
- * Initializes the webgl data for this texture
- *
- * @method initWebGL
- * @private
- */
-Phaser.RenderTexture.prototype.initWebGL = function()
-{
+* Initializes the webgl data for this texture
+*
+* @method Phaser.RenderTexture#initWebGL
+* @memberof Phaser.RenderTexture
+* @private
+*/
+Phaser.RenderTexture.prototype.initWebGL = function() {
+
var gl = PIXI.gl;
this.glFramebuffer = gl.createFramebuffer();
@@ -583,7 +583,12 @@ Phaser.RenderTexture.prototype.initWebGL = function()
// this.render = this.renderWebGL;
}
-
+/**
+* Resizes the RenderTexture.
+*
+* @method Phaser.RenderTexture#resize
+* @memberof Phaser.RenderTexture
+*/
Phaser.RenderTexture.prototype.resize = function(width, height)
{
@@ -609,11 +614,12 @@ Phaser.RenderTexture.prototype.resize = function(width, height)
}
/**
- * Initializes the canvas data for this texture
- *
- * @method initCanvas
- * @private
- */
+* Initializes the canvas data for this texture
+*
+* @method Phaser.RenderTexture#initCanvas
+* @memberof Phaser.RenderTexture
+* @private
+*/
Phaser.RenderTexture.prototype.initCanvas = function()
{
this.renderer = new PIXI.CanvasRenderer(this.width, this.height, null, 0);
@@ -625,14 +631,17 @@ Phaser.RenderTexture.prototype.initCanvas = function()
}
/**
- * This function will draw the display object to the texture.
- *
- * @method renderWebGL
- * @param displayObject {DisplayObject} The display object to render this texture on
- * @param clear {Boolean} If true the texture will be cleared before the displayObject is drawn
- * @private
- */
-Phaser.RenderTexture.prototype.renderWebGL = function(displayObject, position, clear)
+* This function will draw the display object to the texture.
+*
+* @method Phaser.RenderTexture#renderWebGL
+* @memberof Phaser.RenderTexture
+* @private
+* @param {DisplayObject} displayObject - The display object to render this texture on.
+* @param {Phaser.Point} [position] - Where to draw the display object.
+* @param {boolean} [clear=false] - If true the texture will be cleared before the displayObject is drawn.
+* @param {boolean} [renderHidden=false] - If true displayObjects that have their visible property set to false will still be rendered.
+*/
+Phaser.RenderTexture.prototype.renderWebGL = function(displayObject, position, clear, renderHidden)
{
var gl = PIXI.gl;
@@ -703,12 +712,15 @@ Phaser.RenderTexture.prototype.renderWebGL = function(displayObject, position, c
/**
* This function will draw the display object to the texture.
*
- * @method renderCanvas
- * @param displayObject {DisplayObject} The display object to render this texture on
- * @param clear {Boolean} If true the texture will be cleared before the displayObject is drawn
- * @private
- */
-Phaser.RenderTexture.prototype.renderCanvas = function(displayObject, position, clear)
+* @method Phaser.RenderTexture#renderCanvas
+* @memberof Phaser.RenderTexture
+* @private
+* @param {DisplayObject} displayObject - The display object to render this texture on.
+* @param {Phaser.Point} [position] - Where to draw the display object.
+* @param {boolean} [clear=false] - If true the texture will be cleared before the displayObject is drawn.
+* @param {boolean} [renderHidden=false] - If true displayObjects that have their visible property set to false will still be rendered.
+*/
+Phaser.RenderTexture.prototype.renderCanvas = function(displayObject, position, clear, renderHidden)
{
var children = displayObject.children;
@@ -729,12 +741,11 @@ Phaser.RenderTexture.prototype.renderCanvas = function(displayObject, position,
{
this.renderer.context.clearRect(0, 0, this.width, this.height);
}
-
- this.renderer.renderDisplayObject(displayObject);
+
+ this.renderer.renderDisplayObject(displayObject, renderHidden);
this.renderer.context.setTransform(1, 0, 0, 1, 0, 0);
- // PIXI.texturesToUpdate.push(this.baseTexture);
}
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/RequestAnimationFrame.js.html b/docs/RequestAnimationFrame.js.html index f78cb6cf..c47f23db 100644 --- a/docs/RequestAnimationFrame.js.html +++ b/docs/RequestAnimationFrame.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -483,7 +477,7 @@ Phaser.RequestAnimationFrame = function(game) {
Phaser.RequestAnimationFrame.prototype = {
/**
- * Starts the requestAnimatioFrame running or setTimeout if unavailable in browser
+ * Starts the requestAnimationFrame running or setTimeout if unavailable in browser
* @method Phaser.RequestAnimationFrame#start
*/
start: function () {
@@ -577,7 +571,10 @@ Phaser.RequestAnimationFrame.prototype = {
return (this._isSetTimeOut === false);
}
-};
+};
+
+Phaser.RequestAnimationFrame.prototype.constructor = Phaser.RequestAnimationFrame;
+
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/SAT.js.html b/docs/SAT.js.html new file mode 100644 index 00000000..daffcd9a --- /dev/null +++ b/docs/SAT.js.html @@ -0,0 +1,1340 @@ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/Signal.js.html b/docs/Signal.js.html
index da14fe14..02fe379b 100644
--- a/docs/Signal.js.html
+++ b/docs/Signal.js.html
@@ -90,6 +90,10 @@
Device
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source: physics/arcade/SAT.js
+ +// Version 0.2 - Copyright 2013 - Jim Riecken <jimr@jimr.ca>
+//
+// Released under the MIT License - https://github.com/jriecken/sat-js
+//
+// A simple library for determining intersections of circles and
+// polygons using the Separating Axis Theorem.
+/** @preserve SAT.js - Version 0.2 - Copyright 2013 - Jim Riecken <jimr@jimr.ca> - released under the MIT License. https://github.com/jriecken/sat-js */
+
+/*global define: false, module: false*/
+/*jshint shadow:true, sub:true, forin:true, noarg:true, noempty:true,
+ eqeqeq:true, bitwise:true, strict:true, undef:true,
+ curly:true, browser:true */
+
+// Create a UMD wrapper for SAT. Works in:
+//
+// - Plain browser via global SAT variable
+// - AMD loader (like require.js)
+// - Node.js
+//
+// The quoted properties all over the place are used so that the Closure Compiler
+// does not mangle the exposed API in advanced mode.
+/**
+ * @param {*} root - The global scope
+ * @param {Function} factory - Factory that creates SAT module
+ */
+(function (root, factory) {
+ "use strict";
+ if (typeof define === 'function' && define['amd']) {
+ define(factory);
+ } else if (typeof exports === 'object') {
+ module['exports'] = factory();
+ } else {
+ root['SAT'] = factory();
+ }
+}(this, function () {
+ "use strict";
+
+ var SAT = {};
+
+ //
+ // ## Vector
+ //
+ // Represents a vector in two dimensions with `x` and `y` properties.
+
+
+ // Create a new Vector, optionally passing in the `x` and `y` coordinates. If
+ // a coordinate is not specified, it will be set to `0`
+ /**
+ * @param {?number=} x The x position.
+ * @param {?number=} y The y position.
+ * @constructor
+ */
+ function Vector(x, y) {
+ this['x'] = x || 0;
+ this['y'] = y || 0;
+ }
+ SAT['Vector'] = Vector;
+ // Alias `Vector` as `V`
+ SAT['V'] = Vector;
+
+
+ // Copy the values of another Vector into this one.
+ /**
+ * @param {Vector} other The other Vector.
+ * @return {Vector} This for chaining.
+ */
+ Vector.prototype['copy'] = Vector.prototype.copy = function(other) {
+ this['x'] = other['x'];
+ this['y'] = other['y'];
+ return this;
+ };
+
+ // Change this vector to be perpendicular to what it was before. (Effectively
+ // roatates it 90 degrees in a clockwise direction)
+ /**
+ * @return {Vector} This for chaining.
+ */
+ Vector.prototype['perp'] = Vector.prototype.perp = function() {
+ var x = this['x'];
+ this['x'] = this['y'];
+ this['y'] = -x;
+ return this;
+ };
+
+ // Rotate this vector (counter-clockwise) by the specified angle (in radians).
+ /**
+ * @param {number} angle The angle to rotate (in radians)
+ * @return {Vector} This for chaining.
+ */
+ Vector.prototype['rotate'] = Vector.prototype.rotate = function (angle) {
+ var x = this['x'];
+ var y = this['y'];
+ this['x'] = x * Math.cos(angle) - y * Math.sin(angle);
+ this['y'] = x * Math.sin(angle) + y * Math.cos(angle);
+ return this;
+ };
+
+ // Rotate this vector (counter-clockwise) by the specified angle (in radians) which has already been calculated into sin and cos.
+ /**
+ * @param {number} sin - The Math.sin(angle)
+ * @param {number} cos - The Math.cos(angle)
+ * @return {Vector} This for chaining.
+ */
+ Vector.prototype['rotatePrecalc'] = Vector.prototype.rotatePrecalc = function (sin, cos) {
+ var x = this['x'];
+ var y = this['y'];
+ this['x'] = x * cos - y * sin;
+ this['y'] = x * sin + y * cos;
+ return this;
+ };
+
+ // Reverse this vector.
+ /**
+ * @return {Vector} This for chaining.
+ */
+ Vector.prototype['reverse'] = Vector.prototype.reverse = function() {
+ this['x'] = -this['x'];
+ this['y'] = -this['y'];
+ return this;
+ };
+
+
+ // Normalize this vector. (make it have length of `1`)
+ /**
+ * @return {Vector} This for chaining.
+ */
+ Vector.prototype['normalize'] = Vector.prototype.normalize = function() {
+ var d = this.len();
+ if(d > 0) {
+ this['x'] = this['x'] / d;
+ this['y'] = this['y'] / d;
+ }
+ return this;
+ };
+
+ // Add another vector to this one.
+ /**
+ * @param {Vector} other The other Vector.
+ * @return {Vector} This for chaining.
+ */
+ Vector.prototype['add'] = Vector.prototype.add = function(other) {
+ this['x'] += other['x'];
+ this['y'] += other['y'];
+ return this;
+ };
+
+ // Subtract another vector from this one.
+ /**
+ * @param {Vector} other The other Vector.
+ * @return {Vector} This for chaiing.
+ */
+ Vector.prototype['sub'] = Vector.prototype.sub = function(other) {
+ this['x'] -= other['x'];
+ this['y'] -= other['y'];
+ return this;
+ };
+
+ // Scale this vector. An independant scaling factor can be provided
+ // for each axis, or a single scaling factor that will scale both `x` and `y`.
+ /**
+ * @param {number} x The scaling factor in the x direction.
+ * @param {?number=} y The scaling factor in the y direction. If this
+ * is not specified, the x scaling factor will be used.
+ * @return {Vector} This for chaining.
+ */
+ Vector.prototype['scale'] = Vector.prototype.scale = function(x,y) {
+ this['x'] *= x;
+ this['y'] *= y || x;
+ return this;
+ };
+
+ // Project this vector on to another vector.
+ /**
+ * @param {Vector} other The vector to project onto.
+ * @return {Vector} This for chaining.
+ */
+ Vector.prototype['project'] = Vector.prototype.project = function(other) {
+ var amt = this.dot(other) / other.len2();
+ this['x'] = amt * other['x'];
+ this['y'] = amt * other['y'];
+ return this;
+ };
+
+ // Project this vector onto a vector of unit length. This is slightly more efficient
+ // than `project` when dealing with unit vectors.
+ /**
+ * @param {Vector} other The unit vector to project onto.
+ * @return {Vector} This for chaining.
+ */
+ Vector.prototype['projectN'] = Vector.prototype.projectN = function(other) {
+ var amt = this.dot(other);
+ this['x'] = amt * other['x'];
+ this['y'] = amt * other['y'];
+ return this;
+ };
+
+ // Reflect this vector on an arbitrary axis.
+ /**
+ * @param {Vector} axis The vector representing the axis.
+ * @return {Vector} This for chaining.
+ */
+ Vector.prototype['reflect'] = Vector.prototype.reflect = function(axis) {
+ var x = this['x'];
+ var y = this['y'];
+ this.project(axis).scale(2);
+ this['x'] -= x;
+ this['y'] -= y;
+ return this;
+ };
+
+ // Reflect this vector on an arbitrary axis (represented by a unit vector). This is
+ // slightly more efficient than `reflect` when dealing with an axis that is a unit vector.
+ /**
+ * @param {Vector} axis The unit vector representing the axis.
+ * @return {Vector} This for chaining.
+ */
+ Vector.prototype['reflectN'] = Vector.prototype.reflectN = function(axis) {
+ var x = this['x'];
+ var y = this['y'];
+ this.projectN(axis).scale(2);
+ this['x'] -= x;
+ this['y'] -= y;
+ return this;
+ };
+
+ // Get the dot product of this vector and another.
+ /**
+ * @param {Vector} other The vector to dot this one against.
+ * @return {number} The dot product.
+ */
+ Vector.prototype['dot'] = Vector.prototype.dot = function(other) {
+ return this['x'] * other['x'] + this['y'] * other['y'];
+ };
+
+ // Get the squared length of this vector.
+ /**
+ * @return {number} The length^2 of this vector.
+ */
+ Vector.prototype['len2'] = Vector.prototype.len2 = function() {
+ return this.dot(this);
+ };
+
+ // Get the length of this vector.
+ /**
+ * @return {number} The length of this vector.
+ */
+ Vector.prototype['len'] = Vector.prototype.len = function() {
+ return Math.sqrt(this.len2());
+ };
+
+ // ## Circle
+ //
+ // Represents a circle with a position and a radius.
+
+ // Create a new circle, optionally passing in a position and/or radius. If no position
+ // is given, the circle will be at `(0,0)`. If no radius is provided, the circle will
+ // have a radius of `0`.
+ /**
+ * @param {Vector=} pos A vector representing the position of the center of the circle
+ * @param {?number=} r The radius of the circle
+ * @constructor
+ */
+ function Circle(pos, r) {
+ this['pos'] = pos || new Vector();
+ this['r'] = r || 0;
+ }
+ SAT['Circle'] = Circle;
+
+ // ## Polygon
+ //
+ // Represents a *convex* polygon with any number of points (specified in counter-clockwise order)
+ //
+ // The edges/normals of the polygon will be calculated on creation and stored in the
+ // `edges` and `normals` properties. If you change the polygon's points, you will need
+ // to call `recalc` to recalculate the edges/normals.
+
+ // Create a new polygon, passing in a position vector, and an array of points (represented
+ // by vectors relative to the position vector). If no position is passed in, the position
+ // of the polygon will be `(0,0)`.
+ /**
+ * @param {Vector=} pos A vector representing the origin of the polygon. (all other
+ * points are relative to this one)
+ * @param {Array.<Vector>=} points An array of vectors representing the points in the polygon,
+ * in counter-clockwise order.
+ * @constructor
+ */
+ function Polygon(pos, points) {
+ this['pos'] = pos || new Vector();
+ this['points'] = points || [];
+ this.recalc();
+ }
+ SAT['Polygon'] = Polygon;
+
+ // Recalculates the edges and normals of the polygon. This **must** be called
+ // if the `points` array is modified at all and the edges or normals are to be
+ // accessed.
+ /**
+ * @return {Polygon} This for chaining.
+ */
+ Polygon.prototype['recalc'] = Polygon.prototype.recalc = function() {
+ // The edges here are the direction of the `n`th edge of the polygon, relative to
+ // the `n`th point. If you want to draw a given edge from the edge value, you must
+ // first translate to the position of the starting point.
+ this['edges'] = [];
+ // The normals here are the direction of the normal for the `n`th edge of the polygon, relative
+ // to the position of the `n`th point. If you want to draw an edge normal, you must first
+ // translate to the position of the starting point.
+ this['normals'] = [];
+ var points = this['points'];
+ var len = points.length;
+ for (var i = 0; i < len; i++) {
+ var p1 = points[i];
+ var p2 = i < len - 1 ? points[i + 1] : points[0];
+ var e = new Vector().copy(p2).sub(p1);
+ var n = new Vector().copy(e).perp().normalize();
+ this['edges'].push(e);
+ this['normals'].push(n);
+ }
+ return this;
+ };
+
+ // Rotates this polygon counter-clockwise around the origin of *its local coordinate system* (i.e. `pos`).
+ //
+ // Note: You do **not** need to call `recalc` after rotation.
+ /**
+ * @param {number} angle The angle to rotate (in radians)
+ * @return {Polygon} This for chaining.
+ */
+ Polygon.prototype['rotate'] = Polygon.prototype.rotate = function(angle) {
+ var i;
+ var points = this['points'];
+ var edges = this['edges'];
+ var normals = this['normals'];
+ var len = points.length;
+
+ // Calc it just the once, rather than 4 times per array element
+ var cos = Math.cos(angle);
+ var sin = Math.sin(angle);
+
+ for (i = 0; i < len; i++) {
+ points[i].rotatePrecalc(sin, cos);
+ edges[i].rotatePrecalc(sin, cos);
+ normals[i].rotatePrecalc(sin, cos);
+ }
+ return this;
+ };
+
+ // Rotates this polygon counter-clockwise around the origin of *its local coordinate system* (i.e. `pos`).
+ //
+ // Note: You do **not** need to call `recalc` after rotation.
+ /**
+ * @param {number} angle The angle to rotate (in radians)
+ * @return {Polygon} This for chaining.
+ */
+ Polygon.prototype['scale'] = Polygon.prototype.scale = function(x, y) {
+ var i;
+ var points = this['points'];
+ var edges = this['edges'];
+ var normals = this['normals'];
+ var len = points.length;
+ for (i = 0; i < len; i++) {
+ points[i].scale(x,y);
+ edges[i].scale(x,y);
+ normals[i].scale(x,y);
+ }
+ return this;
+ };
+
+ // Translates the points of this polygon by a specified amount relative to the origin of *its own coordinate
+ // system* (i.e. `pos`).
+ //
+ // This is most useful to change the "center point" of a polygon.
+ //
+ // Note: You do **not** need to call `recalc` after translation.
+ /**
+ * @param {number} x The horizontal amount to translate.
+ * @param {number} y The vertical amount to translate.
+ * @return {Polygon} This for chaining.
+ */
+ Polygon.prototype['translate'] = Polygon.prototype.translate = function (x, y) {
+ var i;
+ var points = this['points'];
+ var len = points.length;
+ for (i = 0; i < len; i++) {
+ points[i].x += x;
+ points[i].y += y;
+ }
+ return this;
+ };
+
+ // ## Box
+ //
+ // Represents an axis-aligned box, with a width and height.
+
+
+ // Create a new box, with the specified position, width, and height. If no position
+ // is given, the position will be `(0,0)`. If no width or height are given, they will
+ // be set to `0`.
+ /**
+ * @param {Vector=} pos A vector representing the top-left of the box.
+ * @param {?number=} w The width of the box.
+ * @param {?number=} h The height of the box.
+ * @constructor
+ */
+ function Box(pos, w, h) {
+ this['pos'] = pos || new Vector();
+ this['w'] = w || 0;
+ this['h'] = h || 0;
+ }
+ SAT['Box'] = Box;
+
+ // Returns a polygon whose edges are the same as this box.
+ /**
+ * @return {Polygon} A new Polygon that represents this box.
+ */
+ Box.prototype['toPolygon'] = Box.prototype.toPolygon = function() {
+ var pos = this['pos'];
+ var w = this['w'];
+ var h = this['h'];
+ return new Polygon(new Vector(pos['x'], pos['y']), [
+ new Vector(), new Vector(w, 0),
+ new Vector(w,h), new Vector(0,h)
+ ]);
+ };
+
+ // ## Response
+ //
+ // An object representing the result of an intersection. Contains:
+ // - The two objects participating in the intersection
+ // - The vector representing the minimum change necessary to extract the first object
+ // from the second one (as well as a unit vector in that direction and the magnitude
+ // of the overlap)
+ // - Whether the first object is entirely inside the second, and vice versa.
+ /**
+ * @constructor
+ */
+ function Response() {
+ this['a'] = null;
+ this['b'] = null;
+ this['overlapN'] = new Vector();
+ this['overlapV'] = new Vector();
+ this.clear();
+ }
+ SAT['Response'] = Response;
+
+ // Set some values of the response back to their defaults. Call this between tests if
+ // you are going to reuse a single Response object for multiple intersection tests (recommented
+ // as it will avoid allcating extra memory)
+ /**
+ * @return {Response} This for chaining
+ */
+ Response.prototype['clear'] = Response.prototype.clear = function() {
+ this['aInB'] = true;
+ this['bInA'] = true;
+ this['overlap'] = Number.MAX_VALUE;
+ return this;
+ };
+
+ // ## Object Pools
+
+ // A pool of `Vector` objects that are used in calculations to avoid
+ // allocating memory.
+ /**
+ * @type {Array.<Vector>}
+ */
+ var T_VECTORS = [];
+ for (var i = 0; i < 10; i++) { T_VECTORS.push(new Vector()); }
+
+ // A pool of arrays of numbers used in calculations to avoid allocating
+ // memory.
+ /**
+ * @type {Array.<Array.<number>>}
+ */
+ var T_ARRAYS = [];
+ for (var i = 0; i < 5; i++) { T_ARRAYS.push([]); }
+
+ // ## Helper Functions
+
+ // Flattens the specified array of points onto a unit vector axis,
+ // resulting in a one dimensional range of the minimum and
+ // maximum value on that axis.
+ /**
+ * @param {Array.<Vector>} points The points to flatten.
+ * @param {Vector} normal The unit vector axis to flatten on.
+ * @param {Array.<number>} result An array. After calling this function,
+ * result[0] will be the minimum value,
+ * result[1] will be the maximum value.
+ */
+ function flattenPointsOn(points, normal, result) {
+ var min = Number.MAX_VALUE;
+ var max = -Number.MAX_VALUE;
+ var len = points.length;
+ for (var i = 0; i < len; i++ ) {
+ // The magnitude of the projection of the point onto the normal
+ var dot = points[i].dot(normal);
+ if (dot < min) { min = dot; }
+ if (dot > max) { max = dot; }
+ }
+ result[0] = min; result[1] = max;
+ }
+
+ // Check whether two convex polygons are separated by the specified
+ // axis (must be a unit vector).
+ /**
+ * @param {Vector} aPos The position of the first polygon.
+ * @param {Vector} bPos The position of the second polygon.
+ * @param {Array.<Vector>} aPoints The points in the first polygon.
+ * @param {Array.<Vector>} bPoints The points in the second polygon.
+ * @param {Vector} axis The axis (unit sized) to test against. The points of both polygons
+ * will be projected onto this axis.
+ * @param {Response=} response A Response object (optional) which will be populated
+ * if the axis is not a separating axis.
+ * @return {boolean} true if it is a separating axis, false otherwise. If false,
+ * and a response is passed in, information about how much overlap and
+ * the direction of the overlap will be populated.
+ */
+ function isSeparatingAxis(aPos, bPos, aPoints, bPoints, axis, response) {
+ var rangeA = T_ARRAYS.pop();
+ var rangeB = T_ARRAYS.pop();
+ // The magnitude of the offset between the two polygons
+ var offsetV = T_VECTORS.pop().copy(bPos).sub(aPos);
+ var projectedOffset = offsetV.dot(axis);
+ // Project the polygons onto the axis.
+ flattenPointsOn(aPoints, axis, rangeA);
+ flattenPointsOn(bPoints, axis, rangeB);
+ // Move B's range to its position relative to A.
+ rangeB[0] += projectedOffset;
+ rangeB[1] += projectedOffset;
+ // Check if there is a gap. If there is, this is a separating axis and we can stop
+ if (rangeA[0] > rangeB[1] || rangeB[0] > rangeA[1]) {
+ T_VECTORS.push(offsetV);
+ T_ARRAYS.push(rangeA);
+ T_ARRAYS.push(rangeB);
+ return true;
+ }
+ // This is not a separating axis. If we're calculating a response, calculate the overlap.
+ if (response) {
+ var overlap = 0;
+ // A starts further left than B
+ if (rangeA[0] < rangeB[0]) {
+ response['aInB'] = false;
+ // A ends before B does. We have to pull A out of B
+ if (rangeA[1] < rangeB[1]) {
+ overlap = rangeA[1] - rangeB[0];
+ response['bInA'] = false;
+ // B is fully inside A. Pick the shortest way out.
+ } else {
+ var option1 = rangeA[1] - rangeB[0];
+ var option2 = rangeB[1] - rangeA[0];
+ overlap = option1 < option2 ? option1 : -option2;
+ }
+ // B starts further left than A
+ } else {
+ response['bInA'] = false;
+ // B ends before A ends. We have to push A out of B
+ if (rangeA[1] > rangeB[1]) {
+ overlap = rangeA[0] - rangeB[1];
+ response['aInB'] = false;
+ // A is fully inside B. Pick the shortest way out.
+ } else {
+ var option1 = rangeA[1] - rangeB[0];
+ var option2 = rangeB[1] - rangeA[0];
+ overlap = option1 < option2 ? option1 : -option2;
+ }
+ }
+ // If this is the smallest amount of overlap we've seen so far, set it as the minimum overlap.
+ var absOverlap = Math.abs(overlap);
+ if (absOverlap < response['overlap']) {
+ response['overlap'] = absOverlap;
+ response['overlapN'].copy(axis);
+ if (overlap < 0) {
+ response['overlapN'].reverse();
+ }
+ }
+ }
+ T_VECTORS.push(offsetV);
+ T_ARRAYS.push(rangeA);
+ T_ARRAYS.push(rangeB);
+ return false;
+ }
+
+ // Calculates which Vornoi region a point is on a line segment.
+ // It is assumed that both the line and the point are relative to `(0,0)`
+ //
+ // | (0) |
+ // (-1) [S]--------------[E] (1)
+ // | (0) |
+ /**
+ * @param {Vector} line The line segment.
+ * @param {Vector} point The point.
+ * @return {number} LEFT_VORNOI_REGION (-1) if it is the left region,
+ * MIDDLE_VORNOI_REGION (0) if it is the middle region,
+ * RIGHT_VORNOI_REGION (1) if it is the right region.
+ */
+ function vornoiRegion(line, point) {
+ var len2 = line.len2();
+ var dp = point.dot(line);
+ // If the point is beyond the start of the line, it is in the
+ // left vornoi region.
+ if (dp < 0) { return LEFT_VORNOI_REGION; }
+ // If the point is beyond the end of the line, it is in the
+ // right vornoi region.
+ else if (dp > len2) { return RIGHT_VORNOI_REGION; }
+ // Otherwise, it's in the middle one.
+ else { return MIDDLE_VORNOI_REGION; }
+ }
+ // Constants for Vornoi regions
+ /**
+ * @const
+ */
+ var LEFT_VORNOI_REGION = -1;
+ /**
+ * @const
+ */
+ var MIDDLE_VORNOI_REGION = 0;
+ /**
+ * @const
+ */
+ var RIGHT_VORNOI_REGION = 1;
+
+ // ## Collision Tests
+
+ // Check if two circles collide.
+ /**
+ * @param {Circle} a The first circle.
+ * @param {Circle} b The second circle.
+ * @param {Response=} response Response object (optional) that will be populated if
+ * the circles intersect.
+ * @return {boolean} true if the circles intersect, false if they don't.
+ */
+ function testCircleCircle(a, b, response) {
+ // Check if the distance between the centers of the two
+ // circles is greater than their combined radius.
+ var differenceV = T_VECTORS.pop().copy(b['pos']).sub(a['pos']);
+ var totalRadius = a['r'] + b['r'];
+ var totalRadiusSq = totalRadius * totalRadius;
+ var distanceSq = differenceV.len2();
+ // If the distance is bigger than the combined radius, they don't intersect.
+ if (distanceSq > totalRadiusSq) {
+ T_VECTORS.push(differenceV);
+ return false;
+ }
+ // They intersect. If we're calculating a response, calculate the overlap.
+ if (response) {
+ var dist = Math.sqrt(distanceSq);
+ response['a'] = a;
+ response['b'] = b;
+ response['overlap'] = totalRadius - dist;
+ response['overlapN'].copy(differenceV.normalize());
+ response['overlapV'].copy(differenceV).scale(response['overlap']);
+ response['aInB']= a['r'] <= b['r'] && dist <= b['r'] - a['r'];
+ response['bInA'] = b['r'] <= a['r'] && dist <= a['r'] - b['r'];
+ }
+ T_VECTORS.push(differenceV);
+ return true;
+ }
+ SAT['testCircleCircle'] = testCircleCircle;
+
+ // Check if a polygon and a circle collide.
+ /**
+ * @param {Polygon} polygon The polygon.
+ * @param {Circle} circle The circle.
+ * @param {Response=} response Response object (optional) that will be populated if
+ * they interset.
+ * @return {boolean} true if they intersect, false if they don't.
+ */
+ function testPolygonCircle(polygon, circle, response) {
+ // Get the position of the circle relative to the polygon.
+ var circlePos = T_VECTORS.pop().copy(circle['pos']).sub(polygon['pos']);
+ var radius = circle['r'];
+ var radius2 = radius * radius;
+ var points = polygon['points'];
+ var len = points.length;
+ var edge = T_VECTORS.pop();
+ var point = T_VECTORS.pop();
+
+ // For each edge in the polygon:
+ for (var i = 0; i < len; i++) {
+ var next = i === len - 1 ? 0 : i + 1;
+ var prev = i === 0 ? len - 1 : i - 1;
+ var overlap = 0;
+ var overlapN = null;
+
+ // Get the edge.
+ edge.copy(polygon['edges'][i]);
+ // Calculate the center of the circle relative to the starting point of the edge.
+ point.copy(circlePos).sub(points[i]);
+
+ // If the distance between the center of the circle and the point
+ // is bigger than the radius, the polygon is definitely not fully in
+ // the circle.
+ if (response && point.len2() > radius2) {
+ response['aInB'] = false;
+ }
+
+ // Calculate which Vornoi region the center of the circle is in.
+ var region = vornoiRegion(edge, point);
+ // If it's the left region:
+ if (region === LEFT_VORNOI_REGION) {
+ // We need to make sure we're in the RIGHT_VORNOI_REGION of the previous edge.
+ edge.copy(polygon['edges'][prev]);
+ // Calculate the center of the circle relative the starting point of the previous edge
+ var point2 = T_VECTORS.pop().copy(circlePos).sub(points[prev]);
+ region = vornoiRegion(edge, point2);
+ if (region === RIGHT_VORNOI_REGION) {
+ // It's in the region we want. Check if the circle intersects the point.
+ var dist = point.len();
+ if (dist > radius) {
+ // No intersection
+ T_VECTORS.push(circlePos);
+ T_VECTORS.push(edge);
+ T_VECTORS.push(point);
+ T_VECTORS.push(point2);
+ return false;
+ } else if (response) {
+ // It intersects, calculate the overlap.
+ response['bInA'] = false;
+ overlapN = point.normalize();
+ overlap = radius - dist;
+ }
+ }
+ T_VECTORS.push(point2);
+ // If it's the right region:
+ } else if (region === RIGHT_VORNOI_REGION) {
+ // We need to make sure we're in the left region on the next edge
+ edge.copy(polygon['edges'][next]);
+ // Calculate the center of the circle relative to the starting point of the next edge.
+ point.copy(circlePos).sub(points[next]);
+ region = vornoiRegion(edge, point);
+ if (region === LEFT_VORNOI_REGION) {
+ // It's in the region we want. Check if the circle intersects the point.
+ var dist = point.len();
+ if (dist > radius) {
+ // No intersection
+ T_VECTORS.push(circlePos);
+ T_VECTORS.push(edge);
+ T_VECTORS.push(point);
+ return false;
+ } else if (response) {
+ // It intersects, calculate the overlap.
+ response['bInA'] = false;
+ overlapN = point.normalize();
+ overlap = radius - dist;
+ }
+ }
+ // Otherwise, it's the middle region:
+ } else {
+ // Need to check if the circle is intersecting the edge,
+ // Change the edge into its "edge normal".
+ var normal = edge.perp().normalize();
+ // Find the perpendicular distance between the center of the
+ // circle and the edge.
+ var dist = point.dot(normal);
+ var distAbs = Math.abs(dist);
+ // If the circle is on the outside of the edge, there is no intersection.
+ if (dist > 0 && distAbs > radius) {
+ // No intersection
+ T_VECTORS.push(circlePos);
+ T_VECTORS.push(normal);
+ T_VECTORS.push(point);
+ return false;
+ } else if (response) {
+ // It intersects, calculate the overlap.
+ overlapN = normal;
+ overlap = radius - dist;
+ // If the center of the circle is on the outside of the edge, or part of the
+ // circle is on the outside, the circle is not fully inside the polygon.
+ if (dist >= 0 || overlap < 2 * radius) {
+ response['bInA'] = false;
+ }
+ }
+ }
+
+ // If this is the smallest overlap we've seen, keep it.
+ // (overlapN may be null if the circle was in the wrong Vornoi region).
+ if (overlapN && response && Math.abs(overlap) < Math.abs(response['overlap'])) {
+ response['overlap'] = overlap;
+ response['overlapN'].copy(overlapN);
+ }
+ }
+
+ // Calculate the final overlap vector - based on the smallest overlap.
+ if (response) {
+ response['a'] = polygon;
+ response['b'] = circle;
+ response['overlapV'].copy(response['overlapN']).scale(response['overlap']);
+ }
+ T_VECTORS.push(circlePos);
+ T_VECTORS.push(edge);
+ T_VECTORS.push(point);
+ return true;
+ }
+ SAT['testPolygonCircle'] = testPolygonCircle;
+
+ // Check if a circle and a polygon collide.
+ //
+ // **NOTE:** This is slightly less efficient than polygonCircle as it just
+ // runs polygonCircle and reverses everything at the end.
+ /**
+ * @param {Circle} circle The circle.
+ * @param {Polygon} polygon The polygon.
+ * @param {Response=} response Response object (optional) that will be populated if
+ * they interset.
+ * @return {boolean} true if they intersect, false if they don't.
+ */
+ function testCirclePolygon(circle, polygon, response) {
+ // Test the polygon against the circle.
+ var result = testPolygonCircle(polygon, circle, response);
+ if (result && response) {
+ // Swap A and B in the response.
+ var a = response['a'];
+ var aInB = response['aInB'];
+ response['overlapN'].reverse();
+ response['overlapV'].reverse();
+ response['a'] = response['b'];
+ response['b'] = a;
+ response['aInB'] = response['bInA'];
+ response['bInA'] = aInB;
+ }
+ return result;
+ }
+ SAT['testCirclePolygon'] = testCirclePolygon;
+
+ // Checks whether polygons collide.
+ /**
+ * @param {Polygon} a The first polygon.
+ * @param {Polygon} b The second polygon.
+ * @param {Response=} response Response object (optional) that will be populated if
+ * they interset.
+ * @return {boolean} true if they intersect, false if they don't.
+ */
+ function testPolygonPolygon(a, b, response) {
+ var aPoints = a['points'];
+ var aLen = aPoints.length;
+ var bPoints = b['points'];
+ var bLen = bPoints.length;
+ // If any of the edge normals of A is a separating axis, no intersection.
+ for (var i = 0; i < aLen; i++) {
+ if (isSeparatingAxis(a['pos'], b['pos'], aPoints, bPoints, a['normals'][i], response)) {
+ return false;
+ }
+ }
+ // If any of the edge normals of B is a separating axis, no intersection.
+ for (var i = 0;i < bLen; i++) {
+ if (isSeparatingAxis(a['pos'], b['pos'], aPoints, bPoints, b['normals'][i], response)) {
+ return false;
+ }
+ }
+ // Since none of the edge normals of A or B are a separating axis, there is an intersection
+ // and we've already calculated the smallest overlap (in isSeparatingAxis). Calculate the
+ // final overlap vector.
+ if (response) {
+ response['a'] = a;
+ response['b'] = b;
+ response['overlapV'].copy(response['overlapN']).scale(response['overlap']);
+ }
+ return true;
+ }
+ SAT['testPolygonPolygon'] = testPolygonPolygon;
+
+ return SAT;
+}));
+ +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -723,6 +717,8 @@ Phaser.Signal.prototype = {
}
};
+
+Phaser.Signal.prototype.constructor = Phaser.Signal;
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/SignalBinding.html b/docs/SignalBinding.html index 08019875..b3c0f540 100644 --- a/docs/SignalBinding.html +++ b/docs/SignalBinding.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:36 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:37 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/SignalBinding.js.html b/docs/SignalBinding.js.html index 795bcae8..8bc0854f 100644 --- a/docs/SignalBinding.js.html +++ b/docs/SignalBinding.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -583,6 +577,8 @@ Phaser.SignalBinding.prototype = {
}
};
+
+Phaser.SignalBinding.prototype.constructor = Phaser.SignalBinding;
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/SinglePad.js.html b/docs/SinglePad.js.html new file mode 100644 index 00000000..af2fdfca --- /dev/null +++ b/docs/SinglePad.js.html @@ -0,0 +1,1048 @@ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/Sound.js.html b/docs/Sound.js.html
index 7db91a13..03167d6d 100644
--- a/docs/Sound.js.html
+++ b/docs/Sound.js.html
@@ -90,6 +90,10 @@
Device
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source: input/SinglePad.js
+ +/**
+* @author @karlmacklin <tacklemcclean@gmail.com>
+* @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;
+
+ /**
+ * @property {Phaser.Gamepad} padParent - Main Phaser Gamepad object
+ */
+ this._padParent = padParent;
+
+ /**
+ * @property {number} index - The gamepad index as per browsers data
+ * @default
+ */
+ this._index = null;
+
+ /**
+ * @property {Object} _rawPad - The 'raw' gamepad data.
+ * @private
+ */
+ this._rawPad = null;
+
+ /**
+ * @property {boolean} _connected - Is this pad connected or not.
+ * @private
+ */
+ this._connected = false;
+
+ /**
+ * @property {number} _prevTimestamp - Used to check for differences between earlier polls and current state of gamepads.
+ * @private
+ */
+ this._prevTimestamp = null;
+
+ /**
+ * @property {Array} _rawButtons - The 'raw' button state.
+ * @private
+ */
+ this._rawButtons = [];
+
+ /**
+ * @property {Array} _buttons - Current Phaser state of the buttons.
+ * @private
+ */
+ this._buttons = [];
+
+ /**
+ * @property {Array} _axes - Current axes state.
+ * @private
+ */
+ this._axes = [];
+
+ /**
+ * @property {Array} _hotkeys - Hotkey buttons.
+ * @private
+ */
+ this._hotkeys = [];
+
+ /**
+ * @property {Object} callbackContext - The context under which the callbacks are run.
+ */
+ this.callbackContext = this;
+
+ /**
+ * @property {function} onConnectCallback - This callback is invoked every time this gamepad is connected
+ */
+ this.onConnectCallback = null;
+
+ /**
+ * @property {function} onDisconnectCallback - This callback is invoked every time this gamepad is disconnected
+ */
+ this.onDisconnectCallback = null;
+
+ /**
+ * @property {function} onDownCallback - This callback is invoked every time a button is pressed down.
+ */
+ this.onDownCallback = null;
+
+ /**
+ * @property {function} onUpCallback - This callback is invoked every time a gamepad button is released.
+ */
+ this.onUpCallback = null;
+
+ /**
+ * @property {function} onAxisCallback - This callback is invoked every time an axis is changed.
+ */
+ this.onAxisCallback = null;
+
+ /**
+ * @property {function} onFloatCallback - This callback is invoked every time a button is changed to a value where value > 0 and value < 1.
+ */
+ this.onFloatCallback = null;
+
+ /**
+ * @property {number} deadZone - Dead zone for axis feedback - within this value you won't trigger updates.
+ */
+ this.deadZone = 0.26;
+
+};
+
+Phaser.SinglePad.prototype = {
+
+ /**
+ * Add callbacks to the this Gamepad to handle connect/disconnect/button down/button up/axis change/float value buttons
+ * @method Phaser.Gamepad#addCallbacks
+ * @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;
+ }
+
+ },
+
+ /**
+ * If you need more fine-grained control over a Key you can create a new Phaser.Key object via this method.
+ * The Key object can then be polled, have events attached to it, etc.
+ *
+ * @method Phaser.SinglePad#addButton
+ * @param {number} buttonCode - The buttonCode of the button, i.e. Phaser.Gamepad.BUTTON_0 or Phaser.Gamepad.BUTTON_1
+ * @return {Phaser.GamepadButton} The GamepadButton object which you can store locally and reference directly.
+ */
+ addButton: function (buttonCode) {
+
+ this._hotkeys[buttonCode] = new Phaser.GamepadButton(this.game, buttonCode);
+ return this._hotkeys[buttonCode];
+
+ },
+
+ /**
+ * Main update function, should be called by Phaser.Gamepad
+ * @method Phaser.SinglePad#pollStatus
+ */
+ pollStatus: function () {
+
+ if (this._rawPad.timestamp && (this._rawPad.timestamp == this._prevTimestamp))
+ {
+ return;
+ }
+
+ for (var i = 0; i < this._rawPad.buttons.length; i += 1)
+ {
+ var buttonValue = this._rawPad.buttons[i];
+
+ if (this._rawButtons[i] !== buttonValue)
+ {
+ if (buttonValue === 1)
+ {
+ this.processButtonDown(i, buttonValue);
+ }
+ else if (buttonValue === 0)
+ {
+ this.processButtonUp(i, buttonValue);
+ }
+ else
+ {
+ this.processButtonFloat(i, buttonValue);
+ }
+
+ this._rawButtons[i] = buttonValue;
+ }
+ }
+
+ var axes = this._rawPad.axes;
+
+ for (var j = 0; j < axes.length; j += 1)
+ {
+ var axis = axes[j];
+
+ if (axis > 0 && axis > this.deadZone || axis < 0 && axis < -this.deadZone)
+ {
+ this.processAxisChange({axis: j, value: axis});
+ }
+ else
+ {
+ this.processAxisChange({axis: j, value: 0});
+ }
+ }
+
+ this._prevTimestamp = this._rawPad.timestamp;
+
+ },
+
+ /**
+ * Gamepad connect function, should be called by Phaser.Gamepad
+ * @param {Object} rawPad - The raw gamepad object
+ * @method Phaser.SinglePad#connect
+ */
+ connect: function (rawPad) {
+
+ var triggerCallback = !this._connected;
+
+ this._index = rawPad.index;
+ this._connected = true;
+ this._rawPad = rawPad;
+ this._rawButtons = rawPad.buttons;
+ this._axes = rawPad.axes;
+
+ if (triggerCallback && this._padParent.onConnectCallback)
+ {
+ this._padParent.onConnectCallback.call(this._padParent.callbackContext, this._index);
+ }
+
+ if (triggerCallback && this.onConnectCallback)
+ {
+ this.onConnectCallback.call(this.callbackContext);
+ }
+
+ },
+
+ /**
+ * Gamepad disconnect function, should be called by Phaser.Gamepad
+ * @method Phaser.SinglePad#disconnect
+ */
+ disconnect: function () {
+
+ var triggerCallback = this._connected;
+ this._connected = false;
+ this._rawPad = undefined;
+ this._rawButtons = [];
+ this._buttons = [];
+ var disconnectingIndex = this._index;
+ this._index = null;
+
+ if (triggerCallback && this._padParent.onDisconnectCallback)
+ {
+ this._padParent.onDisconnectCallback.call(this._padParent.callbackContext, disconnectingIndex);
+ }
+
+ if (triggerCallback && this.onDisconnectCallback)
+ {
+ this.onDisconnectCallback.call(this.callbackContext);
+ }
+
+ },
+
+ /**
+ * Handles changes in axis
+ * @param {Object} axisState - State of the relevant axis
+ * @method Phaser.SinglePad#processAxisChange
+ */
+ processAxisChange: function (axisState) {
+
+ if (this.game.input.disabled || this.game.input.gamepad.disabled)
+ {
+ return;
+ }
+
+ if (this._axes[axisState.axis] === axisState.value)
+ {
+ return;
+ }
+
+ this._axes[axisState.axis] = axisState.value;
+
+ if (this._padParent.onAxisCallback)
+ {
+ this._padParent.onAxisCallback.call(this._padParent.callbackContext, axisState, this._index);
+ }
+
+ if (this.onAxisCallback)
+ {
+ this.onAxisCallback.call(this.callbackContext, axisState);
+ }
+
+ },
+
+ /**
+ * Handles button down press
+ * @param {number} buttonCode - Which buttonCode of this button
+ * @param {Object} value - Button value
+ * @method Phaser.SinglePad#processButtonDown
+ */
+ processButtonDown: function (buttonCode, value) {
+
+ if (this.game.input.disabled || this.game.input.gamepad.disabled)
+ {
+ return;
+ }
+
+ if (this._padParent.onDownCallback)
+ {
+ this._padParent.onDownCallback.call(this._padParent.callbackContext, buttonCode, value, this._index);
+ }
+
+ if (this.onDownCallback)
+ {
+ this.onDownCallback.call(this.callbackContext, buttonCode, value);
+ }
+
+ if (this._buttons[buttonCode] && this._buttons[buttonCode].isDown)
+ {
+ // Key already down and still down, so update
+ this._buttons[buttonCode].duration = this.game.time.now - this._buttons[buttonCode].timeDown;
+ }
+ else
+ {
+ if (!this._buttons[buttonCode])
+ {
+ // Not used this button before, so register it
+ this._buttons[buttonCode] = {
+ isDown: true,
+ timeDown: this.game.time.now,
+ timeUp: 0,
+ duration: 0,
+ value: value
+ };
+ }
+ else
+ {
+ // Button used before but freshly down
+ this._buttons[buttonCode].isDown = true;
+ this._buttons[buttonCode].timeDown = this.game.time.now;
+ this._buttons[buttonCode].duration = 0;
+ this._buttons[buttonCode].value = value;
+ }
+ }
+
+ if (this._hotkeys[buttonCode])
+ {
+ this._hotkeys[buttonCode].processButtonDown(value);
+ }
+
+ },
+
+ /**
+ * Handles button release
+ * @param {number} buttonCode - Which buttonCode of this button
+ * @param {Object} value - Button value
+ * @method Phaser.SinglePad#processButtonUp
+ */
+ processButtonUp: function (buttonCode, value) {
+
+ if (this.game.input.disabled || this.game.input.gamepad.disabled)
+ {
+ return;
+ }
+
+ if (this._padParent.onUpCallback)
+ {
+ this._padParent.onUpCallback.call(this._padParent.callbackContext, buttonCode, value, this._index);
+ }
+
+ if (this.onUpCallback)
+ {
+ this.onUpCallback.call(this.callbackContext, buttonCode, value);
+ }
+
+ if (this._hotkeys[buttonCode])
+ {
+ this._hotkeys[buttonCode].processButtonUp(value);
+ }
+
+ if (this._buttons[buttonCode])
+ {
+ this._buttons[buttonCode].isDown = false;
+ this._buttons[buttonCode].timeUp = this.game.time.now;
+ this._buttons[buttonCode].value = value;
+ }
+ else
+ {
+ // Not used this button before, so register it
+ this._buttons[buttonCode] = {
+ isDown: false,
+ timeDown: this.game.time.now,
+ timeUp: this.game.time.now,
+ duration: 0,
+ value: value
+ };
+ }
+
+ },
+
+ /**
+ * Handles buttons with floating values (like analog buttons that acts almost like an axis but still registers like a button)
+ * @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.
+ * @method Phaser.SinglePad#processButtonFloat
+ */
+ processButtonFloat: function (buttonCode, value) {
+
+ if (this.game.input.disabled || this.game.input.gamepad.disabled)
+ {
+ return;
+ }
+
+ if (this._padParent.onFloatCallback)
+ {
+ this._padParent.onFloatCallback.call(this._padParent.callbackContext, buttonCode, value, this._index);
+ }
+
+ if (this.onFloatCallback)
+ {
+ this.onFloatCallback.call(this.callbackContext, buttonCode, value);
+ }
+
+ if (!this._buttons[buttonCode])
+ {
+ // Not used this button before, so register it
+ this._buttons[buttonCode] = { value: value };
+ }
+ else
+ {
+ // Button used before but freshly down
+ this._buttons[buttonCode].value = value;
+ }
+
+ if (this._hotkeys[buttonCode])
+ {
+ this._hotkeys[buttonCode].processButtonFloat(value);
+ }
+
+ },
+
+ /**
+ * Returns value of requested axis
+ * @method Phaser.SinglePad#isDown
+ * @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;
+
+ },
+
+ /**
+ * Returns true if the button is currently pressed down.
+ * @method Phaser.SinglePad#isDown
+ * @param {number} buttonCode - The buttonCode of the key to check.
+ * @return {boolean} True if the key is currently down.
+ */
+ isDown: function (buttonCode) {
+
+ if (this._buttons[buttonCode])
+ {
+ return this._buttons[buttonCode].isDown;
+ }
+
+ return false;
+
+ },
+
+ /**
+ * 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).
+ * @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 released.
+ * @return {boolean} True if the button is just released otherwise false.
+ */
+ justReleased: function (buttonCode, duration) {
+
+ if (typeof duration === "undefined") { duration = 250; }
+
+ return (this._buttons[buttonCode] && this._buttons[buttonCode].isDown === false && (this.game.time.now - this._buttons[buttonCode].timeUp < duration));
+
+ },
+
+ /**
+ * 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).
+ * @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) {
+
+ if (typeof duration === "undefined") { duration = 250; }
+
+ return (this._buttons[buttonCode] && this._buttons[buttonCode].isDown && this._buttons[buttonCode].duration < duration);
+
+ },
+
+ /**
+ * Returns the value of a gamepad button. Intended mainly for cases when you have floating button values, for example
+ * analog trigger buttons on the XBOX 360 controller
+ * @method Phaser.SinglePad#buttonValue
+ * @param {number} buttonCode - The buttonCode of the button to check.
+ * @return {boolean} Button value if available otherwise false.
+ */
+ buttonValue: function (buttonCode) {
+
+ if (this._buttons[buttonCode])
+ {
+ return this._buttons[buttonCode].value;
+ }
+
+ return false;
+
+ },
+
+ /**
+ * Reset all buttons/axes of this gamepad
+ * @method Phaser.SinglePad#reset
+ */
+ reset: function () {
+
+ for (var i = 0; i < this._buttons.length; i++)
+ {
+ this._buttons[i] = 0;
+ }
+
+ for (var j = 0; j < this._axes.length; j++)
+ {
+ this._axes[j] = 0;
+ }
+
+ }
+
+};
+
+Phaser.SinglePad.prototype.constructor = Phaser.SinglePad;
+
+/**
+ * Whether or not this particular gamepad is connected or not.
+ * @name Phaser.SinglePad#connected
+ * @property {boolean} connected - Whether or not this particular gamepad is connected or not.
+ * @readonly
+ */
+Object.defineProperty(Phaser.SinglePad.prototype, "connected", {
+
+ get: function () {
+ return this._connected;
+ }
+
+});
+
+/**
+ * Gamepad index as per browser data
+ * @name Phaser.SinglePad#index
+ * @property {number} index - The gamepad index, used to identify specific gamepads in the browser
+ * @readonly
+ */
+Object.defineProperty(Phaser.SinglePad.prototype, "index", {
+
+ get: function () {
+ return this._index;
+ }
+
+});
+
+ +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -769,25 +763,25 @@ Phaser.Sound.prototype = {
{
if (this.loop)
{
- //console.log('loop1');
+ // console.log('loop1');
// won't work with markers, needs to reset the position
this.onLoop.dispatch(this);
if (this.currentMarker === '')
{
- //console.log('loop2');
+ // console.log('loop2');
this.currentTime = 0;
this.startTime = this.game.time.now;
}
else
{
- //console.log('loop3');
+ // console.log('loop3');
this.play(this.currentMarker, 0, this.volume, true, true);
}
}
else
{
- //console.log('stopping, no loop for marker');
+ // console.log('stopping, no loop for marker');
this.stop();
}
}
@@ -975,7 +969,7 @@ Phaser.Sound.prototype = {
else
{
// console.log('sound not locked, state?', this._sound.readyState);
- if (this._sound && this._sound.readyState == 4)
+ if (this._sound && (this.game.device.cocoonJS || this._sound.readyState === 4))
{
this._sound.play();
// This doesn't become available until you call play(), wonderful ...
@@ -1065,7 +1059,20 @@ Phaser.Sound.prototype = {
this._sound = this.context.createBufferSource();
this._sound.buffer = this._buffer;
- this._sound.connect(this.gainNode);
+
+ if (this.externalNode)
+ {
+ this._sound.connect(this.externalNode.input);
+ }
+ else
+ {
+ this._sound.connect(this.gainNode);
+ }
+
+ if (this.loop)
+ {
+ this._sound.loop = true;
+ }
if (typeof this._sound.start === 'undefined')
{
@@ -1126,6 +1133,8 @@ Phaser.Sound.prototype = {
};
+Phaser.Sound.prototype.constructor = Phaser.Sound;
+
/**
* @name Phaser.Sound#isDecoding
* @property {boolean} isDecoding - Returns true if the sound file is still decoding.
@@ -1246,13 +1255,13 @@ Object.defineProperty(Phaser.Sound.prototype, "volume", {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/SoundManager.js.html b/docs/SoundManager.js.html
index ef9762a0..6fa385c5 100644
--- a/docs/SoundManager.js.html
+++ b/docs/SoundManager.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -711,7 +705,7 @@ Phaser.SoundManager.prototype = {
that.game.cache.decodedSound(key, buffer);
if (sound)
{
- that.onSoundDecode.dispatch(sound);
+ that.onSoundDecode.dispatch(key, sound);
}
});
}
@@ -792,6 +786,8 @@ Phaser.SoundManager.prototype = {
};
+Phaser.SoundManager.prototype.constructor = Phaser.SoundManager;
+
/**
* @name Phaser.SoundManager#mute
* @property {boolean} mute - Gets or sets the muted state of the SoundManager. This effects all sounds in the game.
@@ -916,13 +912,13 @@ Object.defineProperty(Phaser.SoundManager.prototype, "volume", {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Sprite.js.html b/docs/Sprite.js.html
index 41ff5ec3..cce3609a 100644
--- a/docs/Sprite.js.html
+++ b/docs/Sprite.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -632,6 +626,7 @@ Phaser.Sprite = function (game, x, y, key, frame) {
*/
this._cache = {
+ fresh: true,
dirty: false,
// Transform cache
@@ -777,7 +772,7 @@ Phaser.Sprite = function (game, x, y, key, frame) {
/**
* @property {Phaser.Point} cameraOffset - If this Sprite is fixed to the camera then use this Point to specify how far away from the Camera x/y it's rendered.
*/
- this.cameraOffset = new Phaser.Point();
+ this.cameraOffset = new Phaser.Point(x, y);
/**
* You can crop the Sprites texture by modifying the crop properties. For example crop.width = 50 would set the Sprite to only render 50px wide.
@@ -793,9 +788,19 @@ Phaser.Sprite = function (game, x, y, key, frame) {
*/
this.cropEnabled = false;
+ /**
+ * @property {boolean} debug - Handy flag to use with Game.enableStep
+ * @default
+ */
+ this.debug = false;
+
this.updateCache();
this.updateBounds();
+ /**
+ * @property {PIXI.Point} pivot - The pivot point of the displayObject that it rotates around.
+ */
+
};
// Needed to keep the PIXI.Sprite constructor in the prototype chain (as the core pixi renderer uses an instanceof check sadly)
@@ -810,6 +815,24 @@ Phaser.Sprite.prototype.constructor = Phaser.Sprite;
*/
Phaser.Sprite.prototype.preUpdate = function() {
+ if (this._cache.fresh)
+ {
+ this.world.setTo(this.parent.position.x + this.x, this.parent.position.y + this.y);
+ this.worldTransform[2] = this.world.x;
+ this.worldTransform[5] = this.world.y;
+ this._cache.fresh = false;
+
+ if (this.body)
+ {
+ this.body.x = (this.world.x - (this.anchor.x * this.width)) + this.body.offset.x;
+ this.body.y = (this.world.y - (this.anchor.y * this.height)) + this.body.offset.y;
+ this.body.preX = this.body.x;
+ this.body.preY = this.body.y;
+ }
+
+ return;
+ }
+
if (!this.exists || (this.group && !this.group.exists))
{
this.renderOrderID = -1;
@@ -925,7 +948,6 @@ Phaser.Sprite.prototype.updateAnimation = function() {
this._cache.halfHeight = Math.floor(this._cache.height / 2);
this._cache.dirty = true;
-
}
};
@@ -1020,12 +1042,6 @@ Phaser.Sprite.prototype.updateBounds = function() {
this.renderable = this._cache.cameraVisible;
}
- // Update our physics bounds
- if (this.body)
- {
- this.body.updateBounds(this.center.x, this.center.y, this._cache.scaleX, this._cache.scaleY);
- }
-
};
/**
@@ -1036,9 +1052,7 @@ Phaser.Sprite.prototype.updateBounds = function() {
* @memberof Phaser.Sprite
* @param {Phaser.Point} p - The Point object to store the results in.
* @param {number} x - x coordinate within the Sprite to translate.
-* @param {number} y - x coordinate within the Sprite to translate.
-* @param {number} sx - Scale factor to be applied.
-* @param {number} sy - Scale factor to be applied.
+* @param {number} y - y coordinate within the Sprite to translate.
* @return {Phaser.Point} The translated point.
*/
Phaser.Sprite.prototype.getLocalPosition = function(p, x, y) {
@@ -1057,8 +1071,8 @@ Phaser.Sprite.prototype.getLocalPosition = function(p, x, y) {
* @method Phaser.Sprite#getLocalUnmodifiedPosition
* @memberof Phaser.Sprite
* @param {Phaser.Point} p - The Point object to store the results in.
-* @param {number} x - x coordinate within the Sprite to translate.
-* @param {number} y - x coordinate within the Sprite to translate.
+* @param {number} gx - x coordinate within the Sprite to translate.
+* @param {number} gy - y coordinate within the Sprite to translate.
* @return {Phaser.Point} The translated point.
*/
Phaser.Sprite.prototype.getLocalUnmodifiedPosition = function(p, gx, gy) {
@@ -1099,7 +1113,6 @@ Phaser.Sprite.prototype.postUpdate = function() {
if (this.exists)
{
- // The sprite is positioned in this call, after taking into consideration motion updates and collision
if (this.body)
{
this.body.postUpdate();
@@ -1116,8 +1129,6 @@ Phaser.Sprite.prototype.postUpdate = function() {
this._cache.y = this.y;
}
- this.world.setTo(this.game.camera.x + this.worldTransform[2], this.game.camera.y + this.worldTransform[5]);
-
this.position.x = this._cache.x;
this.position.y = this._cache.y;
}
@@ -1195,8 +1206,17 @@ Phaser.Sprite.prototype.loadTexture = function (key, frame) {
*/
Phaser.Sprite.prototype.centerOn = function(x, y) {
- this.x = x + (this.x - this.center.x);
- this.y = y + (this.y - this.center.y);
+ if (this.fixedToCamera)
+ {
+ this.cameraOffset.x = x + (this.cameraOffset.x - this.center.x);
+ this.cameraOffset.y = y + (this.cameraOffset.y - this.center.y);
+ }
+ else
+ {
+ this.x = x + (this.x - this.center.x);
+ this.y = y + (this.y - this.center.y);
+ }
+
return this;
};
@@ -1263,6 +1283,11 @@ Phaser.Sprite.prototype.kill = function() {
*/
Phaser.Sprite.prototype.destroy = function() {
+ if (this.filters)
+ {
+ this.filters = null;
+ }
+
if (this.group)
{
this.group.remove(this);
@@ -1283,6 +1308,11 @@ Phaser.Sprite.prototype.destroy = function() {
this.animations.destroy();
}
+ if (this.body)
+ {
+ this.body.destroy();
+ }
+
this.alive = false;
this.exists = false;
this.visible = false;
@@ -1334,6 +1364,7 @@ Phaser.Sprite.prototype.reset = function(x, y, health) {
this.x = x;
this.y = y;
+ this.world.setTo(x, y);
this.position.x = this.x;
this.position.y = this.y;
this.alive = true;
@@ -1346,7 +1377,7 @@ Phaser.Sprite.prototype.reset = function(x, y, health) {
if (this.body)
{
- this.body.reset();
+ this.body.reset(false);
}
return this;
@@ -1397,6 +1428,34 @@ Phaser.Sprite.prototype.play = function (name, frameRate, loop, killOnComplete)
};
+/**
+* Returns the delta x value. The difference between Sprite.x now and in the previous step.
+* @name Phaser.Sprite#deltaX
+* @property {number} deltaX - The delta value. Positive if the motion was to the right, negative if to the left.
+* @readonly
+*/
+Object.defineProperty(Phaser.Sprite.prototype, 'deltaX', {
+
+ get: function() {
+ return this.world.x - this._cache.prevX;
+ }
+
+});
+
+/**
+* Returns the delta x value. The difference between Sprite.y now and in the previous step.
+* @name Phaser.Sprite#deltaY
+* @property {number} deltaY - The delta value. Positive if the motion was downwards, negative if upwards.
+* @readonly
+*/
+Object.defineProperty(Phaser.Sprite.prototype, 'deltaY', {
+
+ get: function() {
+ return this.world.y - this._cache.prevY;
+ }
+
+});
+
/**
* Indicates the rotation of the Sprite, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.
* Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement player.angle = 450 is the same as player.angle = 90.
@@ -1461,6 +1520,32 @@ Object.defineProperty(Phaser.Sprite.prototype, "inCamera", {
});
+/**
+* @name Phaser.Sprite#worldCenterX
+* @property {number} worldCenterX - The center of the Sprite in world coordinates.
+* @readonly
+*/
+Object.defineProperty(Phaser.Sprite.prototype, "worldCenterX", {
+
+ get: function () {
+ return this.game.camera.x + this.center.x;
+ }
+
+});
+
+/**
+* @name Phaser.Sprite#worldCenterY
+* @property {number} worldCenterY - The center of the Sprite in world coordinates.
+* @readonly
+*/
+Object.defineProperty(Phaser.Sprite.prototype, "worldCenterY", {
+
+ get: function () {
+ return this.game.camera.y + this.center.y;
+ }
+
+});
+
/**
* The width of the sprite in pixels, setting this will actually modify the scale to acheive the value desired.
* If you wish to crop the Sprite instead see the Sprite.crop value.
@@ -1524,8 +1609,6 @@ Object.defineProperty(Phaser.Sprite.prototype, "inputEnabled", {
set: function (value) {
- console.log('inputEnabled', value, this.input);
-
if (value)
{
if (this.input.enabled === false)
@@ -1559,13 +1642,13 @@ Object.defineProperty(Phaser.Sprite.prototype, "inputEnabled", {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Stage.js.html b/docs/Stage.js.html
index ea337d27..61e45c67 100644
--- a/docs/Stage.js.html
+++ b/docs/Stage.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -447,7 +441,6 @@ Phaser.Stage = function (game, width, height) {
/**
* @property {string} game - Background color of the stage (defaults to black). Set via the public backgroundColor property.
* @private
- * @default 'rgb(0,0,0)'
*/
this._backgroundColor = 'rgb(0,0,0)';
@@ -457,10 +450,9 @@ Phaser.Stage = function (game, width, height) {
this.offset = new Phaser.Point();
/**
- * @property {HTMLCanvasElement} canvas - Reference to the newly created <canvas> element.
+ * @property {HTMLCanvasElement} canvas - Reference to the newly created `canvas` element.
*/
- this.canvas = Phaser.Canvas.create(width, height);
- this.canvas.style['-webkit-full-screen'] = 'width: 100%; height: 100%';
+ this.canvas = null;
/**
* @property {PIXI.Stage} _stage - The Pixi Stage which is hooked to the renderer.
@@ -470,11 +462,21 @@ Phaser.Stage = function (game, width, height) {
this._stage.name = '_stage_root';
this._stage.interactive = false;
+ /**
+ * @property {PIXI.Stage} display - The Pixi Stage which is hooked to the renderer.
+ */
+ this.display = this._stage;
+
/**
* @property {number} scaleMode - The current scaleMode.
*/
this.scaleMode = Phaser.StageScaleMode.NO_SCALE;
+ /*
+ * @property {number} fullScreenScaleMode - Scale mode to be used in fullScreen
+ */
+ this.fullScreenScaleMode = Phaser.StageScaleMode.NO_SCALE;
+
/**
* @property {Phaser.StageScaleMode} scale - The scale of the current running game.
*/
@@ -485,6 +487,12 @@ Phaser.Stage = function (game, width, height) {
*/
this.aspectRatio = width / height;
+ /**
+ * @property {boolean} disableVisibilityChange - By default if the browser tab loses focus the game will pause. You can stop that behaviour by setting this property to true.
+ * @default
+ */
+ this.disableVisibilityChange = false;
+
/**
* @property {number} _nextOffsetCheck - The time to run the next offset check.
* @private
@@ -497,10 +505,73 @@ Phaser.Stage = function (game, width, height) {
*/
this.checkOffsetInterval = 2500;
+ if (game.config)
+ {
+ this.parseConfig(game.config);
+ }
+ else
+ {
+ this.canvas = Phaser.Canvas.create(width, height);
+ this.canvas.style['-webkit-full-screen'] = 'width: 100%; height: 100%';
+ }
+
};
Phaser.Stage.prototype = {
+ /**
+ * Parses a Game configuration object.
+ *
+ * @method Phaser.Stage#parseConfig
+ * @protected
+ */
+ parseConfig: function (config) {
+
+ if (config['canvasID'])
+ {
+ this.canvas = Phaser.Canvas.create(this.game.width, this.game.height, config['canvasID']);
+ }
+ else
+ {
+ this.canvas = Phaser.Canvas.create(this.game.width, this.game.height);
+ }
+
+ if (config['canvasStyle'])
+ {
+ this.canvas.stlye = config['canvasStyle'];
+ }
+ else
+ {
+ this.canvas.style['-webkit-full-screen'] = 'width: 100%; height: 100%';
+ }
+
+ if (config['checkOffsetInterval'])
+ {
+ this.checkOffsetInterval = config['checkOffsetInterval'];
+ }
+
+ if (config['disableVisibilityChange'])
+ {
+ this.disableVisibilityChange = config['disableVisibilityChange'];
+ }
+
+ if (config['fullScreenScaleMode'])
+ {
+ this.fullScreenScaleMode = config['fullScreenScaleMode'];
+ }
+
+ if (config['scaleMode'])
+ {
+ this.scaleMode = config['scaleMode'];
+ }
+
+ if (config['backgroundColor'])
+ {
+ this.backgroundColor = config['backgroundColor'];
+ }
+
+ },
+
/**
* Initialises the stage and adds the event listeners.
* @method Phaser.Stage#boot
@@ -563,7 +634,7 @@ Phaser.Stage.prototype = {
return;
}
- if (event.type == 'pagehide' || event.type == 'blur' || document['hidden'] === true || document['webkitHidden'] === true)
+ if (this.game.paused === false && (event.type == 'pagehide' || event.type == 'blur' || document['hidden'] === true || document['webkitHidden'] === true))
{
this.game.paused = true;
}
@@ -576,6 +647,8 @@ Phaser.Stage.prototype = {
};
+Phaser.Stage.prototype.constructor = Phaser.Stage;
+
/**
* @name Phaser.Stage#backgroundColor
* @property {number|string} backgroundColor - Gets and sets the background color of the stage. The color can be given as a number: 0xff0000 or a hex string: '#ff0000'
@@ -627,13 +700,13 @@ Object.defineProperty(Phaser.Stage.prototype, "backgroundColor", {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/StageScaleMode.js.html b/docs/StageScaleMode.js.html
index 93f2d900..156a13d6 100644
--- a/docs/StageScaleMode.js.html
+++ b/docs/StageScaleMode.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -683,7 +677,8 @@ Phaser.StageScaleMode.prototype = {
this._width = this.width;
this._height = this.height;
- console.log('startFullScreen', this._width, this._height);
+ // This needs updating to match the final spec:
+ // http://generatedcontent.org/post/70347573294/is-your-fullscreen-api-code-up-to-date-find-out-how-to
if (element['requestFullScreen'])
{
@@ -691,7 +686,7 @@ Phaser.StageScaleMode.prototype = {
}
else if (element['mozRequestFullScreen'])
{
- element['mozRequestFullScreen']();
+ element.parentNode['mozRequestFullScreen']();
}
else if (element['webkitRequestFullScreen'])
{
@@ -733,16 +728,24 @@ Phaser.StageScaleMode.prototype = {
if (this.isFullScreen)
{
- this.game.stage.canvas.style['width'] = '100%';
- this.game.stage.canvas.style['height'] = '100%';
+ if (this.game.stage.fullScreenScaleMode === Phaser.StageScaleMode.EXACT_FIT)
+ {
+ this.game.stage.canvas.style['width'] = '100%';
+ this.game.stage.canvas.style['height'] = '100%';
- this.setMaximum();
+ this.setMaximum();
- this.game.input.scale.setTo(this.game.width / this.width, this.game.height / this.height);
+ this.game.input.scale.setTo(this.game.width / this.width, this.game.height / this.height);
- this.aspectRatio = this.width / this.height;
- this.scaleFactor.x = this.game.width / this.width;
- this.scaleFactor.y = this.game.height / this.height;
+ this.aspectRatio = this.width / this.height;
+ this.scaleFactor.x = this.game.width / this.width;
+ this.scaleFactor.y = this.game.height / this.height;
+ }
+ else if (this.game.stage.fullScreenScaleMode === Phaser.StageScaleMode.SHOW_ALL)
+ {
+ this.game.stage.scale.setShowAll();
+ this.game.stage.scale.refresh();
+ }
}
else
{
@@ -983,13 +986,27 @@ Phaser.StageScaleMode.prototype = {
{
this.setMaximum();
}
- else if (this.game.stage.scaleMode == Phaser.StageScaleMode.EXACT_FIT)
+ else if (!this.isFullScreen)
{
- this.setExactFit();
+ if (this.game.stage.scaleMode == Phaser.StageScaleMode.EXACT_FIT)
+ {
+ this.setExactFit();
+ }
+ else if (this.game.stage.scaleMode == Phaser.StageScaleMode.SHOW_ALL)
+ {
+ this.setShowAll();
+ }
}
- else if (this.game.stage.scaleMode == Phaser.StageScaleMode.SHOW_ALL)
+ else
{
- this.setShowAll();
+ if (this.game.stage.fullScreenScaleMode == Phaser.StageScaleMode.EXACT_FIT)
+ {
+ this.setExactFit();
+ }
+ else if (this.game.stage.fullScreenScaleMode == Phaser.StageScaleMode.SHOW_ALL)
+ {
+ this.setShowAll();
+ }
}
this.setSize();
@@ -1110,8 +1127,6 @@ Phaser.StageScaleMode.prototype = {
var availableWidth = window.innerWidth;
var availableHeight = window.innerHeight;
- // console.log('available', availableWidth, availableHeight);
-
if (this.maxWidth && availableWidth > this.maxWidth)
{
this.width = this.maxWidth;
@@ -1134,6 +1149,8 @@ Phaser.StageScaleMode.prototype = {
};
+Phaser.StageScaleMode.prototype.constructor = Phaser.StageScaleMode;
+
/**
* @name Phaser.StageScaleMode#isFullScreen
* @property {boolean} isFullScreen - Returns true if the browser is in full screen mode, otherwise false.
@@ -1189,13 +1206,13 @@ Object.defineProperty(Phaser.StageScaleMode.prototype, "isLandscape", {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/State.js.html b/docs/State.js.html
index db95688b..b20515cf 100644
--- a/docs/State.js.html
+++ b/docs/State.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -590,6 +584,8 @@ Phaser.State.prototype = {
}
};
+
+Phaser.State.prototype.constructor = Phaser.State;
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/StateManager.js.html b/docs/StateManager.js.html index aa2184db..e3b8a73f 100644 --- a/docs/StateManager.js.html +++ b/docs/StateManager.js.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Text.js.html b/docs/Text.js.html index 84b4a4f7..9376f7f1 100644 --- a/docs/Text.js.html +++ b/docs/Text.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
-* Create a new <code>Text</code>.
+* Create a new `Text` object.
* @class Phaser.Text
* @constructor
* @param {Phaser.Game} game - Current game instance.
@@ -513,6 +507,18 @@ Phaser.Text = function (game, x, y, text, style) {
*/
this.scale = new Phaser.Point(1, 1);
+ /**
+ * An object that is fixed to the camera ignores the position of any ancestors in the display list and uses its x/y coordinates as offsets from the top left of the camera.
+ * @property {boolean} fixedToCamera - Fixes this object to the Camera.
+ * @default
+ */
+ this.fixedToCamera = false;
+
+ /**
+ * @property {Phaser.Point} cameraOffset - If this object is fixed to the camera then use this Point to specify how far away from the Camera x/y it's rendered.
+ */
+ this.cameraOffset = new Phaser.Point(x, y);
+
/**
* @property {object} _cache - A mini cache for storing all of the calculated values.
* @private
@@ -564,6 +570,12 @@ Phaser.Text.prototype.update = function() {
return;
}
+ if (this.fixedToCamera)
+ {
+ this.x = this.game.camera.view.x + this.cameraOffset.x;
+ this.y = this.game.camera.view.y + this.cameraOffset.y;
+ }
+
this._cache.dirty = false;
this._cache.x = this.x;
@@ -719,13 +731,13 @@ Object.defineProperty(Phaser.Text.prototype, 'font', {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Tile.js.html b/docs/Tile.js.html
index 548be967..0dc8af7a 100644
--- a/docs/Tile.js.html
+++ b/docs/Tile.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
-* Create a new `Tile` object. Tiles live inside of Tilesets and are rendered via TilemapLayers.
+* Create a new `Tile` object.
*
* @class Phaser.Tile
-* @classdesc A Tile is a single representation of a tile within a Tilemap.
+* @classdesc A Tile is a representation of a single tile within the Tilemap.
* @constructor
-* @param {Phaser.Tileset} tileset - The tileset this tile belongs to.
+* @param {object} layer - The layer in the Tilemap data that this tile belongs to.
* @param {number} index - The index of this tile type in the core map data.
* @param {number} x - The x coordinate of this tile.
* @param {number} y - The y coordinate of this tile.
* @param {number} width - Width of the tile.
* @param {number} height - Height of the tile.
*/
-Phaser.Tile = function (tileset, index, x, y, width, height) {
+Phaser.Tile = function (layer, index, x, y, width, height) {
/**
- * @property {Phaser.Tileset} tileset - The tileset this tile belongs to.
+ * @property {object} layer - The layer in the Tilemap data that this tile belongs to.
*/
- this.tileset = tileset;
-
+ this.layer = layer;
+
/**
- * @property {number} index - The index of this tile within the tileset.
+ * @property {number} index - The index of this tile within the map data corresponding to the tileset.
*/
this.index = index;
+ /**
+ * @property {number} x - The x map coordinate of this tile.
+ */
+ this.x = x;
+
+ /**
+ * @property {number} y - The y map coordinate of this tile.
+ */
+ this.y = y;
+
/**
* @property {number} width - The width of the tile in pixels.
*/
@@ -463,22 +467,44 @@ Phaser.Tile = function (tileset, index, x, y, width, height) {
this.height = height;
/**
- * @property {number} x - The top-left corner of the tile within the tileset.
+ * @property {number} alpha - The alpha value at which this tile is drawn to the canvas.
*/
- this.x = x;
-
- /**
- * @property {number} y - The top-left corner of the tile within the tileset.
- */
- this.y = y;
-
- // Any extra meta data info we need here
+ this.alpha = 1;
/**
- * @property {number} mass - The virtual mass of the tile.
- * @default
+ * @property {object} properties - Tile specific properties.
*/
- this.mass = 1.0;
+ this.properties = {};
+
+ /**
+ * @property {boolean} scanned - Has this tile been walked / turned into a poly?
+ */
+ this.scanned = false;
+
+ /**
+ * @property {boolean} faceTop - Is the top of this tile an interesting edge?
+ */
+ this.faceTop = false;
+
+ /**
+ * @property {boolean} faceBottom - Is the bottom of this tile an interesting edge?
+ */
+ this.faceBottom = false;
+
+ /**
+ * @property {boolean} faceLeft - Is the left of this tile an interesting edge?
+ */
+ this.faceLeft = false;
+
+ /**
+ * @property {boolean} faceRight - Is the right of this tile an interesting edge?
+ */
+ this.faceRight = false;
+
+ /**
+ * @property {boolean} collides - Does this tile collide at all?
+ */
+ this.collides = false;
/**
* @property {boolean} collideNone - Indicating this Tile doesn't collide at all.
@@ -511,38 +537,27 @@ Phaser.Tile = function (tileset, index, x, y, width, height) {
this.collideDown = false;
/**
- * @property {boolean} separateX - Enable separation at x-axis.
+ * @property {function} callback - Tile collision callback.
* @default
*/
- this.separateX = true;
+ this.callback = null;
/**
- * @property {boolean} separateY - Enable separation at y-axis.
+ * @property {object} callbackContext - The context in which the collision callback will be called.
* @default
*/
- this.separateY = true;
-
- /**
- * @property {boolean} collisionCallback - Tilemap collision callback.
- * @default
- */
- this.collisionCallback = null;
-
- /**
- * @property {boolean} collisionCallback - Tilemap collision callback.
- * @default
- */
- this.collisionCallbackContext = this;
+ this.callbackContext = this;
};
Phaser.Tile.prototype = {
/**
- * Set callback to be called when this tilemap collides.
+ * Set a callback to be called when this tile is hit by an object.
+ * The callback must true true for collision processing to take place.
*
* @method Phaser.Tile#setCollisionCallback
- * @param {Function} callback - Callback function.
+ * @param {function} callback - Callback function.
* @param {object} context - Callback will be called with this context.
*/
setCollisionCallback: function (callback, context) {
@@ -558,7 +573,9 @@ Phaser.Tile.prototype = {
*/
destroy: function () {
- this.tileset = null;
+ this.collisionCallback = null;
+ this.collisionCallbackContext = null;
+ this.properties = null;
},
@@ -600,19 +617,55 @@ Phaser.Tile.prototype = {
this.collideUp = false;
this.collideDown = false;
+ },
+
+ /**
+ * Copies the tile data and properties from the given tile to this tile.
+ * @method Phaser.Tile#copy
+ * @param {Phaser.Tile} tile - The tile to copy from.
+ */
+ copy: function (tile) {
+
+ this.index = tile.index;
+ this.alpha = tile.alpha;
+ this.properties = tile.properties;
+ this.collides = tile.collides;
+ this.collideNone = tile.collideNone;
+ this.collideUp = tile.collideUp;
+ this.collideDown = tile.collideDown;
+ this.collideLeft = tile.collideLeft;
+ this.collideRight = tile.collideRight;
+ this.collisionCallback = tile.collisionCallback;
+ this.collisionCallbackContext = tile.collisionCallbackContext;
+
}
};
+Phaser.Tile.prototype.constructor = Phaser.Tile;
+
/**
-* @name Phaser.Tile#bottom
-* @property {number} bottom - The sum of the y and height properties.
+* @name Phaser.Tile#canCollide
+* @property {boolean} canCollide - True if this tile can collide or has a collision callback.
* @readonly
*/
-Object.defineProperty(Phaser.Tile.prototype, "bottom", {
+Object.defineProperty(Phaser.Tile.prototype, "canCollide", {
get: function () {
- return this.y + this.height;
+ return (this.collides || this.collisionCallback || this.layer.callbacks[this.index]);
+ }
+
+});
+
+/**
+* @name Phaser.Tile#left
+* @property {number} left - The x value.
+* @readonly
+*/
+Object.defineProperty(Phaser.Tile.prototype, "left", {
+
+ get: function () {
+ return this.x;
}
});
@@ -628,6 +681,32 @@ Object.defineProperty(Phaser.Tile.prototype, "right", {
return this.x + this.width;
}
+});
+
+/**
+* @name Phaser.Tile#top
+* @property {number} top - The y value.
+* @readonly
+*/
+Object.defineProperty(Phaser.Tile.prototype, "top", {
+
+ get: function () {
+ return this.y;
+ }
+
+});
+
+/**
+* @name Phaser.Tile#bottom
+* @property {number} bottom - The sum of the y and height properties.
+* @readonly
+*/
+Object.defineProperty(Phaser.Tile.prototype, "bottom", {
+
+ get: function () {
+ return this.y + this.height;
+ }
+
});
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/TileSprite.js.html b/docs/TileSprite.js.html index ac778ade..a9fdfd0d 100644 --- a/docs/TileSprite.js.html +++ b/docs/TileSprite.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -438,18 +432,16 @@
* @param {number} width - the width of the tilesprite.
* @param {number} height - the height of the tilesprite.
* @param {string|Phaser.RenderTexture|PIXI.Texture} key - This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.
-* @param {string|number} frame - If this Sprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.
*/
-Phaser.TileSprite = function (game, x, y, width, height, key, frame) {
+Phaser.TileSprite = function (game, x, y, width, height, key) {
x = x || 0;
y = y || 0;
width = width || 256;
height = height || 256;
key = key || null;
- frame = frame || null;
- Phaser.Sprite.call(this, game, x, y, key, frame);
+ Phaser.Sprite.call(this, game, x, y, key);
/**
* @property {PIXI.Texture} texture - The texture that the sprite renders with.
@@ -474,11 +466,113 @@ Phaser.TileSprite = function (game, x, y, width, height, key, frame) {
*/
this.tilePosition = new Phaser.Point(0, 0);
+ this.body.width = width;
+ this.body.height = height;
+
};
Phaser.TileSprite.prototype = Phaser.Utils.extend(true, PIXI.TilingSprite.prototype, Phaser.Sprite.prototype);
Phaser.TileSprite.prototype.constructor = Phaser.TileSprite;
+/**
+* Indicates the rotation of the Sprite, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.
+* Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement player.angle = 450 is the same as player.angle = 90.
+* If you wish to work in radians instead of degrees use the property Sprite.rotation instead.
+* @name Phaser.TileSprite#angle
+* @property {number} angle - Gets or sets the Sprites angle of rotation in degrees.
+*/
+Object.defineProperty(Phaser.TileSprite.prototype, 'angle', {
+
+ get: function() {
+ return Phaser.Math.wrapAngle(Phaser.Math.radToDeg(this.rotation));
+ },
+
+ set: function(value) {
+ this.rotation = Phaser.Math.degToRad(Phaser.Math.wrapAngle(value));
+ }
+
+});
+
+/**
+* @name Phaser.TileSprite#frame
+* @property {number} frame - Gets or sets the current frame index and updates the Texture Cache for display.
+*/
+Object.defineProperty(Phaser.TileSprite.prototype, "frame", {
+
+ get: function () {
+ return this.animations.frame;
+ },
+
+ set: function (value) {
+ this.animations.frame = value;
+ }
+
+});
+
+/**
+* @name Phaser.TileSprite#frameName
+* @property {string} frameName - Gets or sets the current frame name and updates the Texture Cache for display.
+*/
+Object.defineProperty(Phaser.TileSprite.prototype, "frameName", {
+
+ get: function () {
+ return this.animations.frameName;
+ },
+
+ set: function (value) {
+ this.animations.frameName = value;
+ }
+
+});
+
+/**
+* @name Phaser.TileSprite#inCamera
+* @property {boolean} inCamera - Is this sprite visible to the camera or not?
+* @readonly
+*/
+Object.defineProperty(Phaser.TileSprite.prototype, "inCamera", {
+
+ get: function () {
+ return this._cache.cameraVisible;
+ }
+
+});
+
+/**
+* By default a Sprite won't process any input events at all. By setting inputEnabled to true the Phaser.InputHandler is
+* activated for this Sprite instance and it will then start to process click/touch events and more.
+*
+* @name Phaser.TileSprite#inputEnabled
+* @property {boolean} inputEnabled - Set to true to allow this Sprite to receive input events, otherwise false.
+*/
+Object.defineProperty(Phaser.TileSprite.prototype, "inputEnabled", {
+
+ get: function () {
+
+ return (this.input.enabled);
+
+ },
+
+ set: function (value) {
+
+ if (value)
+ {
+ if (this.input.enabled === false)
+ {
+ this.input.start();
+ }
+ }
+ else
+ {
+ if (this.input.enabled)
+ {
+ this.input.stop();
+ }
+ }
+
+ }
+
+});
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Tilemap.js.html b/docs/Tilemap.js.html index e82c2655..ed75f137 100644 --- a/docs/Tilemap.js.html +++ b/docs/Tilemap.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -444,22 +438,52 @@ Phaser.Tilemap = function (game, key) {
this.game = game;
/**
- * @property {array} layers - An array of Tilemap layers.
+ * @property {string} key - The key of this map data in the Phaser.Cache.
*/
- this.layers = null;
+ this.key = key;
- if (typeof key === 'string')
- {
- this.key = key;
+ var data = Phaser.TilemapParser.parse(this.game, key);
- this.layers = game.cache.getTilemapData(key).layers;
- this.calculateIndexes();
- }
- else
+ if (data === null)
{
- this.layers = [];
+ return;
}
+ this.width = data.width;
+ this.height = data.height;
+ this.tileWidth = data.tileWidth;
+ this.tileHeight = data.tileHeight;
+ this.orientation = data.orientation;
+ this.version = data.version;
+ this.properties = data.properties;
+ this.widthInPixels = data.widthInPixels;
+ this.heightInPixels = data.heightInPixels;
+
+ /**
+ * @property {array} layers - An array of Tilemap layer data.
+ */
+ this.layers = data.layers;
+
+ /**
+ * @property {array} tilesets - An array of Tilesets.
+ */
+ this.tilesets = data.tilesets;
+
+ /**
+ * @property {array} tiles - The super array of Tiles.
+ */
+ this.tiles = data.tiles;
+
+ /**
+ * @property {array} objects - An array of Tiled Object Layers.
+ */
+ this.objects = data.objects;
+
+ /**
+ * @property {array} images - An array of Tiled Image Layers.
+ */
+ this.images = data.images;
+
/**
* @property {number} currentLayer - The current layer.
*/
@@ -468,14 +492,8 @@ Phaser.Tilemap = function (game, key) {
/**
* @property {array} debugMap - Map data used for debug values only.
*/
-
this.debugMap = [];
- /**
- * @property {boolean} dirty - Internal rendering related flag.
- */
- this.dirty = false;
-
/**
* @property {array} _results - Internal var.
* @private
@@ -543,36 +561,500 @@ Phaser.Tilemap.prototype = {
tileSpacing: 0,
format: Phaser.Tilemap.CSV,
data: data,
- indexes: []
+ indexes: [],
+ dirty: true
});
this.currentLayer = this.layers.length - 1;
- this.dirty = true;
+ },
+
+ /**
+ * Adds an image to the map to be used as a tileset. A single map may use multiple tilesets.
+ * Note that the tileset name can be found in the JSON file exported from Tiled, or in the Tiled editor.
+ *
+ * @method Phaser.Tilemap#addTilesetImage
+ * @param {string} tileset - The name of the tileset as specified in the map data.
+ * @param {string} [key] - The key of the Phaser.Cache image used for this tileset. If not specified it will look for an image with a key matching the tileset parameter.
+ */
+ addTilesetImage: function (tileset, key) {
+
+ if (typeof key === 'undefined')
+ {
+ if (typeof tileset === 'string')
+ {
+ key = tileset;
+ }
+ else
+ {
+ return false;
+ }
+ }
+
+ if (typeof tileset === 'string')
+ {
+ tileset = this.getTilesetIndex(tileset);
+ }
+
+ if (this.tilesets[tileset])
+ {
+ this.tilesets[tileset].image = this.game.cache.getImage(key);
+
+ return true;
+ }
+
+ return false;
+
+ },
+
+ // Region? Remove tile from map data?
+ createFromTiles: function (layer, tileIndex, key, frame, group) {
+
+ if (typeof group === 'undefined') { group = this.game.world; }
},
/**
- * Internal function that calculates the tile indexes for the map data.
+ * Creates a Sprite for every object matching the given gid in the map data. You can optionally specify the group that the Sprite will be created in. If none is
+ * given it will be created in the World. All properties from the map data objectgroup are copied across to the Sprite, so you can use this as an easy way to
+ * configure Sprite properties from within the map editor. For example giving an object a property if alpha: 0.5 in the map editor will duplicate that when the
+ * Sprite is created. You could also give it a value like: body.velocity.x: 100 to set it moving automatically.
*
- * @method Phaser.Tilemap#calculateIndexes
+ * @method Phaser.Tileset#createFromObjects
+ * @param {string} name - The name of the Object Group to create Sprites from.
+ * @param {number} gid - The layer array index value, or if a string is given the layer name, within the map data that this TilemapLayer represents.
+ * @param {string} key - The Game.cache key of the image that this Sprite will use.
+ * @param {number|string} [frame] - If the Sprite image contains multiple frames you can specify which one to use here.
+ * @param {boolean} [exists=true] - The default exists state of the Sprite.
+ * @param {boolean} [autoCull=true] - The default autoCull state of the Sprite. Sprites that are autoCulled are culled from the camera if out of its range.
+ * @param {Phaser.Group} [group] - Optional Group to add the Sprite to. If not specified it will be added to the World group.
*/
- calculateIndexes: function () {
+ createFromObjects: function (name, gid, key, frame, exists, autoCull, group) {
- for (var layer = 0; layer < this.layers.length; layer++)
+ if (typeof exists === 'undefined') { exists = true; }
+ if (typeof autoCull === 'undefined') { autoCull = true; }
+ if (typeof group === 'undefined') { group = this.game.world; }
+
+ if (!this.objects[name])
{
- this.layers[layer].indexes = [];
+ console.warn('Tilemap.createFromObjects: Invalid objectgroup name given: ' + name);
+ return;
+ }
- for (var y = 0; y < this.layers[layer].height ; y++)
+ var sprite;
+
+ for (var i = 0, len = this.objects[name].length; i < len; i++)
+ {
+ if (this.objects[name][i].gid === gid)
{
- for (var x = 0; x < this.layers[layer].width; x++)
- {
- var idx = this.layers[layer].data[y][x];
+ sprite = group.create(this.objects[name][i].x, this.objects[name][i].y, key, frame, exists);
- if (this.layers[layer].indexes.indexOf(idx) === -1)
+ sprite.anchor.setTo(0, 1);
+ sprite.name = this.objects[name][i].name;
+ sprite.visible = this.objects[name][i].visible;
+ sprite.autoCull = autoCull;
+
+ for (property in this.objects[name][i].properties)
+ {
+ group.set(sprite, property, this.objects[name][i].properties[property], false, false, 0);
+ }
+ }
+ }
+
+ },
+
+ /**
+ * Creates a new TilemapLayer object. By default TilemapLayers are fixed to the camera.
+ *
+ * @method Phaser.Tileset#createLayer
+ * @param {number|string} layer - The layer array index value, or if a string is given the layer name, within the map data that this TilemapLayer represents.
+ * @param {number} [width] - The rendered width of the layer, should never be wider than Game.width. If not given it will be set to Game.width.
+ * @param {number} [height] - The rendered height of the layer, should never be wider than Game.height. If not given it will be set to Game.height.
+ * @param {Phaser.Group} [group] - Optional Group to add the object to. If not specified it will be added to the World group.
+ * @return {Phaser.TilemapLayer} The TilemapLayer object. This is an extension of Phaser.Sprite and can be moved around the display list accordingly.
+ */
+ createLayer: function (layer, width, height, group) {
+
+ // Add Buffer support for the left of the canvas
+
+ if (typeof width === 'undefined') { width = this.game.width; }
+ if (typeof height === 'undefined') { height = this.game.height; }
+ if (typeof group === 'undefined') { group = this.game.world; }
+
+ var index = layer;
+
+ if (typeof layer === 'string')
+ {
+ index = this.getLayerIndex(layer);
+ }
+
+ if (index === null || index > this.layers.length)
+ {
+ console.warn('Tilemap.createLayer: Invalid layer ID given: ' + index);
+ return;
+ }
+
+ return group.add(new Phaser.TilemapLayer(this.game, this, index, width, height));
+
+ },
+
+ /**
+ * Gets the layer index based on the layers name.
+ *
+ * @method Phaser.Tileset#getIndex
+ * @protected
+ * @param {array} location - The local array to search.
+ * @param {string} name - The name of the array element to get.
+ * @return {number} The index of the element in the array, or null if not found.
+ */
+ getIndex: function (location, name) {
+
+ for (var i = 0; i < location.length; i++)
+ {
+ if (location[i].name === name)
+ {
+ return i;
+ }
+ }
+
+ return null;
+
+ },
+
+ /**
+ * Gets the layer index based on its name.
+ *
+ * @method Phaser.Tileset#getLayerIndex
+ * @param {string} name - The name of the layer to get.
+ * @return {number} The index of the layer in this tilemap, or null if not found.
+ */
+ getLayerIndex: function (name) {
+
+ return this.getIndex(this.layers, name);
+
+ },
+
+ /**
+ * Gets the tileset index based on its name.
+ *
+ * @method Phaser.Tileset#getTilesetIndex
+ * @param {string} name - The name of the tileset to get.
+ * @return {number} The index of the tileset in this tilemap, or null if not found.
+ */
+ getTilesetIndex: function (name) {
+
+ return this.getIndex(this.tilesets, name);
+
+ },
+
+ /**
+ * Gets the image index based on its name.
+ *
+ * @method Phaser.Tileset#getImageIndex
+ * @param {string} name - The name of the image to get.
+ * @return {number} The index of the image in this tilemap, or null if not found.
+ */
+ getImageIndex: function (name) {
+
+ return this.getIndex(this.images, name);
+
+ },
+
+ /**
+ * Gets the object index based on its name.
+ *
+ * @method Phaser.Tileset#getObjectIndex
+ * @param {string} name - The name of the object to get.
+ * @return {number} The index of the object in this tilemap, or null if not found.
+ */
+ getObjectIndex: function (name) {
+
+ return this.getIndex(this.objects, name);
+
+ },
+
+ /**
+ * Sets a global collision callback for the given tile index within the layer. This will affect all tiles on this layer that have the same index.
+ * If a callback is already set for the tile index it will be replaced. Set the callback to null to remove it.
+ * If you want to set a callback for a tile at a specific location on the map then see setTileLocationCallback.
+ *
+ * @method Phaser.Tileset#setTileIndexCallback
+ * @param {number|array} indexes - Either a single tile index, or an array of tile indexes to have a collision callback set for.
+ * @param {function} callback - The callback that will be invoked when the tile is collided with.
+ * @param {object} callbackContext - The context under which the callback is called.
+ * @param {number|string|Phaser.TilemapLayer} [layer] - The layer to operate on. If not given will default to this.currentLayer.
+ */
+ setTileIndexCallback: function (indexes, callback, callbackContext, layer) {
+
+ layer = this.getLayer(layer);
+
+ if (typeof indexes === 'number')
+ {
+ // This may seem a bit wasteful, because it will cause empty array elements to be created, but the look-up cost is much
+ // less than having to iterate through the callbacks array hunting down tile indexes each time, so I'll take the small memory hit.
+ this.layers[layer].callbacks[indexes] = { callback: callback, callbackContext: callbackContext };
+ }
+ else
+ {
+ for (var i = 0, len = indexes.length; i < len; i++)
+ {
+ this.layers[layer].callbacks[indexes[i]] = { callback: callback, callbackContext: callbackContext };
+ }
+ }
+
+ },
+
+ /**
+ * Sets a global collision callback for the given tile index within the layer. This will affect all tiles on this layer that have the same index.
+ * If a callback is already set for the tile index it will be replaced. Set the callback to null to remove it.
+ * If you want to set a callback for a tile at a specific location on the map then see setTileLocationCallback.
+ *
+ * @method Phaser.Tileset#setTileLocationCallback
+ * @param {number} x - X position of the top left of the area to copy (given in tiles, not pixels)
+ * @param {number} y - Y position of the top left of the area to copy (given in tiles, not pixels)
+ * @param {number} width - The width of the area to copy (given in tiles, not pixels)
+ * @param {number} height - The height of the area to copy (given in tiles, not pixels)
+ * @param {function} callback - The callback that will be invoked when the tile is collided with.
+ * @param {object} callbackContext - The context under which the callback is called.
+ * @param {number|string|Phaser.TilemapLayer} [layer] - The layer to operate on. If not given will default to this.currentLayer.
+ */
+ setTileLocationCallback: function (x, y, width, height, callback, callbackContext, layer) {
+
+ layer = this.getLayer(layer);
+
+ this.copy(x, y, width, height, layer);
+
+ if (this._results.length < 2)
+ {
+ return;
+ }
+
+ for (var i = 1; i < this._results.length; i++)
+ {
+ this._results[i].setCollisionCallback(callback, callbackContext);
+ }
+
+ },
+
+ /**
+ * Sets collision the given tile or tiles. You can pass in either a single numeric index or an array of indexes: [ 2, 3, 15, 20].
+ * The `collides` parameter controls if collision will be enabled (true) or disabled (false).
+ *
+ * @method Phaser.Tileset#setCollision
+ * @param {number|array} indexes - Either a single tile index, or an array of tile IDs to be checked for collision.
+ * @param {boolean} [collides=true] - If true it will enable collision. If false it will clear collision.
+ * @param {number|string|Phaser.TilemapLayer} [layer] - The layer to operate on. If not given will default to this.currentLayer.
+ */
+ setCollision: function (indexes, collides, layer) {
+
+ if (typeof collides === 'undefined') { collides = true; }
+
+ layer = this.getLayer(layer);
+
+ if (typeof indexes === 'number')
+ {
+ return this.setCollisionByIndex(indexes, collides, layer, true);
+ }
+ else
+ {
+ // Collide all of the IDs given in the indexes array
+ for (var i = 0, len = indexes.length; i < len; i++)
+ {
+ this.setCollisionByIndex(indexes[i], collides, layer, false);
+ }
+
+ // Now re-calculate interesting faces
+ this.calculateFaces(layer);
+ }
+
+ },
+
+ /**
+ * Sets collision on a range of tiles where the tile IDs increment sequentially.
+ * Calling this with a start value of 10 and a stop value of 14 would set collision for tiles 10, 11, 12, 13 and 14.
+ * The `collides` parameter controls if collision will be enabled (true) or disabled (false).
+ *
+ * @method Phaser.Tileset#setCollisionBetween
+ * @param {number} start - The first index of the tile to be set for collision.
+ * @param {number} stop - The last index of the tile to be set for collision.
+ * @param {boolean} [collides=true] - If true it will enable collision. If false it will clear collision.
+ * @param {number|string|Phaser.TilemapLayer} [layer] - The layer to operate on. If not given will default to this.currentLayer.
+ */
+ setCollisionBetween: function (start, stop, collides, layer) {
+
+ if (typeof collides === 'undefined') { collides = true; }
+
+ layer = this.getLayer(layer);
+
+ if (start > stop)
+ {
+ return;
+ }
+
+ for (var index = start; index <= stop; index++)
+ {
+ this.setCollisionByIndex(index, collides, layer, false);
+ }
+
+ // Now re-calculate interesting faces
+ this.calculateFaces(layer);
+
+ },
+
+ /**
+ * Sets collision on all tiles in the given layer, except for the IDs of those in the given array.
+ * The `collides` parameter controls if collision will be enabled (true) or disabled (false).
+ *
+ * @method Phaser.Tileset#setCollisionByExclusion
+ * @param {array} indexes - An array of the tile IDs to not be counted for collision.
+ * @param {boolean} [collides=true] - If true it will enable collision. If false it will clear collision.
+ * @param {number|string|Phaser.TilemapLayer} [layer] - The layer to operate on. If not given will default to this.currentLayer.
+ */
+ setCollisionByExclusion: function (indexes, collides, layer) {
+
+ if (typeof collides === 'undefined') { collides = true; }
+
+ layer = this.getLayer(layer);
+
+ // Collide everything, except the IDs given in the indexes array
+ for (var i = 0, len = this.tiles.length; i < len; i++)
+ {
+ if (indexes.indexOf(i) === -1)
+ {
+ this.setCollisionByIndex(i, collides, layer, false);
+ }
+ }
+
+ // Now re-calculate interesting faces
+ this.calculateFaces(layer);
+
+ },
+
+ /**
+ * Sets collision values on a tile in the set.
+ * You shouldn't usually call this method directly, instead use setCollision, setCollisionBetween or setCollisionByExclusion.
+ *
+ * @method Phaser.Tileset#setCollisionByIndex
+ * @protected
+ * @param {number} index - The index of the tile on the layer.
+ * @param {boolean} [collides=true] - If true it will enable collision on the tile. If false it will clear collision values from the tile.
+ * @param {number} [layer] - The layer to operate on. If not given will default to this.currentLayer.
+ * @param {boolean} [recalculate=true] - Recalculates the tile faces after the update.
+ */
+ setCollisionByIndex: function (index, collides, layer, recalculate) {
+
+ if (typeof collides === 'undefined') { collides = true; }
+ if (typeof layer === 'undefined') { layer = this.currentLayer; }
+ if (typeof recalculate === 'undefined') { recalculate = true; }
+
+ for (var y = 0; y < this.layers[layer].height ; y++)
+ {
+ for (var x = 0; x < this.layers[layer].width; x++)
+ {
+ var tile = this.layers[layer].data[y][x];
+
+ if (tile && tile.index === index)
+ {
+ tile.collides = collides;
+ tile.faceTop = collides;
+ tile.faceBottom = collides;
+ tile.faceLeft = collides;
+ tile.faceRight = collides;
+ }
+ }
+ }
+
+ if (recalculate)
+ {
+ // Now re-calculate interesting faces
+ this.calculateFaces(layer);
+ }
+
+ return layer;
+
+ },
+
+ /**
+ * Gets the TilemapLayer index as used in the setCollision calls.
+ *
+ * @method Phaser.Tileset#getLayer
+ * @protected
+ * @param {number|string|Phaser.TilemapLayer} layer - The layer to operate on. If not given will default to this.currentLayer.
+ * @return {number} The TilemapLayer index.
+ */
+ getLayer: function (layer) {
+
+ if (typeof layer === 'undefined')
+ {
+ layer = this.currentLayer;
+ }
+ // else if (typeof layer === 'number')
+ // {
+ // layer = layer;
+ // }
+ else if (typeof layer === 'string')
+ {
+ layer = this.getLayerIndex(layer);
+ }
+ else if (layer instanceof Phaser.TilemapLayer)
+ {
+ layer = layer.index;
+ }
+
+ return layer;
+
+ },
+
+ /**
+ * Internal function.
+ *
+ * @method Phaser.Tileset#calculateFaces
+ * @protected
+ * @param {number} layer - The index of the TilemapLayer to operate on.
+ */
+ calculateFaces: function (layer) {
+
+ var above = null;
+ var below = null;
+ var left = null;
+ var right = null;
+
+ for (var y = 0, h = this.layers[layer].height; y < h; y++)
+ {
+ for (var x = 0, w = this.layers[layer].width; x < w; x++)
+ {
+ var tile = this.layers[layer].data[y][x];
+
+ if (tile)
+ {
+ above = this.getTileAbove(layer, x, y);
+ below = this.getTileBelow(layer, x, y);
+ left = this.getTileLeft(layer, x, y);
+ right = this.getTileRight(layer, x, y);
+
+ if (above && above.collides)
{
- this.layers[layer].indexes.push(idx);
+ // There is a tile above this one that also collides, so the top of this tile is no longer interesting
+ tile.faceTop = false;
+ }
+
+ if (below && below.collides)
+ {
+ // There is a tile below this one that also collides, so the bottom of this tile is no longer interesting
+ tile.faceBottom = false;
+ }
+
+ if (left && left.collides)
+ {
+ // There is a tile left this one that also collides, so the left of this tile is no longer interesting
+ tile.faceLeft = false;
+ }
+
+ if (right && right.collides)
+ {
+ // There is a tile right this one that also collides, so the right of this tile is no longer interesting
+ tile.faceRight = false;
}
}
}
@@ -580,14 +1062,96 @@ Phaser.Tilemap.prototype = {
},
+ /**
+ * Gets the tile above the tile coordinates given.
+ * Mostly used as an internal function by calculateFaces.
+ *
+ * @method Phaser.Tileset#getTileAbove
+ * @param {number} layer - The local layer index to get the tile from. Can be determined by Tilemap.getLayer().
+ * @param {number} x - The x coordinate to get the tile from. In tiles, not pixels.
+ * @param {number} y - The y coordinate to get the tile from. In tiles, not pixels.
+ */
+ getTileAbove: function (layer, x, y) {
+
+ if (y > 0)
+ {
+ return this.layers[layer].data[y - 1][x];
+ }
+
+ return null;
+
+ },
+
+ /**
+ * Gets the tile below the tile coordinates given.
+ * Mostly used as an internal function by calculateFaces.
+ *
+ * @method Phaser.Tileset#getTileBelow
+ * @param {number} layer - The local layer index to get the tile from. Can be determined by Tilemap.getLayer().
+ * @param {number} x - The x coordinate to get the tile from. In tiles, not pixels.
+ * @param {number} y - The y coordinate to get the tile from. In tiles, not pixels.
+ */
+ getTileBelow: function (layer, x, y) {
+
+ if (y < this.layers[layer].height - 1)
+ {
+ return this.layers[layer].data[y + 1][x];
+ }
+
+ return null;
+
+ },
+
+ /**
+ * Gets the tile to the left of the tile coordinates given.
+ * Mostly used as an internal function by calculateFaces.
+ *
+ * @method Phaser.Tileset#getTileLeft
+ * @param {number} layer - The local layer index to get the tile from. Can be determined by Tilemap.getLayer().
+ * @param {number} x - The x coordinate to get the tile from. In tiles, not pixels.
+ * @param {number} y - The y coordinate to get the tile from. In tiles, not pixels.
+ */
+ getTileLeft: function (layer, x, y) {
+
+ if (x > 0)
+ {
+ return this.layers[layer].data[y][x - 1];
+ }
+
+ return null;
+
+ },
+
+ /**
+ * Gets the tile to the right of the tile coordinates given.
+ * Mostly used as an internal function by calculateFaces.
+ *
+ * @method Phaser.Tileset#getTileRight
+ * @param {number} layer - The local layer index to get the tile from. Can be determined by Tilemap.getLayer().
+ * @param {number} x - The x coordinate to get the tile from. In tiles, not pixels.
+ * @param {number} y - The y coordinate to get the tile from. In tiles, not pixels.
+ */
+ getTileRight: function (layer, x, y) {
+
+ if (x < this.layers[layer].width - 1)
+ {
+ return this.layers[layer].data[y][x + 1];
+ }
+
+ return null;
+
+ },
+
/**
* Sets the current layer to the given index.
*
* @method Phaser.Tilemap#setLayer
- * @param {number} layer - Sets the current layer to the given index.
+ * @param {number|string|Phaser.TilemapLayer} layer - The layer to set as current.
*/
setLayer: function (layer) {
+ layer = this.getLayer(layer);
+
if (this.layers[layer])
{
this.currentLayer = layer;
@@ -597,36 +1161,68 @@ Phaser.Tilemap.prototype = {
/**
* Puts a tile of the given index value at the coordinate specified.
+ *
* @method Phaser.Tilemap#putTile
- * @param {number} index - The index of this tile to set.
+ * @param {Phaser.Tile|number} tile - The index of this tile to set or a Phaser.Tile object.
* @param {number} x - X position to place the tile (given in tile units, not pixels)
* @param {number} y - Y position to place the tile (given in tile units, not pixels)
- * @param {number} [layer] - The Tilemap Layer to operate on.
+ * @param {number|string|Phaser.TilemapLayer} [layer] - The layer to modify.
*/
- putTile: function (index, x, y, layer) {
+ putTile: function (tile, x, y, layer) {
- if (typeof layer === "undefined") { layer = this.currentLayer; }
+ layer = this.getLayer(layer);
if (x >= 0 && x < this.layers[layer].width && y >= 0 && y < this.layers[layer].height)
{
- this.layers[layer].data[y][x] = index;
+ if (tile instanceof Phaser.Tile)
+ {
+ this.layers[layer].data[y][x].copy(tile);
+ }
+ else
+ {
+ this.layers[layer].data[y][x].index = tile;
+ }
+
+ this.layers[layer].dirty = true;
+ this.calculateFaces(layer);
}
- this.dirty = true;
+ },
+
+ /**
+ * Puts a tile into the Tilemap layer. The coordinates are given in pixel values.
+ *
+ * @method Phaser.Tilemap#putTileWorldXY
+ * @param {Phaser.Tile|number} tile - The index of this tile to set or a Phaser.Tile object.
+ * @param {number} x - X position to insert the tile (given in pixels)
+ * @param {number} y - Y position to insert the tile (given in pixels)
+ * @param {number} tileWidth - The width of the tile in pixels.
+ * @param {number} tileHeight - The height of the tile in pixels.
+ * @param {number|string|Phaser.TilemapLayer} [layer] - The layer to modify.
+ */
+ putTileWorldXY: function (tile, x, y, tileWidth, tileHeight, layer) {
+
+ layer = this.getLayer(layer);
+
+ x = this.game.math.snapToFloor(x, tileWidth) / tileWidth;
+ y = this.game.math.snapToFloor(y, tileHeight) / tileHeight;
+
+ this.putTile(tile, x, y, layer);
},
/**
* Gets a tile from the Tilemap Layer. The coordinates are given in tile values.
+ *
* @method Phaser.Tilemap#getTile
* @param {number} x - X position to get the tile from (given in tile units, not pixels)
* @param {number} y - Y position to get the tile from (given in tile units, not pixels)
- * @param {number} [layer] - The Tilemap Layer to operate on.
- * @return {number} The index of the tile at the given coordinates.
+ * @param {number|string|Phaser.TilemapLayer} [layer] - The layer to get the tile from.
+ * @return {Phaser.Tile} The tile at the given coordinates.
*/
getTile: function (x, y, layer) {
- if (typeof layer === "undefined") { layer = this.currentLayer; }
+ layer = this.getLayer(layer);
if (x >= 0 && x < this.layers[layer].width && y >= 0 && y < this.layers[layer].height)
{
@@ -637,65 +1233,38 @@ Phaser.Tilemap.prototype = {
/**
* Gets a tile from the Tilemap layer. The coordinates are given in pixel values.
+ *
* @method Phaser.Tilemap#getTileWorldXY
* @param {number} x - X position to get the tile from (given in pixels)
* @param {number} y - Y position to get the tile from (given in pixels)
- * @param {number} [layer] - The Tilemap Layer to operate on.
- * @return {number} The index of the tile at the given coordinates.
+ * @param {number|string|Phaser.TilemapLayer} [layer] - The layer to get the tile from.
+ * @return {Phaser.Tile} The tile at the given coordinates.
*/
getTileWorldXY: function (x, y, tileWidth, tileHeight, layer) {
- if (typeof layer === "undefined") { layer = this.currentLayer; }
+ layer = this.getLayer(layer);
x = this.game.math.snapToFloor(x, tileWidth) / tileWidth;
y = this.game.math.snapToFloor(y, tileHeight) / tileHeight;
- if (x >= 0 && x < this.layers[layer].width && y >= 0 && y < this.layers[layer].height)
- {
- return this.layers[layer].data[y][x];
- }
-
- },
-
- /**
- * Puts a tile into the Tilemap layer. The coordinates are given in pixel values.
- * @method Phaser.Tilemap#putTileWorldXY
- * @param {number} index - The index of the tile to put into the layer.
- * @param {number} x - X position to insert the tile (given in pixels)
- * @param {number} y - Y position to insert the tile (given in pixels)
- * @param {number} tileWidth - The width of the tile in pixels.
- * @param {number} tileHeight - The height of the tile in pixels.
- * @param {number} [layer] - The Tilemap Layer to operate on.
- */
- putTileWorldXY: function (index, x, y, tileWidth, tileHeight, layer) {
-
- if (typeof layer === "undefined") { layer = this.currentLayer; }
-
- x = this.game.math.snapToFloor(x, tileWidth) / tileWidth;
- y = this.game.math.snapToFloor(y, tileHeight) / tileHeight;
-
- if (x >= 0 && x < this.layers[layer].width && y >= 0 && y < this.layers[layer].height)
- {
- this.layers[layer].data[y][x] = index;
- }
-
- this.dirty = true;
+ return this.getTile(x, y, layer);
},
/**
* Copies all of the tiles in the given rectangular block into the tilemap data buffer.
+ *
* @method Phaser.Tilemap#copy
* @param {number} x - X position of the top left of the area to copy (given in tiles, not pixels)
* @param {number} y - Y position of the top left of the area to copy (given in tiles, not pixels)
* @param {number} width - The width of the area to copy (given in tiles, not pixels)
* @param {number} height - The height of the area to copy (given in tiles, not pixels)
- * @param {number} [layer] - The Tilemap Layer to operate on.
+ * @param {number|string|Phaser.TilemapLayer} [layer] - The layer to copy the tiles from.
* @return {array} An array of the tiles that were copied.
*/
copy: function (x, y, width, height, layer) {
- if (typeof layer === "undefined") { layer = this.currentLayer; }
+ layer = this.getLayer(layer);
if (!this.layers[layer])
{
@@ -736,7 +1305,7 @@ Phaser.Tilemap.prototype = {
{
for (var tx = x; tx < x + width; tx++)
{
- this._results.push({ x: tx, y: ty, index: this.layers[layer].data[ty][tx] });
+ this._results.push(this.layers[layer].data[ty][tx]);
}
}
@@ -746,17 +1315,19 @@ Phaser.Tilemap.prototype = {
/**
* Pastes a previously copied block of tile data into the given x/y coordinates. Data should have been prepared with Tilemap.copy.
+ *
* @method Phaser.Tilemap#paste
* @param {number} x - X position of the top left of the area to paste to (given in tiles, not pixels)
* @param {number} y - Y position of the top left of the area to paste to (given in tiles, not pixels)
* @param {array} tileblock - The block of tiles to paste.
- * @param {number} layer - The Tilemap Layer to operate on.
+ * @param {number|string|Phaser.TilemapLayer} [layer] - The layer to paste the tiles into.
*/
paste: function (x, y, tileblock, layer) {
if (typeof x === "undefined") { x = 0; }
if (typeof y === "undefined") { y = 0; }
- if (typeof layer === "undefined") { layer = this.currentLayer; }
+
+ layer = this.getLayer(layer);
if (!tileblock || tileblock.length < 2)
{
@@ -769,15 +1340,17 @@ Phaser.Tilemap.prototype = {
for (var i = 1; i < tileblock.length; i++)
{
- this.layers[layer].data[ diffY + tileblock[i].y ][ diffX + tileblock[i].x ] = tileblock[i].index;
+ this.layers[layer].data[ diffY + tileblock[i].y ][ diffX + tileblock[i].x ].copy(tileblock[i]);
}
- this.dirty = true;
+ this.layers[layer].dirty = true;
+ this.calculateFaces(layer);
},
/**
- * Swap tiles with 2 kinds of indexes.
+ * Scans the given area for tiles with an index matching tileA and swaps them with tileB.
+ *
* @method Phaser.Tilemap#swapTile
* @param {number} tileA - First tile index.
* @param {number} tileB - Second tile index.
@@ -785,9 +1358,12 @@ Phaser.Tilemap.prototype = {
* @param {number} y - Y position of the top left of the area to operate one, given in tiles, not pixels.
* @param {number} width - The width in tiles of the area to operate on.
* @param {number} height - The height in tiles of the area to operate on.
+ * @param {number|string|Phaser.TilemapLayer} [layer] - The layer to operate on.
*/
swap: function (tileA, tileB, x, y, width, height, layer) {
+ layer = this.getLayer(layer);
+
this.copy(x, y, width, height, layer);
if (this._results.length < 2)
@@ -800,13 +1376,15 @@ Phaser.Tilemap.prototype = {
this._results.forEach(this.swapHandler, this);
- this.paste(x, y, this._results);
+ this.paste(x, y, this._results, layer);
},
/**
* Internal function that handles the swapping of tiles.
+ *
* @method Phaser.Tilemap#swapHandler
+ * @private
* @param {number} value
* @param {number} index
*/
@@ -824,7 +1402,8 @@ Phaser.Tilemap.prototype = {
},
/**
- * For each tile in the given area (defined by x/y and width/height) run the given callback.
+ * For each tile in the given area defined by x/y and width/height run the given callback.
+ *
* @method Phaser.Tilemap#forEach
* @param {number} callback - The callback. Each tile in the given area will be passed to this callback as the first and only parameter.
* @param {number} context - The context under which the callback should be run.
@@ -832,10 +1411,12 @@ Phaser.Tilemap.prototype = {
* @param {number} y - Y position of the top left of the area to operate one, given in tiles, not pixels.
* @param {number} width - The width in tiles of the area to operate on.
* @param {number} height - The height in tiles of the area to operate on.
- * @param {number} [layer] - The Tilemap Layer to operate on.
+ * @param {number|string|Phaser.TilemapLayer} [layer] - The layer to operate on.
*/
forEach: function (callback, context, x, y, width, height, layer) {
+ layer = this.getLayer(layer);
+
this.copy(x, y, width, height, layer);
if (this._results.length < 2)
@@ -845,22 +1426,25 @@ Phaser.Tilemap.prototype = {
this._results.forEach(callback, context);
- this.paste(x, y, this._results);
+ this.paste(x, y, this._results, layer);
},
/**
- * Replaces one type of tile with another in the given area (defined by x/y and width/height).
+ * Scans the given area for tiles with an index matching `source` and updates their index to match `dest`.
+ *
* @method Phaser.Tilemap#replace
- * @param {number} tileA - First tile index.
- * @param {number} tileB - Second tile index.
+ * @param {number} source - The tile index value to scan for.
+ * @param {number} dest - The tile index value to replace found tiles with.
* @param {number} x - X position of the top left of the area to operate one, given in tiles, not pixels.
* @param {number} y - Y position of the top left of the area to operate one, given in tiles, not pixels.
* @param {number} width - The width in tiles of the area to operate on.
* @param {number} height - The height in tiles of the area to operate on.
- * @param {number} [layer] - The Tilemap Layer to operate on.
+ * @param {number|string|Phaser.TilemapLayer} [layer] - The layer to operate on.
*/
- replace: function (tileA, tileB, x, y, width, height, layer) {
+ replace: function (source, dest, x, y, width, height, layer) {
+
+ layer = this.getLayer(layer);
this.copy(x, y, width, height, layer);
@@ -871,30 +1455,29 @@ Phaser.Tilemap.prototype = {
for (var i = 1; i < this._results.length; i++)
{
- if (this._results[i].index === tileA)
+ if (this._results[i].index === source)
{
- this._results[i].index = tileB;
+ this._results[i].index = dest;
}
}
- this.paste(x, y, this._results);
+ this.paste(x, y, this._results, layer);
},
/**
* Randomises a set of tiles in a given area.
+ *
* @method Phaser.Tilemap#random
- * @param {number} tileA - First tile index.
- * @param {number} tileB - Second tile index.
* @param {number} x - X position of the top left of the area to operate one, given in tiles, not pixels.
* @param {number} y - Y position of the top left of the area to operate one, given in tiles, not pixels.
* @param {number} width - The width in tiles of the area to operate on.
* @param {number} height - The height in tiles of the area to operate on.
- * @param {number} [layer] - The Tilemap Layer to operate on.
+ * @param {number|string|Phaser.TilemapLayer} [layer] - The layer to operate on.
*/
random: function (x, y, width, height, layer) {
- if (typeof layer === "undefined") { layer = this.currentLayer; }
+ layer = this.getLayer(layer);
this.copy(x, y, width, height, layer);
@@ -907,11 +1490,14 @@ Phaser.Tilemap.prototype = {
for (var t = 1; t < this._results.length; t++)
{
- var idx = this._results[t].index;
-
- if (indexes.indexOf(idx) === -1)
+ if (this._results[t].index)
{
- indexes.push(idx);
+ var idx = this._results[t].index;
+
+ if (indexes.indexOf(idx) === -1)
+ {
+ indexes.push(idx);
+ }
}
}
@@ -920,24 +1506,23 @@ Phaser.Tilemap.prototype = {
this._results[i].index = this.game.rnd.pick(indexes);
}
- this.paste(x, y, this._results);
+ this.paste(x, y, this._results, layer);
},
/**
* Shuffles a set of tiles in a given area. It will only randomise the tiles in that area, so if they're all the same nothing will appear to have changed!
+ *
* @method Phaser.Tilemap#shuffle
- * @param {number} tileA - First tile index.
- * @param {number} tileB - Second tile index.
* @param {number} x - X position of the top left of the area to operate one, given in tiles, not pixels.
* @param {number} y - Y position of the top left of the area to operate one, given in tiles, not pixels.
* @param {number} width - The width in tiles of the area to operate on.
* @param {number} height - The height in tiles of the area to operate on.
- * @param {number} [layer] - The Tilemap Layer to operate on.
+ * @param {number|string|Phaser.TilemapLayer} [layer] - The layer to operate on.
*/
shuffle: function (x, y, width, height, layer) {
- if (typeof layer === "undefined") { layer = this.currentLayer; }
+ layer = this.getLayer(layer);
this.copy(x, y, width, height, layer);
@@ -946,28 +1531,42 @@ Phaser.Tilemap.prototype = {
return;
}
- var header = this._results.shift();
+ var indexes = [];
- Phaser.Utils.shuffle(this._results);
+ for (var t = 1; t < this._results.length; t++)
+ {
+ if (this._results[t].index)
+ {
+ indexes.push(this._results[t].index);
+ }
+ }
- this._results.unshift(header);
+ Phaser.Utils.shuffle(indexes);
- this.paste(x, y, this._results);
+ for (var i = 1; i < this._results.length; i++)
+ {
+ this._results[i].index = indexes[i - 1];
+ }
+
+ this.paste(x, y, this._results, layer);
},
/**
- * Fill a block with a specific tile index.
+ * Fills the given area with the specified tile.
+ *
* @method Phaser.Tilemap#fill
- * @param {number} index - Index of tiles you want to fill with.
+ * @param {number} index - The index of the tile that the area will be filled with.
* @param {number} x - X position of the top left of the area to operate one, given in tiles, not pixels.
* @param {number} y - Y position of the top left of the area to operate one, given in tiles, not pixels.
* @param {number} width - The width in tiles of the area to operate on.
* @param {number} height - The height in tiles of the area to operate on.
- * @param {number} [layer] - The Tilemap Layer to operate on.
+ * @param {number|string|Phaser.TilemapLayer} [layer] - The layer to operate on.
*/
fill: function (index, x, y, width, height, layer) {
+ layer = this.getLayer(layer);
+
this.copy(x, y, width, height, layer);
if (this._results.length < 2)
@@ -980,12 +1579,13 @@ Phaser.Tilemap.prototype = {
this._results[i].index = index;
}
- this.paste(x, y, this._results);
+ this.paste(x, y, this._results, layer);
},
/**
* Removes all layers from this tile map.
+ *
* @method Phaser.Tilemap#removeAllLayers
*/
removeAllLayers: function () {
@@ -997,6 +1597,7 @@ Phaser.Tilemap.prototype = {
/**
* Dumps the tilemap data out to the console.
+ *
* @method Phaser.Tilemap#dump
*/
dump: function () {
@@ -1037,16 +1638,20 @@ Phaser.Tilemap.prototype = {
/**
* Removes all layers from this tile map and nulls the game reference.
+ *
* @method Phaser.Tilemap#destroy
*/
destroy: function () {
this.removeAllLayers();
+ this.data = [];
this.game = null;
}
};
+
+Phaser.Tilemap.prototype.constructor = Phaser.Tilemap;
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/TilemapLayer.js.html b/docs/TilemapLayer.js.html index 88cf9a57..e92aa009 100644 --- a/docs/TilemapLayer.js.html +++ b/docs/TilemapLayer.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -433,25 +427,37 @@
* @class Phaser.TilemapLayer
* @constructor
* @param {Phaser.Game} game - Game reference to the currently running game.
-* @param {number} x - The x coordinate of this layer.
-* @param {number} y - The y coordinate of this layer.
-* @param {number} renderWidth - Width of the layer.
-* @param {number} renderHeight - Height of the layer.
-* @param {Phaser.Tileset|string} tileset - The tile set used for rendering.
* @param {Phaser.Tilemap} tilemap - The tilemap to which this layer belongs.
-* @param {number} layer - The layer index within the map.
+* @param {number} index - The layer index within the map that this TilemapLayer represents.
+* @param {number} width - Width of the renderable area of the layer.
+* @param {number} height - Height of the renderable area of the layer.
*/
-Phaser.TilemapLayer = function (game, x, y, renderWidth, renderHeight, tileset, tilemap, layer) {
+Phaser.TilemapLayer = function (game, tilemap, index, width, height) {
/**
* @property {Phaser.Game} game - A reference to the currently running Game.
*/
this.game = game;
-
+
/**
- * @property {HTMLCanvasElement} canvas - The canvas to which this BitmapData draws.
+ * @property {Phaser.Tilemap} map - The Tilemap to which this layer is bound.
*/
- this.canvas = Phaser.Canvas.create(renderWidth, renderHeight);
+ this.map = tilemap;
+
+ /**
+ * @property {number} index - The index of this layer within the Tilemap.
+ */
+ this.index = index;
+
+ /**
+ * @property {object} layer - The layer object within the Tilemap that this layer represents.
+ */
+ this.layer = tilemap.layers[index];
+
+ /**
+ * @property {HTMLCanvasElement} canvas - The canvas to which this TilemapLayer draws.
+ */
+ this.canvas = Phaser.Canvas.create(width, height);
/**
* @property {CanvasRenderingContext2D} context - The 2d context of the canvas.
@@ -471,9 +477,14 @@ Phaser.TilemapLayer = function (game, x, y, renderWidth, renderHeight, tileset,
/**
* @property {Phaser.Frame} textureFrame - Dimensions of the renderable area.
*/
- this.textureFrame = new Phaser.Frame(0, 0, 0, renderWidth, renderHeight, 'tilemaplayer', game.rnd.uuid());
+ this.textureFrame = new Phaser.Frame(0, 0, 0, width, height, 'tilemapLayer', game.rnd.uuid());
- Phaser.Sprite.call(this, this.game, x, y, this.texture, this.textureFrame);
+ Phaser.Sprite.call(this, this.game, 0, 0, this.texture, this.textureFrame);
+
+ /**
+ * @property {string} name - The name of the layer.
+ */
+ this.name = '';
/**
* @property {number} type - The const type of this object.
@@ -482,58 +493,91 @@ Phaser.TilemapLayer = function (game, x, y, renderWidth, renderHeight, tileset,
this.type = Phaser.TILEMAPLAYER;
/**
- * A layer that is fixed to the camera ignores the position of any ancestors in the display list and uses its x/y coordinates as offsets from the top left of the camera.
- * @property {boolean} fixedToCamera - Fixes this layer to the Camera.
+ * An object that is fixed to the camera ignores the position of any ancestors in the display list and uses its x/y coordinates as offsets from the top left of the camera.
+ * @property {boolean} fixedToCamera - Fixes this object to the Camera.
* @default
*/
this.fixedToCamera = true;
/**
- * @property {Phaser.Tileset} tileset - The tile set used for rendering.
+ * @property {Phaser.Point} cameraOffset - If this object is fixed to the camera then use this Point to specify how far away from the Camera x/y it's rendered.
*/
- this.tileset = null;
+ this.cameraOffset = new Phaser.Point(0, 0);
/**
- * @property {number} tileWidth - The width of a single tile in pixels.
+ * @property {string} tileColor - If no tileset is given the tiles will be rendered as rectangles in this color. Provide in hex or rgb/rgba string format.
+ * @default
*/
- this.tileWidth = 0;
+ this.tileColor = 'rgb(255, 255, 255)';
/**
- * @property {number} tileHeight - The height of a single tile in pixels.
+ * @property {boolean} debug - If set to true the collideable tile edges path will be rendered. Only works when game is running in Phaser.CANVAS mode.
+ * @default
*/
- this.tileHeight = 0;
+ this.debug = false;
/**
- * @property {number} tileMargin - The margin around the tiles.
+ * @property {number} debugAlpha - If debug is true then the tileset is rendered with this alpha level, to make the tile edges clearer.
+ * @default
*/
- this.tileMargin = 0;
+ this.debugAlpha = 0.5;
/**
- * @property {number} tileSpacing - The spacing around the tiles.
+ * @property {string} debugColor - If debug is true this is the color used to outline the edges of collidable tiles. Provide in hex or rgb/rgba string format.
+ * @default
*/
- this.tileSpacing = 0;
+ this.debugColor = 'rgba(0, 255, 0, 1)';
/**
- * @property {number} widthInPixels - Do NOT recommend changing after the map is loaded!
- * @readonly
+ * @property {boolean} debugFill - If true the debug tiles are filled with debugFillColor AND stroked around.
+ * @default
*/
- this.widthInPixels = 0;
+ this.debugFill = false;
/**
- * @property {number} heightInPixels - Do NOT recommend changing after the map is loaded!
- * @readonly
+ * @property {string} debugFillColor - If debugFill is true this is the color used to fill the tiles. Provide in hex or rgb/rgba string format.
+ * @default
*/
- this.heightInPixels = 0;
+ this.debugFillColor = 'rgba(0, 255, 0, 0.2)';
/**
- * @property {number} renderWidth - The width of the area being rendered.
+ * @property {string} debugCallbackColor - If debug is true this is the color used to outline the edges of tiles that have collision callbacks. Provide in hex or rgb/rgba string format.
+ * @default
*/
- this.renderWidth = renderWidth;
+ this.debugCallbackColor = 'rgba(255, 0, 0, 1)';
/**
- * @property {number} renderHeight - The height of the area being rendered.
+ * @property {number} scrollFactorX - speed at which this layer scrolls
+ * horizontally, relative to the camera (e.g. scrollFactorX of 0.5 scrolls
+ * half as quickly as the 'normal' camera-locked layers do)
+ * @default 1
*/
- this.renderHeight = renderHeight;
+ this.scrollFactorX = 1;
+
+ /**
+ * @property {number} scrollFactorY - speed at which this layer scrolls
+ * vertically, relative to the camera (e.g. scrollFactorY of 0.5 scrolls
+ * half as quickly as the 'normal' camera-locked layers do)
+ * @default 1
+ */
+ this.scrollFactorY = 1;
+
+ /**
+ * @property {boolean} dirty - Flag controlling when to re-render the layer.
+ */
+ this.dirty = true;
+
+ /**
+ * @property {number} _cw - Local collision var.
+ * @private
+ */
+ this._cw = tilemap.tileWidth;
+
+ /**
+ * @property {number} _ch - Local collision var.
+ * @private
+ */
+ this._ch = tilemap.tileHeight;
/**
* @property {number} _ga - Local render loop var to help avoid gc spikes.
@@ -649,51 +693,7 @@ Phaser.TilemapLayer = function (game, x, y, renderWidth, renderHeight, tileset,
*/
this._prevY = 0;
- /**
- * @property {number} scrollFactorX - speed at which this layer scrolls
- * horizontally, relative to the camera (e.g. scrollFactorX of 0.5 scrolls
- * half as quickly as the 'normal' camera-locked layers do)
- * @default 1
- */
- this.scrollFactorX = 1;
-
- /**
- * @property {number} scrollFactorY - speed at which this layer scrolls
- * vertically, relative to the camera (e.g. scrollFactorY of 0.5 scrolls
- * half as quickly as the 'normal' camera-locked layers do)
- * @default 1
- */
- this.scrollFactorY = 1;
-
- /**
- * @property {Phaser.Tilemap} tilemap - The Tilemap to which this layer is bound.
- */
- this.tilemap = null;
-
- /**
- * @property {number} layer - Tilemap layer index.
- */
- this.layer = null;
-
- /**
- * @property {number} index
- */
- this.index = 0;
-
- /**
- * @property {boolean} dirty - Flag controlling when to re-render the layer.
- */
- this.dirty = true;
-
- if (tileset instanceof Phaser.Tileset || typeof tileset === 'string')
- {
- this.updateTileset(tileset);
- }
-
- if (tilemap instanceof Phaser.Tilemap)
- {
- this.updateMapData(tilemap, layer);
- }
+ this.updateMax();
};
@@ -702,13 +702,16 @@ Phaser.TilemapLayer.prototype = Phaser.Utils.extend(true, Phaser.TilemapLayer.pr
Phaser.TilemapLayer.prototype.constructor = Phaser.TilemapLayer;
/**
-* Automatically called by World.preUpdate. Handles cache updates.
+* Automatically called by World.postUpdate. Handles cache updates.
*
-* @method Phaser.TilemapLayer#update
+* @method Phaser.TilemapLayer#postUpdate
* @memberof Phaser.TilemapLayer
*/
-Phaser.TilemapLayer.prototype.update = function () {
+Phaser.TilemapLayer.prototype.postUpdate = function () {
+ Phaser.Sprite.prototype.postUpdate.call(this);
+
+ // Stops you being able to auto-scroll the camera if it's not following a sprite
this.scrollX = this.game.camera.x * this.scrollFactorX;
this.scrollY = this.game.camera.y * this.scrollFactorY;
@@ -724,69 +727,12 @@ Phaser.TilemapLayer.prototype.update = function () {
*/
Phaser.TilemapLayer.prototype.resizeWorld = function () {
- this.game.world.setBounds(0, 0, this.widthInPixels, this.heightInPixels);
+ this.game.world.setBounds(0, 0, this.layer.widthInPixels, this.layer.heightInPixels);
}
/**
-* Updates the Tileset data.
-*
-* @method Phaser.TilemapLayer#updateTileset
-* @memberof Phaser.TilemapLayer
-* @param {Phaser.Tileset|string} tileset - The tileset to use for this layer.
-*/
-Phaser.TilemapLayer.prototype.updateTileset = function (tileset) {
-
- if (tileset instanceof Phaser.Tileset)
- {
- this.tileset = tileset;
- }
- else if (typeof tileset === 'string')
- {
- this.tileset = this.game.cache.getTileset('tiles');
- }
- else
- {
- return;
- }
-
- this.tileWidth = this.tileset.tileWidth;
- this.tileHeight = this.tileset.tileHeight;
- this.tileMargin = this.tileset.tileMargin;
- this.tileSpacing = this.tileset.tileSpacing;
-
- this.updateMax();
-
-}
-
-/**
-* Updates the Tilemap data.
-*
-* @method Phaser.TilemapLayer#updateMapData
-* @memberof Phaser.TilemapLayer
-* @param {Phaser.Tilemap} tilemap - The tilemap to which this layer belongs.
-* @param {number} layer - The layer index within the map.
-*/
-Phaser.TilemapLayer.prototype.updateMapData = function (tilemap, layer) {
-
- if (typeof layer === 'undefined')
- {
- layer = 0;
- }
-
- if (tilemap instanceof Phaser.Tilemap)
- {
- this.tilemap = tilemap;
- this.layer = this.tilemap.layers[layer];
- this.index = layer;
- this.updateMax();
- this.tilemap.dirty = true;
- }
-
-}
-
-/**
-* Take an x coordinate that doesn't account for scrollFactorY and 'fix' it
+* Take an x coordinate that doesn't account for scrollFactorX and 'fix' it
* into a scrolled local space. Used primarily internally
* @method Phaser.TilemapLayer#_fixX
* @memberof Phaser.TilemapLayer
@@ -796,19 +742,22 @@ Phaser.TilemapLayer.prototype.updateMapData = function (tilemap, layer) {
*/
Phaser.TilemapLayer.prototype._fixX = function(x) {
+ if (x < 0)
+ {
+ x = 0;
+ }
+
if (this.scrollFactorX === 1)
{
return x;
}
- var leftEdge = x - (this._x / this.scrollFactorX);
-
- return this._x + leftEdge;
+ return this._x + (x - (this._x / this.scrollFactorX));
}
/**
-* Take an x coordinate that _does_ account for scrollFactorY and 'unfix' it
+* Take an x coordinate that _does_ account for scrollFactorX and 'unfix' it
* back to camera space. Used primarily internally
* @method Phaser.TilemapLayer#_unfixX
* @memberof Phaser.TilemapLayer
@@ -823,9 +772,7 @@ Phaser.TilemapLayer.prototype._unfixX = function(x) {
return x;
}
- var leftEdge = x - this._x;
-
- return (this._x / this.scrollFactorX) + leftEdge;
+ return (this._x / this.scrollFactorX) + (x - this._x);
}
@@ -840,14 +787,17 @@ Phaser.TilemapLayer.prototype._unfixX = function(x) {
*/
Phaser.TilemapLayer.prototype._fixY = function(y) {
+ if (y < 0)
+ {
+ y = 0;
+ }
+
if (this.scrollFactorY === 1)
{
return y;
}
- var topEdge = y - (this._y / this.scrollFactorY);
-
- return this._y + topEdge;
+ return this._y + (y - (this._y / this.scrollFactorY));
}
@@ -867,9 +817,7 @@ Phaser.TilemapLayer.prototype._unfixY = function(y) {
return y;
}
- var topEdge = y - this._y;
-
- return (this._y / this.scrollFactorY) + topEdge;
+ return (this._y / this.scrollFactorY) + (y - this._y);
}
@@ -882,9 +830,9 @@ Phaser.TilemapLayer.prototype._unfixY = function(y) {
*/
Phaser.TilemapLayer.prototype.getTileX = function (x) {
- var tileWidth = this.tileWidth * this.scale.x;
+ // var tileWidth = this.tileWidth * this.scale.x;
- return this.game.math.snapToFloor(this._fixX(x), tileWidth) / tileWidth;
+ return this.game.math.snapToFloor(this._fixX(x), this.map.tileWidth) / this.map.tileWidth;
}
@@ -897,9 +845,9 @@ Phaser.TilemapLayer.prototype.getTileX = function (x) {
*/
Phaser.TilemapLayer.prototype.getTileY = function (y) {
- var tileHeight = this.tileHeight * this.scale.y;
+ // var tileHeight = this.tileHeight * this.scale.y;
- return this.game.math.snapToFloor(this._fixY(y), tileHeight) / tileHeight;
+ return this.game.math.snapToFloor(this._fixY(y), this.map.tileHeight) / this.map.tileHeight;
}
@@ -909,7 +857,8 @@ Phaser.TilemapLayer.prototype.getTileY = function (y) {
* @memberof Phaser.TilemapLayer
* @param {number} x - X position of the point in target tile.
* @param {number} y - Y position of the point in target tile.
-* @return {Phaser.Tile} The tile with specific properties.
+* @param {Phaser.Point|object} point - The Point object to set the x and y values on.
+* @return {Phaser.Point|object} A Point object with its x and y properties set.
*/
Phaser.TilemapLayer.prototype.getTileXY = function (x, y, point) {
@@ -921,73 +870,43 @@ Phaser.TilemapLayer.prototype.getTileXY = function (x, y, point) {
}
/**
-* Get the tiles within the given area.
+* Get all tiles that exist within the given area, defined by the top-left corner, width and height. Values given are in pixels, not tiles.
* @method Phaser.TilemapLayer#getTiles
* @memberof Phaser.TilemapLayer
-* @param {number} x - X position of the top left of the area to copy (given in tiles, not pixels)
-* @param {number} y - Y position of the top left of the area to copy (given in tiles, not pixels)
-* @param {number} width - The width of the area to copy (given in tiles, not pixels)
-* @param {number} height - The height of the area to copy (given in tiles, not pixels)
-* @param {boolean} collides - If true only return tiles that collide on one or more faces.
+* @param {number} x - X position of the top left corner.
+* @param {number} y - Y position of the top left corner.
+* @param {number} width - Width of the area to get.
+* @param {number} height - Height of the area to get.
+* @param {boolean} [collides=false] - If true only return tiles that collide on one or more faces.
* @return {array} Array with tiles informations (each contains x, y, and the tile).
*/
Phaser.TilemapLayer.prototype.getTiles = function (x, y, width, height, collides) {
- if (this.tilemap === null)
- {
- return;
- }
-
// Should we only get tiles that have at least one of their collision flags set? (true = yes, false = no just get them all)
if (typeof collides === 'undefined') { collides = false; }
- // Cap the values
-
- if (x < 0)
- {
- x = 0;
- }
-
- if (y < 0)
- {
- y = 0;
- }
-
// adjust the x,y coordinates for scrollFactor
- x = this._fixX( x );
- y = this._fixY( y );
+ x = this._fixX(x);
+ y = this._fixY(y);
- if (width > this.widthInPixels)
+ if (width > this.layer.widthInPixels)
{
- width = this.widthInPixels;
+ width = this.layer.widthInPixels;
}
- if (height > this.heightInPixels)
+ if (height > this.layer.heightInPixels)
{
- height = this.heightInPixels;
+ height = this.layer.heightInPixels;
}
- var tileWidth = this.tileWidth * this.scale.x;
- var tileHeight = this.tileHeight * this.scale.y;
-
// Convert the pixel values into tile coordinates
- this._tx = this.game.math.snapToFloor(x, tileWidth) / tileWidth;
- this._ty = this.game.math.snapToFloor(y, tileHeight) / tileHeight;
- this._tw = (this.game.math.snapToCeil(width, tileWidth) + tileWidth) / tileWidth;
- this._th = (this.game.math.snapToCeil(height, tileHeight) + tileHeight) / tileHeight;
+ this._tx = this.game.math.snapToFloor(x, this._cw) / this._cw;
+ this._ty = this.game.math.snapToFloor(y, this._ch) / this._ch;
+ this._tw = (this.game.math.snapToCeil(width, this._cw) + this._cw) / this._cw;
+ this._th = (this.game.math.snapToCeil(height, this._ch) + this._ch) / this._ch;
// This should apply the layer x/y here
-
- // this._results.length = 0;
- this._results = [];
-
- // pretty sure we don't use this any more?
- // this._results.push( { x: x, y: y, width: width, height: height, tx: this._tx, ty: this._ty, tw: this._tw, th: this._th });
-
- var _index = 0;
- var _tile = null;
- var sx = 0;
- var sy = 0;
+ this._results.length = 0;
for (var wy = this._ty; wy < this._ty + this._th; wy++)
{
@@ -995,19 +914,20 @@ Phaser.TilemapLayer.prototype.getTiles = function (x, y, width, height, collides
{
if (this.layer.data[wy] && this.layer.data[wy][wx])
{
- // Could combine
- _index = this.layer.data[wy][wx] - 1;
- _tile = this.tileset.getTile(_index);
-
- sx = _tile.width * this.scale.x;
- sy = _tile.height * this.scale.y;
-
- if (collides === false || (collides && _tile.collideNone === false))
+ if (collides === false || (collides && this.layer.data[wy][wx].canCollide))
{
- // convert tile coordinates back to camera space for return
- var _wx = this._unfixX( wx*sx ) / tileWidth;
- var _wy = this._unfixY( wy*sy ) / tileHeight;
- this._results.push({ x: _wx * sx, right: (_wx * sx) + sx, y: _wy * sy, bottom: (_wy * sy) + sy, width: sx, height: sy, tx: _wx, ty: _wy, tile: _tile });
+ // Convert tile coordinates back to camera space for return
+ var _wx = this._unfixX(wx * this._cw) / this._cw;
+ var _wy = this._unfixY(wy * this._ch) / this._ch;
+
+ this._results.push({
+ x: _wx * this._cw,
+ y: _wy * this._ch,
+ right: (_wx * this._cw) + this._cw,
+ bottom: (_wy * this._ch) + this._ch,
+ tile: this.layer.data[wy][wx],
+ layer: this.layer.data[wy][wx].layer
+ });
}
}
}
@@ -1024,8 +944,8 @@ Phaser.TilemapLayer.prototype.getTiles = function (x, y, width, height, collides
*/
Phaser.TilemapLayer.prototype.updateMax = function () {
- this._maxX = this.game.math.ceil(this.canvas.width / this.tileWidth) + 1;
- this._maxY = this.game.math.ceil(this.canvas.height / this.tileHeight) + 1;
+ this._maxX = this.game.math.ceil(this.canvas.width / this.map.tileWidth) + 1;
+ this._maxY = this.game.math.ceil(this.canvas.height / this.map.tileHeight) + 1;
if (this.layer)
{
@@ -1038,9 +958,6 @@ Phaser.TilemapLayer.prototype.updateMax = function () {
{
this._maxY = this.layer.height;
}
-
- this.widthInPixels = this.layer.width * this.tileWidth;
- this.heightInPixels = this.layer.height * this.tileHeight;
}
this.dirty = true;
@@ -1054,12 +971,12 @@ Phaser.TilemapLayer.prototype.updateMax = function () {
*/
Phaser.TilemapLayer.prototype.render = function () {
- if (this.tilemap && this.tilemap.dirty)
+ if (this.layer.dirty)
{
this.dirty = true;
}
- if (!this.dirty || !this.tileset || !this.tilemap || !this.visible)
+ if (!this.dirty || !this.visible)
{
return;
}
@@ -1067,101 +984,194 @@ Phaser.TilemapLayer.prototype.render = function () {
this._prevX = this._dx;
this._prevY = this._dy;
- this._dx = -(this._x - (this._startX * this.tileWidth));
- this._dy = -(this._y - (this._startY * this.tileHeight));
+ this._dx = -(this._x - (this._startX * this.map.tileWidth));
+ this._dy = -(this._y - (this._startY * this.map.tileHeight));
this._tx = this._dx;
this._ty = this._dy;
this.context.clearRect(0, 0, this.canvas.width, this.canvas.height);
- for (var y = this._startY; y < this._startY + this._maxY; y++)
+ this.context.fillStyle = this.tileColor;
+
+ var tile;
+ var set;
+ var ox = 0;
+ var oy = 0;
+
+ if (this.debug)
+ {
+ this.context.globalAlpha = this.debugAlpha;
+ }
+
+ for (var y = this._startY, lenY = this._startY + this._maxY; y < lenY; y++)
{
this._column = this.layer.data[y];
- for (var x = this._startX; x < this._startX + this._maxX; x++)
+ for (var x = this._startX, lenX = this._startX + this._maxX; x < lenX; x++)
{
- // only -1 on TILED maps, not CSV
- var tile = this.tileset.tiles[this._column[x]-1];
-
- if (tile)
+ if (this._column[x])
{
- this.context.drawImage(
- this.tileset.image,
- tile.x,
- tile.y,
- this.tileWidth,
- this.tileHeight,
- Math.floor(this._tx),
- Math.floor(this._ty),
- this.tileWidth,
- this.tileHeight
- );
+ tile = this._column[x];
+
+ if (this.map.tiles[tile.index])
+ {
+ set = this.map.tilesets[this.map.tiles[tile.index][2]]
+
+ if (set.image)
+ {
+ if (this.debug === false && tile.alpha !== this.context.globalAlpha)
+ {
+ this.context.globalAlpha = tile.alpha;
+ }
+
+ if (set.tileWidth !== this.map.tileWidth || set.tileHeight !== this.map.tileHeight)
+ {
+ // TODO: Smaller sized tile check
+ this.context.drawImage(
+ this.map.tilesets[this.map.tiles[tile.index][2]].image,
+ this.map.tiles[tile.index][0],
+ this.map.tiles[tile.index][1],
+ set.tileWidth,
+ set.tileHeight,
+ Math.floor(this._tx),
+ Math.floor(this._ty) - (set.tileHeight - this.map.tileHeight),
+ set.tileWidth,
+ set.tileHeight
+ );
+ }
+ else
+ {
+ this.context.drawImage(
+ this.map.tilesets[this.map.tiles[tile.index][2]].image,
+ this.map.tiles[tile.index][0],
+ this.map.tiles[tile.index][1],
+ this.map.tileWidth,
+ this.map.tileHeight,
+ Math.floor(this._tx),
+ Math.floor(this._ty),
+ this.map.tileWidth,
+ this.map.tileHeight
+ );
+ }
+
+ if (tile.debug)
+ {
+ this.context.fillStyle = 'rgba(0, 255, 0, 0.4)';
+ this.context.fillRect(Math.floor(this._tx), Math.floor(this._ty), this.map.tileWidth, this.map.tileHeight);
+ }
+ }
+ else
+ {
+ this.context.fillRect(Math.floor(this._tx), Math.floor(this._ty), this.map.tileWidth, this.map.tileHeight);
+ }
+ }
}
- this._tx += this.tileWidth;
+ this._tx += this.map.tileWidth;
}
this._tx = this._dx;
- this._ty += this.tileHeight;
+ this._ty += this.map.tileHeight;
+
+ }
+
+ if (this.debug)
+ {
+ this.context.globalAlpha = 1;
+ this.renderDebug();
}
// Only needed if running in WebGL, otherwise this array will never get cleared down I don't think!
- if (this.game.renderType == Phaser.WEBGL)
+ if (this.game.renderType === Phaser.WEBGL)
{
PIXI.texturesToUpdate.push(this.baseTexture);
}
this.dirty = false;
-
- if (this.tilemap.dirty)
- {
- this.tilemap.dirty = false;
- }
+ this.layer.dirty = false;
return true;
}
/**
-* Returns the absolute delta x value.
-* @method Phaser.TilemapLayer#deltaAbsX
+* Renders a collision debug overlay on-top of the canvas. Called automatically by render when debug = true.
+* @method Phaser.TilemapLayer#renderDebug
* @memberof Phaser.TilemapLayer
-* @return {number} Absolute delta X value
*/
-Phaser.TilemapLayer.prototype.deltaAbsX = function () {
- return (this.deltaX() > 0 ? this.deltaX() : -this.deltaX());
-}
+Phaser.TilemapLayer.prototype.renderDebug = function () {
-/**
-* Returns the absolute delta y value.
-* @method Phaser.TilemapLayer#deltaAbsY
-* @memberof Phaser.TilemapLayer
-* @return {number} Absolute delta Y value
-*/
-Phaser.TilemapLayer.prototype.deltaAbsY = function () {
- return (this.deltaY() > 0 ? this.deltaY() : -this.deltaY());
-}
+ this._tx = this._dx;
+ this._ty = this._dy;
-/**
-* Returns the delta x value.
-* @method Phaser.TilemapLayer#deltaX
-* @memberof Phaser.TilemapLayer
-* @return {number} Delta X value
-*/
-Phaser.TilemapLayer.prototype.deltaX = function () {
- return this._dx - this._prevX;
-}
+ this.context.strokeStyle = this.debugColor;
+ this.context.fillStyle = this.debugFillColor;
+
+ for (var y = this._startY, lenY = this._startY + this._maxY; y < lenY; y++)
+ {
+ this._column = this.layer.data[y];
+
+ for (var x = this._startX, lenX = this._startX + this._maxX; x < lenX; x++)
+ {
+ var tile = this._column[x];
+
+ if (tile && (tile.faceTop || tile.faceBottom || tile.faceLeft || tile.faceRight))
+ {
+ this._tx = Math.floor(this._tx);
+
+ if (this.debugFill)
+ {
+ this.context.fillRect(this._tx, this._ty, this._cw, this._ch);
+ }
+
+ this.context.beginPath();
+
+ if (tile.faceTop)
+ {
+ this.context.moveTo(this._tx, this._ty);
+ this.context.lineTo(this._tx + this._cw, this._ty);
+ }
+
+ if (tile.faceBottom)
+ {
+ this.context.moveTo(this._tx, this._ty + this._ch);
+ this.context.lineTo(this._tx + this._cw, this._ty + this._ch);
+ }
+
+ if (tile.faceLeft)
+ {
+ this.context.moveTo(this._tx, this._ty);
+ this.context.lineTo(this._tx, this._ty + this._ch);
+ }
+
+ if (tile.faceRight)
+ {
+ this.context.moveTo(this._tx + this._cw, this._ty);
+ this.context.lineTo(this._tx + this._cw, this._ty + this._ch);
+ }
+
+ this.context.stroke();
+ }
+
+ // Collision callback
+ if (tile && (tile.collisionCallback || tile.layer.callbacks[tile.index]))
+ {
+ this.context.fillStyle = this.debugCallbackColor;
+ this.context.fillRect(this._tx, this._ty, this._cw, this._ch);
+ this.context.fillStyle = this.debugFillColor;
+ }
+
+ this._tx += this.map.tileWidth;
+
+ }
+
+ this._tx = this._dx;
+ this._ty += this.map.tileHeight;
+
+ }
-/**
-* Returns the delta y value.
-* @method Phaser.TilemapLayer#deltaY
-* @memberof Phaser.TilemapLayer
-* @return {number} Delta Y value
-*/
-Phaser.TilemapLayer.prototype.deltaY = function () {
- return this._dy - this._prevY;
}
/**
@@ -1176,16 +1186,17 @@ Object.defineProperty(Phaser.TilemapLayer.prototype, "scrollX", {
set: function (value) {
- if (value !== this._x && value >= 0 && this.layer)
+ // if (value !== this._x && value >= 0 && this.layer && this.layer.widthInPixels > this.width)
+ if (value !== this._x && value >= 0 && this.layer.widthInPixels > this.width)
{
this._x = value;
-
- if (this._x > (this.widthInPixels - this.renderWidth))
+
+ if (this._x > (this.layer.widthInPixels - this.width))
{
- this._x = this.widthInPixels - this.renderWidth;
+ this._x = this.layer.widthInPixels - this.width;
}
- this._startX = this.game.math.floor(this._x / this.tileWidth);
+ this._startX = this.game.math.floor(this._x / this.map.tileWidth);
if (this._startX < 0)
{
@@ -1216,16 +1227,17 @@ Object.defineProperty(Phaser.TilemapLayer.prototype, "scrollY", {
set: function (value) {
- if (value !== this._y && value >= 0 && this.layer)
+ // if (value !== this._y && value >= 0 && this.layer && this.heightInPixels > this.renderHeight)
+ if (value !== this._y && value >= 0 && this.layer.heightInPixels > this.height)
{
this._y = value;
- if (this._y > (this.heightInPixels - this.renderHeight))
+ if (this._y > (this.layer.heightInPixels - this.height))
{
- this._y = this.heightInPixels - this.renderHeight;
+ this._y = this.layer.heightInPixels - this.height;
}
- this._startY = this.game.math.floor(this._y / this.tileHeight);
+ this._startY = this.game.math.floor(this._y / this.map.tileHeight);
if (this._startY < 0)
{
@@ -1242,6 +1254,46 @@ Object.defineProperty(Phaser.TilemapLayer.prototype, "scrollY", {
}
+});
+
+/**
+* @name Phaser.TilemapLayer#collisionWidth
+* @property {number} collisionWidth - The width of the collision tiles.
+*/
+Object.defineProperty(Phaser.TilemapLayer.prototype, "collisionWidth", {
+
+ get: function () {
+ return this._cw;
+ },
+
+ set: function (value) {
+
+ this._cw = value;
+
+ this.dirty = true;
+
+ }
+
+});
+
+/**
+* @name Phaser.TilemapLayer#collisionHeight
+* @property {number} collisionHeight - The height of the collision tiles.
+*/
+Object.defineProperty(Phaser.TilemapLayer.prototype, "collisionHeight", {
+
+ get: function () {
+ return this._ch;
+ },
+
+ set: function (value) {
+
+ this._ch = value;
+
+ this.dirty = true;
+
+ }
+
});
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/TilemapParser.js.html b/docs/TilemapParser.js.html index c4f1ddb2..8bd6058b 100644 --- a/docs/TilemapParser.js.html +++ b/docs/TilemapParser.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -438,47 +432,45 @@ Phaser.TilemapParser = {
* Creates a Tileset object.
* @method Phaser.TilemapParser.tileset
* @param {Phaser.Game} game - Game reference to the currently running game.
- * @param {string} key
- * @param {number} tileWidth
- * @param {number} tileHeight
- * @param {number} tileMax
- * @param {number} tileMargin
- * @param {number} tileSpacing
+ * @param {string} key - The Cache key of this tileset.
+ * @param {number} tileWidth - Width of each single tile in pixels.
+ * @param {number} tileHeight - Height of each single tile in pixels.
+ * @param {number} [tileMargin=0] - If the tiles have been drawn with a margin, specify the amount here.
+ * @param {number} [tileSpacing=0] - If the tiles have been drawn with spacing between them, specify the amount here.
+ * @param {number} [rows=-1] - How many tiles are placed horizontally in each row? If -1 it will calculate rows by dividing the image width by tileWidth.
+ * @param {number} [columns=-1] - How many tiles are placed vertically in each column? If -1 it will calculate columns by dividing the image height by tileHeight.
+ * @param {number} [total=-1] - The maximum number of tiles to extract from the image. If -1 it will extract `rows * columns` worth. You can also set a value lower than the actual number of tiles.
* @return {Phaser.Tileset} Generated Tileset object.
*/
- tileset: function (game, key, tileWidth, tileHeight, tileMax, tileMargin, tileSpacing) {
+ tileset: function (game, key, tileWidth, tileHeight, tileMargin, tileSpacing, rows, columns, total) {
// How big is our image?
var img = game.cache.getTilesetImage(key);
- if (img == null)
+ if (img === null)
{
+ console.warn("Phaser.TilemapParser.tileSet: Invalid image key given");
return null;
}
var width = img.width;
var height = img.height;
- // If no tile width/height is given, try and figure it out (won't work if the tileset has margin/spacing)
- if (tileWidth <= 0)
+ if (rows === -1)
{
- tileWidth = Math.floor(-width / Math.min(-1, tileWidth));
+ rows = Math.round(width / tileWidth);
}
- if (tileHeight <= 0)
+ if (columns === -1)
{
- tileHeight = Math.floor(-height / Math.min(-1, tileHeight));
+ columns = Math.round(height / tileHeight);
}
- var row = Math.round(width / tileWidth);
- var column = Math.round(height / tileHeight);
- var total = row * column;
+ if (total === -1)
+ {
+ total = rows * columns;
+ }
- if (tileMax !== -1)
- {
- total = tileMax;
- }
-
// Zero or smaller than tile sizes?
if (width === 0 || height === 0 || width < tileWidth || height < tileHeight || total === 0)
{
@@ -486,26 +478,7 @@ Phaser.TilemapParser = {
return null;
}
- // Let's create some tiles
- var x = tileMargin;
- var y = tileMargin;
-
- var tileset = new Phaser.Tileset(img, key, tileWidth, tileHeight, tileMargin, tileSpacing);
-
- for (var i = 0; i < total; i++)
- {
- tileset.addTile(new Phaser.Tile(tileset, i, x, y, tileWidth, tileHeight));
-
- x += tileWidth + tileSpacing;
-
- if (x === width)
- {
- x = tileMargin;
- y += tileHeight + tileSpacing;
- }
- }
-
- return tileset;
+ return new Phaser.Tileset(img, key, tileWidth, tileHeight, tileMargin, tileSpacing, rows, columns, total);
},
@@ -513,19 +486,27 @@ Phaser.TilemapParser = {
* Parse tileset data from the cache and creates a Tileset object.
* @method Phaser.TilemapParser.parse
* @param {Phaser.Game} game - Game reference to the currently running game.
- * @param {object} data
- * @param {string} format
- * @return {Phaser.Tileset} Generated Tileset object.
+ * @param {string} key - The key of the tilemap in the Cache.
+ * @return {object} The parsed map object.
*/
- parse: function (game, data, format) {
+ parse: function (game, key) {
- if (format === Phaser.Tilemap.CSV)
+ var map = game.cache.getTilemapData(key);
+
+ if (map)
{
- return this.parseCSV(data);
+ if (map.format === Phaser.Tilemap.CSV)
+ {
+ return this.parseCSV(map.data);
+ }
+ else if (map.format === Phaser.Tilemap.TILED_JSON)
+ {
+ return this.parseTiledJSON(map.data);
+ }
}
- else if (format === Phaser.Tilemap.TILED_JSON)
+ else
{
- return this.parseTiledJSON(data);
+ return { layers: [], objects: [], images: [], tilesets: [] };
}
},
@@ -563,6 +544,8 @@ Phaser.TilemapParser = {
}
}
+ // Build collision map
+
return [{ name: 'csv', width: width, height: height, alpha: 1, visible: true, indexes: [], tileMargin: 0, tileSpacing: 0, data: output }];
},
@@ -570,66 +553,242 @@ Phaser.TilemapParser = {
/**
* Parses a Tiled JSON file into valid map data.
* @method Phaser.TilemapParser.parseJSON
- * @param {object} json- The Tiled JSON data.
- * @return {object} Generated map data.
+ * @param {object} json - The JSON map data.
+ * @return {object} Generated and parsed map data.
*/
parseTiledJSON: function (json) {
+ if (json.orientation !== 'orthogonal')
+ {
+ console.warn('TilemapParser.parseTiledJSON: Only orthogonal map types are supported in this version of Phaser');
+ return null;
+ }
+
+ // Map data will consist of: layers, objects, images, tilesets, sizes
+ var map = {};
+
+ map.width = json.width;
+ map.height = json.height;
+ map.tileWidth = json.tilewidth;
+ map.tileHeight = json.tileheight;
+ map.orientation = json.orientation;
+ map.version = json.version;
+ map.properties = json.properties;
+ map.widthInPixels = map.width * map.tileWidth;
+ map.heightInPixels = map.height * map.tileHeight;
+
+ // Tile Layers
var layers = [];
for (var i = 0; i < json.layers.length; i++)
{
- // Check it's a data layer
- if (!json.layers[i].data)
+ if (json.layers[i].type !== 'tilelayer')
{
continue;
}
- // json.tilewidth
- // json.tileheight
-
var layer = {
name: json.layers[i].name,
+ x: json.layers[i].x,
+ y: json.layers[i].y,
width: json.layers[i].width,
height: json.layers[i].height,
+ widthInPixels: json.layers[i].width * json.tilewidth,
+ heightInPixels: json.layers[i].height * json.tileheight,
alpha: json.layers[i].opacity,
visible: json.layers[i].visible,
+ properties: {},
indexes: [],
-
- tileMargin: json.tilesets[0].margin,
- tileSpacing: json.tilesets[0].spacing
+ callbacks: []
};
- var output = [];
- var c = 0;
- var row;
-
- for (var t = 0; t < json.layers[i].data.length; t++)
+ if (json.layers[i].properties)
{
- if (c === 0)
+ layer.properties = json.layers[i].properties;
+ }
+
+ var x = 0;
+ var row = [];
+ var output = [];
+
+ // Loop through the data field in the JSON.
+
+ // This is an array containing the tile indexes, one after the other. 0 = no tile, everything else = the tile index (starting at 1)
+ // If the map contains multiple tilesets then the indexes are relative to that which the set starts from.
+ // Need to set which tileset in the cache = which tileset in the JSON, if you do this manually it means you can use the same map data but a new tileset.
+
+ for (var t = 0, len = json.layers[i].data.length; t < len; t++)
+ {
+ // index, x, y, width, height
+ if (json.layers[i].data[t] > 0)
{
- row = [];
+ row.push(new Phaser.Tile(layer, json.layers[i].data[t], x, output.length, json.tilewidth, json.tileheight));
+ }
+ else
+ {
+ row.push(null);
}
- row.push(json.layers[i].data[t]);
- c++;
+ x++;
- if (c == json.layers[i].width)
+ if (x === json.layers[i].width)
{
output.push(row);
- c = 0;
+ x = 0;
+ row = [];
}
}
layer.data = output;
-
+
layers.push(layer);
}
- return layers;
+ map.layers = layers;
+
+ // Images
+ var images = [];
+
+ for (var i = 0; i < json.layers.length; i++)
+ {
+ if (json.layers[i].type !== 'imagelayer')
+ {
+ continue;
+ }
+
+ var image = {
+
+ name: json.layers[i].name,
+ image: json.layers[i].image,
+ x: json.layers[i].x,
+ y: json.layers[i].y,
+ alpha: json.layers[i].opacity,
+ visible: json.layers[i].visible,
+ properties: {}
+
+ };
+
+ if (json.layers[i].properties)
+ {
+ image.properties = json.layers[i].properties;
+ }
+
+ images.push(image);
+
+ }
+
+ map.images = images;
+
+ // Objects
+ var objects = {};
+
+ for (var i = 0; i < json.layers.length; i++)
+ {
+ if (json.layers[i].type !== 'objectgroup')
+ {
+ continue;
+ }
+
+ objects[json.layers[i].name] = [];
+
+ for (var v = 0, len = json.layers[i].objects.length; v < len; v++)
+ {
+ // For now we'll just support object tiles
+ if (json.layers[i].objects[v].gid)
+ {
+ var object = {
+
+ gid: json.layers[i].objects[v].gid,
+ name: json.layers[i].objects[v].name,
+ x: json.layers[i].objects[v].x,
+ y: json.layers[i].objects[v].y,
+ visible: json.layers[i].objects[v].visible,
+ properties: json.layers[i].objects[v].properties
+
+ };
+
+ objects[json.layers[i].name].push(object);
+ }
+
+ }
+ }
+
+ map.objects = objects;
+
+ // Tilesets
+ var tilesets = [];
+
+ for (var i = 0; i < json.tilesets.length; i++)
+ {
+ // name, firstgid, width, height, margin, spacing, properties
+ var set = json.tilesets[i];
+ var newSet = new Phaser.Tileset(set.name, set.firstgid, set.tilewidth, set.tileheight, set.margin, set.spacing, set.properties);
+
+ if (set.tileproperties)
+ {
+ newSet.tileProperties = set.tileproperties;
+ }
+
+ newSet.rows = (set.imageheight - set.margin) / (set.tileheight + set.spacing);
+ newSet.columns = (set.imagewidth - set.margin) / (set.tilewidth + set.spacing);
+ newSet.total = newSet.rows * newSet.columns;
+
+ tilesets.push(newSet);
+ }
+
+ map.tilesets = tilesets;
+
+ map.tiles = [];
+
+ // Finally lets build our super tileset index
+ for (var i = 0; i < map.tilesets.length; i++)
+ {
+ var set = map.tilesets[i];
+
+ var x = set.tileMargin;
+ var y = set.tileMargin;
+
+ var count = 0;
+ var countX = 0;
+ var countY = 0;
+
+ for (var t = set.firstgid; t < set.firstgid + set.total; t++)
+ {
+ // Can add extra properties here as needed
+ map.tiles[t] = [x, y, i];
+
+ x += set.tileWidth + set.tileSpacing;
+
+ count++;
+
+ if (count === set.total)
+ {
+ break;
+ }
+
+ countX++;
+
+ if (countX === set.columns)
+ {
+ x = set.tileMargin;
+ y += set.tileHeight + set.tileSpacing;
+
+ countX = 0;
+ countY++;
+
+ if (countY === set.rows)
+ {
+ break;
+ }
+ }
+ }
+
+ }
+
+ return map;
}
@@ -649,13 +808,13 @@ Phaser.TilemapParser = {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/Tileset.js.html b/docs/Tileset.js.html
index faf94c4d..56d573a1 100644
--- a/docs/Tileset.js.html
+++ b/docs/Tileset.js.html
@@ -90,6 +90,10 @@
Device
+ /**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
* A Tile set is a combination of an image containing the tiles and collision data per tile.
+* You should not normally instantiate this class directly.
*
* @class Phaser.Tileset
* @constructor
-* @param {Image} image - The Image object from the Cache.
-* @param {string} key - The key of the tileset in the cache.
-* @param {number} tileWidth - The width of the tile in pixels.
-* @param {number} tileHeight - The height of the tile in pixels.
-* @param {number} [tileMargin] - The margin around the tiles in the sheet.
-* @param {number} [tileSpacing] - The spacing between the tiles in the sheet.
+* @param {string} name - The name of the tileset in the map data.
+* @param {number} firstgid - The Tiled firstgid value.
+* @param {number} width - Width of each tile in pixels.
+* @param {number} height - Height of each tile in pixels.
+* @param {number} margin - The amount of margin around the tilesheet.
+* @param {number} spacing - The amount of spacing between each tile in the sheet.
+* @param {object} properties - Tileset properties.
*/
-Phaser.Tileset = function (image, key, tileWidth, tileHeight, tileMargin, tileSpacing) {
-
- if (typeof tileMargin === "undefined") { tileMargin = 0; }
- if (typeof tileSpacing === "undefined") { tileSpacing = 0; }
+Phaser.Tileset = function (name, firstgid, width, height, margin, spacing, properties) {
/**
- * @property {string} key - The cache ID.
+ * @property {string} name - The name of the Tileset.
*/
- this.key = key;
+ this.name = name;
/**
- * @property {object} image - The image used for rendering.
+ * @property {number} firstgid - The Tiled firstgid value.
+ * @default
*/
- this.image = image;
+ this.firstgid = firstgid;
/**
* @property {number} tileWidth - The width of a tile in pixels.
*/
- this.tileWidth = tileWidth;
+ this.tileWidth = width;
/**
* @property {number} tileHeight - The height of a tile in pixels.
*/
- this.tileHeight = tileHeight;
+ this.tileHeight = height;
/**
* @property {number} tileMargin - The margin around the tiles in the sheet.
*/
- this.margin = tileMargin;
+ this.tileMargin = margin;
/**
* @property {number} tileSpacing - The margin around the tiles in the sheet.
*/
- this.spacing = tileSpacing;
+ this.tileSpacing = spacing;
/**
- * @property {array} tiles - An array of the tile collision data.
+ * @property {object} properties - Tileset specific properties (typically defined in the Tiled editor).
*/
- this.tiles = [];
+ this.properties = properties;
-}
+ /**
+ * @property {object} tilePproperties - Tile specific properties (typically defined in the Tiled editor).
+ */
+ // this.tileProperties = {};
+
+ /**
+ * @property {object} image - The image used for rendering. This is a reference to the image stored in Phaser.Cache.
+ */
+ this.image = null;
+
+ /**
+ * @property {number} rows - The number of rows in the tile sheet.
+ */
+ this.rows = 0;
+
+ /**
+ * @property {number} columns - The number of columns in the tile sheet.
+ */
+ this.columns = 0;
+
+ /**
+ * @property {number} total - The total number of tiles in the tilesheet.
+ */
+ this.total = 0;
+
+};
Phaser.Tileset.prototype = {
- /**
- * Adds a Tile into this set.
- *
- * @method Phaser.Tileset#addTile
- * @param {Phaser.Tile} tile - The tile to add to this set.
- */
- addTile: function (tile) {
-
- this.tiles.push(tile);
-
- return tile;
-
- },
-
/**
* Gets a Tile from this set.
*
* @method Phaser.Tileset#getTile
* @param {number} index - The index of the tile within the set.
- * @return {Phaser.Tile} The tile.
- */
+ * @return {object} The tile object.
getTile: function (index) {
- if (this.tiles[index])
- {
- return this.tiles[index];
- }
-
- return null;
+ return this.tiles[index];
},
+ */
+
+ /**
+ * Gets a Tile from this set.
+ *
+ * @method Phaser.Tileset#getTileX
+ * @param {number} index - The index of the tile within the set.
+ * @return {object} The tile object.
+ getTileX: function (index) {
+
+ return this.tiles[index][0];
+
+ },
+ */
+
+ /**
+ * Gets a Tile from this set.
+ *
+ * @method Phaser.Tileset#getTileY
+ * @param {number} index - The index of the tile within the set.
+ * @return {object} The tile object.
+ getTileY: function (index) {
+
+ return this.tiles[index][1];
+
+ },
+ */
/**
* Sets tile spacing and margins.
@@ -529,93 +555,22 @@ Phaser.Tileset.prototype = {
},
- /**
- * Checks if the tile at the given index can collide.
- *
- * @method Phaser.Tileset#canCollide
- * @param {number} index - The index of the tile within the set.
- * @return {boolean} True or false depending on the tile collision or null if no tile was found at the given index.
- */
- canCollide: function (index) {
-
- if (this.tiles[index])
- {
- return this.tiles[index].collideNone;
- }
-
- return null;
-
- },
-
/**
* Checks if the tile at the given index exists.
*
* @method Phaser.Tileset#checkTileIndex
* @param {number} index - The index of the tile within the set.
* @return {boolean} True if a tile exists at the given index otherwise false.
- */
checkTileIndex: function (index) {
return (this.tiles[index]);
- },
-
- /**
- * Sets collision values on a range of tiles in the set.
- *
- * @method Phaser.Tileset#setCollisionRange
- * @param {number} start - The index to start setting the collision data on.
- * @param {number} stop - The index to stop setting the collision data on.
- * @param {boolean} left - Should the tile collide on the left?
- * @param {boolean} right - Should the tile collide on the right?
- * @param {boolean} up - Should the tile collide on the top?
- * @param {boolean} down - Should the tile collide on the bottom?
- */
- setCollisionRange: function (start, stop, left, right, up, down) {
-
- if (this.tiles[start] && this.tiles[stop] && start < stop)
- {
- for (var i = start; i <= stop; i++)
- {
- this.tiles[i].setCollision(left, right, up, down);
- }
- }
-
- },
-
- /**
- * Sets collision values on a tile in the set.
- *
- * @method Phaser.Tileset#setCollision
- * @param {number} index - The index of the tile within the set.
- * @param {boolean} left - Should the tile collide on the left?
- * @param {boolean} right - Should the tile collide on the right?
- * @param {boolean} up - Should the tile collide on the top?
- * @param {boolean} down - Should the tile collide on the bottom?
- */
- setCollision: function (index, left, right, up, down) {
-
- if (this.tiles[index])
- {
- this.tiles[index].setCollision(left, right, up, down);
- }
-
}
+ */
-}
+};
-/**
-* @name Phaser.Tileset#total
-* @property {number} total - The total number of tiles in this Tileset.
-* @readonly
-*/
-Object.defineProperty(Phaser.Tileset.prototype, "total", {
-
- get: function () {
- return this.tiles.length;
- }
-
-});
+Phaser.Tileset.prototype.constructor = Phaser.Tileset;
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Time.js.html b/docs/Time.js.html index 07640993..91ac8c29 100644 --- a/docs/Time.js.html +++ b/docs/Time.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -437,228 +431,338 @@
*/
Phaser.Time = function (game) {
- /**
- * @property {Phaser.Game} game - Local reference to game.
- */
- this.game = game;
+ /**
+ * @property {Phaser.Game} game - Local reference to game.
+ */
+ this.game = game;
- /**
- * @property {number} _started - The time at which the Game instance started.
- * @private
- */
- this._started = 0;
+ /**
+ * @property {number} time - Game time counter. If you need a value for in-game calculation please use Phaser.Time.now instead.
+ * @protected
+ */
+ this.time = 0;
- /**
- * @property {number} _timeLastSecond - The time (in ms) that the last second counter ticked over.
- * @private
- */
- this._timeLastSecond = 0;
+ /**
+ * @property {number} now - The time right now.
+ * @protected
+ */
+ this.now = 0;
- /**
- * @property {number} _pauseStarted - The time the game started being paused.
- * @private
- */
- this._pauseStarted = 0;
+ /**
+ * @property {number} elapsed - Elapsed time since the last frame (in ms).
+ * @protected
+ */
+ this.elapsed = 0;
- /**
- * @property {number} physicsElapsed - The elapsed time calculated for the physics motion updates.
- */
- this.physicsElapsed = 0;
+ /**
+ * @property {number} pausedTime - Records how long the game has been paused for. Is reset each time the game pauses.
+ * @protected
+ */
+ this.pausedTime = 0;
- /**
- * @property {number} time - Game time counter.
- */
- this.time = 0;
+ /**
+ * @property {number} fps - Frames per second.
+ * @protected
+ */
+ this.fps = 0;
- /**
- * @property {number} pausedTime - Records how long the game has been paused for. Is reset each time the game pauses.
- */
- this.pausedTime = 0;
+ /**
+ * @property {number} fpsMin - The lowest rate the fps has dropped to.
+ */
+ this.fpsMin = 1000;
- /**
- * @property {number} now - The time right now.
- */
- this.now = 0;
+ /**
+ * @property {number} fpsMax - The highest rate the fps has reached (usually no higher than 60fps).
+ */
+ this.fpsMax = 0;
- /**
- * @property {number} elapsed - Elapsed time since the last frame.
- */
- this.elapsed = 0;
+ /**
+ * @property {number} msMin - The minimum amount of time the game has taken between two frames.
+ * @default
+ */
+ this.msMin = 1000;
- /**
- * @property {number} fps - Frames per second.
- */
- this.fps = 0;
+ /**
+ * @property {number} msMax - The maximum amount of time the game has taken between two frames.
+ */
+ this.msMax = 0;
- /**
- * @property {number} fpsMin - The lowest rate the fps has dropped to.
- */
- this.fpsMin = 1000;
+ /**
+ * @property {number} physicsElapsed - The elapsed time calculated for the physics motion updates.
+ */
+ this.physicsElapsed = 0;
- /**
- * @property {number} fpsMax - The highest rate the fps has reached (usually no higher than 60fps).
- */
- this.fpsMax = 0;
+ /**
+ * @property {number} frames - The number of frames record in the last second.
+ */
+ this.frames = 0;
- /**
- * @property {number} msMin - The minimum amount of time the game has taken between two frames.
- * @default
- */
- this.msMin = 1000;
+ /**
+ * @property {number} pauseDuration - Records how long the game was paused for in miliseconds.
+ */
+ this.pauseDuration = 0;
- /**
- * @property {number} msMax - The maximum amount of time the game has taken between two frames.
- */
- this.msMax = 0;
+ /**
+ * @property {number} timeToCall - The value that setTimeout needs to work out when to next update
+ */
+ this.timeToCall = 0;
- /**
- * @property {number} frames - The number of frames record in the last second.
- */
- this.frames = 0;
+ /**
+ * @property {number} lastTime - Internal value used by timeToCall as part of the setTimeout loop
+ */
+ this.lastTime = 0;
- /**
- * @property {number} pauseDuration - Records how long the game was paused for in miliseconds.
- */
- this.pauseDuration = 0;
+ /**
+ * @property {Phaser.Timer} events - This is a Phaser.Timer object bound to the master clock to which you can add timed events.
+ */
+ this.events = new Phaser.Timer(this.game, false);
- /**
- * @property {number} timeToCall - The value that setTimeout needs to work out when to next update
- */
- this.timeToCall = 0;
-
- /**
- * @property {number} lastTime - Internal value used by timeToCall as part of the setTimeout loop
- */
- this.lastTime = 0;
-
- // Listen for game pause/resume events
- this.game.onPause.add(this.gamePaused, this);
- this.game.onResume.add(this.gameResumed, this);
-
- /**
- * @property {boolean} _justResumed - Internal value used to recover from the game pause state.
+ /**
+ * @property {number} _started - The time at which the Game instance started.
* @private
- */
- this._justResumed = false;
+ */
+ this._started = 0;
+
+ /**
+ * @property {number} _timeLastSecond - The time (in ms) that the last second counter ticked over.
+ * @private
+ */
+ this._timeLastSecond = 0;
+
+ /**
+ * @property {number} _pauseStarted - The time the game started being paused.
+ * @private
+ */
+ this._pauseStarted = 0;
+
+ /**
+ * @property {boolean} _justResumed - Internal value used to recover from the game pause state.
+ * @private
+ */
+ this._justResumed = false;
+
+ /**
+ * @property {array} _timers - Internal store of Phaser.Timer objects.
+ * @private
+ */
+ this._timers = [];
+
+ /**
+ * @property {number} _len - Temp. array length variable.
+ * @private
+ */
+ this._len = 0;
+
+ /**
+ * @property {number} _i - Temp. array counter variable.
+ * @private
+ */
+ this._i = 0;
+
+ // Listen for game pause/resume events
+ this.game.onPause.add(this.gamePaused, this);
+ this.game.onResume.add(this.gameResumed, this);
};
Phaser.Time.prototype = {
- /**
- * Updates the game clock and calculate the fps. This is called automatically by Phaser.Game.
- * @method Phaser.Time#update
- * @param {number} time - The current timestamp, either performance.now or Date.now depending on the browser.
- */
- update: function (time) {
+ /**
+ * @method Phaser.Time#boot
+ */
+ boot: function () {
- this.now = time;
+ this.events.start();
- if (this._justResumed)
- {
- this.time = this.now;
- this._justResumed = false;
- }
+ },
- this.timeToCall = this.game.math.max(0, 16 - (time - this.lastTime));
+ /**
+ * Creates a new stand-alone Phaser.Timer object.
+ * @method Phaser.Time#create
+ * @param {boolean} [autoDestroy=true] - A Timer that is set to automatically destroy itself will do so after all of its events have been dispatched (assuming no looping events).
+ * @return {Phaser.Timer} The Timer object that was created.
+ */
+ create: function (autoDestroy) {
- this.elapsed = this.now - this.time;
+ if (typeof autoDestroy === 'undefined') { autoDestroy = true; }
- this.msMin = this.game.math.min(this.msMin, this.elapsed);
- this.msMax = this.game.math.max(this.msMax, this.elapsed);
+ var timer = new Phaser.Timer(this.game, autoDestroy);
- this.frames++;
+ this._timers.push(timer);
- if (this.now > this._timeLastSecond + 1000)
- {
- this.fps = Math.round((this.frames * 1000) / (this.now - this._timeLastSecond));
- this.fpsMin = this.game.math.min(this.fpsMin, this.fps);
- this.fpsMax = this.game.math.max(this.fpsMax, this.fps);
- this._timeLastSecond = this.now;
- this.frames = 0;
- }
+ return timer;
- this.time = this.now;
+ },
+
+ /**
+ * Remove all Timer objects, regardless of their state.
+ * @method Phaser.Time#removeAll
+ */
+ removeAll: function () {
+
+ for (var i = 0; i < this._timers.length; i++)
+ {
+ this._timers[i].destroy();
+ }
+
+ this._timers = [];
+
+ },
+
+ /**
+ * Updates the game clock and calculate the fps. This is called automatically by Phaser.Game.
+ * @method Phaser.Time#update
+ * @param {number} time - The current timestamp, either performance.now or Date.now depending on the browser.
+ */
+ update: function (time) {
+
+ this.now = time;
+
+ if (this._justResumed)
+ {
+ this.time = this.now;
+ this._justResumed = false;
+
+ this.events.resume();
+
+ for (var i = 0; i < this._timers.length; i++)
+ {
+ this._timers[i].resume();
+ }
+ }
+
+ this.timeToCall = this.game.math.max(0, 16 - (time - this.lastTime));
+
+ this.elapsed = this.now - this.time;
+
+ this.msMin = this.game.math.min(this.msMin, this.elapsed);
+ this.msMax = this.game.math.max(this.msMax, this.elapsed);
+
+ this.frames++;
+
+ if (this.now > this._timeLastSecond + 1000)
+ {
+ this.fps = Math.round((this.frames * 1000) / (this.now - this._timeLastSecond));
+ this.fpsMin = this.game.math.min(this.fpsMin, this.fps);
+ this.fpsMax = this.game.math.max(this.fpsMax, this.fps);
+ this._timeLastSecond = this.now;
+ this.frames = 0;
+ }
+
+ this.time = this.now;
this.lastTime = time + this.timeToCall;
- this.physicsElapsed = 1.0 * (this.elapsed / 1000);
+ this.physicsElapsed = 1.0 * (this.elapsed / 1000);
- // Clamp the delta
- if (this.physicsElapsed > 1)
- {
- this.physicsElapsed = 1;
- }
+ // Clamp the delta
+ if (this.physicsElapsed > 0.05)
+ {
+ this.physicsElapsed = 0.05;
+ }
- // Paused?
- if (this.game.paused)
- {
- this.pausedTime = this.now - this._pauseStarted;
- }
+ // Paused?
+ if (this.game.paused)
+ {
+ this.pausedTime = this.now - this._pauseStarted;
+ }
+ else
+ {
+ // Our internal Phaser.Timer
+ this.events.update(this.now);
- },
+ // Any game level timers
+ this._i = 0;
+ this._len = this._timers.length;
- /**
- * Called when the game enters a paused state.
- * @method Phaser.Time#gamePaused
- * @private
- */
- gamePaused: function () {
-
- this._pauseStarted = this.now;
+ while (this._i < this._len)
+ {
+ if (this._timers[this._i].update(this.now))
+ {
+ this._i++;
+ }
+ else
+ {
+ this._timers.splice(this._i, 1);
- },
+ this._len--;
+ }
+ }
+ }
- /**
- * Called when the game resumes from a paused state.
- * @method Phaser.Time#gameResumed
- * @private
- */
- gameResumed: function () {
+ },
- // Level out the elapsed timer to avoid spikes
- this.time = Date.now();
- this.pauseDuration = this.pausedTime;
- this._justResumed = true;
+ /**
+ * Called when the game enters a paused state.
+ * @method Phaser.Time#gamePaused
+ * @private
+ */
+ gamePaused: function () {
+
+ this._pauseStarted = this.now;
- },
+ this.events.pause();
- /**
- * The number of seconds that have elapsed since the game was started.
- * @method Phaser.Time#totalElapsedSeconds
- * @return {number}
- */
- totalElapsedSeconds: function() {
- return (this.now - this._started) * 0.001;
- },
+ for (var i = 0; i < this._timers.length; i++)
+ {
+ this._timers[i].pause();
+ }
- /**
- * How long has passed since the given time.
- * @method Phaser.Time#elapsedSince
- * @param {number} since - The time you want to measure against.
- * @return {number} The difference between the given time and now.
- */
- elapsedSince: function (since) {
- return this.now - since;
- },
+ },
- /**
- * How long has passed since the given time (in seconds).
- * @method Phaser.Time#elapsedSecondsSince
- * @param {number} since - The time you want to measure (in seconds).
- * @return {number} Duration between given time and now (in seconds).
- */
- elapsedSecondsSince: function (since) {
- return (this.now - since) * 0.001;
- },
+ /**
+ * Called when the game resumes from a paused state.
+ * @method Phaser.Time#gameResumed
+ * @private
+ */
+ gameResumed: function () {
- /**
- * Resets the private _started value to now.
- * @method Phaser.Time#reset
- */
- reset: function () {
- this._started = this.now;
- }
+ // Level out the elapsed timer to avoid spikes
+ this.time = Date.now();
+ this.pauseDuration = this.pausedTime;
+ this._justResumed = true;
-};
+ },
+
+ /**
+ * The number of seconds that have elapsed since the game was started.
+ * @method Phaser.Time#totalElapsedSeconds
+ * @return {number}
+ */
+ totalElapsedSeconds: function() {
+ return (this.now - this._started) * 0.001;
+ },
+
+ /**
+ * How long has passed since the given time.
+ * @method Phaser.Time#elapsedSince
+ * @param {number} since - The time you want to measure against.
+ * @return {number} The difference between the given time and now.
+ */
+ elapsedSince: function (since) {
+ return this.now - since;
+ },
+
+ /**
+ * How long has passed since the given time (in seconds).
+ * @method Phaser.Time#elapsedSecondsSince
+ * @param {number} since - The time you want to measure (in seconds).
+ * @return {number} Duration between given time and now (in seconds).
+ */
+ elapsedSecondsSince: function (since) {
+ return (this.now - since) * 0.001;
+ },
+
+ /**
+ * Resets the private _started value to now.
+ * @method Phaser.Time#reset
+ */
+ reset: function () {
+ this._started = this.now;
+ }
+
+};
+
+Phaser.Time.prototype.constructor = Phaser.Time;
+
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Timer.js.html b/docs/Timer.js.html index b61fefbe..fd8151d7 100644 --- a/docs/Timer.js.html +++ b/docs/Timer.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
-* Timer constructor.
+* A Timer is a way to create small re-usable or disposable objects that do nothing but wait for a specific moment in time, and then dispatch an event.
+* You can add as many events to a Timer as you like, each with their own delays. A Timer uses milliseconds as its unit of time. There are 1000 ms in 1 second.
+* So if you want to fire an event every quarter of a second you'd need to set the delay to 250.
*
* @class Phaser.Timer
-* @classdesc A Timer
+* @classdesc A Timer is a way to create small re-usable or disposable objects that do nothing but wait for a specific moment in time, and then dispatch an event.
* @constructor
* @param {Phaser.Game} game A reference to the currently running game.
+* @param {boolean} [autoDestroy=true] - A Timer that is set to automatically destroy itself will do so after all of its events have been dispatched (assuming no looping events).
*/
-Phaser.Timer = function (game) {
+Phaser.Timer = function (game, autoDestroy) {
+
+ if (typeof autoDestroy === 'undefined') { autoDestroy = true; }
/**
* @property {Phaser.Game} game - Local reference to game.
@@ -443,67 +442,208 @@ Phaser.Timer = function (game) {
this.game = game;
/**
- * The time at which this Timer instance started.
- * @property {number} _started
+ * @property {boolean} running - True if the Timer is actively running. Do not switch this boolean, if you wish to pause the timer then use Timer.pause() instead.
+ * @default
+ */
+ this.running = false;
+
+ /**
+ * @property {boolean} autoDestroy - A Timer that is set to automatically destroy itself will do so after all of its events have been dispatched (assuming no looping events).
+ */
+ this.autoDestroy = autoDestroy;
+
+ /**
+ * @property {boolean} expired - An expired Timer is one in which all of its events have been dispatched and none are pending.
+ * @readonly
+ * @default
+ */
+ this.expired = false;
+
+ /**
+ * @property {array<Phaser.TimerEvent>} events - An array holding all of this timers Phaser.TimerEvent objects. Use the methods add, repeat and loop to populate it.
+ */
+ this.events = [];
+
+ /**
+ * @property {Phaser.Signal} onComplete - This signal will be dispatched when this Timer has completed, meaning there are no more events in the queue.
+ */
+ this.onComplete = new Phaser.Signal();
+
+ /**
+ * @property {number} nextTick - The time the next tick will occur.
+ * @readonly
+ * @protected
+ */
+ this.nextTick = 0;
+
+ /**
+ * @property {boolean} paused - The paused state of the Timer. You can pause the timer by calling Timer.pause() and Timer.resume() or by the game pausing.
+ * @readonly
+ * @default
+ */
+ this.paused = false;
+
+ /**
+ * @property {number} _started - The time at which this Timer instance started running.
* @private
* @default
*/
this._started = 0;
/**
- * The time (in ms) that the last second counter ticked over.
- * @property {number} _timeLastSecond
+ * @property {number} _pauseStarted - The time the game started being paused.
* @private
- * @default
*/
- this._timeLastSecond = 0;
+ this._pauseStarted = 0;
- this.running = false;
+ /**
+ * @property {number} _now - The current start-time adjusted time.
+ * @private
+ */
+ this._now = 0;
- this.events = [];
+ /**
+ * @property {number} _len - Temp. array length variable.
+ * @private
+ */
+ this._len = 0;
- this.onEvent = new Phaser.Signal();
+ /**
+ * @property {number} _i - Temp. array counter variable.
+ * @private
+ */
+ this._i = 0;
- // Need to add custom FPS rate, for now we'll just use seconds
+};
-}
+/**
+* @constant
+* @type {number}
+*/
+Phaser.Timer.MINUTE = 60000;
+
+/**
+* @constant
+* @type {number}
+*/
+Phaser.Timer.SECOND = 1000;
+
+/**
+* @constant
+* @type {number}
+*/
+Phaser.Timer.HALF = 500;
+
+/**
+* @constant
+* @type {number}
+*/
+Phaser.Timer.QUARTER = 250;
Phaser.Timer.prototype = {
- // delay could be from now, when the timer is created, or relative to an already running timer
+ /**
+ * Creates a new TimerEvent on this Timer. Use the methods add, repeat or loop instead of this.
+ * @method Phaser.Timer#create
+ * @private
+ * @param {number} delay - The number of milliseconds that should elapse before the Timer will call the given callback.
+ * @param {boolean} loop - Should the event loop or not?
+ * @param {number} repeatCount - The number of times the event will repeat.
+ * @param {function} callback - The callback that will be called when the Timer event occurs.
+ * @param {object} callbackContext - The context in which the callback will be called.
+ * @param {array} arguments - The values to be sent to your callback function when it is called.
+ * @return {Phaser.TimerEvent} The Phaser.TimerEvent object that was created.
+ */
+ create: function (delay, loop, repeatCount, callback, callbackContext, args) {
- // add: function (delay, callback, callbackContext) {
- add: function (delay) {
+ var tick = delay;
- this.events.push({
- delay: delay,
- dispatched: false,
- args: Array.prototype.splice.call(arguments, 1)
- });
+ if (this.running)
+ {
+ tick += this._now;
+ }
- // this.events.push({
- // delay: delay,
- // dispatched: false,
- // callback: callback,
- // callbackContext: callbackContext,
- // args: Array.prototype.splice.call(arguments, 3)
- // });
+ var event = new Phaser.TimerEvent(this, delay, tick, repeatCount, loop, callback, callbackContext, args);
+
+ this.events.push(event);
+
+ this.order();
+
+ this.expired = false;
+
+ return event;
},
+ /**
+ * Adds a new Event to this Timer. The event will fire after the given amount of 'delay' in milliseconds has passed, once the Timer has started running.
+ * Call Timer.start() once you have added all of the Events you require for this Timer. The delay is in relation to when the Timer starts, not the time it was added.
+ * If the Timer is already running the delay will be calculated based on the timers current time.
+ * @method Phaser.Timer#add
+ * @param {number} delay - The number of milliseconds that should elapse before the Timer will call the given callback.
+ * @param {function} callback - The callback that will be called when the Timer event occurs.
+ * @param {object} callbackContext - The context in which the callback will be called.
+ * @param {...*} arguments - The values to be sent to your callback function when it is called.
+ * @return {Phaser.TimerEvent} The Phaser.TimerEvent object that was created.
+ */
+ add: function (delay, callback, callbackContext) {
+
+ return this.create(delay, false, 0, callback, callbackContext, Array.prototype.splice.call(arguments, 3));
+
+ },
+
+ /**
+ * Adds a new Event to this Timer that will repeat for the given number of iterations.
+ * The event will fire after the given amount of 'delay' milliseconds has passed once the Timer has started running.
+ * Call Timer.start() once you have added all of the Events you require for this Timer. The delay is in relation to when the Timer starts, not the time it was added.
+ * If the Timer is already running the delay will be calculated based on the timers current time.
+ * @method Phaser.Timer#repeat
+ * @param {number} delay - The number of milliseconds that should elapse before the Timer will call the given callback.
+ * @param {number} repeatCount - The number of times the event will repeat.
+ * @param {function} callback - The callback that will be called when the Timer event occurs.
+ * @param {object} callbackContext - The context in which the callback will be called.
+ * @param {...*} arguments - The values to be sent to your callback function when it is called.
+ * @return {Phaser.TimerEvent} The Phaser.TimerEvent object that was created.
+ */
+ repeat: function (delay, repeatCount, callback, callbackContext) {
+
+ return this.create(delay, false, repeatCount, callback, callbackContext, Array.prototype.splice.call(arguments, 4));
+
+ },
+
+ /**
+ * Adds a new looped Event to this Timer that will repeat forever or until the Timer is stopped.
+ * The event will fire after the given amount of 'delay' milliseconds has passed once the Timer has started running.
+ * Call Timer.start() once you have added all of the Events you require for this Timer. The delay is in relation to when the Timer starts, not the time it was added.
+ * If the Timer is already running the delay will be calculated based on the timers current time.
+ * @method Phaser.Timer#loop
+ * @param {number} delay - The number of milliseconds that should elapse before the Timer will call the given callback.
+ * @param {function} callback - The callback that will be called when the Timer event occurs.
+ * @param {object} callbackContext - The context in which the callback will be called.
+ * @param {...*} arguments - The values to be sent to your callback function when it is called.
+ * @return {Phaser.TimerEvent} The Phaser.TimerEvent object that was created.
+ */
+ loop: function (delay, callback, callbackContext) {
+
+ return this.create(delay, true, 0, callback, callbackContext, Array.prototype.splice.call(arguments, 3));
+
+ },
+
+ /**
+ * Starts this Timer running.
+ * @method Phaser.Timer#start
+ */
start: function() {
this._started = this.game.time.now;
this.running = true;
- // sort the events based on delay here, also don't run unless events is populated
- // add ability to auto-stop once all events are done
- // add support for maximum duration
- // add support for delay before starting
- // add signals?
-
},
+ /**
+ * Stops this Timer from running. Does not cause it to be destroyed if autoDestroy is set to true.
+ * @method Phaser.Timer#stop
+ */
stop: function() {
this.running = false;
@@ -511,33 +651,258 @@ Phaser.Timer.prototype = {
},
- update: function() {
+ /**
+ * Removes a pending TimerEvent from the queue.
+ * @param {Phaser.TimerEvent} event - The event to remove from the queue.
+ * @method Phaser.Timer#remove
+ */
+ remove: function(event) {
- // TODO: Game Paused support
-
- if (this.running)
+ for (var i = 0; i < this.events.length; i++)
{
- var seconds = this.seconds();
-
- for (var i = 0, len = this.events.length; i < len; i++)
+ if (this.events[i] === event)
{
- if (this.events[i].dispatched === false && seconds >= this.events[i].delay)
- {
- this.events[i].dispatched = true;
- // this.events[i].callback.apply(this.events[i].callbackContext, this.events[i].args);
- this.onEvent.dispatch.apply(this, this.events[i].args);
- // ought to slice it now
- }
+ this.events.splice(i, 1);
+ return true;
}
}
+ return false;
+
+ },
+
+ /**
+ * Orders the events on this Timer so they are in tick order. This is called automatically when new events are created.
+ * @method Phaser.Timer#order
+ */
+ order: function () {
+
+ if (this.events.length > 0)
+ {
+ // Sort the events so the one with the lowest tick is first
+ this.events.sort(this.sortHandler);
+
+ this.nextTick = this.events[0].tick;
+ }
+
},
- seconds: function() {
- return (this.game.time.now - this._started) * 0.001;
+ /**
+ * Sort handler used by Phaser.Timer.order.
+ * @method Phaser.Timer#sortHandler
+ * @protected
+ */
+ sortHandler: function (a, b) {
+
+ if (a.tick < b.tick)
+ {
+ return -1;
+ }
+ else if (a.tick > b.tick)
+ {
+ return 1;
+ }
+
+ return 0;
+
+ },
+
+ /**
+ * The main Timer update event, called automatically by the Game clock.
+ * @method Phaser.Timer#update
+ * @protected
+ * @param {number} time - The time from the core game clock.
+ * @return {boolean} True if there are still events waiting to be dispatched, otherwise false if this Timer can be destroyed.
+ */
+ update: function(time) {
+
+ if (this.paused)
+ {
+ return true;
+ }
+
+ this._now = time - this._started;
+
+ this._len = this.events.length;
+
+ if (this.running && this._now >= this.nextTick && this._len > 0)
+ {
+ this._i = 0;
+
+ while (this._i < this._len)
+ {
+ if (this._now >= this.events[this._i].tick)
+ {
+ if (this.events[this._i].loop === true)
+ {
+ this.events[this._i].tick += this.events[this._i].delay - (this._now - this.events[this._i].tick);
+ this.events[this._i].callback.apply(this.events[this._i].callbackContext, this.events[this._i].args);
+ }
+ else if (this.events[this._i].repeatCount > 0)
+ {
+ this.events[this._i].repeatCount--;
+ this.events[this._i].tick += this.events[this._i].delay - (this._now - this.events[this._i].tick);
+ this.events[this._i].callback.apply(this.events[this._i].callbackContext, this.events[this._i].args);
+ }
+ else
+ {
+ this.events[this._i].callback.apply(this.events[this._i].callbackContext, this.events[this._i].args);
+ this.events.splice(this._i, 1);
+ this._len--;
+ }
+
+ this._i++;
+ }
+ else
+ {
+ break;
+ }
+ }
+
+ // Are there any events left?
+ if (this.events.length > 0)
+ {
+ this.order();
+ }
+ else
+ {
+ this.expired = true;
+ this.onComplete.dispatch(this);
+ }
+ }
+
+ if (this.expired && this.autoDestroy)
+ {
+ return false;
+ }
+ else
+ {
+ return true;
+ }
+
+ },
+
+ /**
+ * Pauses the Timer and all events in the queue.
+ * @method Phaser.Timer#pause
+ */
+ pause: function () {
+
+ this._pauseStarted = this.game.time.now;
+
+ this.paused = true;
+
+ },
+
+ /**
+ * Resumes the Timer and updates all pending events.
+ * @method Phaser.Timer#resume
+ */
+ resume: function () {
+
+ var pauseDuration = this.game.time.now - this._pauseStarted;
+
+ for (var i = 0; i < this.events.length; i++)
+ {
+ this.events[i].tick += pauseDuration;
+ }
+
+ this.nextTick += pauseDuration;
+
+ this.paused = false;
+
+ },
+
+ /**
+ * Destroys this Timer. Events are not dispatched.
+ * @method Phaser.Timer#destroy
+ */
+ destroy: function() {
+
+ this.onComplete.removeAll();
+ this.running = false;
+ this.events = [];
+
}
-}
+};
+
+/**
+* @name Phaser.Timer#next
+* @property {number} next - The time at which the next event will occur.
+* @readonly
+*/
+Object.defineProperty(Phaser.Timer.prototype, "next", {
+
+ get: function () {
+ return this.nextTick;
+ }
+
+});
+
+/**
+* @name Phaser.Timer#duration
+* @property {number} duration - The duration in ms remaining until the next event will occur.
+* @readonly
+*/
+Object.defineProperty(Phaser.Timer.prototype, "duration", {
+
+ get: function () {
+
+ if (this.running && this.nextTick > this._now)
+ {
+ return this.nextTick - this._now;
+ }
+ else
+ {
+ return 0;
+ }
+
+ }
+
+});
+
+/**
+* @name Phaser.Timer#length
+* @property {number} length - The number of pending events in the queue.
+* @readonly
+*/
+Object.defineProperty(Phaser.Timer.prototype, "length", {
+
+ get: function () {
+ return this.events.length;
+ }
+
+});
+
+/**
+* @name Phaser.Timer#ms
+* @property {number} ms - The duration in milliseconds that this Timer has been running for.
+* @readonly
+*/
+Object.defineProperty(Phaser.Timer.prototype, "ms", {
+
+ get: function () {
+ return this._now;
+ }
+
+});
+
+/**
+* @name Phaser.Timer#seconds
+* @property {number} seconds - The duration in seconds that this Timer has been running for.
+* @readonly
+*/
+Object.defineProperty(Phaser.Timer.prototype, "seconds", {
+
+ get: function () {
+ return this._now * 0.001;
+ }
+
+});
+
+Phaser.Timer.prototype.constructor = Phaser.Timer;
+
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/TimerEvent.js.html b/docs/TimerEvent.js.html new file mode 100644 index 00000000..d0a9f1e5 --- /dev/null +++ b/docs/TimerEvent.js.html @@ -0,0 +1,546 @@ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/Touch.js.html b/docs/Touch.js.html
index a03f5f91..3c6bfc6b 100644
--- a/docs/Touch.js.html
+++ b/docs/Touch.js.html
@@ -90,6 +90,10 @@
Device
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source: time/TimerEvent.js
+ +/**
+* @author Richard Davey <rich@photonstorm.com>
+* @copyright 2014 Photon Storm Ltd.
+* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
+*/
+
+/**
+* A TimerEvent is a single event that is processed by a Phaser.Timer. It consists of a delay, which is a value in milliseconds after which the event will fire.
+* It can call a specific callback, passing in optional parameters.
+*
+* @class Phaser.TimerEvent
+* @classdesc A TimerEvent is a single event that is processed by a Phaser.Timer. It consists of a delay, which is a value in milliseconds after which the event will fire.
+* @constructor
+* @param {Phaser.Timer} timer - The Timer object that this TimerEvent belongs to.
+* @param {number} delay - The delay in ms at which this TimerEvent fires.
+* @param {number} tick - The tick is the next game clock time that this event will fire at.
+* @param {number} repeatCount - If this TimerEvent repeats it will do so this many times.
+* @param {boolean} loop - True if this TimerEvent loops, otherwise false.
+* @param {function} callback - The callback that will be called when the TimerEvent occurs.
+* @param {object} callbackContext - The context in which the callback will be called.
+* @param {array} arguments - The values to be passed to the callback.
+*/
+Phaser.TimerEvent = function (timer, delay, tick, repeatCount, loop, callback, callbackContext, args) {
+
+ /**
+ * @property {Phaser.Timer} timer - The Timer object that this TimerEvent belongs to.
+ */
+ this.timer = timer;
+
+ /**
+ * @property {number} delay - The delay in ms at which this TimerEvent fires.
+ */
+ this.delay = delay;
+
+ /**
+ * @property {number} tick - The tick is the next game clock time that this event will fire at.
+ */
+ this.tick = tick;
+
+ /**
+ * @property {number} repeatCount - If this TimerEvent repeats it will do so this many times.
+ */
+ this.repeatCount = repeatCount - 1;
+
+ /**
+ * @property {boolean} loop - True if this TimerEvent loops, otherwise false.
+ */
+ this.loop = loop;
+
+ /**
+ * @property {function} callback - The callback that will be called when the TimerEvent occurs.
+ */
+ this.callback = callback;
+
+ /**
+ * @property {object} callbackContext - The context in which the callback will be called.
+ */
+ this.callbackContext = callbackContext;
+
+ /**
+ * @property {array} arguments - The values to be passed to the callback.
+ */
+ this.args = args;
+
+};
+
+Phaser.TimerEvent.prototype.constructor = Phaser.TimerEvent;
+
+ +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -490,7 +484,8 @@ Phaser.Touch = function (game) {
this.preventDefault = true;
/**
- * @property {TouchEvent} event - The browser touch event.
+ * @property {TouchEvent} event - The browser touch DOM event. Will be set to null if no touch event has ever been received.
+ * @default
*/
this.event = null;
@@ -691,13 +686,6 @@ Phaser.Touch.prototype = {
event.preventDefault();
}
- /*
- for (var i = 0; i < event.changedTouches.length; i++)
- {
- //console.log('touch enter');
- }
- */
-
},
/**
@@ -720,13 +708,6 @@ Phaser.Touch.prototype = {
event.preventDefault();
}
- /*
- for (var i = 0; i < event.changedTouches.length; i++)
- {
- //console.log('touch leave');
- }
- */
-
},
/**
@@ -802,7 +783,10 @@ Phaser.Touch.prototype = {
}
-};
+};
+
+Phaser.Touch.prototype.constructor = Phaser.Touch;
+
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Tween.js.html b/docs/Tween.js.html index 352a9b05..9b4e0de5 100644 --- a/docs/Tween.js.html +++ b/docs/Tween.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -451,119 +445,112 @@ Phaser.Tween = function (object, game) {
this.game = game;
/**
- * @property {object} _manager - Description.
+ * @property {Phaser.TweenManager} _manager - Reference to the TweenManager.
* @private
*/
this._manager = this.game.tweens;
/**
- * @property {object} _valuesStart - Description.
+ * @property {object} _valuesStart - Private value object.
* @private
*/
this._valuesStart = {};
/**
- * @property {object} _valuesEnd - Description.
+ * @property {object} _valuesEnd - Private value object.
* @private
*/
this._valuesEnd = {};
/**
- * @property {object} _valuesStartRepeat - Description.
+ * @property {object} _valuesStartRepeat - Private value object.
* @private
*/
this._valuesStartRepeat = {};
/**
- * @property {number} _duration - Description.
+ * @property {number} _duration - Private duration counter.
* @private
* @default
*/
this._duration = 1000;
/**
- * @property {number} _repeat - Description.
+ * @property {number} _repeat - Private repeat counter.
* @private
* @default
*/
this._repeat = 0;
/**
- * @property {boolean} _yoyo - Description.
+ * @property {boolean} _yoyo - Private yoyo flag.
* @private
* @default
*/
this._yoyo = false;
/**
- * @property {boolean} _reversed - Description.
+ * @property {boolean} _reversed - Private reversed flag.
* @private
* @default
*/
this._reversed = false;
/**
- * @property {number} _delayTime - Description.
+ * @property {number} _delayTime - Private delay counter.
* @private
* @default
*/
this._delayTime = 0;
/**
- * @property {Description} _startTime - Description.
+ * @property {number} _startTime - Private start time counter.
* @private
* @default null
*/
this._startTime = null;
/**
- * @property {Description} _easingFunction - Description.
+ * @property {function} _easingFunction - The easing function used for the tween.
* @private
*/
this._easingFunction = Phaser.Easing.Linear.None;
/**
- * @property {Description} _interpolationFunction - Description.
+ * @property {function} _interpolationFunction - The interpolation function used for the tween.
* @private
*/
this._interpolationFunction = Phaser.Math.linearInterpolation;
/**
- * @property {Description} _chainedTweens - Description.
+ * @property {array} _chainedTweens - A private array of chained tweens.
* @private
*/
this._chainedTweens = [];
/**
- * @property {Description} _onStartCallback - Description.
- * @private
- * @default
- */
- this._onStartCallback = null;
-
- /**
- * @property {boolean} _onStartCallbackFired - Description.
+ * @property {boolean} _onStartCallbackFired - Private flag.
* @private
* @default
*/
this._onStartCallbackFired = false;
/**
- * @property {Description} _onUpdateCallback - Description.
+ * @property {function} _onUpdateCallback - An onUpdate callback.
* @private
* @default null
*/
this._onUpdateCallback = null;
-
+
/**
- * @property {Description} _onCompleteCallback - Description.
+ * @property {object} _onUpdateCallbackContext - The context in which to call the onUpdate callback.
* @private
* @default null
*/
- this._onCompleteCallback = null;
-
+ this._onUpdateCallbackContext = null;
+
/**
- * @property {number} _pausedTime - Description.
+ * @property {number} _pausedTime - Private pause timer.
* @private
* @default
*/
@@ -576,22 +563,28 @@ Phaser.Tween = function (object, game) {
this.pendingDelete = false;
// Set all starting values present on the target object
- for ( var field in object ) {
- this._valuesStart[ field ] = parseFloat(object[field], 10);
+ for (var field in object)
+ {
+ this._valuesStart[field] = parseFloat(object[field], 10);
}
/**
- * @property {Phaser.Signal} onStart - Description.
+ * @property {Phaser.Signal} onStart - The onStart event is fired when the Tween begins.
*/
this.onStart = new Phaser.Signal();
/**
- * @property {Phaser.Signal} onComplete - Description.
+ * @property {Phaser.Signal} onLoop - The onLoop event is fired if the Tween loops.
+ */
+ this.onLoop = new Phaser.Signal();
+
+ /**
+ * @property {Phaser.Signal} onComplete - The onComplete event is fired when the Tween completes. Does not fire if the Tween is set to loop.
*/
this.onComplete = new Phaser.Signal();
/**
- * @property {boolean} isRunning - Description.
+ * @property {boolean} isRunning - If the tween is running this is set to true, otherwise false. Tweens that are in a delayed state, waiting to start, are considered as being running.
* @default
*/
this.isRunning = false;
@@ -605,15 +598,15 @@ Phaser.Tween.prototype = {
*
* @method Phaser.Tween#to
* @param {object} properties - Properties you want to tween.
- * @param {number} duration - Duration of this tween.
- * @param {function} ease - Easing function.
- * @param {boolean} autoStart - Whether this tween will start automatically or not.
- * @param {number} delay - Delay before this tween will start, defaults to 0 (no delay).
- * @param {boolean} repeat - Should the tween automatically restart once complete? (ignores any chained tweens).
- * @param {Phaser.Tween} yoyo - Description.
- * @return {Phaser.Tween} Itself.
+ * @param {number} [duration=1000] - Duration of this tween in ms.
+ * @param {function} [ease=null] - Easing function. If not set it will default to Phaser.Easing.Linear.None.
+ * @param {boolean} [autoStart=false] - Whether this tween will start automatically or not.
+ * @param {number} [delay=0] - Delay before this tween will start, defaults to 0 (no delay). Value given is in ms.
+ * @param {boolean} [repeat=0] - Should the tween automatically restart once complete? (ignores any chained tweens).
+ * @param {boolean} [yoyo=false] - A tween that yoyos will reverse itself when it completes.
+ * @return {Phaser.Tween} This Tween object.
*/
- to: function ( properties, duration, ease, autoStart, delay, repeat, yoyo ) {
+ to: function (properties, duration, ease, autoStart, delay, repeat, yoyo) {
duration = duration || 1000;
ease = ease || null;
@@ -623,6 +616,7 @@ Phaser.Tween.prototype = {
yoyo = yoyo || false;
var self;
+
if (this._parent)
{
self = this._manager.create(this._object);
@@ -652,9 +646,12 @@ Phaser.Tween.prototype = {
self._yoyo = yoyo;
- if (autoStart) {
+ if (autoStart)
+ {
return this.start();
- } else {
+ }
+ else
+ {
return this;
}
@@ -668,43 +665,41 @@ Phaser.Tween.prototype = {
*/
start: function () {
- if (this.game === null || this._object === null) {
+ if (this.game === null || this._object === null)
+ {
return;
}
this._manager.add(this);
- this.onStart.dispatch(this._object);
-
this.isRunning = true;
this._onStartCallbackFired = false;
this._startTime = this.game.time.now + this._delayTime;
- for ( var property in this._valuesEnd ) {
-
+ for (var property in this._valuesEnd)
+ {
// check if an Array was provided as property value
- if ( this._valuesEnd[ property ] instanceof Array ) {
-
- if ( this._valuesEnd[ property ].length === 0 ) {
-
+ if (this._valuesEnd[property] instanceof Array)
+ {
+ if (this._valuesEnd[property].length === 0)
+ {
continue;
-
}
// create a local copy of the Array with the start value at the front
- this._valuesEnd[ property ] = [ this._object[ property ] ].concat( this._valuesEnd[ property ] );
-
+ this._valuesEnd[property] = [this._object[property]].concat(this._valuesEnd[property]);
}
- this._valuesStart[ property ] = this._object[ property ];
+ this._valuesStart[property] = this._object[property];
- if ( ( this._valuesStart[ property ] instanceof Array ) === false ) {
- this._valuesStart[ property ] *= 1.0; // Ensures we're using numbers, not strings
+ if ((this._valuesStart[property] instanceof Array) === false)
+ {
+ this._valuesStart[property] *= 1.0; // Ensures we're using numbers, not strings
}
- this._valuesStartRepeat[ property ] = this._valuesStart[ property ] || 0;
+ this._valuesStartRepeat[property] = this._valuesStart[property] || 0;
}
@@ -722,6 +717,8 @@ Phaser.Tween.prototype = {
this.isRunning = false;
+ this._onUpdateCallback = null;
+
this._manager.remove(this);
return this;
@@ -735,7 +732,7 @@ Phaser.Tween.prototype = {
* @param {number} amount - The amount of the delay in ms.
* @return {Phaser.Tween} Itself.
*/
- delay: function ( amount ) {
+ delay: function (amount) {
this._delayTime = amount;
return this;
@@ -749,7 +746,7 @@ Phaser.Tween.prototype = {
* @param {number} times - How many times to repeat.
* @return {Phaser.Tween} Itself.
*/
- repeat: function ( times ) {
+ repeat: function (times) {
this._repeat = times;
return this;
@@ -764,7 +761,7 @@ Phaser.Tween.prototype = {
* @param {boolean} yoyo - Set to true to yoyo this tween.
* @return {Phaser.Tween} Itself.
*/
- yoyo: function( yoyo ) {
+ yoyo: function(yoyo) {
this._yoyo = yoyo;
return this;
@@ -778,7 +775,7 @@ Phaser.Tween.prototype = {
* @param {function} easing - The easing function this tween will use, i.e. Phaser.Easing.Linear.None.
* @return {Phaser.Tween} Itself.
*/
- easing: function ( easing ) {
+ easing: function (easing) {
this._easingFunction = easing;
return this;
@@ -787,12 +784,13 @@ Phaser.Tween.prototype = {
/**
* Set interpolation function the tween will use, by default it uses Phaser.Math.linearInterpolation.
+ * Also available: Phaser.Math.bezierInterpolation and Phaser.Math.catmullRomInterpolation.
*
* @method Phaser.Tween#interpolation
* @param {function} interpolation - The interpolation function to use (Phaser.Math.linearInterpolation by default)
* @return {Phaser.Tween} Itself.
*/
- interpolation: function ( interpolation ) {
+ interpolation: function (interpolation) {
this._interpolationFunction = interpolation;
return this;
@@ -832,20 +830,6 @@ Phaser.Tween.prototype = {
},
- /**
- * Sets a callback to be fired when the tween starts. Note: callback will be called in the context of the global scope.
- *
- * @method Phaser.Tween#onStartCallback
- * @param {function} callback - The callback to invoke on start.
- * @return {Phaser.Tween} Itself.
- */
- onStartCallback: function ( callback ) {
-
- this._onStartCallback = callback;
- return this;
-
- },
-
/**
* Sets a callback to be fired each time this tween updates. Note: callback will be called in the context of the global scope.
*
@@ -853,23 +837,11 @@ Phaser.Tween.prototype = {
* @param {function} callback - The callback to invoke each time this tween is updated.
* @return {Phaser.Tween} Itself.
*/
- onUpdateCallback: function ( callback ) {
+ onUpdateCallback: function (callback, callbackContext) {
this._onUpdateCallback = callback;
- return this;
+ this._onUpdateCallbackContext = callbackContext;
- },
-
- /**
- * Sets a callback to be fired when the tween completes. Note: callback will be called in the context of the global scope.
- *
- * @method Phaser.Tween#onCompleteCallback
- * @param {function} callback - The callback to invoke on completion.
- * @return {Phaser.Tween} Itself.
- */
- onCompleteCallback: function ( callback ) {
-
- this._onCompleteCallback = callback;
return this;
},
@@ -880,8 +852,10 @@ Phaser.Tween.prototype = {
* @method Phaser.Tween#pause
*/
pause: function () {
+
this._paused = true;
this._pausedTime = this.game.time.now;
+
},
/**
@@ -890,8 +864,10 @@ Phaser.Tween.prototype = {
* @method Phaser.Tween#resume
*/
resume: function () {
+
this._paused = false;
this._startTime += (this.game.time.now - this._pausedTime);
+
},
/**
@@ -901,127 +877,112 @@ Phaser.Tween.prototype = {
* @param {number} time - A timestamp passed in by the TweenManager.
* @return {boolean} false if the tween has completed and should be deleted from the manager, otherwise true (still active).
*/
- update: function ( time ) {
+ update: function (time) {
if (this.pendingDelete)
{
return false;
}
- if (this._paused || time < this._startTime) {
-
+ if (this._paused || time < this._startTime)
+ {
return true;
-
}
var property;
- if ( time < this._startTime ) {
-
+ if (time < this._startTime)
+ {
return true;
-
}
- if ( this._onStartCallbackFired === false ) {
-
- if ( this._onStartCallback !== null ) {
-
- this._onStartCallback.call( this._object );
-
- }
-
+ if (this._onStartCallbackFired === false)
+ {
+ this.onStart.dispatch(this._object);
this._onStartCallbackFired = true;
-
}
- var elapsed = ( time - this._startTime ) / this._duration;
+ var elapsed = (time - this._startTime) / this._duration;
elapsed = elapsed > 1 ? 1 : elapsed;
- var value = this._easingFunction( elapsed );
+ var value = this._easingFunction(elapsed);
- for ( property in this._valuesEnd ) {
-
- var start = this._valuesStart[ property ] || 0;
- var end = this._valuesEnd[ property ];
-
- if ( end instanceof Array ) {
-
- this._object[ property ] = this._interpolationFunction( end, value );
-
- } else {
+ for (property in this._valuesEnd)
+ {
+ var start = this._valuesStart[property] || 0;
+ var end = this._valuesEnd[property];
+ if (end instanceof Array)
+ {
+ this._object[property] = this._interpolationFunction(end, value);
+ }
+ else
+ {
// Parses relative end values with start as base (e.g.: +10, -3)
- if ( typeof(end) === "string" ) {
+ if (typeof(end) === 'string')
+ {
end = start + parseFloat(end, 10);
}
// protect against non numeric properties.
- if ( typeof(end) === "number" ) {
- this._object[ property ] = start + ( end - start ) * value;
+ if (typeof(end) === 'number')
+ {
+ this._object[property] = start + ( end - start ) * value;
}
-
}
-
}
- if ( this._onUpdateCallback !== null ) {
-
- this._onUpdateCallback.call( this._object, value );
-
+ if (this._onUpdateCallback !== null)
+ {
+ this._onUpdateCallback.call(this._onUpdateCallbackContext, this, value);
}
- if ( elapsed == 1 ) {
-
- if ( this._repeat > 0 ) {
-
- if ( isFinite( this._repeat ) ) {
+ if (elapsed == 1)
+ {
+ if (this._repeat > 0)
+ {
+ if (isFinite(this._repeat))
+ {
this._repeat--;
}
// reassign starting values, restart by making startTime = now
- for ( property in this._valuesStartRepeat ) {
-
- if ( typeof( this._valuesEnd[ property ] ) === "string" ) {
- this._valuesStartRepeat[ property ] = this._valuesStartRepeat[ property ] + parseFloat(this._valuesEnd[ property ], 10);
+ for (property in this._valuesStartRepeat)
+ {
+ if (typeof(this._valuesEnd[property]) === 'string')
+ {
+ this._valuesStartRepeat[property] = this._valuesStartRepeat[property] + parseFloat(this._valuesEnd[property], 10);
}
- if (this._yoyo) {
- var tmp = this._valuesStartRepeat[ property ];
- this._valuesStartRepeat[ property ] = this._valuesEnd[ property ];
- this._valuesEnd[ property ] = tmp;
+ if (this._yoyo)
+ {
+ var tmp = this._valuesStartRepeat[property];
+ this._valuesStartRepeat[property] = this._valuesEnd[property];
+ this._valuesEnd[property] = tmp;
this._reversed = !this._reversed;
}
- this._valuesStart[ property ] = this._valuesStartRepeat[ property ];
+ this._valuesStart[property] = this._valuesStartRepeat[property];
}
this._startTime = time + this._delayTime;
- this.onComplete.dispatch(this._object);
-
- if ( this._onCompleteCallback !== null ) {
- this._onCompleteCallback.call( this._object );
- }
+ this.onLoop.dispatch(this._object);
return true;
- } else {
-
+ }
+ else
+ {
this.isRunning = false;
this.onComplete.dispatch(this._object);
- if ( this._onCompleteCallback !== null ) {
- this._onCompleteCallback.call( this._object );
- }
-
- for ( var i = 0, numChainedTweens = this._chainedTweens.length; i < numChainedTweens; i ++ ) {
-
- this._chainedTweens[ i ].start( time );
-
+ for (var i = 0, numChainedTweens = this._chainedTweens.length; i < numChainedTweens; i ++)
+ {
+ this._chainedTweens[i].start(time);
}
return false;
-
}
}
@@ -1031,6 +992,8 @@ Phaser.Tween.prototype = {
}
};
+
+Phaser.Tween.prototype.constructor = Phaser.Tween;
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/TweenManager.js.html b/docs/TweenManager.js.html index b705ba69..07e47e17 100644 --- a/docs/TweenManager.js.html +++ b/docs/TweenManager.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -451,13 +445,13 @@ Phaser.TweenManager = function (game) {
this.game = game;
/**
- * @property {array} _tweens - Description.
+ * @property {array<Phaser.Tween>} _tweens - All of the currently running tweens.
* @private
*/
this._tweens = [];
/**
- * @property {array} _add - Description.
+ * @property {array<Phaser.Tween>} _add - All of the tweens queued to be added in the next update.
* @private
*/
this._add = [];
@@ -469,13 +463,6 @@ Phaser.TweenManager = function (game) {
Phaser.TweenManager.prototype = {
- /**
- * Version number of this library.
- * @property {string} REVISION
- * @default
- */
- REVISION: '11dev',
-
/**
* Get all the tween objects in an array.
* @method Phaser.TweenManager#getAll
@@ -488,12 +475,17 @@ Phaser.TweenManager.prototype = {
},
/**
- * Remove all tween objects.
+ * Remove all tweens running and in the queue. Doesn't call any of the tween onComplete events.
* @method Phaser.TweenManager#removeAll
*/
removeAll: function () {
- this._tweens = [];
+ for (var i = 0; i < this._tweens.length; i++)
+ {
+ this._tweens[i].pendingDelete = true;
+ }
+
+ this._add = [];
},
@@ -504,9 +496,9 @@ Phaser.TweenManager.prototype = {
* @param {Phaser.Tween} tween - The tween object you want to add.
* @returns {Phaser.Tween} The tween object you added to the manager.
*/
- add: function ( tween ) {
+ add: function (tween) {
- this._add.push( tween );
+ this._add.push(tween);
},
@@ -529,14 +521,13 @@ Phaser.TweenManager.prototype = {
* @method Phaser.TweenManager#remove
* @param {Phaser.Tween} tween - The tween object you want to remove.
*/
- remove: function ( tween ) {
+ remove: function (tween) {
- var i = this._tweens.indexOf( tween );
-
- if ( i !== -1 ) {
+ var i = this._tweens.indexOf(tween);
+ if (i !== -1)
+ {
this._tweens[i].pendingDelete = true;
-
}
},
@@ -549,7 +540,7 @@ Phaser.TweenManager.prototype = {
*/
update: function () {
- if ( this._tweens.length === 0 && this._add.length === 0 )
+ if (this._tweens.length === 0 && this._add.length === 0)
{
return false;
}
@@ -557,20 +548,18 @@ Phaser.TweenManager.prototype = {
var i = 0;
var numTweens = this._tweens.length;
- while ( i < numTweens ) {
-
- if ( this._tweens[ i ].update( this.game.time.now ) ) {
-
+ while (i < numTweens)
+ {
+ if (this._tweens[i].update(this.game.time.now))
+ {
i++;
-
- } else {
-
- this._tweens.splice( i, 1 );
+ }
+ else
+ {
+ this._tweens.splice(i, 1);
numTweens--;
-
}
-
}
// If there are any new tweens to be added, do so now - otherwise they can be spliced out of the array before ever running
@@ -606,7 +595,8 @@ Phaser.TweenManager.prototype = {
*/
pauseAll: function () {
- for (var i = this._tweens.length - 1; i >= 0; i--) {
+ for (var i = this._tweens.length - 1; i >= 0; i--)
+ {
this._tweens[i].pause();
}
@@ -619,13 +609,17 @@ Phaser.TweenManager.prototype = {
*/
resumeAll: function () {
- for (var i = this._tweens.length - 1; i >= 0; i--) {
+ for (var i = this._tweens.length - 1; i >= 0; i--)
+ {
this._tweens[i].resume();
}
}
-};
+};
+
+Phaser.TweenManager.prototype.constructor = Phaser.TweenManager;
+
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/Utils.js.html b/docs/Utils.js.html index 4dd4ef8d..abbfff1f 100644 --- a/docs/Utils.js.html +++ b/docs/Utils.js.html @@ -90,6 +90,10 @@ Device +
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/World.js.html b/docs/World.js.html index 94cc8e92..dc04dbad 100644 --- a/docs/World.js.html +++ b/docs/World.js.html @@ -90,6 +90,10 @@ Device +
/**
* @author Richard Davey <rich@photonstorm.com>
-* @copyright 2013 Photon Storm Ltd.
+* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
@@ -435,6 +429,7 @@
* the world at world-based coordinates. By default a world is created the same size as your Stage.
*
* @class Phaser.World
+* @extends Phaser.Group
* @constructor
* @param {Phaser.Game} game - Reference to the current game instance.
*/
@@ -442,11 +437,6 @@ Phaser.World = function (game) {
Phaser.Group.call(this, game, null, '__world', false);
- /**
- * @property {Phaser.Point} scale - Replaces the PIXI.Point with a slightly more flexible one.
- */
- this.scale = new Phaser.Point(1, 1);
-
/**
* The World has no fixed size, but it does have a bounds outside of which objects are no longer considered as being "in world" and you should use this to clean-up the display list and purge dead objects.
* By default we set the Bounds to be from 0,0 to Game.width,Game.height. I.e. it will match the size given to the game constructor with 0,0 representing the top-left of the display.
@@ -488,34 +478,21 @@ Phaser.World.prototype.boot = function () {
}
/**
-* This is called automatically every frame, and is where main logic happens.
+* This is called automatically after the plugins preUpdate and before the State.update.
+* Most objects have preUpdate methods and it's where initial movement, drawing and calculations are done.
*
* @method Phaser.World#update
*/
-Phaser.World.prototype.update = function () {
-
- this.currentRenderOrderID = 0;
+Phaser.World.prototype.preUpdate = function () {
if (this.game.stage._stage.first._iNext)
{
var currentNode = this.game.stage._stage.first._iNext;
- var skipChildren;
do
{
- skipChildren = false;
-
- if (currentNode['preUpdate'])
- {
- skipChildren = (currentNode.preUpdate() === false);
- }
-
- if (currentNode['update'])
- {
- skipChildren = (currentNode.update() === false) || skipChildren;
- }
-
- if (skipChildren)
+ // If preUpdate exists, and it returns false, skip PIXI child objects
+ if (currentNode['preUpdate'] && !currentNode.preUpdate())
{
currentNode = currentNode.last._iNext;
}
@@ -531,48 +508,123 @@ Phaser.World.prototype.update = function () {
}
/**
-* This is called automatically every frame, and is where main logic happens.
-* @method Phaser.World#postUpdate
+* This is called automatically after the State.update, but before particles or plugins update.
+* Most objects won't have an update method set unless explicitly given one.
+*
+* @method Phaser.World#update
*/
-Phaser.World.prototype.postUpdate = function () {
+Phaser.World.prototype.update = function () {
+ this.currentRenderOrderID = 0;
+
if (this.game.stage._stage.first._iNext)
{
var currentNode = this.game.stage._stage.first._iNext;
do
{
- if (currentNode['postUpdate'])
+ // If update exists, and it returns false, skip PIXI child objects
+ if (currentNode['update'] && !currentNode.update())
{
- currentNode.postUpdate();
+ currentNode = currentNode.last._iNext;
+ }
+ else
+ {
+ currentNode = currentNode._iNext;
}
- currentNode = currentNode._iNext;
}
while (currentNode != this.game.stage._stage.last._iNext)
}
- this.camera.update();
+}
+
+/**
+* This is called automatically before the renderer runs and after the plugins have updated.
+* In postUpdate this is where all the final physics calculatations and object positioning happens.
+* The objects are processed in the order of the display list.
+* The only exception to this is if the camera is following an object, in which case that is updated first.
+*
+* @method Phaser.World#postUpdate
+*/
+Phaser.World.prototype.postUpdate = function () {
+
+ if (this.camera.target && this.camera.target['postUpdate'])
+ {
+ this.camera.target.postUpdate();
+
+ this.camera.update();
+
+ if (this.game.stage._stage.first._iNext)
+ {
+ var currentNode = this.game.stage._stage.first._iNext;
+
+ do
+ {
+ if (currentNode['postUpdate'] && currentNode !== this.camera.target)
+ {
+ currentNode.postUpdate();
+ }
+
+ currentNode = currentNode._iNext;
+ }
+ while (currentNode != this.game.stage._stage.last._iNext)
+ }
+ }
+ else
+ {
+ this.camera.update();
+
+ if (this.game.stage._stage.first._iNext)
+ {
+ var currentNode = this.game.stage._stage.first._iNext;
+
+ do
+ {
+ if (currentNode['postUpdate'])
+ {
+ currentNode.postUpdate();
+ }
+
+ currentNode = currentNode._iNext;
+ }
+ while (currentNode != this.game.stage._stage.last._iNext)
+ }
+ }
+
}
/**
* Updates the size of this world. Note that this doesn't modify the world x/y coordinates, just the width and height.
-* If you need to adjust the bounds of the world
+*
* @method Phaser.World#setBounds
* @param {number} x - Top left most corner of the world.
* @param {number} y - Top left most corner of the world.
-* @param {number} width - New width of the world.
-* @param {number} height - New height of the world.
+* @param {number} width - New width of the world. Can never be smaller than the Game.width.
+* @param {number} height - New height of the world. Can never be smaller than the Game.height.
*/
Phaser.World.prototype.setBounds = function (x, y, width, height) {
+ if (width < this.game.width)
+ {
+ width = this.game.width;
+ }
+
+ if (height < this.game.height)
+ {
+ height = this.game.height;
+ }
+
this.bounds.setTo(x, y, width, height);
if (this.camera.bounds)
{
+ // The Camera can never be smaller than the game size
this.camera.bounds.setTo(x, y, width, height);
}
+ this.game.physics.setBoundsToWorld();
+
}
/**
@@ -722,13 +774,13 @@ Object.defineProperty(Phaser.World.prototype, "visible", {
- Phaser Copyright © 2012-2013 Photon Storm Ltd.
+ Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev
- on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template.
+ on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template.
diff --git a/docs/build/build dev.bat b/docs/build/build dev.bat
deleted file mode 100644
index 144602f1..00000000
--- a/docs/build/build dev.bat
+++ /dev/null
@@ -1 +0,0 @@
-jsdoc -c conf_dev.json
\ No newline at end of file
diff --git a/docs/build/build master.bat b/docs/build/build master.bat
index 25b9d2c4..a1279222 100644
--- a/docs/build/build master.bat
+++ b/docs/build/build master.bat
@@ -1 +1 @@
-jsdoc -c conf.json
\ No newline at end of file
+jsdoc -c conf.json ../../README.md
\ No newline at end of file
diff --git a/docs/build/conf.json b/docs/build/conf.json
index 95acdf2a..b965156b 100644
--- a/docs/build/conf.json
+++ b/docs/build/conf.json
@@ -5,7 +5,6 @@
"source": {
"include": [
"../../src/Phaser.js",
- "../../src/IntroDocs.js",
"../../src/animation/",
"../../src/core/",
"../../src/gameobjects/",
@@ -36,7 +35,7 @@
},
"systemName" : "Phaser",
"footer" : "",
- "copyright" : "Phaser Copyright © 2012-2013 Photon Storm Ltd.",
+ "copyright" : "Phaser Copyright © 2012-2014 Photon Storm Ltd.",
"navType" : "vertical",
"theme" : "cerulean",
"linenums" : true,
diff --git a/docs/build/conf_dev.json b/docs/build/conf_dev.json
deleted file mode 100644
index 95acdf2a..00000000
--- a/docs/build/conf_dev.json
+++ /dev/null
@@ -1,58 +0,0 @@
-{
- "tags": {
- "allowUnknownTags": true
- },
- "source": {
- "include": [
- "../../src/Phaser.js",
- "../../src/IntroDocs.js",
- "../../src/animation/",
- "../../src/core/",
- "../../src/gameobjects/",
- "../../src/geom/",
- "../../src/input/",
- "../../src/loader/",
- "../../src/math/",
- "../../src/net/",
- "../../src/particles/",
- "../../src/physics/arcade/",
- "../../src/sound/",
- "../../src/system/",
- "../../src/tilemap/",
- "../../src/time/",
- "../../src/tween/",
- "../../src/utils/"
- ],
- "exclude": [],
- "includePattern": ".+\\.js(doc)?$",
- "excludePattern": "(^|\\/|\\\\)_"
- },
- "plugins" : ["plugins/markdown"],
- "templates": {
- "cleverLinks" : false,
- "monospaceLinks" : false,
- "default" : {
- "outputSourceFiles" : true
- },
- "systemName" : "Phaser",
- "footer" : "",
- "copyright" : "Phaser Copyright © 2012-2013 Photon Storm Ltd.",
- "navType" : "vertical",
- "theme" : "cerulean",
- "linenums" : true,
- "collapseSymbols" : false,
- "inverseNav" : true
- },
- "markdown" : {
- "parser" : "gfm",
- "hardwrap" : true
- },
- "opts": {
- "template": "docstrap-master/template/",
- "encoding": "utf8",
- "destination": "../",
- "recurse": true,
- "private": false,
- "lenient": true
- }
-}
\ No newline at end of file
diff --git a/docs/classes.list.html b/docs/classes.list.html
index 6dc2e9d4..411a0665 100644
--- a/docs/classes.list.html
+++ b/docs/classes.list.html
@@ -90,6 +90,10 @@
Device
+ Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/global.html b/docs/global.html index d6ada66d..36df3ad4 100644 --- a/docs/global.html +++ b/docs/global.html @@ -90,6 +90,10 @@ Device +
- - bottom + hex2rgb
- @@ -389,15 +413,11 @@
- - render + x
- - renderXY - - -
- - right + y @@ -486,7 +506,7 @@
-
-
bottom() → {number}
+hex2rgb(hex)
@@ -494,95 +514,7 @@
- Source: -
- - - - - - - - -
- - Type - -
- - -number - - - -
-
-
bottom(value)
- - -
- -
-
-
- -@@ -616,13 +548,13 @@
The sum of the y and height properties. Changing the bottom property of a Rectangle object has no effect on the x, y and width properties, but does change the height property.
+Converts a hex color number to an [R, G, B] array
- valuehex-number +Number @@ -664,7 +596,7 @@ - Source:
- @@ -782,7 +714,7 @@
- Source:
- @@ -829,473 +761,13 @@
- -
render(displayObject, position, clear)
+x() → {number}
- -
- - - --- - - - - - - -This function will draw the display object to the texture. If the display object is a Group or has children it will -draw all children as well.
-Parameters:
- - -- -
- - - - -- - - - - - - -Name - - -Type - - -Argument - - - -Default - - -Description -- - - - - -displayObject- - -DisplayObject - - - - - - -- - - - - - - - - -- - - - -The display object to render this texture on.
- - - - - -position- - -Phaser.Point - - - - - - -- - <optional> - - - -
- - - - - -- - - - -Where to draw the display object.
- - - - - -clear- - -boolean - - - - - - -- - <optional> - - - -
- - - - - -- - false - - - - -If true the texture will be cleared before the displayObject is drawn.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
- -
-renderXY(displayObject, x, y, clear)
- - -- - - -
- - - --- - - - - - - -This function will draw the display object to the texture at the given x/y coordinates. -If the display object is a Group or has children it will draw all children as well.
-Parameters:
- - -- -
- - - - -- - - - - - - -Name - - -Type - - -Argument - - - -Default - - -Description -- - - - - -displayObject- - -DisplayObject - - - - - - -- - - - - - - - - -- - - - -The display object to render this texture on.
- - - - - -x- - -number - - - - - - -- - - - - - - - - -- - - - -The x coordinate to draw the display object at.
- - - - - -y- - -number - - - - - - -- - - - - - - - - -- - - - -The y coordinate to draw the display object at.
- - - - - -clear- - -boolean - - - - - - -- - <optional> - - - -
- - - - - -- - false - - - - -If true the texture will be cleared before the displayObject is drawn.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - - - - - - - -
- -
-right() → {number}
- - -- - - -
-- @@ -1326,7 +798,7 @@ However it does affect the width property.The sum of the x and width properties. Changing the right property of a Rectangle object has no effect on the x, y and height properties. -However it does affect the width property.
-- Source:
- @@ -1373,18 +845,13 @@ However it does affect the width property.
- -
right(value)
+x(value)
- -
-- @@ -1464,7 +931,205 @@ However it does affect the width property.The sum of the x and width properties. Changing the right property of a Rectangle object has no effect on the x, y and height properties. -However it does affect the width property.
-- Source:
- + + + + + + + + + + + + + + + + + + + + + + + + + +
- +
+y() → {number}
+ + +- + + + + + + + + + + +
+ + + +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Returns:
+ + + + +-
+
- + Type + +
- + +number + + + +
- +
+y(value)
+ + +- + + + + + + + + +
Parameters:
+ + ++ +
+ + + + ++ + + + + + + +Name + + +Type + + + + + +Description ++ + + + + +value+ + +number + + + + + + + + + ++ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- @@ -1509,13 +1174,13 @@ However it does affect the width property. - Phaser Copyright © 2012-2013 Photon Storm Ltd. + Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:20:17 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/index.html b/docs/index.html index f483d9dc..0af4ffc2 100644 --- a/docs/index.html +++ b/docs/index.html @@ -90,6 +90,10 @@ Device +- + DOMSprite +
+- Easing
@@ -162,6 +166,14 @@ GameObjectFactory +- + Gamepad +
+ +- + GamepadButton +
+- Graphics
@@ -186,6 +198,10 @@ Keyboard +- + Line +
+- LinkedList
@@ -278,6 +294,10 @@ Signal +- + SinglePad +
+- Sound
@@ -342,6 +362,10 @@ Timer +- + TimerEvent +
+- Touch
@@ -374,36 +398,6 @@ -- - Global - - -
- @@ -440,102 +434,333 @@ ++ - - - - -
+
Phaser 1.1.4
+Phaser is a fast, free and fun open source game framework for making desktop and mobile browser HTML5 games. It uses Pixi.js internally for fast 2D Canvas and WebGL rendering.
+Version: 1.1.4 "Kandor" - Released: February 5th 2014
+By Richard Davey, Photon Storm
+-
+
- View the Official Website +
- Follow on Twitter +
- Join the Forum +
- Try out 220+ Phaser Examples +
- Read the documentation online +
Subscribe to our new Phaser Newsletter. We'll email you when new versions are released as well as send you our regular Phaser game making magazine.
+
+
Welcome to Phaser
+As you may know we had planned to release 1.1.4 at the end of 2013. For various reasons this didn't quite happen, but we're happy to announce it's finally out! There have been some dramatic changes internally, and if you make use of either the physics systems or tilemaps then you are going to need to update your code. Hopefully only a little bit, but there have been a number of core API changes which we detail below. There are also a host of new features, the headliners being:
+-
+
- New Physics system. Uses SAT.js internally so physics bodies can now be rectangles, circles or polygons and support rotation. +
- New Tilemap system. Brand new collision system for tiles, much more advanced layer handling, tile properties, multiple tilesets of layer and more. +
- New Timer. This handy new class lets you create timed events easily. +
- Your Game can now be configured from an external configuration object. +
- Over 150 new features and updates and over 30 reported bug fixes. +
This release also brings the TypeScript definitions file as bang up to date as possible. There are still a few areas that need looking at, but with your help hopefully we can iron those final few bits out and have a 100% accruate defs file on offer.
+There is a new Contributors Guide which we'd urge you to follow if you wish to help with Phaser development, and we've updated the doc files and added lots more details into key areas. The Examples have grown too! Now over 220 of them including several great ones from the community.
+We're going to settle on this build for a short while as we do some quick iteration bug fixing, so expect to see some small point releases very soon that do nothing but address any issues you may find. But in parallel to this we are also now rebuilding our core to bring it in-line with the latest version of Pixi.js, which has had some dramatic changes under the hood, changes will impact a lot of what Phaser does internally. But the changes are all for the better and once we upgrade Pixi you'll have a significantly faster renderer and a smaller codebase too, as we do away with stacks of linked list code :)
+As always we offer a heart-felt "Thank you!" to everyone who has encouraged us along the way. To those of you who worked with Phaser during its various incarnations. The number of games being released that were made with Phaser is staggering and we really love to see how you use it! You are our heroes. It's your kind words and enthusiasm that has keeps us going.
+Phaser is everything we ever wanted from an HTML5 game framework. It powers all of our client work in build today and remains our single most important product, and we've still only just scratched the surface of what we have planned for it.
+
+
Getting Started Guides
+We have a new Getting Started Guide which covers all you need to begin developing games with Phaser. From setting up a web server to picking an IDE. If you're new to HTML5 game development, or are coming from another language like AS3, then we recommend starting there.
+There is a comprehensive How to Learn Phaser guide on the GameDevTuts+ site which is a great place to learn where to find tutorials, examples and support.
+There is also an un-official Getting Started Guide.
+Change Log
+Version 1.1.4 - "Kandor" - February 5th 2014
+Significant API changes:
+-
+
- Loader.tileset has been removed as it's no longer required, this was as part of the Tilemap system overhaul. +
- TilemapLayers are now created via the Tilemap object itself: map.createLayer(x, y, width, height, tileset, layer, group) and no longer via the GameObjectFactory. +
- Tilemap.createFromObjects can now turn a bunch of Tiled objects into Sprites in one single call, and copies across all properties as well. +
- Tween.onStartCallback and onCompleteCallback have been removed to avoid confusion. You should use the onStart, onLoop and onComplete events instead. +
- Button.forceOut default value has changed from true to false, so Buttons will revert to an Up state (if set) when pressed and released. +
- The way the collision process callback works has changed significantly and now works as originally intended. +
- The World level quadtree is no longer created, they are now built and ripped down each time you collide a Group, this helps collision accuracy. +
- A SAT system has been integrated for Body collision and separation. +
- Bodies are no longer added to a world quadtree, so have had all of their quadtree properties removed such as skipQuadtree, quadTreeIndex, etc. +
- Body.drag has been removed. Please use the new Body.linearDamping value instead (which is a number value, not a Point object) +
- Body.embedded and Body.wasTouching have been removed as they are no longer required. +
- Body.customSeparateX/Y have been removed as you should now use Body.customSeparateCallback. +
- Body.maxVelocity defaults have been removed from 10,000 to 2000. +
- Body.customSeparateCallback allows you to set your own callback when two Bodies need to separate rather than using the built-in method. +
- Body.collideCallback allows you to set a callback that is fired whenever the Body is hit on any of its active faces. +
- Body.allowCollision has been renamed to Body.checkCollision. +
- Body.rebound is a boolean that controls if a body will exchange velocity on collision. Set to false to allow it to be 'pushed' (see new examples). +
- Removed Body.deltaAbsX and deltaAbsY as they are no longer used internally. +
- Body.screenX and screenY moved to getters, no longer calculated every frame. +
- ArcadePhysics now has setBounds and setBoundsToWorld, and you can specify which walls are created or not (left, right, up, down) +
- Removed: Debug.renderSpriteTouching, Debug.renderLocalTransformInfo, Debug.renderWorldTransformInfo, Debug.renderSpriteCollision and Debug.dumpLinkedList. +
- Body.setSize has been removed. Please use Body.setCircle, setRectangle or setPolygon instead. +
New features:
+-
+
- Phaser.Timer is now feature complete and fully documented. You can create Phaser.TimerEvents on a Timer and lots of new examples have been provided. +
- Gamepad API support has been added with lots of new examples (thanks Karl Macklin) +
- Phaser.Game constructor can now be passed a single object containing all of your game settings + Stage settings. Useful for advanced configurations. +
- The width/height given to Phaser.Game can now be percentages, i.e. "100%" will set the width to the maximum window innerWidth. +
- Added a stage.fullScreenScaleMode property to determine scaling when fullscreen (thanks oysterCrusher) +
- Added support for margin and spacing around a frame in Loader.spritesheet. +
- Added Device.vibration to check if the Vibration API is available or not. +
- Added Device.trident and Device.tridentVersion for testing IE11. +
- Added Device.silk for detecting a Kindle Fire and updated desktop OS check to exclude Kindles (thanks LuckieLordie) +
- TilemapLayers now have debug and debugAlpha values, this turns on the drawing of the collision edges (very handy for debugging, as the name implies!) +
- Tweens have a new event: onLoop. +
- You can now load any binary file via the Loader: game.load.binary(key, url, callback) - the optional callback allows for post-load processing before entering the Cache. +
- Group.set will let you deep set a new propery on a single child of the Group. +
- Stage.display property added. A direct reference to the root Pixi Stage object (very useful for RenderTexture manipulation) +
- Added Ejecta detection to Device (thanks endel) +
- Tweens can now work with relative + and - values. You can do:
tween(sprite).to( { x: '+400' })and it will add 400 to the current sprite.x value.
+ - Buttons now properly use their upFrame if set. +
- InputHandler now has snapOffsetX and snapOffsetY properties so your snap grid doesn't have to be 0,0 aligned (thanks srmeier) +
- Loader.progressFloat contains the actual non-rounded progress value, where-as Loader.progress contains a rounded value. Use progressFloat if you've > 100 files to load. +
- Groups can now be added to other Groups as children via group.add() and group.addAt() +
- Groups now have an 'alive' property, which can be useful when iterating through child groups with functions like forEachAlive. +
- Added a new Project Template "Full Screen Mobile" which you can find in the resources folder. Contains html / css / layout needed for a deployed Phaser game. +
- Body.speed - the current speed of the body. +
- Body.angle - the current angle the Body is facing based on its velocity. This is not the same as the Sprite angle that may own the body. +
- Body.linearDamping - This now replaces Body.drag and provides for a much smoother damping (friction) experience. +
- Body.minBounceVelocity - If a Body has bounce set, this threshold controls if it should rebound or not. Use it to stop 'jittering' on bounds/tiles with super-low velocities. +
- QuadTree.populate - you can pass it a Group and it'll automatically insert all of the children ready for inspection. +
- Input.setMoveCallback allows you to set a callback that will be fired each time the activePointer receives a DOM move event. +
- Math.distancePow(x1,y1,x2,y2,power) returns the distance between two coordinates at the given power. +
- Physics.collide now supports the 2nd parameter as an array, for when you want to collide an object against a number of sprites that aren't all in the same Group. +
- Physics.overlap now supports the 2nd parameter as an array, for when you want to overlap test an object against a number of sprites that aren't all in the same Group. +
- Math.reverseAngle - reverses an angle (in radians). +
- Math.normalizeAngle - normalises an angle, now in radians only. +
- Math.normalizeLatitude - Normalizes a latitude to the [-90,90] range. +
- Math.normalizeLongitude - Normalizes a longitude to the [-180,180] range. +
- Phaser.Line added to the geometry classes, with full point on line/segment and intersection tests (see new examples) +
- Phaser.CANVAS_PX_ROUND is a boolean. If 'true' the Canvas renderer will Math.floor() all coordinates before drawImage, stopping pixel interpolation. Defaults to false. +
- Phaser.CANVAS_CLEAR_RECT is a boolean. If 'true' (the default) it will context.clearRect() every frame. If false this is skipped (useful if you know you don't need it) +
- Collision now works between Sprites positioned via sprite.x/y, sprite.body.x/y or sprite.body.velocity. +
- If you are tweening a sprite and still want physics collision, set
sprite.body.moves = falseotherwise it will fight against the tween motion.
+ - Game.enableStep will enable core game loop stepping. When enabled you must call game.step() directly (perhaps via a DOM button?), very useful for debugging! +
- Game.disableStep turns core update loop stepping off. +
- Debug.renderPhysicsBody(body, color) is extremely useful for debugging the new physics bodies. Will draw the outline + points in the color given. +
- Debug.renderBodyInfo(sprite, x, y, color) will display lots of Sprite body data. +
- Sprite.events.onBeginContact will be fired when a Body makes contact with another Body. Once contact is over an onEndContact event will be dispatched. +
New Examples:
+-
+
- Physics - Bounce by Patrick OReilly. +
- Physics - Bounce with gravity by Patrick OReilly. +
- Physics - Bounce accelerator (use the keyboard) by Patrick OReilly. +
- Physics - Bounce knock (use the keyboard) by Patrick OReilly. +
- Physics - Snake (use the keyboard to control the snake like creature) by Patrick OReilly and Richard Davey. +
- Physics - Launcher - Angry Birds style ball launcher demo by Patrick OReilly. +
- Physics - Launcher Follow - throw the sprite anywhere in the world by Patrick OReilly. +
- Physics - Launcher Follow World - an advanced version of the Launcher Follow example by Patrick OReilly. +
- Input - Touch Joystick example showing how to use the clay.io virtual game controller (thanks gabehollombe) +
- Games - Matching Pairs by Patrick OReilly. +
- Games - Simon Says by Patrick OReilly. +
- Games - Wabbits by Patrick OReilly. +
- Tweens - Example showing how to use the tween events, onStart, onLoop and onComplete. +
- Display - Pixi Render Texture. A Phaser conversion of the Pixi.js Render Texture example. +
- Input - 5 new examples showing how to use the Gamepad API (thanks Karl Macklin) +
- Animation - Group Creation, showing how to create animations across all Group children in one call. +
- Particles - Rain by Jens Anders Bakke. +
- Particles - Snow by Jens Anders Bakke. +
- Groups - Nested Groups - showing how to embed one Group into another Group. +
- Time - Lots of new examples showing how to use the updated Phaser.Timer class. +
Updates:
+-
+
- Updated to latest Pixi.js dev branch build (pre 1.4 release) +
- When a Sprite is destroyed any active filters are removed at the same time. +
- Updated Pixi.js so that removing filters now works correctly without breaking the display list. +
- Phaser.Canvas.create updated so it can be given an ID as the 3rd parameter (can also be set via new Game configuration object). +
- Updated display/fullscreen example to reflect new full screen change. +
- Loads of updates to the TypeScript definitions files - games fully compile now and lots of missing classes added :) (thanks Niondir) +
- Removed 'null parent' check from Group constructor. Will parent to game.world only if parent value is undefined. +
- The tutorials have now been translated into Spanish - thanks feiss :) +
- separateY updated to re-implement the 'riding platforms' special condition (thanks cocoademon) +
- SoundManager.onSoundDecode now dispatches the key followed by the sound object, also now dispatched by the Cache when doing an auto-decode on load. +
- Switch method of using trimmed sprites to support scaling and rotation (thanks cocoademon) +
- Most of the GameObjectFactory functions now have a group parameter, so you can do: game.add.sprite(x, y, frame, frameName, group) rather than defaulting to the World group. +
- Group.countLiving and countDead used to return -1 if the Group was empty, but now return 0. +
- Text can now be fixedToCamera, updated world/fixed to camera example to show this. +
- ArcadePhysics.overlap and collide now recognise TileSprites in the collision checks. +
- Lots of documentation fixes in the Tween class. +
- Tweens fire an onLoop event if they are set to repeat. onComplete is now only fired for the final repeat (or never if the repeat is infinite) +
- Pointer used to un-pause a paused game every time it was clicked/touched (this avoided some rogue browser plugins). Now only happens if Stage.disableVisibilityChange is true. +
- Input doesn't set the cursor to default if it's already set to none. +
- You can now collide a group against itself. This will check all children against each other, but not themselves (thanks cocoademon) +
- RenderTexture.render / renderXY has a new parameter: renderHidden, a boolean which will allow you to render Sprites even if their visible is set to false. +
- Added in prototype.constructor definitions to every class (thanks darkoverlordofdata) +
- Group.destroy has a new parameter: destroyChildren (boolean) which will optionally call the destroy method of all Group children. +
- Button.clearFrames method has been added. +
- Device.quirksMode is a boolean that informs you if the page is in strict (false) or quirks (true) mode. +
- Canvas.getOffset now runs a strict/quirks check and uses document.documentElement when calculating scrollTop and scrollLeft to avoid Chrome console warnings. +
- The Time class now has its own Phaser.Timer which you can access through game.time.events. See the new Timer examples to show how to use them. +
- Added StateManager.getCurrentState to return the currently running State object (thanks Niondir) +
- Removed the console.log redirect from Utils as it was messing with Firefox. +
- Body.acceleration is now much smoother and less eratic at high speeds. +
- Removed ArcadePhysics binding to the QuadTree, so it can now be used independantly of the physics system. +
- Removed ArcadePhysics.preUpdate and postUpdate as neither are needed any more. +
- Body.bottom and Body.right are no longer rounded, so will give accurate sub-pixel values. +
- Fixed lots of documentation in the Emitter class. +
- The delta timer value used for physics calculations has had its cap limit modified from 1.0 to 0.05 in line with the core updates. +
- Phaser.Math.min enhanced so you can now pass in either an array of numbers or lots of numbers as parameters to get the lowest. +
- Phaser.Math.max added as the opposite of Math.min. +
- Phaser.Math.minProperty and maxProperty added. Like Math.min/max but can be given a property an an array or list of objects to inspect. +
- Added 'full' paramter to Body.reset, allowing you to control if motion or all data is reset or not. +
- Exposed Group.pivot and Sprite.pivot to allow you to directly set the pivot points for rotation. +
- Swapped to using the native and faster Array.isArray check. +
- Added callback context parameter to Tween.onUpdateCallback(callback, context) to avoid having to bind or create anonymous functions. +
- Updated TweenManager.removeAll so it flags all tweens as pendingDelete rather than nuking the array, to avoid tween callback array size errors (thanks DarkDev) +
Bug Fixes:
+-
+
- Cache.getImageKeys returned __missing in the array, now excluded. +
- Fixed Group.scale so you can now scale a Group directly. +
- Removed World.scale as it was preventing Group.scale from working - you can still scale the world, but you'll need to factor in Input changes yourself. +
- Moved 'dirty' flag for Tilemap to a per-layer flag. Fixes #242 +
- Group.length now returns the number of children in the Group regardless of their exists/alive state, or 0 if the Group has no children. +
- Switch Camera.setBoundsToWorld to match world.bounds instead of world (thanks cocoademon) +
- Fixed an issue where passing null as the Group parent wouldn't set it to game.world as it should have (thanks tito100) +
- Fixed Pixi bug (#425) incorrect width property for multi-line BitmapText (thanks jcd-as) +
- Tween.onStart is now called when the tween starts AFTER the delay value, if given (thanks stevenbouma) +
- Sprites that are fixedToCamera can now be input dragged regardless of world position (thanks RafaelOliveira) +
- RenderTexture now displays correctly in Canvas games. +
- Canvas.addToDOM is now more robust when applying the overflowHidden style. +
- Fixed Pixi.StripShader which should stop the weird TileSprite GPU issues some were reporting (thanks GoodboyDigital) +
- Patched desyrel.xml so it doesn't contain any zero width/height characters, as they broke Firefox 25. +
- Cache.addSound now implements a locked attribute (thanks haden) +
- Sound now checks for CocoonJS during playback to avoid readyState clash (thanks haden) +
- Buttons now clear previously set frames correctly if you call setFrames. +
- Sounds will now loop correctly if they are paused and resumed (thanks haden) +
- InputHandler.checkBoundsRect and checkBoundsSprite now take into account if the Sprite is fixedToCamera or not. +
- Removed the frame property from TileSprites as it cannot use them, it tiles the whole image only, not just a section of it. +
- Fixed WebGLRenderer updateGraphics bug (thanks theadam) +
- Removed duplicate Timer.create line (thanks hstolte) +
- Fixed issue with the camera being slightly out of sync with 'fixedToCamera' sprites. +
- 1px camera jitter issue fixed where map is same size, or smaller than the game size. +
You can view the Change Log for all previous versions at https://github.com/photonstorm/phaser/changelog.md
+How to Build
+We provide a fully compiled version of Phaser in the
+builddirectory, in both plain and minified formats.We also provide a Grunt script that will build Phaser from source along with all the examples.
+Run
+gruntin the phaser folder for a list of command-line options.Koding
+You can ![clone the Phaser repo in Koding]koding and then start editing and previewing code right away using their web based VM development system.
+Bower
+If you use bowser you can install phaser with:
+
+bower install phaserNice and easy :)
+
+
CDNJS
+Thanks to a community member Phaser is now available on CDNJS. You can include the following in your html:
+
+http://cdnjs.cloudflare.com/ajax/libs/phaser/1.1.3/phaser.min.jsOr if you prefer you can leave the protocol off, so it works via http and https:
+
+//cdnjs.cloudflare.com/ajax/libs/phaser/1.1.3/phaser.min.jsRequirements
+Games created with Phaser require a modern web browser that supports the canvas tag. This includes Internet Explorer 9+, Firefox, Chrome, Safari and Opera. It also works on mobile web browsers including stock Android 2.x browser and above and iOS5 Mobile Safari and above.
+For developing with Phaser you can use either a plain-vanilla JavaScript approach or TypeScript using the provided TypeScript definitions file. We made no assumptions about how you like to code your games, and were careful not to impose any form of class/inheritance/structure upon you.
+Phaser is 321 KB minified and 72 KB gzipped.
+Learn By Example
+Phaser comes with an ever growing suite of Examples. Personally I feel that we learn better by looking at small refined code examples, so we created over 200 of them and create new ones to test every new feature added. Inside the
+examplesfolder you'll find the current set. If you write a particularly good example then please send it to us.The examples need to be run through a local web server (in order to avoid file access permission errors from your browser). You can use your own web server, or start the included web server using grunt.
+Using a locally installed web server browse to the examples folder:
+
+examples/index.htmlAlternatively in order to start the included web server, after you've cloned the repo, run
+npm installto install all dependencies, thengrunt connectto start a local server. After running this command you should be able to access your local webserver athttp://127.0.0.1:8000. Then browse to the examples folder:http://127.0.0.1:8000/examples/index.htmlThere is a new 'Side View' example viewer as well. This loads all the examples into a left-hand frame for faster navigation.
+You can also browse all Phaser Examples online.
+Features
+WebGL & Canvas
+Phaser uses both a Canvas and WebGL renderer internally and can automatically swap between them based on browser support. This allows for lightning fast rendering across Desktop and Mobile. When running under WebGL Phaser now supports shaders, allowing for some incredible in-game effects. Phaser uses and contributes towards the excellent Pixi.js library for rendering.
+Preloader
+We've made the loading of assets as simple as one line of code. Images, Sounds, Sprite Sheets, Tilemaps, JSON data, XML and JavaScrtip files - all parsed and handled automatically, ready for use in game and stored in a global Cache for Sprites to share.
+Physics
+Phaser ships with our Arcade Physics system. A SAT based collision and physics library perfect for low-powered devices and fast collision response. Control velocity, acceleration, bounce, damping and full collision and separation control. As of version 1.1.4 we now support rectangles, circles and polygon collision with full rotation.
+Sprites
+Sprites are the life-blood of your game. Position them, tween them, rotate them, scale them, animate them, collide them, paint them onto custom textures and so much more! +Sprites also have full Input support: click them, touch them, drag them around, snap them - even pixel perfect click detection if needed.
+Groups
+Group bundles of Sprites together for easy pooling and recycling, avoiding constant object creation. Groups can also be collided: for example a "Bullets" group checking for collision against the "Aliens" group, with a custom collision callback to handle the outcome.
+Animation
+Phaser supports classic Sprite Sheets with a fixed frame size, Texture Packer and Flash CS6/CC JSON files (both Hash and Array formats) and Starling XML files. All of these can be used to easily create animation for Sprites.
+Particles
+An Arcade Particle system is built-in, which allows you to create fun particle effects easily. Create explosions or constant streams for effects like rain or fire. Or attach the Emitter to a Sprite for a jet trail.
+Camera
+Phaser has a built-in Game World. Objects can be placed anywhere within the world and you've got access to a powerful Camera to look into that world. Pan around and follow Sprites with ease.
+Input
+Talk to a Phaser.Pointer and it doesn't matter if the input came from a touch-screen or mouse, it can even change mid-game without dropping a beat. Multi-touch, Mouse, Keyboard and lots of useful functions allow you to code custom gesture recognition.
+Sound
+Phaser supports both Web Audio and legacy HTML Audio. It automatically handles mobile device locking, easy Audio Sprite creation, looping, streaming and volume. We know how much of a pain dealing with audio on mobile is, so we did our best to resolve that!
+Tilemaps
+Phaser can load, render and collide with a tilemap with just a couple of lines of code. We support CSV and Tiled map data formats with multiple tile layers. There are lots of powerful tile manipulation functions: swap tiles, replace them, delete them, add them and update the map in realtime.
+Device Scaling
+Phaser has a built-in Scale Manager which allows you to scale your game to fit any size screen. Control aspect ratios, minimum and maximum scales and full-screen support.
+Plugin system
+We are trying hard to keep the core of Phaser limited to only essential classes, so we built a smart Plugin system to handle everything else. Create your own plugins easily and share them with the community.
+Mobile Browser
+Phaser was built specifically for Mobile web browsers. Of course it works blazingly fast on Desktop too, but unlike lots of frameworks mobile was our main focus. If it doesn't perform well on mobile then we don't add it into the Core.
+Developer Support
+We use Phaser every day on our many client projects. As a result it's constantly evolving and improving and we jump on bugs and pull requests quickly. This is a living, breathing framework maintained by a commercial company with custom feature development and support packages available. We live and breathe HTML5 games.
+Battle Tested
+Although Phaser 1.0 is a brand new release it is born from years of experience building some of the biggest mobile HTML5 games out there. We're not saying it is 100% bug free, but we use it for our client work every day, so issues get resolved <em>fast</em> and we stay on-top of the changing browser landscape.
+
+
Road Map
+Here is what's on our road map for the coming months:
+Version 1.1.5 ("Saldaea")
+-
+
- A fast turn-around point release that will focus on addressing any bugs that occured as a result of the large changes that took place in 1.1.4. +
Version 1.2 ("Shienar")
+-
+
- Update to Pixi 1.4 - this newly released build has lots of internal changes and new features we want to take advantage of. +
Version 1.3 ("Tarabon")
+-
+
- Enhance the State Management, so you can perform non-destructive State swaps and persistence. +
- Dedicated CocoonJS packaging features (screencanvas, etc) +
- A more advanced Particle system, one that can render to a single canvas (rather than spawn hundreds of Sprites), more advanced effects, etc. +
- Ability to control DOM elements from the core game and layer them into the game. +
- Touch Gestures. +
- Support for parallel asset loading. +
- Fixed width bitmap font support, plus enhanced Bitmap font rendering. +
Version 2.0 ("Aes Sedai")
+-
+
- Integrate p2.js physics system completely. +
- Comprehensive testing across Firefox OS devices, CocoonJS and Ejecta. +
- Integration with third party services like Google Play Game Services and Amazon JS SDK. +
- Flash CC HTML5 export integration. +
- Massively enhance the audio side of Phaser. Although it does what it does well, it could do with taking more advantage of Web Audio - echo effects, positional sound, etc. +
Beyond version 2.0
+-
+
- Test out packaging with Node-webkit. +
- Game parameters stored in Google Docs. +
- Look at HiDPI Canvas settings. +
- Multiple Camera support. +
Contributing
+We now have a full Contributors Guide which goes into the process in more detail, but here are the headlines:
+-
+
If you find a bug then please report it on GitHub Issues or our Support Forum.
+
+If you have a feature request, or have written a game or demo that shows Phaser in use, then please get in touch. We'd love to hear from you! Either post to our forum or email: rich@photonstorm.com
+
+If you issue a Pull Request for Phaser, please only do so againt the
+devbranch and not against themasterbranch.
+Before submitting a Pull Request please run your code through JSHint to check for stylistic or formatting errors. To use JSHint, first install it by running
+npm install jshint, then test your code by runningjshint src. This isn't a strict requirement and we are happy to receive Pull Requests that haven't been JSHinted, so don't let it put you off contributing, but do know that we'll reformat your source before going live with it.
+
Bugs?
+Please add them to the Issue Tracker with as much info as possible, especially source code demonstrating the issue.
+
+
"Being negative is not how we make progress" - Larry Page, Google
+License
+Phaser is released under the MIT License.
+Index
-- - @@ -547,13 +772,13 @@ and my love of game development originate. - Phaser Copyright © 2012-2013 Photon Storm Ltd. + Phaser Copyright © 2012-2014 Photon Storm Ltd.- - -- D:\wamp\www\phaser\src/IntroDocs.js -
- -- - -- - - - -- - - - - - - - - - - - - - - - - - -- - - -Phaser - http://www.phaser.io
-v1.1.3 - Released November 28th 2013.
-By Richard Davey http://www.photonstorm.com @photonstorm
-A feature-packed 2D HTML5 game framework born from the smouldering pits of Flixel and -constructed via plenty of blood, sweat, tears and coffee by Richard Davey (@photonstorm).
-Phaser uses Pixi.js for rendering, created by Mat Groves http://matgroves.com/ @Doormat23.
-Follow Phaser development progress at http://www.photonstorm.com
-Many thanks to Adam Saltsman (@ADAMATOMIC) for releasing Flixel, from both which Phaser -and my love of game development originate.
-"If you want your children to be intelligent, read them fairy tales." -"If you want them to be more intelligent, read them more fairy tales." - -- Albert Einstein
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source: -
- - IntroDocs.js, line 3 -
-
-
-
-
-
-
-
-
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:26 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/docs/namespaces.list.html b/docs/namespaces.list.html index b93eaf9e..f5a3ebbe 100644 --- a/docs/namespaces.list.html +++ b/docs/namespaces.list.html @@ -90,6 +90,10 @@ Device +- + DOMSprite +
+- Easing
@@ -162,6 +166,14 @@ GameObjectFactory +- + Gamepad +
+ +- + GamepadButton +
+- Graphics
@@ -186,6 +198,10 @@ Keyboard +- + Line +
+- LinkedList
@@ -278,6 +294,10 @@ Signal +- + SinglePad +
+- Sound
@@ -342,6 +362,10 @@ Timer +- + TimerEvent +
+- Touch
@@ -374,36 +398,6 @@ -- - Global - - -
- @@ -514,6 +508,9 @@- Device
+- DOMSprite
+ +- Easing
@@ -568,6 +565,12 @@- GameObjectFactory
+- Gamepad
+ + +- GamepadButton
+ +- Graphics
@@ -586,6 +589,9 @@- Keyboard
+- Line
+ +- LinkedList
@@ -655,6 +661,9 @@- Signal
+- SinglePad
+ +- Sound
@@ -703,6 +712,9 @@- Timer
+- TimerEvent
+ +- Touch
@@ -756,13 +768,13 @@ - Phaser Copyright © 2012-2013 Photon Storm Ltd. + Phaser Copyright © 2012-2014 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-dev - on Thu Nov 28 2013 15:56:25 GMT-0000 (GMT) using the DocStrap template. + on Wed Feb 05 2014 06:28:24 GMT-0000 (GMT) using the DocStrap template. diff --git a/src/IntroDocs.js b/src/IntroDocs.js index 1a1ac134..11c06cfb 100644 --- a/src/IntroDocs.js +++ b/src/IntroDocs.js @@ -7,23 +7,9 @@ /** * @overview * -* Phaser - http://www.phaser.io +* Many thanks to Adam Saltsman (@ADAMATOMIC) for creating Flixel, from which both Phaser and my love of game development originate. * -* v1.1.4 - Released February 5th 2014. -* -* By Richard Davey http://www.photonstorm.com @photonstorm -* -* A feature-packed 2D HTML5 game framework born from the smouldering pits of Flixel and -* constructed via plenty of blood, sweat, tears and coffee by Richard Davey (@photonstorm). -* -* Phaser uses Pixi.js for rendering, created by Mat Groves http://matgroves.com/ @Doormat23. -* -* Follow Phaser development progress at http://www.photonstorm.com -* -* Many thanks to Adam Saltsman (@ADAMATOMIC) for releasing Flixel, from which both Phaser -* and my love of game development originate. -* -* "If you want your children to be intelligent, read them fairy tales." -* "If you want them to be more intelligent, read them more fairy tales." +* "If you want your children to be intelligent, read them fairy tales."
+* "If you want them to be more intelligent, read them more fairy tales."
* -- Albert Einstein */ diff --git a/src/physics/arcade/ArcadePhysics.js b/src/physics/arcade/ArcadePhysics.js index 39bba8a6..cdbbfb40 100644 --- a/src/physics/arcade/ArcadePhysics.js +++ b/src/physics/arcade/ArcadePhysics.js @@ -866,7 +866,7 @@ Phaser.Physics.Arcade.prototype = { * The core separation function to separate a physics body and an array of tiles. * @method Phaser.Physics.Arcade#separateTiles * @param {Phaser.Physics.Arcade.Body} body - The Body object to separate. - * @param {array} tiles - The array of tiles to collide against. + * @param {array } tiles - The array of tiles to collide against. * @returns {boolean} Returns true if the body was separated, otherwise false. */ separateTiles: function (body, tiles) { diff --git a/src/physics/arcade/Body.js b/src/physics/arcade/Body.js index 183046f3..ae796a20 100644 --- a/src/physics/arcade/Body.js +++ b/src/physics/arcade/Body.js @@ -351,7 +351,7 @@ Phaser.Physics.Arcade.Body.prototype = { /** * Internal method that updates the Body scale in relation to the parent Sprite. * - * @method Phaser.Physics.Arcade#updateScale + * @method Phaser.Physics.Arcade.Body#updateScale * @protected */ updateScale: function () { @@ -373,7 +373,7 @@ Phaser.Physics.Arcade.Body.prototype = { /** * Internal method that updates the Body position in relation to the parent Sprite. * - * @method Phaser.Physics.Arcade#preUpdate + * @method Phaser.Physics.Arcade.Body#preUpdate * @protected */ preUpdate: function () { @@ -435,7 +435,7 @@ Phaser.Physics.Arcade.Body.prototype = { /** * Internal method that checks and potentially resets the blocked status flags. * - * @method Phaser.Physics.Arcade#checkBlocked + * @method Phaser.Physics.Arcade.Body#checkBlocked * @protected */ checkBlocked: function () { @@ -457,7 +457,7 @@ Phaser.Physics.Arcade.Body.prototype = { /** * Internal method that updates the left, right, top, bottom, width and height properties. * - * @method Phaser.Physics.Arcade#updateBounds + * @method Phaser.Physics.Arcade.Body#updateBounds * @protected */ updateBounds: function () { @@ -485,7 +485,7 @@ Phaser.Physics.Arcade.Body.prototype = { /** * Internal method that checks the acceleration and applies damping if not set. * - * @method Phaser.Physics.Arcade#applyDamping + * @method Phaser.Physics.Arcade.Body#applyDamping * @protected */ applyDamping: function () { @@ -517,7 +517,7 @@ Phaser.Physics.Arcade.Body.prototype = { /** * Check if we're below minVelocity and gravity isn't trying to drag us in the opposite direction. * - * @method Phaser.Physics.Arcade#reboundCheck + * @method Phaser.Physics.Arcade.Body#reboundCheck * @protected * @param {boolean} x - Check the X axis? * @param {boolean} y - Check the Y axis? @@ -576,7 +576,7 @@ Phaser.Physics.Arcade.Body.prototype = { /** * Gets the total force being applied on the X axis, including gravity and velocity. * - * @method Phaser.Physics.Arcade#getUpwardForce + * @method Phaser.Physics.Arcade.Body#getUpwardForce * @return {number} The total force being applied on the X axis. */ getUpwardForce: function () { @@ -595,7 +595,7 @@ Phaser.Physics.Arcade.Body.prototype = { /** * Gets the total force being applied on the X axis, including gravity and velocity. * - * @method Phaser.Physics.Arcade#getDownwardForce + * @method Phaser.Physics.Arcade.Body#getDownwardForce * @return {number} The total force being applied on the Y axis. */ getDownwardForce: function () { @@ -614,7 +614,7 @@ Phaser.Physics.Arcade.Body.prototype = { /** * Subtracts the given Vector from this Body. * - * @method Phaser.Physics.Arcade#sub + * @method Phaser.Physics.Arcade.Body#sub * @protected * @param {SAT.Vector} v - The vector to substract from this Body. */ @@ -628,7 +628,7 @@ Phaser.Physics.Arcade.Body.prototype = { /** * Adds the given Vector to this Body. * - * @method Phaser.Physics.Arcade#add + * @method Phaser.Physics.Arcade.Body#add * @protected * @param {SAT.Vector} v - The vector to add to this Body. */ @@ -642,7 +642,7 @@ Phaser.Physics.Arcade.Body.prototype = { /** * Separation response handler. * - * @method Phaser.Physics.Arcade#give + * @method Phaser.Physics.Arcade.Body#give * @protected * @param {Phaser.Physics.Arcade.Body} body - The Body that collided. * @param {SAT.Response} response - The SAT Response object containing the collision data. @@ -663,7 +663,7 @@ Phaser.Physics.Arcade.Body.prototype = { /** * Separation response handler. * - * @method Phaser.Physics.Arcade#take + * @method Phaser.Physics.Arcade.Body#take * @protected * @param {Phaser.Physics.Arcade.Body} body - The Body that collided. * @param {SAT.Response} response - The SAT Response object containing the collision data. @@ -684,7 +684,7 @@ Phaser.Physics.Arcade.Body.prototype = { /** * Split the collision response evenly between the two bodies. * - * @method Phaser.Physics.Arcade#split + * @method Phaser.Physics.Arcade.Body#split * @protected * @param {Phaser.Physics.Arcade.Body} body - The Body that collided. * @param {SAT.Response} response - The SAT Response object containing the collision data. @@ -707,7 +707,7 @@ Phaser.Physics.Arcade.Body.prototype = { /** * Exchange velocity with the given Body. * - * @method Phaser.Physics.Arcade#exchange + * @method Phaser.Physics.Arcade.Body#exchange * @protected * @param {Phaser.Physics.Arcade.Body} body - The Body that collided. */ @@ -753,7 +753,7 @@ Phaser.Physics.Arcade.Body.prototype = { /** * Rebound the velocity of this Body. * - * @method Phaser.Physics.Arcade#processRebound + * @method Phaser.Physics.Arcade.Body#processRebound * @protected * @param {Phaser.Physics.Arcade.Body} body - The Body that collided. */ @@ -779,7 +779,7 @@ Phaser.Physics.Arcade.Body.prototype = { /** * Checks for an overlap between this Body and the given Body. * - * @method Phaser.Physics.Arcade#overlap + * @method Phaser.Physics.Arcade.Body#overlap * @param {Phaser.Physics.Arcade.Body} body - The Body that is being checked against this Body. * @param {SAT.Response} response - SAT Response handler. * @return {boolean} True if the two bodies overlap, otherwise false. @@ -817,7 +817,7 @@ Phaser.Physics.Arcade.Body.prototype = { /** * Checks if this Body is already in contact with the given Body. * - * @method Phaser.Physics.Arcade#inContact + * @method Phaser.Physics.Arcade.Body#inContact * @param {Phaser.Physics.Arcade.Body} body - The Body to be checked. * @return {boolean} True if the given Body is already in contact with this Body. */ @@ -830,7 +830,7 @@ Phaser.Physics.Arcade.Body.prototype = { /** * Adds the given Body to the contact list of this Body. Also adds this Body to the contact list of the given Body. * - * @method Phaser.Physics.Arcade#addContact + * @method Phaser.Physics.Arcade.Body#addContact * @param {Phaser.Physics.Arcade.Body} body - The Body to be added. * @return {boolean} True if the given Body was added to this contact list, false if already on it. */ @@ -854,7 +854,7 @@ Phaser.Physics.Arcade.Body.prototype = { /** * Removes the given Body from the contact list of this Body. Also removes this Body from the contact list of the given Body. * - * @method Phaser.Physics.Arcade#removeContact + * @method Phaser.Physics.Arcade.Body#removeContact * @param {Phaser.Physics.Arcade.Body} body - The Body to be removed. * @return {boolean} True if the given Body was removed from this contact list, false if wasn't on it. */ @@ -879,7 +879,7 @@ Phaser.Physics.Arcade.Body.prototype = { * This separates this Body from the given Body unless a customSeparateCallback is set. * It assumes they have already been overlap checked and the resulting overlap is stored in the SAT response. * - * @method Phaser.Physics.Arcade#separate + * @method Phaser.Physics.Arcade.Body#separate * @protected * @param {Phaser.Physics.Arcade.Body} body - The Body to be separated from this one. * @param {SAT.Response} response - SAT Response handler. @@ -966,7 +966,7 @@ Phaser.Physics.Arcade.Body.prototype = { * If the callback returns true then separation, rebounds and the touching flags will all be set. * If it returns false this will be skipped and must be handled manually. * - * @method Phaser.Physics.Arcade#hitLeft + * @method Phaser.Physics.Arcade.Body#hitLeft * @protected * @param {Phaser.Physics.Arcade.Body} body - The Body that collided. * @param {SAT.Response} response - The SAT Response object containing the collision data. @@ -1008,7 +1008,7 @@ Phaser.Physics.Arcade.Body.prototype = { * If the callback returns true then separation, rebounds and the touching flags will all be set. * If it returns false this will be skipped and must be handled manually. * - * @method Phaser.Physics.Arcade#hitRight + * @method Phaser.Physics.Arcade.Body#hitRight * @protected * @param {Phaser.Physics.Arcade.Body} body - The Body that collided. * @param {SAT.Response} response - The SAT Response object containing the collision data. @@ -1050,7 +1050,7 @@ Phaser.Physics.Arcade.Body.prototype = { * If the callback returns true then separation, rebounds and the touching flags will all be set. * If it returns false this will be skipped and must be handled manually. * - * @method Phaser.Physics.Arcade#hitTop + * @method Phaser.Physics.Arcade.Body#hitTop * @protected * @param {Phaser.Physics.Arcade.Body} body - The Body that collided. * @param {SAT.Response} response - The SAT Response object containing the collision data. @@ -1094,7 +1094,7 @@ Phaser.Physics.Arcade.Body.prototype = { * If the callback returns true then separation, rebounds and the touching flags will all be set. * If it returns false this will be skipped and must be handled manually. * - * @method Phaser.Physics.Arcade#hitBottom + * @method Phaser.Physics.Arcade.Body#hitBottom * @protected * @param {Phaser.Physics.Arcade.Body} body - The Body that collided. * @param {SAT.Response} response - The SAT Response object containing the collision data. @@ -1134,7 +1134,7 @@ Phaser.Physics.Arcade.Body.prototype = { /** * Internal method. Integrates velocity, global gravity and the delta timer. * - * @method Phaser.Physics.Arcade#integrateVelocity + * @method Phaser.Physics.Arcade.Body#integrateVelocity * @protected */ integrateVelocity: function () { @@ -1181,7 +1181,7 @@ Phaser.Physics.Arcade.Body.prototype = { /** * Internal method. This is called directly before the sprites are sent to the renderer and after the update function has finished. * - * @method Phaser.Physics.Arcade#postUpdate + * @method Phaser.Physics.Arcade.Body#postUpdate * @protected */ postUpdate: function () { @@ -1237,7 +1237,7 @@ Phaser.Physics.Arcade.Body.prototype = { * Resets the Body motion values: velocity, acceleration, angularVelocity and angularAcceleration. * Also resets the forces to defaults: gravity, bounce, minVelocity,maxVelocity, angularDrag, maxAngular, mass, friction and checkCollision if 'full' specified. * - * @method Phaser.Physics.Arcade#reset + * @method Phaser.Physics.Arcade.Body#reset * @param {boolean} [full=false] - A full reset clears down settings you may have set, such as gravity, bounce and drag. A non-full reset just clears motion values. */ reset: function (full) { @@ -1275,7 +1275,7 @@ Phaser.Physics.Arcade.Body.prototype = { /** * Destroys this Body and all references it holds to other objects. * - * @method Phaser.Physics.Arcade#destroy + * @method Phaser.Physics.Arcade.Body#destroy */ destroy: function () { @@ -1295,7 +1295,7 @@ Phaser.Physics.Arcade.Body.prototype = { * Sets this Body to use a circle of the given radius for all collision. * The Circle will be centered on the center of the Sprite by default, but can be adjusted via the Body.offset property and the setCircle x/y parameters. * - * @method Phaser.Physics.Arcade#setCircle + * @method Phaser.Physics.Arcade.Body#setCircle * @param {number} radius - The radius of this circle (in pixels) * @param {number} [offsetX=0] - The x amount the circle will be offset from the Sprites center. * @param {number} [offsetY=0] - The y amount the circle will be offset from the Sprites center. @@ -1317,7 +1317,7 @@ Phaser.Physics.Arcade.Body.prototype = { * Sets this Body to use a rectangle for all collision. * If you don't specify any parameters it will be sized to match the parent Sprites current width and height (including scale factor) and centered on the sprite. * - * @method Phaser.Physics.Arcade#setRectangle + * @method Phaser.Physics.Arcade.Body#setRectangle * @param {number} [width] - The width of the rectangle. If not specified it will default to the width of the parent Sprite. * @param {number} [height] - The height of the rectangle. If not specified it will default to the height of the parent Sprite. * @param {number} [translateX] - The x amount the rectangle will be translated from the Sprites center. @@ -1344,8 +1344,8 @@ Phaser.Physics.Arcade.Body.prototype = { * The points are specified in a counter-clockwise direction and must create a convex polygon. * Use Body.translate and/or Body.offset to re-position the polygon from the Sprite origin. * - * @method Phaser.Physics.Arcade#setPolygon - * @param {array |Array |SAT.Vector...|Number...} points - This can be an array of Vectors that form the polygon, + * @method Phaser.Physics.Arcade.Body#setPolygon + * @param {(SAT.Vector[]|number[]|...SAT.Vector|...number)} points - This can be an array of Vectors that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `setPolygon(new SAT.Vector(), new SAT.Vector(), ...)`, or the * arguments passed can be flat x,y values e.g. `setPolygon(x,y, x,y, x,y, ...)` where `x` and `y` are Numbers. @@ -1382,7 +1382,7 @@ Phaser.Physics.Arcade.Body.prototype = { * Used for translating rectangle and polygon bodies from the Sprite parent. Doesn't apply to Circles. * See also the Body.offset property. * - * @method Phaser.Physics.Arcade#translate + * @method Phaser.Physics.Arcade.Body#translate * @param {number} x - The x amount the polygon or rectangle will be translated by from the Sprite. * @param {number} y - The y amount the polygon or rectangle will be translated by from the Sprite. */ @@ -1451,14 +1451,10 @@ Phaser.Physics.Arcade.Body.prototype.constructor = Phaser.Physics.Arcade.Body; /** * @name Phaser.Physics.Arcade.Body#x -* @property {number} x +* @property {number} x - The x coordinate of this Body. */ Object.defineProperty(Phaser.Physics.Arcade.Body.prototype, "x", { - /** - * @method x - * @return {number} - */ get: function () { if (this.type === Phaser.Physics.Arcade.CIRCLE) @@ -1472,10 +1468,6 @@ Object.defineProperty(Phaser.Physics.Arcade.Body.prototype, "x", { }, - /** - * @method x - * @param {number} value - */ set: function (value) { if (this.type === Phaser.Physics.Arcade.CIRCLE) @@ -1493,14 +1485,10 @@ Object.defineProperty(Phaser.Physics.Arcade.Body.prototype, "x", { /** * @name Phaser.Physics.Arcade.Body#y -* @property {number} y +* @property {number} y - The y coordinate of this Body. */ Object.defineProperty(Phaser.Physics.Arcade.Body.prototype, "y", { - /** - * @method y - * @return {number} - */ get: function () { if (this.type === Phaser.Physics.Arcade.CIRCLE) @@ -1514,10 +1502,6 @@ Object.defineProperty(Phaser.Physics.Arcade.Body.prototype, "y", { }, - /** - * @method y - * @param {number} value - */ set: function (value) { if (this.type === Phaser.Physics.Arcade.CIRCLE) diff --git a/src/time/Timer.js b/src/time/Timer.js index 71c1acb0..ee170f9c 100644 --- a/src/time/Timer.js +++ b/src/time/Timer.js @@ -166,7 +166,7 @@ Phaser.Timer.prototype = { * @param {number} delay - The number of milliseconds that should elapse before the Timer will call the given callback. * @param {function} callback - The callback that will be called when the Timer event occurs. * @param {object} callbackContext - The context in which the callback will be called. - * @param {...} arguments - The values to be sent to your callback function when it is called. + * @param {...*} arguments - The values to be sent to your callback function when it is called. * @return {Phaser.TimerEvent} The Phaser.TimerEvent object that was created. */ add: function (delay, callback, callbackContext) { @@ -185,7 +185,7 @@ Phaser.Timer.prototype = { * @param {number} repeatCount - The number of times the event will repeat. * @param {function} callback - The callback that will be called when the Timer event occurs. * @param {object} callbackContext - The context in which the callback will be called. - * @param {...} arguments - The values to be sent to your callback function when it is called. + * @param {...*} arguments - The values to be sent to your callback function when it is called. * @return {Phaser.TimerEvent} The Phaser.TimerEvent object that was created. */ repeat: function (delay, repeatCount, callback, callbackContext) { @@ -203,7 +203,7 @@ Phaser.Timer.prototype = { * @param {number} delay - The number of milliseconds that should elapse before the Timer will call the given callback. * @param {function} callback - The callback that will be called when the Timer event occurs. * @param {object} callbackContext - The context in which the callback will be called. - * @param {...} arguments - The values to be sent to your callback function when it is called. + * @param {...*} arguments - The values to be sent to your callback function when it is called. * @return {Phaser.TimerEvent} The Phaser.TimerEvent object that was created. */ loop: function (delay, callback, callbackContext) { diff --git a/src/utils/Utils.js b/src/utils/Utils.js index 0708c2c3..ac501e69 100644 --- a/src/utils/Utils.js +++ b/src/utils/Utils.js @@ -75,18 +75,6 @@ Phaser.Utils = { }, - /** - * Returns true if the object is an Array, otherwise false. - * @method Phaser.Utils.isArray - * @param {object} obj - The object to inspect. - * @return {boolean} - true if the object is an array, otherwise false. - */ - isArray: function (obj) { - - return toString.call(obj) === "[object Array]"; - - }, - /** * This is a slightly modified version of jQuery.isPlainObject. A plain object is an object whose internal class property is [object Object]. * @method Phaser.Utils.isPlainObject @@ -209,22 +197,10 @@ Phaser.Utils = { }; -/** -* Converts a hex color number to an [R, G, B] array -* -* @param {number} hex -* @return {array} -*/ function HEXtoRGB(hex) { return [(hex >> 16 & 0xFF) / 255, ( hex >> 8 & 0xFF) / 255, (hex & 0xFF)/ 255]; } -/** - * Converts a hex color number to an [R, G, B] array - * - * @method hex2rgb - * @param hex {Number} - */ PIXI.hex2rgb = function hex2rgb(hex) { return [(hex >> 16 & 0xFF) / 255, ( hex >> 8 & 0xFF) / 255, (hex & 0xFF)/ 255]; };
-
-
-
-
-
-
-
-
-
-
-The sum of the y and height properties. Changing the bottom property of a Rectangle object has no effect on the x, y and width properties, but does change the height property.
--
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Returns:
- - - - --
-
