Skip to content

Commit c08dde3

Browse files
committed
Documented some remaining TileSprite descriptions.
1 parent ed97d15 commit c08dde3

2 files changed

Lines changed: 14 additions & 12 deletions

File tree

src/gameobjects/tilesprite/TileSprite.js

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ var TileSprite = new Class({
7878
GameObject.call(this, scene, 'TileSprite');
7979

8080
/**
81-
* [description]
81+
* The horizontal scroll position of the Tile Sprite.
8282
*
8383
* @name Phaser.GameObjects.TileSprite#tilePositionX
8484
* @type {number}
@@ -88,7 +88,7 @@ var TileSprite = new Class({
8888
this.tilePositionX = 0;
8989

9090
/**
91-
* [description]
91+
* The vertical scroll position of the Tile Sprite.
9292
*
9393
* @name Phaser.GameObjects.TileSprite#tilePositionY
9494
* @type {number}
@@ -98,7 +98,9 @@ var TileSprite = new Class({
9898
this.tilePositionY = 0;
9999

100100
/**
101-
* [description]
101+
* Whether the Tile Sprite has changed in some way, requiring an re-render of its tile texture.
102+
*
103+
* Such changes include the texture frame and scroll position of the Tile Sprite.
102104
*
103105
* @name Phaser.GameObjects.TileSprite#dirty
104106
* @type {boolean}
@@ -108,7 +110,7 @@ var TileSprite = new Class({
108110
this.dirty = true;
109111

110112
/**
111-
* [description]
113+
* The texture that the Tile Sprite is rendered to, which is then rendered to a Scene.
112114
*
113115
* @name Phaser.GameObjects.TileSprite#tileTexture
114116
* @type {?WebGLTexture}
@@ -118,7 +120,7 @@ var TileSprite = new Class({
118120
this.tileTexture = null;
119121

120122
/**
121-
* [description]
123+
* The renderer in use by this Tile Sprite.
122124
*
123125
* @name Phaser.GameObjects.TileSprite#renderer
124126
* @type {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)}
@@ -222,7 +224,7 @@ var TileSprite = new Class({
222224
},
223225

224226
/**
225-
* [description]
227+
* Render the tile texture if it is dirty, or if the frame has changed.
226228
*
227229
* @method Phaser.GameObjects.TileSprite#updateTileTexture
228230
* @since 3.0.0

src/gameobjects/tilesprite/TileSpriteCreator.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ var TileSprite = require('./TileSprite');
1313
* @typedef {object} TileSprite
1414
* @extends GameObjectConfig
1515
*
16-
* @property {number} [x=0] - [description]
17-
* @property {number} [y=0] - [description]
18-
* @property {number} [width=512] - [description]
19-
* @property {number} [height=512] - [description]
20-
* @property {string} [key=''] - [description]
21-
* @property {string} [frame=''] - [description]
16+
* @property {number} [x=0] - The x coordinate of the Tile Sprite.
17+
* @property {number} [y=0] - The y coordinate of the Tile Sprite.
18+
* @property {number} [width=512] - The width of the Tile Sprite.
19+
* @property {number} [height=512] - The height of the Tile Sprite.
20+
* @property {string} [key=''] - The key of the Texture this Tile Sprite will use to render with, as stored in the Texture Manager.
21+
* @property {string} [frame=''] - An optional frame from the Texture this Tile Sprite is rendering with.
2222
*/
2323

2424
/**

0 commit comments

Comments
 (0)