Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-27 15:12:18 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add AnimationManager.generateFrameNumbers documentation

Browse source
This commit is contained in:
Polar stoat 2018-07-20 11:55:39 +01:00
parent 7b50a87c3e
commit 44e4e7162d
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
src/animations/AnimationManager.js
View file

@ -319,23 +319,23 @@ var AnimationManager = new Class({
/** /**
* @typedef {object} GenerateFrameNumbersConfig * @typedef {object} GenerateFrameNumbersConfig
* *
* @property {integer} [start=0] - [description] * @property {integer} [start=0] - The starting frame of the animation
* @property {integer} [end=-1] - [description] * @property {integer} [end=-1] - The ending frame of the animation
* @property {boolean} [first=false] - [description] * @property {boolean|integer} [first=false] - A frame to put at the beginning of the animation, before `start` or `outputArray` or `frames`
* @property {AnimationFrameConfig[]} [outputArray=[]] - [description] * @property {AnimationFrameConfig[]} [outputArray=[]] - An array to concatenate the output onto
* @property {boolean} [frames=false] - [description] * @property {boolean|integer[]} [frames=false] - A custom sequence of frames
*/ */
/** /**
* [description] * Generates an array of {@link AnimationFrameConfig} objects from a texture key and configuration object
* *
* @method Phaser.Animations.AnimationManager#generateFrameNumbers * @method Phaser.Animations.AnimationManager#generateFrameNumbers
* @since 3.0.0 * @since 3.0.0
* *
* @param {string} key - [description] * @param {string} key - The key for the texture containing the animation frames
* @param {GenerateFrameNumbersConfig} config - [description] * @param {GenerateFrameNumbersConfig} config - The configuration object for the animation frames
* *
* @return {AnimationFrameConfig[]} [description] * @return {AnimationFrameConfig[]} The array of {@link AnimationFrameConfig} objects
*/ */
generateFrameNumbers: function (key, config) generateFrameNumbers: function (key, config)
{ {