Skip to content

Commit fe74eb7

Browse files
committed
Create PlayAnimationConfig.js
1 parent f58f94e commit fe74eb7

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
/**
2+
* @typedef {object} Phaser.Types.Animations.PlayAnimationConfig
3+
* @since 3.50.0
4+
*
5+
* @property {(string|Phaser.Animations.Animation)} key - The string-based key of the animation to play, or an Animation instance.
6+
* @property {integer} [frameRate] - The frame rate of playback in frames per second (default 24 if duration is null)
7+
* @property {integer} [duration] - How long the animation should play for in milliseconds. If not given its derived from frameRate.
8+
* @property {integer} [delay] - Delay before starting playback. Value given in milliseconds.
9+
* @property {integer} [repeat] - Number of times to repeat the animation (-1 for infinity)
10+
* @property {integer} [repeatDelay] - Delay before the animation repeats. Value given in milliseconds.
11+
* @property {boolean} [yoyo] - Should the animation yoyo? (reverse back down to the start) before repeating?
12+
* @property {boolean} [showOnStart] - Should sprite.visible = true when the animation starts to play?
13+
* @property {boolean} [hideOnComplete] - Should sprite.visible = false when the animation finishes?
14+
* @property {integer} [startFrame] - The frame of the animation to start playback from.
15+
* @property {number} [timeScale] - The time scale to be applied to playback of this animation.
16+
*/

0 commit comments

Comments
 (0)