mirror of
https://github.com/photonstorm/phaser
synced 2025-01-25 19:35:15 +00:00
43 lines
1.4 KiB
JavaScript
43 lines
1.4 KiB
JavaScript
/**
|
|
* @author Richard Davey <rich@photonstorm.com>
|
|
* @copyright 2013-2023 Photon Storm Ltd.
|
|
* @license {@link https://opensource.org/licenses/MIT|MIT License}
|
|
*/
|
|
|
|
var BuildGameObject = require('../BuildGameObject');
|
|
var GameObjectCreator = require('../GameObjectCreator');
|
|
var GetAdvancedValue = require('../../utils/object/GetAdvancedValue');
|
|
var Video = require('./Video');
|
|
|
|
/**
|
|
* Creates a new Video Game Object and returns it.
|
|
*
|
|
* Note: This method will only be available if the Video Game Object has been built into Phaser.
|
|
*
|
|
* @method Phaser.GameObjects.GameObjectCreator#video
|
|
* @since 3.20.0
|
|
*
|
|
* @param {Phaser.Types.GameObjects.Video.VideoConfig} config - The configuration object this Game Object will use to create itself.
|
|
* @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.
|
|
*
|
|
* @return {Phaser.GameObjects.Video} The Game Object that was created.
|
|
*/
|
|
GameObjectCreator.register('video', function (config, addToScene)
|
|
{
|
|
if (config === undefined) { config = {}; }
|
|
|
|
var key = GetAdvancedValue(config, 'key', null);
|
|
|
|
var video = new Video(this.scene, 0, 0, key);
|
|
|
|
if (addToScene !== undefined)
|
|
{
|
|
config.add = addToScene;
|
|
}
|
|
|
|
BuildGameObject(this.scene, video, config);
|
|
|
|
return video;
|
|
});
|
|
|
|
// When registering a factory function 'this' refers to the GameObjectCreator context.
|