Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-29 16:10:56 +00:00
Code Issues Projects Releases Packages Wiki Activity

Added missing docs. Fix #5629

Browse source
This commit is contained in:
Richard Davey 2021-03-30 10:30:02 +01:00
parent 1f2b82363c
commit 8c47d54e4d
1 changed files with 25 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
src/gameobjects/GameObjectCreator.js
View file

@ -151,8 +151,19 @@ var GameObjectCreator = new Class({
});
// Static method called directly by the Game Object creator functions
/**
* Static method called directly by the Game Object creator functions.
* With this method you can register a custom GameObject factory in the GameObjectCreator,
* providing a name (`factoryType`) and the constructor (`factoryFunction`) in order
* to be called when you invoke Phaser.Scene.make[ factoryType ] method.
*
* @method Phaser.GameObjects.GameObjectCreator.register
* @static
* @since 3.0.0
*
* @param {string} factoryType - The key of the factory that you will use to call to Phaser.Scene.make[ factoryType ] method.
* @param {function} factoryFunction - The constructor function to be called when you invoke to the Phaser.Scene.make method.
*/
GameObjectCreator.register = function (factoryType, factoryFunction)
{
if (!GameObjectCreator.prototype.hasOwnProperty(factoryType))
@ -161,6 +172,18 @@ GameObjectCreator.register = function (factoryType, factoryFunction)
}
};
/**
* Static method called directly by the Game Object Creator functions.
*
* With this method you can remove a custom Game Object Creator that has been previously
* registered in the Game Object Creator. Pass in its `factoryType` in order to remove it.
*
* @method Phaser.GameObjects.GameObjectCreator.remove
* @static
* @since 3.0.0
*
* @param {string} factoryType - The key of the factory that you want to remove from the GameObjectCreator.
*/
GameObjectCreator.remove = function (factoryType)
{
if (GameObjectCreator.prototype.hasOwnProperty(factoryType))