phaser/src/gameobjects/group/GroupCreator.js
2023-01-02 17:36:27 +00:00

27 lines
960 B
JavaScript

/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2013-2023 Photon Storm Ltd.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
var GameObjectCreator = require('../GameObjectCreator');
var Group = require('./Group');
/**
* Creates a new Group Game Object and returns it.
*
* Note: This method will only be available if the Group Game Object has been built into Phaser.
*
* @method Phaser.GameObjects.GameObjectCreator#group
* @since 3.0.0
*
* @param {Phaser.Types.GameObjects.Group.GroupConfig|Phaser.Types.GameObjects.Group.GroupCreateConfig} config - The configuration object this Game Object will use to create itself.
*
* @return {Phaser.GameObjects.Group} The Game Object that was created.
*/
GameObjectCreator.register('group', function (config)
{
return new Group(this.scene, null, config);
});
// When registering a factory function 'this' refers to the GameObjectCreator context.