wassname/phaser
1
0
Fork 0
mirror of https://github.com/wassname/phaser.git synced 2026-08-15 12:45:11 +08:00
Code Issues Packages Projects Releases Wiki Activity

More docs coming on.

Browse Source
This commit is contained in:
Richard Davey
2013-10-01 16:39:39 +01:00
parent a38ad2d1a9
commit ca113b85aa
80 changed files with 10121 additions and 4763 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Docs/out/Phaser.Animation.Frame.html
+261 -2
View File
@@ -2253,6 +2253,265 @@
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="setTrim"><span class="type-signature">&lt;static> </span>setTrim<span class="signature">(trimmed, actualWidth, actualHeight, destX, destY, destWidth, destHeight)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
If the frame was trimmed when added to the Texture Atlas this records the trim and source data.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>trimmed</code></td>
<td class="type">
<span class="param-type">bool</span>
</td>
<td class="description last">If this frame was trimmed or not.</td>
</tr>
<tr>
<td class="name"><code>actualWidth</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The width of the frame before being trimmed.</td>
</tr>
<tr>
<td class="name"><code>actualHeight</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The height of the frame before being trimmed.</td>
</tr>
<tr>
<td class="name"><code>destX</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The destination X position of the trimmed frame for display.</td>
</tr>
<tr>
<td class="name"><code>destY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The destination Y position of the trimmed frame for display.</td>
</tr>
<tr>
<td class="name"><code>destWidth</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The destination width of the trimmed frame for display.</td>
</tr>
<tr>
<td class="name"><code>destHeight</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The destination height of the trimmed frame for display.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
animation/Frame.js, line 129
</li></ul></dd>
</dl>
</dd>
</dl>
@@ -2267,13 +2526,13 @@
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-Phaser.html">Phaser</a></li><li><a href="Animation.html">Animation</a></li></ul><h3>Classes</h3><ul><li><a href="Phaser.Animation.Frame.html">Frame</a></li><li><a href="Phaser.Animation.FrameData.html">FrameData</a></li><li><a href="Phaser.Animation.Parser.html">Parser</a></li><li><a href="Phaser.AnimationManager.html">AnimationManager</a></li><li><a href="Animation-Phaser.Animation.html">Animation</a></li></ul><h3>Namespaces</h3><ul><li><a href="Phaser.html">Phaser</a></li></ul><h3>Global</h3><ul><li><a href="global.html#add">add</a></li><li><a href="global.html#addFrame">addFrame</a></li><li><a href="global.html#checkFrameName">checkFrameName</a></li><li><a href="global.html#destroy">destroy</a></li><li><a href="global.html#generateFrameNames">generateFrameNames</a></li><li><a href="global.html#getFrame">getFrame</a></li><li><a href="global.html#getFrameByName">getFrameByName</a></li><li><a href="global.html#getFrameIndexes">getFrameIndexes</a></li><li><a href="global.html#getFrameRange">getFrameRange</a></li><li><a href="global.html#getFrames">getFrames</a></li><li><a href="global.html#JSONData">JSONData</a></li><li><a href="global.html#JSONDataHash">JSONDataHash</a></li><li><a href="global.html#onComplete">onComplete</a></li><li><a href="global.html#play">play</a></li><li><a href="global.html#restart">restart</a></li><li><a href="global.html#setTrim">setTrim</a></li><li><a href="global.html#spriteSheet">spriteSheet</a></li><li><a href="global.html#stop">stop</a></li><li><a href="global.html#total">total</a></li><li><a href="global.html#update">update</a></li><li><a href="global.html#validateFrames">validateFrames</a></li><li><a href="global.html#XMLData">XMLData</a></li></ul>
<h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-Phaser.html">Phaser</a></li><li><a href="Animation.html">Animation</a></li><li><a href="Camera.html">Camera</a></li><li><a href="Game.html">Game</a></li><li><a href="Group.html">Group</a></li></ul><h3>Classes</h3><ul><li><a href="Phaser.Animation.Frame.html">Frame</a></li><li><a href="Phaser.Animation.FrameData.html">FrameData</a></li><li><a href="Phaser.Animation.Parser.html">Parser</a></li><li><a href="Phaser.AnimationManager.html">AnimationManager</a></li><li><a href="Animation-Phaser.Animation.html">Animation</a></li><li><a href="Camera-Phaser.Camera.html">Camera</a></li><li><a href="Game-Phaser.Game.html">Game</a></li><li><a href="Group-Phaser.Group.html">Group</a></li></ul><h3>Namespaces</h3><ul><li><a href="Phaser.html">Phaser</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> on Tue Oct 01 2013 16:05:08 GMT+0100 (BST)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> on Tue Oct 01 2013 16:31:58 GMT+0100 (BST)
</footer>
<script> prettyPrint(); </script>