phaser/src/gameobjects/video/VideoFactory.js

41 lines
1.4 KiB
JavaScript
Raw Normal View History

2019-10-03 01:29:05 +00:00
/**
* @author Richard Davey <rich@photonstorm.com>
2020-01-15 12:07:09 +00:00
* @copyright 2020 Photon Storm Ltd.
2019-10-03 01:29:05 +00:00
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
var Video = require('./Video');
var GameObjectFactory = require('../GameObjectFactory');
/**
2020-02-13 12:13:13 +00:00
* Creates a new Video Game Object and adds it to the Scene.
2019-10-03 01:29:05 +00:00
*
2020-02-13 12:13:13 +00:00
* Note: This method will only be available if the Video Game Object has been built into Phaser.
2019-10-03 01:29:05 +00:00
*
* @method Phaser.GameObjects.GameObjectFactory#video
* @since 3.20.0
*
* @param {number} x - The horizontal position of this Game Object in the world.
* @param {number} y - The vertical position of this Game Object in the world.
2020-02-13 12:13:13 +00:00
* @param {string} [key] - Optional key of the Video this Game Object will play, as stored in the Video Cache.
2019-10-03 01:29:05 +00:00
*
2020-02-13 12:13:13 +00:00
* @return {Phaser.GameObjects.Video} The Game Object that was created.
2019-10-03 01:29:05 +00:00
*/
2019-10-09 16:42:37 +00:00
GameObjectFactory.register('video', function (x, y, key)
2019-10-03 01:29:05 +00:00
{
2019-10-09 16:42:37 +00:00
var video = new Video(this.scene, x, y, key);
2019-10-03 01:29:05 +00:00
this.displayList.add(video);
this.updateList.add(video);
return video;
});
// When registering a factory function 'this' refers to the GameObjectFactory context.
//
// There are several properties available to use:
//
// this.scene - a reference to the Scene that owns the GameObjectFactory
// this.displayList - a reference to the Display List the Scene owns
// this.updateList - a reference to the Update List the Scene owns