From 35517d94ad865694f21f0aaed663b67afaf084bb Mon Sep 17 00:00:00 2001 From: Webeled Date: Fri, 25 Oct 2013 14:31:25 +0100 Subject: [PATCH 1/3] Just to test if smartGit works again --- src/gameobjects/GameObjectFactory.js | 34 ++++++++++++++-------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/src/gameobjects/GameObjectFactory.js b/src/gameobjects/GameObjectFactory.js index 3095d1d76..dbd996a1d 100644 --- a/src/gameobjects/GameObjectFactory.js +++ b/src/gameobjects/GameObjectFactory.js @@ -58,7 +58,7 @@ Phaser.GameObjectFactory.prototype = { * @method sprite * @param {number} x - X position of the new sprite. * @param {number} y - Y position of the new sprite. - * @param {string|RenderTexture} [key] - The image key as defined in the Game.Cache to use as the texture for this sprite OR a RenderTexture. + * @param {string|Phaser.RenderTexture|PIXI.Texture} key - This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture. * @param {string|number} [frame] - If the sprite uses an image from a texture atlas or sprite sheet you can pass the frame here. Either a number for a frame ID or a string for a frame name. * @returns {Description} Description. */ @@ -90,7 +90,7 @@ Phaser.GameObjectFactory.prototype = { * * @method tween * @param {object} obj - Object the tween will be run on. - * @return {Description} Description. + * @return {Phaser.Tween} Description. */ tween: function (obj) { @@ -99,12 +99,12 @@ Phaser.GameObjectFactory.prototype = { }, /** - * Description. + * Creates a new group to be added on the display list * * @method group * @param {Description} parent - Description. * @param {Description} name - Description. - * @return {Description} Description. + * @return {Phaser.Group} The newly created group. */ group: function (parent, name) { @@ -116,10 +116,10 @@ Phaser.GameObjectFactory.prototype = { * Description. * * @method audio - * @param {Description} key - Description. - * @param {Description} volume - Description. - * @param {Description} loop - Description. - * @return {Description} Description. + * @param {string} key - The Game.cache key of the sound that this object will use. + * @param {number} volume - The volume at which the sound will be played. + * @param {boolean} loop - Whether or not the sound will loop. + * @return {Phaser.Audio} The audio object. */ audio: function (key, volume, loop) { @@ -131,11 +131,11 @@ Phaser.GameObjectFactory.prototype = { * Description. * * @method tileSprite - * @param {Description} x - Description. - * @param {Description} y - Description. - * @param {Description} width - Description. - * @param {Description} height - Description. - * @param {Description} key - Description. + * @param {number} x - X position of the new tileSprite. + * @param {number} y - Y position of the new tileSprite. + * @param {Description} width - the width of the tilesprite. + * @param {Description} height - the height of the tilesprite. + * @param {string|Phaser.RenderTexture|PIXI.Texture} key - This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture. * @param {Description} frame - Description. * @return {Description} Description. */ @@ -149,10 +149,10 @@ Phaser.GameObjectFactory.prototype = { * Description. * * @method text - * @param {Description} x - Description. - * @param {Description} y - Description. - * @param {Description} text - Description. - * @param {Description} style - Description. + * @param {number} x - X position of the new text object. + * @param {number} y - Y position of the new text object. + * @param {string} text - The actual text that will be written. + * @param {object} style - The style object containing style attributes like font, font size , etc. */ text: function (x, y, text, style) { From ce04ade45843f6b7ccce256ebb73de30ade4d206 Mon Sep 17 00:00:00 2001 From: Webeled Date: Fri, 25 Oct 2013 15:22:45 +0100 Subject: [PATCH 2/3] Lots of JSDocs updates in the gameobjects folder --- src/gameobjects/BitmapText.js | 9 ++- src/gameobjects/Bullet.js | 10 ++- src/gameobjects/Button.js | 1 - src/gameobjects/Events.js | 1 - src/gameobjects/GameObjectFactory.js | 97 ++++++++++++++-------------- src/gameobjects/Graphics.js | 5 +- src/gameobjects/RenderTexture.js | 14 ++-- src/gameobjects/Text.js | 10 ++- src/gameobjects/TileSprite.js | 14 ++-- 9 files changed, 74 insertions(+), 87 deletions(-) diff --git a/src/gameobjects/BitmapText.js b/src/gameobjects/BitmapText.js index 77fb274ae..4558a4111 100644 --- a/src/gameobjects/BitmapText.js +++ b/src/gameobjects/BitmapText.js @@ -2,7 +2,6 @@ * @author Richard Davey * @copyright 2013 Photon Storm Ltd. * @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License} -* @module Phaser.BitmapText */ /** @@ -12,10 +11,10 @@ * @class Phaser.BitmapText * @constructor * @param {Phaser.Game} game - A reference to the currently running game. -* @param {number} x - X position of Description. -* @param {number} y - Y position of Description. -* @param {string} text - Description. -* @param {string} style - Description. +* @param {number} x - X position of the new bitmapText object. +* @param {number} y - Y position of the new bitmapText object. +* @param {string} text - The actual text that will be written. +* @param {object} style - The style object containing style attributes like font, font size , etc. */ Phaser.BitmapText = function (game, x, y, text, style) { diff --git a/src/gameobjects/Bullet.js b/src/gameobjects/Bullet.js index 4c131a3bd..d5a491d75 100644 --- a/src/gameobjects/Bullet.js +++ b/src/gameobjects/Bullet.js @@ -2,7 +2,6 @@ * @author Richard Davey * @copyright 2013 Photon Storm Ltd. * @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License} -* @module Phaser.Bullet */ /** @@ -15,13 +14,12 @@ * animation, all input events, crop support, health/damage, loadTexture * * @class Phaser.Bullet -* @classdesc Description of class. * @constructor * @param {Phaser.Game} game - Current game instance. -* @param {Description} x - Description. -* @param {Description} y - Description. -* @param {string} key - Description. -* @param {Description} frame - Description. +* @param {number} x - X position of the new bullet. +* @param {number} y - Y position of the new bullet. +* @param {string|Phaser.RenderTexture|PIXI.Texture} key - This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture. +* @param {string|number} frame - If this Sprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index. */ Phaser.Bullet = function (game, x, y, key, frame) { diff --git a/src/gameobjects/Button.js b/src/gameobjects/Button.js index 2b1832dae..63bceb825 100644 --- a/src/gameobjects/Button.js +++ b/src/gameobjects/Button.js @@ -2,7 +2,6 @@ * @author Richard Davey * @copyright 2013 Photon Storm Ltd. * @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License} -* @module Phaser.Button */ diff --git a/src/gameobjects/Events.js b/src/gameobjects/Events.js index 1cd1b9e90..73fe1abd1 100644 --- a/src/gameobjects/Events.js +++ b/src/gameobjects/Events.js @@ -2,7 +2,6 @@ * @author Richard Davey * @copyright 2013 Photon Storm Ltd. * @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License} -* @module Phaser.Events */ diff --git a/src/gameobjects/GameObjectFactory.js b/src/gameobjects/GameObjectFactory.js index dbd996a1d..e86c3b1d0 100644 --- a/src/gameobjects/GameObjectFactory.js +++ b/src/gameobjects/GameObjectFactory.js @@ -2,7 +2,6 @@ * @author Richard Davey * @copyright 2013 Photon Storm Ltd. * @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License} -* @module Phaser.GameObjectFactory */ /** @@ -43,8 +42,8 @@ Phaser.GameObjectFactory.prototype = { /** * Description. * @method existing. - * @param {object} - Description. - * @return {boolean} Description. + * @param {*} object - An instance of Phaser.Sprite, Phaser.Button or any other display object.. + * @return {*} The child that was added to the Group. */ existing: function (object) { @@ -60,7 +59,7 @@ Phaser.GameObjectFactory.prototype = { * @param {number} y - Y position of the new sprite. * @param {string|Phaser.RenderTexture|PIXI.Texture} key - This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture. * @param {string|number} [frame] - If the sprite uses an image from a texture atlas or sprite sheet you can pass the frame here. Either a number for a frame ID or a string for a frame name. - * @returns {Description} Description. + * @returns {Phaser.Sprite} the newly created sprite object. */ sprite: function (x, y, key, frame) { @@ -77,7 +76,7 @@ Phaser.GameObjectFactory.prototype = { * @param {number} y - Y position of the new sprite. * @param {string|RenderTexture} [key] - The image key as defined in the Game.Cache to use as the texture for this sprite OR a RenderTexture. * @param {string|number} [frame] - If the sprite uses an image from a texture atlas or sprite sheet you can pass the frame here. Either a number for a frame ID or a string for a frame name. - * @returns {Description} Description. + * @returns {Phaser.Sprite} the newly created sprite object. */ child: function (group, x, y, key, frame) { @@ -102,8 +101,8 @@ Phaser.GameObjectFactory.prototype = { * Creates a new group to be added on the display list * * @method group - * @param {Description} parent - Description. - * @param {Description} name - Description. + * @param {*} parent - The parent Group or DisplayObjectContainer that will hold this group, if any. + * @param {string} [name=group] - A name for this Group. Not used internally but useful for debugging. * @return {Phaser.Group} The newly created group. */ group: function (parent, name) { @@ -119,7 +118,7 @@ Phaser.GameObjectFactory.prototype = { * @param {string} key - The Game.cache key of the sound that this object will use. * @param {number} volume - The volume at which the sound will be played. * @param {boolean} loop - Whether or not the sound will loop. - * @return {Phaser.Audio} The audio object. + * @return {Phaser.Sound} The newly created text object. */ audio: function (key, volume, loop) { @@ -133,11 +132,11 @@ Phaser.GameObjectFactory.prototype = { * @method tileSprite * @param {number} x - X position of the new tileSprite. * @param {number} y - Y position of the new tileSprite. - * @param {Description} width - the width of the tilesprite. - * @param {Description} height - the height of the tilesprite. + * @param {number} width - the width of the tilesprite. + * @param {number} height - the height of the tilesprite. * @param {string|Phaser.RenderTexture|PIXI.Texture} key - This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture. - * @param {Description} frame - Description. - * @return {Description} Description. + * @param {string|number} frame - If this Sprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index. + * @return {Phaser.TileSprite} The newly created tileSprite object. */ tileSprite: function (x, y, width, height, key, frame) { @@ -153,6 +152,7 @@ Phaser.GameObjectFactory.prototype = { * @param {number} y - Y position of the new text object. * @param {string} text - The actual text that will be written. * @param {object} style - The style object containing style attributes like font, font size , etc. + * @return {Phaser.Text} The newly created text object. */ text: function (x, y, text, style) { @@ -164,14 +164,15 @@ Phaser.GameObjectFactory.prototype = { * Description. * * @method button - * @param {Description} x - Description. - * @param {Description} y - Description. - * @param {Description} callback - Description. - * @param {Description} callbackContext - Description. - * @param {Description} overFrame - Description. - * @param {Description} outFrame - Description. - * @param {Description} downFrame - Description. - * @return {Description} Description. + * @param {number} [x] X position of the new button object. + * @param {number} [y] Y position of the new button object. + * @param {string} [key] The image key as defined in the Game.Cache to use as the texture for this button. + * @param {function} [callback] The function to call when this button is pressed + * @param {object} [callbackContext] The context in which the callback will be called (usually 'this') + * @param {string|number} [overFrame] This is the frame or frameName that will be set when this button is in an over state. Give either a number to use a frame ID or a string for a frame name. + * @param {string|number} [outFrame] This is the frame or frameName that will be set when this button is in an out state. Give either a number to use a frame ID or a string for a frame name. + * @param {string|number} [downFrame] This is the frame or frameName that will be set when this button is in a down state. Give either a number to use a frame ID or a string for a frame name. + * @return {Phaser.Button} The newly created button object. */ button: function (x, y, key, callback, callbackContext, overFrame, outFrame, downFrame) { @@ -183,9 +184,9 @@ Phaser.GameObjectFactory.prototype = { * Description. * * @method graphics - * @param {Description} x - Description. - * @param {Description} y - Description. - * @return {Description} Description. + * @param {number} x - X position of the new graphics object. + * @param {number} y - Y position of the new graphics object. + * @return {Phaser.Graphics} The newly created graphics object. */ graphics: function (x, y) { @@ -197,10 +198,10 @@ Phaser.GameObjectFactory.prototype = { * Description. * * @method emitter - * @param {Description} x - Description. - * @param {Description} y - Description. - * @param {Description} maxParticles - Description. - * @return {Description} Description. + * @param {number} [x=0] - The x coordinate within the Emitter that the particles are emitted from. + * @param {number} [y=0] - The y coordinate within the Emitter that the particles are emitted from. + * @param {number} [maxParticles=50] - The total number of particles in this emitter. + * @return {Phaser.Emitter} The newly created emitter object. */ emitter: function (x, y, maxParticles) { @@ -212,11 +213,11 @@ Phaser.GameObjectFactory.prototype = { * Description. * * @method bitmapText - * @param {Description} x - Description. - * @param {Description} y - Description. - * @param {Description} text - Description. - * @param {Description} style - Description. - * @return {Description} Description. + * @param {number} x - X position of the new bitmapText object. + * @param {number} y - Y position of the new bitmapText object. + * @param {string} text - The actual text that will be written. + * @param {object} style - The style object containing style attributes like font, font size , etc. + * @return {Phaser.BitmapText} The newly created bitmapText object. */ bitmapText: function (x, y, text, style) { @@ -228,8 +229,8 @@ Phaser.GameObjectFactory.prototype = { * Description. * * @method tilemap - * @param {Description} key - Description. - * @return {Description} Description. + * @param {string} key - Asset key for the JSON file. + * @return {Phaser.Tilemap} The newly created tilemap object. */ tilemap: function (key) { @@ -240,9 +241,9 @@ Phaser.GameObjectFactory.prototype = { /** * Description. * - * @method tilemap - * @param {Description} key - Description. - * @return {Description} Description. + * @method tileset + * @param {string} key - The image key as defined in the Game.Cache to use as the tileset. + * @return {Phaser.Tileset} The newly created tileset object. */ tileset: function (key) { @@ -253,14 +254,12 @@ Phaser.GameObjectFactory.prototype = { /** * Description. * - * @method tileSprite - * @param {Description} x - Description. - * @param {Description} y - Description. - * @param {Description} width - Description. - * @param {Description} height - Description. - * @param {Description} key - Description. - * @param {Description} frame - Description. - * @return {Description} Description. + * @method tilemaplayer + * @param {number} x - X position of the new tilemapLayer. + * @param {number} y - Y position of the new tilemapLayer. + * @param {number} width - the width of the tilemapLayer. + * @param {number} height - the height of the tilemapLayer. + * @return {Phaser.TilemapLayer} The newly created tilemaplayer object. */ tilemapLayer: function (x, y, width, height, tileset, tilemap, layer) { @@ -272,10 +271,10 @@ Phaser.GameObjectFactory.prototype = { * Description. * * @method renderTexture - * @param {Description} key - Description. - * @param {Description} width - Description. - * @param {Description} height - Description. - * @return {Description} Description. + * @param {string} key - Asset key for the render texture. + * @param {number} width - the width of the render texture. + * @param {number} height - the height of the render texture. + * @return {Phaser.RenderTexture} The newly created renderTexture object. */ renderTexture: function (key, width, height) { diff --git a/src/gameobjects/Graphics.js b/src/gameobjects/Graphics.js index e58e811f3..c1706ea12 100644 --- a/src/gameobjects/Graphics.js +++ b/src/gameobjects/Graphics.js @@ -2,7 +2,6 @@ * @author Richard Davey * @copyright 2013 Photon Storm Ltd. * @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License} -* @module Phaser.Graphics */ /** @@ -12,8 +11,8 @@ * @constructor * * @param {Phaser.Game} game Current game instance. -* @param {number} [x] X position of Description. -* @param {number} [y] Y position of Description. +* @param {number} x - X position of the new graphics object. +* @param {number} y - Y position of the new graphics object. */ Phaser.Graphics = function (game, x, y) { diff --git a/src/gameobjects/RenderTexture.js b/src/gameobjects/RenderTexture.js index 3a2131063..ee5799d3a 100644 --- a/src/gameobjects/RenderTexture.js +++ b/src/gameobjects/RenderTexture.js @@ -2,18 +2,16 @@ * @author Richard Davey * @copyright 2013 Photon Storm Ltd. * @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License} -* @module Phaser.RenderTexture */ /** * Description of constructor. * @class Phaser.RenderTexture -* @classdesc Description of class. * @constructor * @param {Phaser.Game} game - Current game instance. -* @param {string} key - Description. -* @param {number} width - Description. -* @param {number} height - Description. +* @param {string} key - Asset key for the render texture. +* @param {number} width - the width of the render texture. +* @param {number} height - the height of the render texture. */ Phaser.RenderTexture = function (game, key, width, height) { @@ -23,19 +21,19 @@ Phaser.RenderTexture = function (game, key, width, height) { this.game = game; /** - * @property {Description} name - Description. + * @property {string} name - the name of the object. */ this.name = key; PIXI.EventTarget.call( this ); /** - * @property {number} width - Description. + * @property {number} width - the width. */ this.width = width || 100; /** - * @property {number} height - Description. + * @property {number} height - the height. */ this.height = height || 100; diff --git a/src/gameobjects/Text.js b/src/gameobjects/Text.js index d2c9caca2..762477f38 100644 --- a/src/gameobjects/Text.js +++ b/src/gameobjects/Text.js @@ -2,19 +2,17 @@ * @author Richard Davey * @copyright 2013 Photon Storm Ltd. * @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License} -* @module Phaser.Text */ /** * Create a new Text. * @class Phaser.Text -* @classdesc Description of class. * @constructor * @param {Phaser.Game} game - Current game instance. -* @param {Description} x - Description. -* @param {Description} y - Description. -* @param {string} text - Description. -* @param {string} style - Description. +* @param {number} x - X position of the new text object. +* @param {number} y - Y position of the new text object. +* @param {string} text - The actual text that will be written. +* @param {object} style - The style object containing style attributes like font, font size , */ Phaser.Text = function (game, x, y, text, style) { diff --git a/src/gameobjects/TileSprite.js b/src/gameobjects/TileSprite.js index f274940f4..c9ee3ddae 100644 --- a/src/gameobjects/TileSprite.js +++ b/src/gameobjects/TileSprite.js @@ -2,21 +2,19 @@ * @author Richard Davey * @copyright 2013 Photon Storm Ltd. * @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License} -* @module Phaser.TileSprite */ /** * Create a new TileSprite. * @class Phaser.Tilemap -* @classdesc Class description. * @constructor * @param {Phaser.Game} game - Current game instance. -* @param {object} x - Description. -* @param {object} y - Description. -* @param {number} width - Description. -* @param {number} height - Description. -* @param {string} key - Description. -* @param {Description} frame - Description. +* @param {number} x - X position of the new tileSprite. +* @param {number} y - Y position of the new tileSprite. +* @param {number} width - the width of the tilesprite. +* @param {number} height - the height of the tilesprite. +* @param {string|Phaser.RenderTexture|PIXI.Texture} key - This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture. +* @param {string|number} frame - If this Sprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index. */ Phaser.TileSprite = function (game, x, y, width, height, key, frame) { From 12148b315933f95350b1ef2340e0a64efe92984a Mon Sep 17 00:00:00 2001 From: Webeled Date: Fri, 25 Oct 2013 15:42:48 +0100 Subject: [PATCH 3/3] More improvements on GameObjectFactory --- src/gameobjects/BitmapText.js | 4 +--- src/gameobjects/GameObjectFactory.js | 20 +++++++++++--------- src/gameobjects/Graphics.js | 2 +- src/gameobjects/RenderTexture.js | 2 +- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/src/gameobjects/BitmapText.js b/src/gameobjects/BitmapText.js index 4558a4111..8090d8f84 100644 --- a/src/gameobjects/BitmapText.js +++ b/src/gameobjects/BitmapText.js @@ -5,9 +5,7 @@ */ /** -* An Animation instance contains a single animation and the controls to play it. -* It is created by the AnimationManager, consists of Animation.Frame objects and belongs to a single Game Object such as a Sprite. -* +* Creates a new BitmapText. * @class Phaser.BitmapText * @constructor * @param {Phaser.Game} game - A reference to the currently running game. diff --git a/src/gameobjects/GameObjectFactory.js b/src/gameobjects/GameObjectFactory.js index e86c3b1d0..ebd37ed5b 100644 --- a/src/gameobjects/GameObjectFactory.js +++ b/src/gameobjects/GameObjectFactory.js @@ -98,7 +98,7 @@ Phaser.GameObjectFactory.prototype = { }, /** - * Creates a new group to be added on the display list + * A Group is a container for display objects that allows for fast pooling, recycling and collision checks. * * @method group * @param {*} parent - The parent Group or DisplayObjectContainer that will hold this group, if any. @@ -112,7 +112,7 @@ Phaser.GameObjectFactory.prototype = { }, /** - * Description. + * Creates a new instance of the Sound class. * * @method audio * @param {string} key - The Game.cache key of the sound that this object will use. @@ -127,7 +127,7 @@ Phaser.GameObjectFactory.prototype = { }, /** - * Description. + * Creates a new TileSprite. * * @method tileSprite * @param {number} x - X position of the new tileSprite. @@ -145,7 +145,7 @@ Phaser.GameObjectFactory.prototype = { }, /** - * Description. + * Creates a new Text. * * @method text * @param {number} x - X position of the new text object. @@ -161,7 +161,7 @@ Phaser.GameObjectFactory.prototype = { }, /** - * Description. + * Creates a new Button object. * * @method button * @param {number} [x] X position of the new button object. @@ -181,7 +181,7 @@ Phaser.GameObjectFactory.prototype = { }, /** - * Description. + * Creates a new Graphics object. * * @method graphics * @param {number} x - X position of the new graphics object. @@ -195,7 +195,9 @@ Phaser.GameObjectFactory.prototype = { }, /** - * Description. + * Emitter is a lightweight particle emitter. It can be used for one-time explosions or for + * continuous effects like rain and fire. All it really does is launch Particle objects out + * at set intervals, and fixes their positions and velocities accorindgly. * * @method emitter * @param {number} [x=0] - The x coordinate within the Emitter that the particles are emitted from. @@ -210,7 +212,7 @@ Phaser.GameObjectFactory.prototype = { }, /** - * Description. + * * Create a new BitmapText. * * @method bitmapText * @param {number} x - X position of the new bitmapText object. @@ -268,7 +270,7 @@ Phaser.GameObjectFactory.prototype = { }, /** - * Description. + * A dynamic initially blank canvas to which images can be drawn * * @method renderTexture * @param {string} key - Asset key for the render texture. diff --git a/src/gameobjects/Graphics.js b/src/gameobjects/Graphics.js index c1706ea12..e2303e9f3 100644 --- a/src/gameobjects/Graphics.js +++ b/src/gameobjects/Graphics.js @@ -5,7 +5,7 @@ */ /** -* Description. +* Creates a new Graphics object. * * @class Phaser.Graphics * @constructor diff --git a/src/gameobjects/RenderTexture.js b/src/gameobjects/RenderTexture.js index ee5799d3a..597fd7008 100644 --- a/src/gameobjects/RenderTexture.js +++ b/src/gameobjects/RenderTexture.js @@ -5,7 +5,7 @@ */ /** -* Description of constructor. +* A dynamic initially blank canvas to which images can be drawn * @class Phaser.RenderTexture * @constructor * @param {Phaser.Game} game - Current game instance.