Skip to content

Commit

Permalink
Lots of doc updates!
Browse files Browse the repository at this point in the history
  • Loading branch information
@photonstorm
photonstorm committed Oct 25, 2013
1 parent 0463bb4 commit 9f9e6a2
Show file tree
Hide file tree
Showing 147 changed files with 60,439 additions and 977 deletions.
170 changes: 156 additions & 14 deletions docs/Animation.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,18 @@
<a href="Phaser.AnimationParser.html">AnimationParser</a>
</li>

<li>
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>

<li>
<a href="Phaser.Bullet.html">Bullet</a>
</li>

<li>
<a href="Phaser.Button.html">Button</a>
</li>

<li>
<a href="Phaser.Cache.html">Cache</a>
</li>
Expand Down Expand Up @@ -126,6 +138,10 @@
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
</li>

<li>
<a href="Phaser.Events.html">Events</a>
</li>

<li>
<a href="Phaser.Frame.html">Frame</a>
</li>
Expand All @@ -138,6 +154,14 @@
<a href="Phaser.Game.html">Game</a>
</li>

<li>
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>

<li>
<a href="Phaser.Graphics.html">Graphics</a>
</li>

<li>
<a href="Phaser.Group.html">Group</a>
</li>
Expand Down Expand Up @@ -194,6 +218,14 @@
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>

<li>
<a href="Phaser.Physics.html">Physics</a>
</li>

<li>
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>

<li>
<a href="Phaser.Plugin.html">Plugin</a>
</li>
Expand Down Expand Up @@ -222,6 +254,10 @@
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>

<li>
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>

<li>
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
Expand All @@ -238,6 +274,10 @@
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>

<li>
<a href="Phaser.Sprite.html">Sprite</a>
</li>

<li>
<a href="Phaser.Stage.html">Stage</a>
</li>
Expand All @@ -254,6 +294,14 @@
<a href="Phaser.StateManager.html">StateManager</a>
</li>

<li>
<a href="Phaser.Text.html">Text</a>
</li>

<li>
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>

<li>
<a href="Phaser.Time.html">Time</a>
</li>
Expand Down Expand Up @@ -296,10 +344,82 @@

<ul class="dropdown-menu ">

<li>
<a href="global.html#audio">audio</a>
</li>

<li>
<a href="global.html#bitmapText">bitmapText</a>
</li>

<li>
<a href="global.html#bottom">bottom</a>
</li>

<li>
<a href="global.html#button">button</a>
</li>

<li>
<a href="global.html#child">child</a>
</li>

<li>
<a href="global.html#emitter">emitter</a>
</li>

<li>
<a href="global.html#existing.">existing.</a>
</li>

<li>
<a href="global.html#graphics">graphics</a>
</li>

<li>
<a href="global.html#group">group</a>
</li>

<li>
<a href="global.html#HEXtoRGB">HEXtoRGB</a>
</li>

<li>
<a href="global.html#renderTexture">renderTexture</a>
</li>

<li>
<a href="global.html#right">right</a>
</li>

<li>
<a href="global.html#sprite">sprite</a>
</li>

<li>
<a href="global.html#text">text</a>
</li>

<li>
<a href="global.html#tilemap">tilemap</a>
</li>

<li>
<a href="global.html#tilemaplayer">tilemaplayer</a>
</li>

<li>
<a href="global.html#tileset">tileset</a>
</li>

<li>
<a href="global.html#tileSprite">tileSprite</a>
</li>

<li>
<a href="global.html#tween">tween</a>
</li>


</ul>
</li>
Expand Down Expand Up @@ -729,33 +849,55 @@ <h1 class="page-title">Source: animation/Animation.js</h1>
*
* @method Phaser.Animation.generateFrameNames
* @param {string} prefix - The start of the filename. If the filename was 'explosion_0001-large' the prefix would be 'explosion_'.
* @param {number} min - The number to start sequentially counting from. If your frames are named 'explosion_0001' to 'explosion_0034' the min is 1.
* @param {number} max - The number to count up to. If your frames are named 'explosion_0001' to 'explosion_0034' the max is 34.
* @param {number} start - The number to start sequentially counting from. If your frames are named 'explosion_0001' to 'explosion_0034' the start is 1.
* @param {number} stop - The number to count to. If your frames are named 'explosion_0001' to 'explosion_0034' the stop value is 34.
* @param {string} [suffix=''] - The end of the filename. If the filename was 'explosion_0001-large' the prefix would be '-large'.
* @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.
*/
Phaser.Animation.generateFrameNames = function (prefix, min, max, suffix, zeroPad) {
Phaser.Animation.generateFrameNames = function (prefix, start, stop, suffix, zeroPad) {

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

var output = [];
var frame = '';

for (var i = min; i &lt;= max; i++)
if (start &lt; stop)
{
if (typeof zeroPad == 'number')
for (var i = start; i &lt;= stop; i++)
{
// str, len, pad, dir
frame = Phaser.Utils.pad(i.toString(), zeroPad, '0', 1);
if (typeof zeroPad == 'number')
{
// str, len, pad, dir
frame = Phaser.Utils.pad(i.toString(), zeroPad, '0', 1);
}
else
{
frame = i.toString();
}

frame = prefix + frame + suffix;

output.push(frame);
}
else
}
else
{
for (var i = start; i >= stop; i--)
{
frame = i.toString();
}
if (typeof zeroPad == 'number')
{
// str, len, pad, dir
frame = Phaser.Utils.pad(i.toString(), zeroPad, '0', 1);
}
else
{
frame = i.toString();
}

frame = prefix + frame + suffix;
frame = prefix + frame + suffix;

output.push(frame);
output.push(frame);
}
}

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

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

0 comments on commit 9f9e6a2

Please sign in to comment.