Skip to content

Commit 312797d

Browse files
committed
JSDoc fixes
1 parent be15a59 commit 312797d

4 files changed

Lines changed: 15 additions & 16 deletions

File tree

src/gameobjects/video/VideoCanvasRenderer.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@
99
* The object will not render if any of its renderFlags are set or it is being actively filtered out by the Camera.
1010
* This method should not be called directly. It is a utility function of the Render module.
1111
*
12-
* @method Phaser.GameObjects.Image#renderCanvas
13-
* @since 3.0.0
12+
* @method Phaser.GameObjects.Video#renderCanvas
13+
* @since 3.20.0
1414
* @private
1515
*
1616
* @param {Phaser.Renderer.Canvas.CanvasRenderer} renderer - A reference to the current active Canvas renderer.
17-
* @param {Phaser.GameObjects.Image} src - The Game Object being rendered in this call.
17+
* @param {Phaser.GameObjects.Video} src - The Game Object being rendered in this call.
1818
* @param {number} interpolationPercentage - Reserved for future use and custom pipelines.
1919
* @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera that is rendering the Game Object.
2020
* @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - This transform matrix is defined if the game object is nested

src/gameobjects/video/VideoCreator.js

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,35 +10,34 @@ var GetAdvancedValue = require('../../utils/object/GetAdvancedValue');
1010
var Video = require('./Video');
1111

1212
/**
13-
* Creates a new Image Game Object and returns it.
13+
* Creates a new Video Game Object and returns it.
1414
*
15-
* Note: This method will only be available if the Image Game Object has been built into Phaser.
15+
* Note: This method will only be available if the Video Game Object has been built into Phaser.
1616
*
17-
* @method Phaser.GameObjects.GameObjectCreator#image
18-
* @since 3.0.0
17+
* @method Phaser.GameObjects.GameObjectCreator#video
18+
* @since 3.20.0
1919
*
2020
* @param {object} config - The configuration object this Game Object will use to create itself.
2121
* @param {boolean} [addToScene] - Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.
2222
*
23-
* @return {Phaser.GameObjects.Image} The Game Object that was created.
23+
* @return {Phaser.GameObjects.Video} The Game Object that was created.
2424
*/
2525
GameObjectCreator.register('video', function (config, addToScene)
2626
{
2727
if (config === undefined) { config = {}; }
2828

2929
var key = GetAdvancedValue(config, 'key', null);
30-
var frame = GetAdvancedValue(config, 'frame', null);
3130

32-
var image = new Video(this.scene, 0, 0, key, frame);
31+
var video = new Video(this.scene, 0, 0, key);
3332

3433
if (addToScene !== undefined)
3534
{
3635
config.add = addToScene;
3736
}
3837

39-
BuildGameObject(this.scene, image, config);
38+
BuildGameObject(this.scene, video, config);
4039

41-
return image;
40+
return video;
4241
});
4342

4443
// When registering a factory function 'this' refers to the GameObjectCreator context.

src/gameobjects/video/VideoWebGLRenderer.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@
99
* The object will not render if any of its renderFlags are set or it is being actively filtered out by the Camera.
1010
* This method should not be called directly. It is a utility function of the Render module.
1111
*
12-
* @method Phaser.GameObjects.Image#renderWebGL
13-
* @since 3.0.0
12+
* @method Phaser.GameObjects.Video#renderWebGL
13+
* @since 3.20.0
1414
* @private
1515
*
1616
* @param {Phaser.Renderer.WebGL.WebGLRenderer} renderer - A reference to the current active WebGL renderer.
17-
* @param {Phaser.GameObjects.Image} src - The Game Object being rendered in this call.
17+
* @param {Phaser.GameObjects.Video} src - The Game Object being rendered in this call.
1818
* @param {number} interpolationPercentage - Reserved for future use and custom pipelines.
1919
* @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera that is rendering the Game Object.
2020
* @param {Phaser.GameObjects.Components.TransformMatrix} parentMatrix - This transform matrix is defined if the game object is nested

src/tilemaps/dynamiclayer/DynamicTilemapLayer.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -963,7 +963,7 @@ var DynamicTilemapLayer = new Class({
963963
*
964964
* If no layer specified, the map's current layer is used.
965965
*
966-
* @method Phaser.Tilemaps.Tilemap#setCollision
966+
* @method Phaser.Tilemaps.DynamicTilemapLayer#setCollision
967967
* @since 3.0.0
968968
*
969969
* @param {(integer|array)} indexes - Either a single tile index, or an array of tile indexes.

0 commit comments

Comments
 (0)