phaser/src/gameobjects/image/ImageCreator.js
2018-02-12 16:01:21 +00:00

36 lines
1.1 KiB
JavaScript

/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2018 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
var BuildGameObject = require('../BuildGameObject');
var GameObjectCreator = require('../GameObjectCreator');
var GetAdvancedValue = require('../../utils/object/GetAdvancedValue');
var Image = require('./Image');
/**
* Creates a new Image Game Object and returns it.
*
* Note: This method will only be available if the Image Game Object has been built into Phaser.
*
* @method Phaser.GameObjects.GameObjectCreator#image
* @since 3.0.0
*
* @param {object} config - [description]
*
* @return {Phaser.GameObjects.Image} The Game Object that was created.
*/
GameObjectCreator.register('image', function (config)
{
var key = GetAdvancedValue(config, 'key', null);
var frame = GetAdvancedValue(config, 'frame', null);
var image = new Image(this.scene, 0, 0, key, frame);
BuildGameObject(this.scene, image, config);
return image;
});
// When registering a factory function 'this' refers to the GameObjectCreator context.