wassname/phaser
1
0
Fork 0
mirror of https://github.com/wassname/phaser.git synced 2026-08-14 12:40:17 +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
src/animation/FrameData.js
+9 -1
View File
@@ -34,6 +34,7 @@ Phaser.Animation.FrameData.prototype = {
* Adds a new Frame to this FrameData collection. Typically called by the Animation.Parser and not directly.
*
* @method addFrame
* @memberof Phaser.Animation.FrameData
* @param {Phaser.Animation.Frame} frame - The frame to add to this FrameData set.
* @return {Phaser.Animation.Frame} The frame that was just added.
*/
@@ -56,6 +57,7 @@ Phaser.Animation.FrameData.prototype = {
* Get a Frame by its numerical index.
*
* @method getFrame
* @memberof Phaser.Animation.FrameData
* @param {number} index - The index of the frame you want to get.
* @return {Phaser.Animation.Frame} The frame, if found.
*/
@@ -74,6 +76,7 @@ Phaser.Animation.FrameData.prototype = {
* Get a Frame by its frame name.
*
* @method getFrameByName
* @memberof Phaser.Animation.FrameData
* @param {string} name - The name of the frame you want to get.
* @return {Phaser.Animation.Frame} The frame, if found.
*/
@@ -92,6 +95,7 @@ Phaser.Animation.FrameData.prototype = {
* Check if there is a Frame with the given name.
*
* @method checkFrameName
* @memberof Phaser.Animation.FrameData
* @param {string} name - The name of the frame you want to check.
* @return {boolean} True if the frame is found, otherwise false.
*/
@@ -110,6 +114,7 @@ Phaser.Animation.FrameData.prototype = {
* Returns a range of frames based on the given start and end frame indexes and returns them in an Array.
*
* @method getFrameRange
* @memberof Phaser.Animation.FrameData
* @param {number} start - The starting frame index.
* @param {number} end - The ending frame index.
* @param {Array} [output] - If given the results will be appended to the end of this array otherwise a new array will be created.
@@ -133,6 +138,7 @@ Phaser.Animation.FrameData.prototype = {
* The frames are returned in the output array, or if none is provided in a new Array object.
*
* @method getFrames
* @memberof Phaser.Animation.FrameData
* @param {Array} frames - An Array containing the indexes of the frames to retrieve. If the array is empty then all frames in the FrameData are returned.
* @param {boolean} [useNumericIndex=true] - Are the given frames using numeric indexes (default) or strings? (false)
* @param {Array} [output] - If given the results will be appended to the end of this array otherwise a new array will be created.
@@ -180,6 +186,7 @@ Phaser.Animation.FrameData.prototype = {
* The frames indexes are returned in the output array, or if none is provided in a new Array object.
*
* @method getFrameIndexes
* @memberof Phaser.Animation.FrameData
* @param {Array} frames - An Array containing the indexes of the frames to retrieve. If the array is empty then all frames in the FrameData are returned.
* @param {boolean} [useNumericIndex=true] - Are the given frames using numeric indexes (default) or strings? (false)
* @param {Array} [output] - If given the results will be appended to the end of this array otherwise a new array will be created.
@@ -227,7 +234,8 @@ Object.defineProperty(Phaser.Animation.FrameData.prototype, "total", {
* Returns the total number of frames in this FrameData set.
*
* @method total
* @return {Number} The total number of frames in this FrameData set.
* @memberof Phaser.Animation.FrameData
* @return {number} The total number of frames in this FrameData set.
*/
get: function () {
return this._frames.length;