Skip to content

Commit 1924a83

Browse files
photonstormphotonstorm
committed
New docs generated.
1 parent ccc7e67 commit 1924a83

223 files changed

Lines changed: 6468 additions & 2870 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/AABB.js.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@
502502
</ul>
503503
</li>
504504

505-
505+
</strong>
506506
</ul>
507507
</div>
508508
</div>
@@ -1574,7 +1574,7 @@ <h1 class="page-title">Source: physics/ninja/AABB.js</h1>
15741574

15751575
<span class="jsdoc-message">
15761576
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
1577-
on Thu Jul 10 2014 20:18:55 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
1577+
on Fri Jul 18 2014 12:36:36 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
15781578
</span>
15791579
</footer>
15801580
</div>

‎docs/Animation.js.html‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@
502502
</ul>
503503
</li>
504504

505-
505+
</strong>
506506
</ul>
507507
</div>
508508
</div>
@@ -1023,6 +1023,19 @@ <h1 class="page-title">Source: animation/Animation.js</h1>
10231023

10241024
},
10251025

1026+
/**
1027+
* Changes the FrameData object this Animation is using.
1028+
*
1029+
* @method Phaser.Animation#updateFrameData
1030+
* @param {Phaser.FrameData} frameData - The FrameData object that contains all frames used by this Animation.
1031+
*/
1032+
updateFrameData: function (frameData) {
1033+
1034+
this._frameData = frameData;
1035+
this.currentFrame = this._frameData ? this._frameData.getFrame(this._frames[this._frameIndex % this._frames.length]) : null;
1036+
1037+
},
1038+
10261039
/**
10271040
* Cleans up this animation ready for deletion. Nulls all values and references.
10281041
*
@@ -1259,7 +1272,7 @@ <h1 class="page-title">Source: animation/Animation.js</h1>
12591272

12601273
<span class="jsdoc-message">
12611274
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
1262-
on Thu Jul 10 2014 20:18:55 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
1275+
on Fri Jul 18 2014 12:36:36 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
12631276
</span>
12641277
</footer>
12651278
</div>

‎docs/AnimationManager.js.html‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@
502502
</ul>
503503
</li>
504504

505-
505+
</strong>
506506
</ul>
507507
</div>
508508
</div>
@@ -605,6 +605,15 @@ <h1 class="page-title">Source: animation/AnimationManager.js</h1>
605605
*/
606606
loadFrameData: function (frameData, frame) {
607607

608+
if (this.isLoaded)
609+
{
610+
// We need to update the frameData that the animations are using
611+
for (var anim in this._anims)
612+
{
613+
this._anims[anim].updateFrameData(frameData);
614+
}
615+
}
616+
608617
this._frameData = frameData;
609618

610619
if (typeof frame === 'undefined' || frame === null)
@@ -772,6 +781,7 @@ <h1 class="page-title">Source: animation/AnimationManager.js</h1>
772781

773782
this.currentAnim = this._anims[name];
774783
this.currentAnim.paused = false;
784+
this.currentFrame = this.currentAnim.currentFrame;
775785
return this.currentAnim.play(frameRate, loop, killOnComplete);
776786
}
777787
}
@@ -1087,7 +1097,7 @@ <h1 class="page-title">Source: animation/AnimationManager.js</h1>
10871097

10881098
<span class="jsdoc-message">
10891099
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
1090-
on Thu Jul 10 2014 20:18:55 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
1100+
on Fri Jul 18 2014 12:36:36 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
10911101
</span>
10921102
</footer>
10931103
</div>

‎docs/AnimationParser.js.html‎

Lines changed: 37 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@
502502
</ul>
503503
</li>
504504

505-
505+
</strong>
506506
</ul>
507507
</div>
508508
</div>
@@ -581,7 +581,7 @@ <h1 class="page-title">Source: animation/AnimationParser.js</h1>
581581
// Zero or smaller than frame sizes?
582582
if (width === 0 || height === 0 || width &lt; frameWidth || height &lt; frameHeight || total === 0)
583583
{
584-
console.warn("Phaser.AnimationParser.spriteSheet: width/height zero or width/height &lt; given frameWidth/frameHeight");
584+
console.warn("Phaser.AnimationParser.spriteSheet: '" + key + "'s width/height zero or width/height &lt; given frameWidth/frameHeight");
585585
return null;
586586
}
587587

@@ -597,6 +597,13 @@ <h1 class="page-title">Source: animation/AnimationParser.js</h1>
597597
// uuid needed?
598598
data.addFrame(new Phaser.Frame(i, x, y, frameWidth, frameHeight, '', uuid));
599599

600+
PIXI.TextureCache[uuid] = new PIXI.Texture(PIXI.BaseTextureCache[key], {
601+
x: x,
602+
y: y,
603+
width: frameWidth,
604+
height: frameHeight
605+
});
606+
600607
x += frameWidth + spacing;
601608

