phaser/v3/merge/gameobjects/text/TextFactory.js
2016-11-23 00:17:46 +00:00

40 lines
1.8 KiB
JavaScript

/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2016 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
Phaser.GameObject.Text.FACTORY_KEY = 'text';
/**
* Creates a new Text object.
*
* @method Phaser.GameObject.Factory#text
* @param {number} [x=0] - The x coordinate of the Text. The coordinate is relative to any parent container this text may be in.
* @param {number} [y=0] - The y coordinate of the Text. The coordinate is relative to any parent container this text may be in.
* @param {string} [text=''] - The text string that will be displayed.
* @param {object} [style] - The style object containing style attributes like font, font size , etc.
* @param {Phaser.Group} [group] - Optional Group to add the object to. If not specified it will be added to the World group.
* @return {Phaser.Text} The newly created text object.
*/
Phaser.GameObject.Text.FACTORY_ADD = function (x, y, text, style, group)
{
if (group === undefined) { group = this.world; }
return group.add(new Phaser.GameObject.Text(this.game, x, y, text, style));
};
/**
* Creates a new Text object.
*
* @method Phaser.GameObject.Creator#text
* @param {number} [x=0] - The x coordinate of the Text. The coordinate is relative to any parent container this text may be in.
* @param {number} [y=0] - The y coordinate of the Text. The coordinate is relative to any parent container this text may be in.
* @param {string} [text=''] - The text string that will be displayed.
* @param {object} [style] - The style object containing style attributes like font, font size , etc.
* @return {Phaser.Text} The newly created text object.
*/
Phaser.GameObject.Text.FACTORY_MAKE = function (x, y, text, style)
{
return new Phaser.GameObject.Text(this.game, x, y, text, style);
};