Skip to content

Commit 469c34f

Browse files
committed
Documented the remaining descriptions in the Quad and Sprite game objects.
1 parent ae214a8 commit 469c34f

2 files changed

Lines changed: 10 additions & 10 deletions

File tree

src/gameobjects/quad/Quad.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ var Mesh = require('../mesh/Mesh');
2424
* @webglOnly
2525
* @since 3.0.0
2626
*
27-
* @param {Phaser.Scene} scene - [description]
27+
* @param {Phaser.Scene} scene - The Scene to which this Quad belongs.
2828
* @param {number} x - The horizontal position of this Game Object in the world.
2929
* @param {number} y - The vertical position of this Game Object in the world.
3030
* @param {string} texture - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.

src/gameobjects/sprite/Sprite.js

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ var Sprite = new Class({
7979
GameObject.call(this, scene, 'Sprite');
8080

8181
/**
82-
* [description]
82+
* The Animation Controller of this Sprite.
8383
*
8484
* @name Phaser.GameObjects.Sprite#anims
8585
* @type {Phaser.GameObjects.Components.Animation}
@@ -95,29 +95,29 @@ var Sprite = new Class({
9595
},
9696

9797
/**
98-
* [description]
98+
* Update this Sprite's animations.
9999
*
100100
* @method Phaser.GameObjects.Sprite#preUpdate
101101
* @protected
102102
* @since 3.0.0
103103
*
104-
* @param {number} time - [description]
105-
* @param {number} delta - [description]
104+
* @param {number} time - The current timestamp.
105+
* @param {number} delta - The delta time, in ms, elapsed since the last frame.
106106
*/
107107
preUpdate: function (time, delta)
108108
{
109109
this.anims.update(time, delta);
110110
},
111111

112112
/**
113-
* [description]
113+
* Start playing the given animation.
114114
*
115115
* @method Phaser.GameObjects.Sprite#play
116116
* @since 3.0.0
117117
*
118-
* @param {string} key - [description]
119-
* @param {boolean} [ignoreIfPlaying=false] - [description]
120-
* @param {integer} [startFrame=0] - [description]
118+
* @param {string} key - The string-based key of the animation to play.
119+
* @param {boolean} [ignoreIfPlaying=false] - If an animation is already playing then ignore this call.
120+
* @param {integer} [startFrame=0] - Optionally start the animation playing from this frame index.
121121
*
122122
* @return {Phaser.GameObjects.Sprite} This Game Object.
123123
*/
@@ -129,7 +129,7 @@ var Sprite = new Class({
129129
},
130130

131131
/**
132-
* [description]
132+
* Build a JSON representation of this Sprite.
133133
*
134134
* @method Phaser.GameObjects.Sprite#toJSON
135135
* @since 3.0.0

0 commit comments

Comments
 (0)