Skip to content

Commit 9f9e6a2

Browse files
photonstormphotonstorm
committed
Lots of doc updates!
1 parent 0463bb4 commit 9f9e6a2

147 files changed

Lines changed: 60439 additions & 977 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/Animation.js.html‎

Lines changed: 156 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,18 @@
5454
<a href="Phaser.AnimationParser.html">AnimationParser</a>
5555
</li>
5656

57+
<li>
58+
<a href="Phaser.BitmapText.html">BitmapText</a>
59+
</li>
60+
61+
<li>
62+
<a href="Phaser.Bullet.html">Bullet</a>
63+
</li>
64+
65+
<li>
66+
<a href="Phaser.Button.html">Button</a>
67+
</li>
68+
5769
<li>
5870
<a href="Phaser.Cache.html">Cache</a>
5971
</li>
@@ -126,6 +138,10 @@
126138
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
127139
</li>
128140

141+
<li>
142+
<a href="Phaser.Events.html">Events</a>
143+
</li>
144+
129145
<li>
130146
<a href="Phaser.Frame.html">Frame</a>
131147
</li>
@@ -138,6 +154,14 @@
138154
<a href="Phaser.Game.html">Game</a>
139155
</li>
140156

157+
<li>
158+
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
159+
</li>
160+
161+
<li>
162+
<a href="Phaser.Graphics.html">Graphics</a>
163+
</li>
164+
141165
<li>
142166
<a href="Phaser.Group.html">Group</a>
143167
</li>
@@ -194,6 +218,14 @@
194218
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
195219
</li>
196220

221+
<li>
222+
<a href="Phaser.Physics.html">Physics</a>
223+
</li>
224+
225+
<li>
226+
<a href="Phaser.Physics.Arcade.html">Arcade</a>
227+
</li>
228+
197229
<li>
198230
<a href="Phaser.Plugin.html">Plugin</a>
199231
</li>
@@ -222,6 +254,10 @@
222254
<a href="Phaser.Rectangle.html">Rectangle</a>
223255
</li>
224256

257+
<li>
258+
<a href="Phaser.RenderTexture.html">RenderTexture</a>
259+
</li>
260+
225261
<li>
226262
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
227263
</li>
@@ -238,6 +274,10 @@
238274
<a href="Phaser.SoundManager.html">SoundManager</a>
239275
</li>
240276

277+
<li>
278+
<a href="Phaser.Sprite.html">Sprite</a>
279+
</li>
280+
241281
<li>
242282
<a href="Phaser.Stage.html">Stage</a>
243283
</li>
@@ -254,6 +294,14 @@
254294
<a href="Phaser.StateManager.html">StateManager</a>
255295
</li>
256296

297+
<li>
298+
<a href="Phaser.Text.html">Text</a>
299+
</li>
300+
301+
<li>
302+
<a href="Phaser.TileSprite.html">TileSprite</a>
303+
</li>
304+
257305
<li>
258306
<a href="Phaser.Time.html">Time</a>
259307
</li>
@@ -296,10 +344,82 @@
296344

297345
<ul class="dropdown-menu ">
298346

347+
<li>
348+
<a href="global.html#audio">audio</a>
349+
</li>
350+
351+
<li>
352+
<a href="global.html#bitmapText">bitmapText</a>
353+
</li>
354+
355+
<li>
356+
<a href="global.html#bottom">bottom</a>
357+
</li>
358+
359+
<li>
360+
<a href="global.html#button">button</a>
361+
</li>
362+
363+
<li>
364+
<a href="global.html#child">child</a>
365+
</li>
366+
367+
<li>
368+
<a href="global.html#emitter">emitter</a>
369+
</li>
370+
371+
<li>
372+
<a href="global.html#existing.">existing.</a>
373+
</li>
374+
375+
<li>
376+
<a href="global.html#graphics">graphics</a>
377+
</li>
378+
379+
<li>
380+
<a href="global.html#group">group</a>
381+
</li>
382+
299383
<li>
300384
<a href="global.html#HEXtoRGB">HEXtoRGB</a>
301385
</li>
302386

