Group Types

Author: photonstorm

src/gameobjects/group/Group.js

@@ -27,8 +27,8 @@ var Sprite = require('../sprite/Sprite');
  * @constructor
  * @since 3.0.0
  * @param {Phaser.Scene} scene - The scene this group belongs to.
- * @param {(Phaser.GameObjects.GameObject[]|Phaser.GameObjects.Group.Types.GroupConfig|Phaser.GameObjects.Group.Types.GroupCreateConfig)} [children] - Game Objects to add to this group; or the `config` argument.
- * @param {Phaser.GameObjects.Group.Types.GroupConfig|Phaser.GameObjects.Group.Types.GroupCreateConfig} [config] - Settings for this group. If `key` is set, Phaser.GameObjects.Group#createMultiple is also called with these settings.
+ * @param {(Phaser.GameObjects.GameObject[]|Phaser.Types.GameObjects.Group.GroupConfig|Phaser.Types.GameObjects.Group.GroupCreateConfig)} [children] - Game Objects to add to this group; or the `config` argument.
+ * @param {Phaser.Types.GameObjects.Group.GroupConfig|Phaser.Types.GameObjects.Group.GroupCreateConfig} [config] - Settings for this group. If `key` is set, Phaser.GameObjects.Group#createMultiple is also called with these settings.
  *
  * @see Phaser.Physics.Arcade.Group
  * @see Phaser.Physics.Arcade.StaticGroup
