Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-14 17:07:43 +00:00
Code Issues Projects Releases Packages Wiki Activity

Updated jsdocs for play to show it can take the new config

Browse source
This commit is contained in:
Richard Davey 2020-09-02 17:41:43 +01:00
parent fe74eb70f7
commit 90fbb0f13d
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
src/gameobjects/sprite/Sprite.js
View file

@ -137,9 +137,12 @@ var Sprite = new Class({
* Start playing the given animation.
*
* @method Phaser.GameObjects.Sprite#play
* @fires Phaser.Animations.Events#ANIMATION_START
* @fires Phaser.Animations.Events#SPRITE_ANIMATION_START
* @fires Phaser.Animations.Events#SPRITE_ANIMATION_KEY_START
* @since 3.0.0
*
* @param {string} key - The string-based key of the animation to play.
* @param {(string|Phaser.Animations.Animation|Phaser.Types.Animations.PlayAnimationConfig)} key - The string-based key of the animation to play, or an Animation instance, or a `PlayAnimationConfig` object.
* @param {boolean} [ignoreIfPlaying=false] - If an animation is already playing then ignore this call.
* @param {integer} [startFrame=0] - Optionally start the animation playing from this frame index.
*
@ -147,9 +150,7 @@ var Sprite = new Class({
*/
play: function (key, ignoreIfPlaying, startFrame)
{
this.anims.play(key, ignoreIfPlaying, startFrame);
return this;
return this.anims.play(key, ignoreIfPlaying, startFrame);
},
/**