602609
if (x + frameWidth > width)
@@ -616,9 +623,10 @@ <h1 class="page-title">Source: animation/AnimationParser.js</h1>
616623
* @method Phaser.AnimationParser.JSONData
617624
* @param {Phaser.Game} game - A reference to the currently running game.
618625
* @param {Object} json - The JSON data from the Texture Atlas. Must be in Array format.
626+
* @param {string} cacheKey - The Game.Cache asset key of the texture image.
619627
* @return {Phaser.FrameData} A FrameData object containing the parsed frames.
620628
*/
621-
JSONData: function (game, json) {
629+
JSONData: function (game, json, cacheKey) {
622630

623631
// Malformed?
624632
if (!json['frames'])
@@ -649,6 +657,13 @@ <h1 class="page-title">Source: animation/AnimationParser.js</h1>
649657
uuid
650658
));
651659

660+
PIXI.TextureCache[uuid] = new PIXI.Texture(PIXI.BaseTextureCache[cacheKey], {
661+
x: frames[i].frame.x,
662+
y: frames[i].frame.y,
663+
width: frames[i].frame.w,
664+
height: frames[i].frame.h
665+
});
666+
652667
if (frames[i].trimmed)
653668
{
654669
newFrame.setTrim(
@@ -673,9 +688,10 @@ <h1 class="page-title">Source: animation/AnimationParser.js</h1>
673688
* @method Phaser.AnimationParser.JSONDataHash
674689
* @param {Phaser.Game} game - A reference to the currently running game.
675690
* @param {Object} json - The JSON data from the Texture Atlas. Must be in JSON Hash format.
691+
* @param {string} cacheKey - The Game.Cache asset key of the texture image.
676692
* @return {Phaser.FrameData} A FrameData object containing the parsed frames.
677693
*/
678-
JSONDataHash: function (game, json) {
694+
JSONDataHash: function (game, json, cacheKey) {
679695

680696
// Malformed?
681697
if (!json['frames'])
@@ -707,6 +723,13 @@ <h1 class="page-title">Source: animation/AnimationParser.js</h1>
707723
uuid
708724
));
709725

726+
PIXI.TextureCache[uuid] = new PIXI.Texture(PIXI.BaseTextureCache[cacheKey], {
727+
x: frames[key].frame.x,
728+
y: frames[key].frame.y,
729+
width: frames[key].frame.w,
730+
height: frames[key].frame.h
731+
});
732+
710733
if (frames[key].trimmed)
711734
{
712735
newFrame.setTrim(
@@ -733,9 +756,10 @@ <h1 class="page-title">Source: animation/AnimationParser.js</h1>
733756
* @method Phaser.AnimationParser.XMLData
734757
* @param {Phaser.Game} game - A reference to the currently running game.
735758
* @param {Object} xml - The XML data from the Texture Atlas. Must be in Starling XML format.
759+
* @param {string} cacheKey - The Game.Cache asset key of the texture image.
736760
* @return {Phaser.FrameData} A FrameData object containing the parsed frames.
737761
*/
738-
XMLData: function (game, xml) {
762+
XMLData: function (game, xml, cacheKey) {
739763

740764
// Malformed?
741765
if (!xml.getElementsByTagName('TextureAtlas'))
@@ -786,7 +810,13 @@ <h1 class="page-title">Source: animation/AnimationParser.js</h1>
786810

787811
newFrame = data.addFrame(new Phaser.Frame(i, x, y, width, height, name, uuid));
788812

789-
// Trimmed?
813+
PIXI.TextureCache[uuid] = new PIXI.Texture(PIXI.BaseTextureCache[cacheKey], {
814+
x: x,
815+
y: y,
816+
width: width,
817+
height: height
818+
});
819+
// Trimmed?
790820
if (frameX !== null || frameY !== null)
791821
{
792822
newFrame.setTrim(true, width, height, frameX, frameY, frameWidth, frameHeight);
@@ -819,7 +849,7 @@ <h1 class="page-title">Source: animation/AnimationParser.js</h1>
819849

820850
<span class="jsdoc-message">
821851
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
822-
on Thu Jul 10 2014 20:18:55 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
852+
on Fri Jul 18 2014 12:36:36 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
823853
</span>
824854
</footer>
825855
</div>

‎docs/ArrayList.js.html‎

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@
502502
</ul>
503503
</li>
504504

505-
505+
</strong>
506506
</ul>
507507
</div>
508508
</div>
@@ -632,6 +632,27 @@ <h1 class="page-title">Source: core/ArrayList.js</h1>
632632

633633
},
634634

635+
/**
636+
* Sets the property `key` to the given value on all members of this list.
637+
*
638+
* @method Phaser.ArrayList#setAll
639+
* @param {object} key - The object on the child to set.
640+
* @param {*} value - The value to set the property to.
641+
*/
642+
setAll: function (key, value) {
643+
644+
var i = this.list.length;
645+
646+
while (i--)
647+
{
648+
if (this.list[i] && this.list[i][key])
649+
{
650+
this.list[i][key] = value;
651+
}
652+
}
653+
654+
},
655+
635656
/**
636657
* Calls a function on all members of this list, using the member as the context for the callback.
637658
* The function must exist on the member.
@@ -730,7 +751,7 @@ <h1 class="page-title">Source: core/ArrayList.js</h1>
730751

731752
<span class="jsdoc-message">
732753
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
733-
on Thu Jul 10 2014 20:18:55 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
754+
on Fri Jul 18 2014 12:36:36 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
734755
</span>
735756
</footer>
736757
</div>

‎docs/BitmapData.js.html‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@
502502
</ul>
503503
</li>
504504

505-
505+
</strong>
506506
</ul>
507507
</div>
508508
</div>
@@ -800,6 +800,9 @@ <h1 class="page-title">Source: gameobjects/BitmapData.js</h1>
800800
this.texture.width = width;
801801
this.texture.height = height;
802802

803+
this.texture.crop.width = width;
804+
this.texture.crop.height = height;
805+
803806
this.refreshBuffer();
804807
this.dirty = true;
805808
}
@@ -1588,7 +1591,7 @@ <h1 class="page-title">Source: gameobjects/BitmapData.js</h1>
15881591

15891592
<span class="jsdoc-message">
15901593
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
1591-
on Thu Jul 10 2014 20:18:55 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
1594+
on Fri Jul 18 2014 12:36:36 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
15921595
</span>
15931596
</footer>
15941597
</div>

‎docs/BitmapText.js.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@
502502
</ul>
503503
</li>
504504

505-
505+
</strong>
506506
</ul>
507507
</div>
508508
</div>
@@ -691,7 +691,7 @@ <h1 class="page-title">Source: gameobjects/BitmapText.js</h1>
691691
this.renderable = this.game.world.camera.screenView.intersects(this.getBounds());
692692
}
693693

694-
this.world.setTo(this.game.camera.x + this.worldTransform[2], this.game.camera.y + this.worldTransform[5]);
694+
this.world.setTo(this.game.camera.x + this.worldTransform.tx, this.game.camera.y + this.worldTransform.ty);
695695

696696
if (this.visible)
697697
{
@@ -1026,7 +1026,7 @@ <h1 class="page-title">Source: gameobjects/BitmapText.js</h1>
10261026

10271027
<span class="jsdoc-message">
10281028
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
1029-
on Thu Jul 10 2014 20:18:55 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
1029+
on Fri Jul 18 2014 12:36:36 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
10301030
</span>
10311031
</footer>
10321032
</div>

‎docs/Body.js.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@
502502
</ul>
503503
</li>
504504

505-
505+
</strong>
506506
</ul>
507507
</div>
508508
</div>
@@ -1366,7 +1366,7 @@ <h1 class="page-title">Source: physics/arcade/Body.js</h1>
13661366

13671367
<span class="jsdoc-message">
13681368
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
1369-
on Thu Jul 10 2014 20:18:55 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
1369+
on Fri Jul 18 2014 12:36:36 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
13701370
</span>
13711371
</footer>
13721372
</div>

‎docs/Body.js_.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@
502502
</ul>
503503
</li>
504504

505-
505+
</strong>
506506
</ul>
507507
</div>
508508
</div>
@@ -1111,7 +1111,7 @@ <h1 class="page-title">Source: physics/ninja/Body.js</h1>
11111111

11121112
<span class="jsdoc-message">
11131113
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
1114-
on Thu Jul 10 2014 20:18:55 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
1114+
on Fri Jul 18 2014 12:36:36 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
11151115
</span>
11161116
</footer>
11171117
</div>

‎docs/Body.js__.html‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@
502502
</ul>
503503
</li>
504504

505-
505+
</strong>
506506
</ul>
507507
</div>
508508
</div>
@@ -1472,7 +1472,9 @@ <h1 class="page-title">Source: physics/p2/Body.js</h1>
14721472

14731473
options = options || {};
14741474

1475-
points = Array.prototype.slice.call(arguments, 1);
1475+
if (!Array.isArray(points)) {
1476+
points = Array.prototype.slice.call(arguments, 1);
1477+
}
14761478

14771479
var path = [];
14781480

@@ -2334,7 +2336,7 @@ <h1 class="page-title">Source: physics/p2/Body.js</h1>
23342336

23352337
<span class="jsdoc-message">
23362338
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
2337-
on Thu Jul 10 2014 20:18:55 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
2339+
on Fri Jul 18 2014 12:36:36 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
23382340
</span>
23392341
</footer>
23402342
</div>

0 commit comments

Comments
 (0)