@@ -107,7 +107,7 @@ var Group = new Class({
          * The class to create new group members from.
          *
          * @name Phaser.GameObjects.Group#classType
-         * @type {Phaser.GameObjects.Group.Types.GroupClassTypeConstructor}
+         * @type {Phaser.Types.GameObjects.Group.GroupClassTypeConstructor}
          * @since 3.0.0
          * @default Phaser.GameObjects.Sprite
          */
@@ -169,7 +169,7 @@ var Group = new Class({
          * A function to be called when adding or creating group members.
          *
          * @name Phaser.GameObjects.Group#createCallback
-         * @type {?Phaser.GameObjects.Group.Types.GroupCallback}
+         * @type {?Phaser.Types.GameObjects.Group.GroupCallback}
          * @since 3.0.0
          */
         this.createCallback = GetFastValue(config, 'createCallback', null);
@@ -178,7 +178,7 @@ var Group = new Class({
          * A function to be called when removing group members.
          *
          * @name Phaser.GameObjects.Group#removeCallback
-         * @type {?Phaser.GameObjects.Group.Types.GroupCallback}
+         * @type {?Phaser.Types.GameObjects.Group.GroupCallback}
          * @since 3.0.0
          */
         this.removeCallback = GetFastValue(config, 'removeCallback', null);
@@ -187,7 +187,7 @@ var Group = new Class({
          * A function to be called when creating several group members at once.
          *
          * @name Phaser.GameObjects.Group#createMultipleCallback
-         * @type {?Phaser.GameObjects.Group.Types.GroupMultipleCreateCallback}
+         * @type {?Phaser.Types.GameObjects.Group.GroupMultipleCreateCallback}
          * @since 3.0.0
          */
         this.createMultipleCallback = GetFastValue(config, 'createMultipleCallback', null);
@@ -257,7 +257,7 @@ var Group = new Class({
      * @method Phaser.GameObjects.Group#createMultiple
      * @since 3.0.0
      *
-     * @param {Phaser.GameObjects.Group.Types.GroupCreateConfig|Phaser.GameObjects.Group.Types.GroupCreateConfig[]} config - Creation settings. This can be a single configuration object or an array of such objects, which will be applied in turn.
+     * @param {Phaser.Types.GameObjects.Group.GroupCreateConfig|Phaser.Types.GameObjects.Group.GroupCreateConfig[]} config - Creation settings. This can be a single configuration object or an array of such objects, which will be applied in turn.
      *
      * @return {any[]} The newly created Game Objects.
      */
@@ -294,7 +294,7 @@ var Group = new Class({
      * @method Phaser.GameObjects.Group#createFromConfig
      * @since 3.0.0
      *
-     * @param {Phaser.GameObjects.Group.Types.GroupCreateConfig} options - Creation settings.
+     * @param {Phaser.Types.GameObjects.Group.GroupCreateConfig} options - Creation settings.
      *
      * @return {any[]} The newly created Game Objects.
      */

src/gameobjects/group/GroupCreator.js

@@ -15,7 +15,7 @@ var Group = require('./Group');
  * @method Phaser.GameObjects.GameObjectCreator#group
  * @since 3.0.0
  *
- * @param {Phaser.GameObjects.Group.Types.GroupConfig|Phaser.GameObjects.Group.Types.GroupCreateConfig} config - The configuration object this Game Object will use to create itself.
+ * @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.
  */

src/gameobjects/group/GroupFactory.js

@@ -15,8 +15,8 @@ var GameObjectFactory = require('../GameObjectFactory');
  * @method Phaser.GameObjects.GameObjectFactory#group
  * @since 3.0.0
  *
- * @param {(Phaser.GameObjects.GameObject[]|Phaser.GameObjects.Group.Types.GroupConfig|Phaser.GameObjects.Group.Types.GroupConfig[])} [children] - Game Objects to add to this Group; or the `config` argument.
- * @param {Phaser.GameObjects.Group.Types.GroupConfig|Phaser.GameObjects.Group.Types.GroupCreateConfig} [config] - A Group Configuration object.
+ * @param {(Phaser.GameObjects.GameObject[]|Phaser.Types.GameObjects.Group.GroupConfig|Phaser.Types.GameObjects.Group.GroupConfig[])} [children] - Game Objects to add to this Group; or the `config` argument.
+ * @param {Phaser.Types.GameObjects.Group.GroupConfig|Phaser.Types.GameObjects.Group.GroupCreateConfig} [config] - A Group Configuration object.
  *
  * @return {Phaser.GameObjects.Group} The Game Object that was created.
  */

src/gameobjects/group/typedefs/GroupCallback.js

@@ -1,5 +1,5 @@
 /**
- * @callback Phaser.GameObjects.Group.Types.GroupCallback
+ * @callback Phaser.Types.GameObjects.Group.GroupCallback
  * @since 3.0.0
  *
  * @param {Phaser.GameObjects.GameObject} item - A group member

src/gameobjects/group/typedefs/GroupClassTypeConstructor.js

@@ -1,7 +1,7 @@
 /**
  * A constructor function (class) that can be assigned to `classType`.
  * 
- * @callback Phaser.GameObjects.Group.Types.GroupClassTypeConstructor
+ * @callback Phaser.Types.GameObjects.Group.GroupClassTypeConstructor
  * @since 3.0.0
  * 
  * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs. A Game Object can only belong to one Scene at a time.

src/gameobjects/group/typedefs/GroupConfig.js

@@ -1,14 +1,14 @@
 /**
- * @typedef {object} Phaser.GameObjects.Group.Types.GroupConfig
+ * @typedef {object} Phaser.Types.GameObjects.Group.GroupConfig
  * @since 3.0.0
  *
- * @property {?Phaser.GameObjects.Group.Types.GroupClassTypeConstructor} [classType=Sprite] - Sets {@link Phaser.GameObjects.Group#classType}.
+ * @property {?Phaser.Types.GameObjects.Group.GroupClassTypeConstructor} [classType=Sprite] - Sets {@link Phaser.GameObjects.Group#classType}.
  * @property {?boolean} [active=true] - Sets {@link Phaser.GameObjects.Group#active}.
  * @property {?number} [maxSize=-1] - Sets {@link Phaser.GameObjects.Group#maxSize}.
  * @property {?string} [defaultKey=null] - Sets {@link Phaser.GameObjects.Group#defaultKey}.
  * @property {?(string|integer)} [defaultFrame=null] - Sets {@link Phaser.GameObjects.Group#defaultFrame}.
  * @property {?boolean} [runChildUpdate=false] - Sets {@link Phaser.GameObjects.Group#runChildUpdate}.
- * @property {?Phaser.GameObjects.Group.Types.GroupCallback} [createCallback=null] - Sets {@link Phaser.GameObjects.Group#createCallback}.
- * @property {?Phaser.GameObjects.Group.Types.GroupCallback} [removeCallback=null] - Sets {@link Phaser.GameObjects.Group#removeCallback}.
- * @property {?Phaser.GameObjects.Group.Types.GroupMultipleCreateCallback} [createMultipleCallback=null] - Sets {@link Phaser.GameObjects.Group#createMultipleCallback}.
+ * @property {?Phaser.Types.GameObjects.Group.GroupCallback} [createCallback=null] - Sets {@link Phaser.GameObjects.Group#createCallback}.
+ * @property {?Phaser.Types.GameObjects.Group.GroupCallback} [removeCallback=null] - Sets {@link Phaser.GameObjects.Group#removeCallback}.
+ * @property {?Phaser.Types.GameObjects.Group.GroupMultipleCreateCallback} [createMultipleCallback=null] - Sets {@link Phaser.GameObjects.Group#createMultipleCallback}.
  */

src/gameobjects/group/typedefs/GroupCreateConfig.js

@@ -9,10 +9,10 @@
  *
  * `key` is required. {@link Phaser.GameObjects.Group#defaultKey} is not used.
  * 
- * @typedef {object} Phaser.GameObjects.Group.Types.GroupCreateConfig
+ * @typedef {object} Phaser.Types.GameObjects.Group.GroupCreateConfig
  * @since 3.0.0
  *
- * @property {?Phaser.GameObjects.Group.Types.GroupClassTypeConstructor} [classType] - The class of each new Game Object.
+ * @property {?Phaser.Types.GameObjects.Group.GroupClassTypeConstructor} [classType] - The class of each new Game Object.
  * @property {string} [key] - The texture key of each new Game Object.
  * @property {?(string|integer)} [frame=null] - The texture frame of each new Game Object.
  * @property {?boolean} [visible=true] - The visible state of each new Game Object.

src/gameobjects/group/typedefs/GroupMultipleCreateCallback.js

@@ -1,5 +1,5 @@
 /**
- * @callback Phaser.GameObjects.Group.Types.GroupMultipleCreateCallback
+ * @callback Phaser.Types.GameObjects.Group.GroupMultipleCreateCallback
  * @since 3.0.0
  *
  * @param {Phaser.GameObjects.GameObject[]} items - The newly created group members

src/gameobjects/group/typedefs/index.js

@@ -5,5 +5,5 @@
  */
 
 /**
- * @namespace Phaser.GameObjects.Group.Types
+ * @namespace Phaser.Types.GameObjects.Group
  */

src/physics/arcade/Factory.js

@@ -220,8 +220,8 @@ var Factory = new Class({
      * @method Phaser.Physics.Arcade.Factory#staticGroup
      * @since 3.0.0
      *
-     * @param {(Phaser.GameObjects.GameObject[]|Phaser.GameObjects.Group.Types.GroupConfig|Phaser.GameObjects.Group.Types.GroupCreateConfig)} [children] - Game Objects to add to this group; or the `config` argument.
-     * @param {Phaser.GameObjects.Group.Types.GroupConfig|Phaser.GameObjects.Group.Types.GroupCreateConfig} [config] - Settings for this group.
+     * @param {(Phaser.GameObjects.GameObject[]|Phaser.Types.GameObjects.Group.GroupConfig|Phaser.Types.GameObjects.Group.GroupCreateConfig)} [children] - Game Objects to add to this group; or the `config` argument.
+     * @param {Phaser.Types.GameObjects.Group.GroupConfig|Phaser.Types.GameObjects.Group.GroupCreateConfig} [config] - Settings for this group.
      *
      * @return {Phaser.Physics.Arcade.StaticGroup} The Static Group object that was created.
      */
@@ -237,8 +237,8 @@ var Factory = new Class({
      * @method Phaser.Physics.Arcade.Factory#group
      * @since 3.0.0
      *
-     * @param {(Phaser.GameObjects.GameObject[]|Phaser.Physics.Arcade.Types.PhysicsGroupConfig|Phaser.GameObjects.Group.Types.GroupCreateConfig)} [children] - Game Objects to add to this group; or the `config` argument.
-     * @param {Phaser.Physics.Arcade.Types.PhysicsGroupConfig|Phaser.GameObjects.Group.Types.GroupCreateConfig} [config] - Settings for this group.
+     * @param {(Phaser.GameObjects.GameObject[]|Phaser.Physics.Arcade.Types.PhysicsGroupConfig|Phaser.Types.GameObjects.Group.GroupCreateConfig)} [children] - Game Objects to add to this group; or the `config` argument.
+     * @param {Phaser.Physics.Arcade.Types.PhysicsGroupConfig|Phaser.Types.GameObjects.Group.GroupCreateConfig} [config] - Settings for this group.
      *
      * @return {Phaser.Physics.Arcade.Group} The Group object that was created.
      */