387+
<li>
388+
<a href="global.html#renderTexture">renderTexture</a>
389+
</li>
390+
391+
<li>
392+
<a href="global.html#right">right</a>
393+
</li>
394+
395+
<li>
396+
<a href="global.html#sprite">sprite</a>
397+
</li>
398+
399+
<li>
400+
<a href="global.html#text">text</a>
401+
</li>
402+
403+
<li>
404+
<a href="global.html#tilemap">tilemap</a>
405+
</li>
406+
407+
<li>
408+
<a href="global.html#tilemaplayer">tilemaplayer</a>
409+
</li>
410+
411+
<li>
412+
<a href="global.html#tileset">tileset</a>
413+
</li>
414+
415+
<li>
416+
<a href="global.html#tileSprite">tileSprite</a>
417+
</li>
418+
419+
<li>
420+
<a href="global.html#tween">tween</a>
421+
</li>
422+
303423

304424
</ul>
305425
</li>
@@ -729,33 +849,55 @@ <h1 class="page-title">Source: animation/Animation.js</h1>
729849
*
730850
* @method Phaser.Animation.generateFrameNames
731851
* @param {string} prefix - The start of the filename. If the filename was 'explosion_0001-large' the prefix would be 'explosion_'.
732-
* @param {number} min - The number to start sequentially counting from. If your frames are named 'explosion_0001' to 'explosion_0034' the min is 1.
733-
* @param {number} max - The number to count up to. If your frames are named 'explosion_0001' to 'explosion_0034' the max is 34.
852+
* @param {number} start - The number to start sequentially counting from. If your frames are named 'explosion_0001' to 'explosion_0034' the start is 1.
853+
* @param {number} stop - The number to count to. If your frames are named 'explosion_0001' to 'explosion_0034' the stop value is 34.
734854
* @param {string} [suffix=''] - The end of the filename. If the filename was 'explosion_0001-large' the prefix would be '-large'.
735855
* @param {number} [zeroPad=0] - The number of zeroes to pad the min and max values with. If your frames are named 'explosion_0001' to 'explosion_0034' then the zeroPad is 4.
736856
*/
737-
Phaser.Animation.generateFrameNames = function (prefix, min, max, suffix, zeroPad) {
857+
Phaser.Animation.generateFrameNames = function (prefix, start, stop, suffix, zeroPad) {
738858

739859
if (typeof suffix == 'undefined') { suffix = ''; }
740860

741861
var output = [];
742862
var frame = '';
743863

744-
for (var i = min; i &lt;= max; i++)
864+
if (start &lt; stop)
745865
{
746-
if (typeof zeroPad == 'number')
866+
for (var i = start; i &lt;= stop; i++)
747867
{
748-
// str, len, pad, dir
749-
frame = Phaser.Utils.pad(i.toString(), zeroPad, '0', 1);
868+
if (typeof zeroPad == 'number')
869+
{
870+
// str, len, pad, dir
871+
frame = Phaser.Utils.pad(i.toString(), zeroPad, '0', 1);
872+
}
873+
else
874+
{
875+
frame = i.toString();
876+
}
877+
878+
frame = prefix + frame + suffix;
879+
880+
output.push(frame);
750881
}
751-
else
882+
}
883+
else
884+
{
885+
for (var i = start; i >= stop; i--)
752886
{
753-
frame = i.toString();
754-
}
887+
if (typeof zeroPad == 'number')
888+
{
889+
// str, len, pad, dir
890+
frame = Phaser.Utils.pad(i.toString(), zeroPad, '0', 1);
891+
}
892+
else
893+
{
894+
frame = i.toString();
895+
}
755896

756-
frame = prefix + frame + suffix;
897+
frame = prefix + frame + suffix;
757898

758-
output.push(frame);
899+
output.push(frame);
900+
}
759901
}
760902

761903
return output;
@@ -781,8 +923,8 @@ <h1 class="page-title">Source: animation/Animation.js</h1>
781923
<br />
782924

783925
<span class="jsdoc-message">
784-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
785-
on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
926+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
927+
on Fri Oct 25 2013 16:16:43 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
786928
</span>
787929
</footer>
788930
</div>

0 commit comments

Comments
 (0)