Skip to content

Commit e3f73b8

Browse files
committed
Fixed some jsdocs issues and added the Image.alive property.
1 parent 05922d6 commit e3f73b8

1 file changed

Lines changed: 17 additions & 11 deletions

File tree

src/gameobjects/Image.js

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,12 @@ Phaser.Image = function (game, x, y, key, frame) {
7171
*/
7272
this.world = new Phaser.Point(x, y);
7373

74+
/**
75+
* @property {boolean} alive - A useful boolean to control if the Image is alive or dead (in terms of your gameplay, it doesn't effect rendering).
76+
* @default
77+
*/
78+
this.alive = true;
79+
7480
/**
7581
* Should this Image be automatically culled if out of range of the camera?
7682
* A culled sprite has its renderable property set to 'false'.
@@ -284,12 +290,12 @@ Phaser.Image.prototype.loadTexture = function (key, frame) {
284290
};
285291

286292
/**
287-
* Sets the Texture frame the Sprite uses for rendering.
288-
* This is primarily an internal method used by Sprite.loadTexture, although you may call it directly.
293+
* Sets the Texture frame the Image uses for rendering.
294+
* This is primarily an internal method used by Image.loadTexture, although you may call it directly.
289295
*
290-
* @method Phaser.Sprite#setFrame
291-
* @memberof Phaser.Sprite
292-
* @param {Phaser.Frame} frame - The Frame to be used by the Sprite texture.
296+
* @method Phaser.Image#setFrame
297+
* @memberof Phaser.Image
298+
* @param {Phaser.Frame} frame - The Frame to be used by the Image texture.
293299
*/
294300
Phaser.Image.prototype.setFrame = function(frame) {
295301

@@ -340,10 +346,10 @@ Phaser.Image.prototype.setFrame = function(frame) {
340346
};
341347

342348
/**
343-
* Resets the Texture frame dimensions that the Sprite uses for rendering.
349+
* Resets the Texture frame dimensions that the Image uses for rendering.
344350
*
345-
* @method Phaser.Sprite#resetFrame
346-
* @memberof Phaser.Sprite
351+
* @method Phaser.Image#resetFrame
352+
* @memberof Phaser.Image
347353
*/
348354
Phaser.Image.prototype.resetFrame = function() {
349355

@@ -397,11 +403,11 @@ Phaser.Image.prototype.crop = function(rect) {
397403
};
398404

399405
/**
400-
* If you have set a crop rectangle on this Sprite via Sprite.crop and since modified the Sprite.cropRect property (or the rectangle it references)
406+
* If you have set a crop rectangle on this Image via Image.crop and since modified the Image.cropRect property (or the rectangle it references)
401407
* then you need to update the crop frame by calling this method.
402408
*
403-
* @method Phaser.Sprite#updateCrop
404-
* @memberof Phaser.Sprite
409+
* @method Phaser.Image#updateCrop
410+
* @memberof Phaser.Image
405411
*/
406412
Phaser.Image.prototype.updateCrop = function() {
407413

0 commit comments

Comments
 (0)