Skip to content

Commit 2af65b2

Browse files
committed
Improved JSDocs and types. Fix phaserjs#5217
1 parent 1766f66 commit 2af65b2

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

src/animations/typedefs/Animation.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* @since 3.0.0
44
*
55
* @property {string} [key] - The key that the animation will be associated with. i.e. sprite.animations.play(key)
6-
* @property {Phaser.Types.Animations.AnimationFrame[]} [frames] - An object containing data used to generate the frames for the animation
6+
* @property {Phaser.Types.Animations.AnimationFrame[]} [frames] - An object containing data used to generate the frames for the animation.
77
* @property {string} [defaultTextureKey=null] - The key of the texture all frames of the animation will use. Can be overridden on a per frame basis.
88
* @property {integer} [frameRate] - The frame rate of playback in frames per second (default 24 if duration is null)
99
* @property {integer} [duration] - How long the animation should play for in milliseconds. If not given its derived from frameRate.

src/animations/typedefs/AnimationFrame.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
* @typedef {object} Phaser.Types.Animations.AnimationFrame
33
* @since 3.0.0
44
*
5-
* @property {string} key - The key that the animation will be associated with. i.e. sprite.animations.play(key)
6-
* @property {(string|number)} frame - The key, or index number, of the frame within the animation.
5+
* @property {string} key - The key of the texture within the Texture Manager to use for this Animation Frame.
6+
* @property {(string|number)} [frame] - The key, or index number, of the frame within the texture to use for this Animation Frame.
77
* @property {number} [duration=0] - The duration, in ms, of this frame of the animation.
88
* @property {boolean} [visible] - Should the parent Game Object be visible during this frame of the animation?
99
*/

0 commit comments

Comments
 (0)