Fixed Group defs and completed Arcade Physics defs

Author: photonstorm

src/core/typedefs/PhysicsConfig.js

@@ -3,7 +3,7 @@
  * @since 3.0.0
  *
  * @property {string} [default] - The default physics system. It will be started for each scene. Phaser provides 'arcade', 'impact', and 'matter'.
- * @property {ArcadeWorldConfig} [arcade] - Arcade Physics configuration.
+ * @property {Phaser.Physics.Arcade.Types.ArcadeWorldConfig} [arcade] - Arcade Physics configuration.
  * @property {ImpactWorldConfig} [impact] - Impact Physics configuration.
  * @property {MatterWorldConfig} [matter] - Matter Physics configuration.
  */

src/gameobjects/group/Group.js

@@ -107,7 +107,7 @@ var Group = new Class({
          * The class to create new group members from.
          *
          * @name Phaser.GameObjects.Group#classType
-         * @type {GroupClassTypeConstructor}
+         * @type {Phaser.GameObjects.Group.Types.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 {?GroupCallback}
+         * @type {?Phaser.GameObjects.Group.Types.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 {?GroupCallback}
+         * @type {?Phaser.GameObjects.Group.Types.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 {?GroupMultipleCreateCallback}
+         * @type {?Phaser.GameObjects.Group.Types.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 {GroupCreateConfig|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.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.
      *
      * @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 {GroupCreateConfig} options - Creation settings.
+     * @param {Phaser.GameObjects.Group.Types.GroupCreateConfig} options - Creation settings.
      *
      * @return {any[]} The newly created Game Objects.
      */

src/actions/typedefs/GroupCallback.js …eobjects/group/typedefs/GroupCallback.jssrc/actions/typedefs/GroupCallback.js renamed to src/gameobjects/group/typedefs/GroupCallback.js src/actions/typedefs/GroupCallback.js renamed to src/gameobjects/group/typedefs/GroupCallback.js

@@ -152,8 +152,8 @@ var ArcadePhysics = new Class({
      * @method Phaser.Physics.Arcade.ArcadePhysics#overlap
      * @since 3.0.0
      *
-     * @param {ArcadeColliderType} object1 - The first object or array of objects to check.
-     * @param {ArcadeColliderType} [object2] - The second object or array of objects to check, or `undefined`.
+     * @param {Phaser.Physics.Arcade.Types.ArcadeColliderType} object1 - The first object or array of objects to check.
+     * @param {Phaser.Physics.Arcade.Types.ArcadeColliderType} [object2] - The second object or array of objects to check, or `undefined`.
      * @param {ArcadePhysicsCallback} [collideCallback] - An optional callback function that is called if the objects collide.
      * @param {ArcadePhysicsCallback} [processCallback] - An optional callback function that lets you perform additional checks against the two objects if they overlap. If this is set then `collideCallback` will only be called if this callback returns `true`.
      * @param {*} [callbackContext] - The context in which to run the callbacks.
@@ -177,8 +177,8 @@ var ArcadePhysics = new Class({
      * @method Phaser.Physics.Arcade.ArcadePhysics#collide
      * @since 3.0.0
      *
-     * @param {ArcadeColliderType} object1 - The first object or array of objects to check.
-     * @param {ArcadeColliderType} [object2] - The second object or array of objects to check, or `undefined`.
+     * @param {Phaser.Physics.Arcade.Types.ArcadeColliderType} object1 - The first object or array of objects to check.
+     * @param {Phaser.Physics.Arcade.Types.ArcadeColliderType} [object2] - The second object or array of objects to check, or `undefined`.
      * @param {ArcadePhysicsCallback} [collideCallback] - An optional callback function that is called if the objects collide.
      * @param {ArcadePhysicsCallback} [processCallback] - An optional callback function that lets you perform additional checks against the two objects if they collide. If this is set then `collideCallback` will only be called if this callback returns `true`.
      * @param {*} [callbackContext] - The context in which to run the callbacks.

…ns/typedefs/GroupClassTypeConstructor.js …up/typedefs/GroupClassTypeConstructor.jssrc/actions/typedefs/GroupClassTypeConstructor.js renamed to src/gameobjects/group/typedefs/GroupClassTypeConstructor.js src/actions/typedefs/GroupClassTypeConstructor.js renamed to src/gameobjects/group/typedefs/GroupClassTypeConstructor.js

@@ -13,25 +13,6 @@ var Rectangle = require('../../geom/rectangle/Rectangle');
 var RectangleContains = require('../../geom/rectangle/Contains');
 var Vector2 = require('../../math/Vector2');
 
-/**
- * @typedef {object} ArcadeBodyBounds
- *
- * @property {number} x - The left edge.
- * @property {number} y - The upper edge.
- * @property {number} right - The right edge.
- * @property {number} bottom - The lower edge.
- */
-
-/**
- * @typedef {object} ArcadeBodyCollision
- *
- * @property {boolean} none - True if the Body is not colliding.
- * @property {boolean} up - True if the Body is colliding on its upper edge.
- * @property {boolean} down - True if the Body is colliding on its lower edge.
- * @property {boolean} left - True if the Body is colliding on its left edge.
- * @property {boolean} right - True if the Body is colliding on its right edge.
- */
-
 /**
  * @classdesc
  * A Dynamic Arcade Body.
@@ -661,7 +642,7 @@ var Body = new Class({
          * You can set `checkCollision.none = true` to disable collision checks.
          *
          * @name Phaser.Physics.Arcade.Body#checkCollision
-         * @type {ArcadeBodyCollision}
+         * @type {Phaser.Physics.Arcade.Types.ArcadeBodyCollision}
          * @since 3.0.0
          */
         this.checkCollision = { none: false, up: true, down: true, left: true, right: true };
@@ -670,7 +651,7 @@ var Body = new Class({
          * Whether this Body is colliding with another and in which direction.
          *
          * @name Phaser.Physics.Arcade.Body#touching
-         * @type {ArcadeBodyCollision}
+         * @type {Phaser.Physics.Arcade.Types.ArcadeBodyCollision}
          * @since 3.0.0
          */
         this.touching = { none: true, up: false, down: false, left: false, right: false };
@@ -679,7 +660,7 @@ var Body = new Class({
          * Whether this Body was colliding with another during the last step, and in which direction.
          *
          * @name Phaser.Physics.Arcade.Body#wasTouching
-         * @type {ArcadeBodyCollision}
+         * @type {Phaser.Physics.Arcade.Types.ArcadeBodyCollision}
          * @since 3.0.0
          */
         this.wasTouching = { none: true, up: false, down: false, left: false, right: false };
@@ -688,7 +669,7 @@ var Body = new Class({
          * Whether this Body is colliding with a tile or the world boundary.
          *
          * @name Phaser.Physics.Arcade.Body#blocked
-         * @type {ArcadeBodyCollision}
+         * @type {Phaser.Physics.Arcade.Types.ArcadeBodyCollision}
          * @since 3.0.0
          */
         this.blocked = { none: true, up: false, down: false, left: false, right: false };
@@ -1262,9 +1243,9 @@ var Body = new Class({
      * @method Phaser.Physics.Arcade.Body#getBounds
      * @since 3.0.0
      *
-     * @param {ArcadeBodyBounds} obj - An object to copy the values into.
+     * @param {Phaser.Physics.Arcade.Types.ArcadeBodyBounds} obj - An object to copy the values into.
      *
-     * @return {ArcadeBodyBounds} - An object with {x, y, right, bottom}.
+     * @return {Phaser.Physics.Arcade.Types.ArcadeBodyBounds} - An object with {x, y, right, bottom}.
      */
     getBounds: function (obj)
     {

…/typedefs/GroupMultipleCreateCallback.js …/typedefs/GroupMultipleCreateCallback.jssrc/actions/typedefs/GroupMultipleCreateCallback.js renamed to src/gameobjects/group/typedefs/GroupMultipleCreateCallback.js src/actions/typedefs/GroupMultipleCreateCallback.js renamed to src/gameobjects/group/typedefs/GroupMultipleCreateCallback.js

@@ -18,8 +18,8 @@ var Class = require('../../utils/Class');
  *
  * @param {Phaser.Physics.Arcade.World} world - The Arcade physics World that will manage the collisions.
  * @param {boolean} overlapOnly - Whether to check for collisions or overlap.
- * @param {ArcadeColliderType} object1 - The first object to check for collision.
- * @param {ArcadeColliderType} object2 - The second object to check for collision.
+ * @param {Phaser.Physics.Arcade.Types.ArcadeColliderType} object1 - The first object to check for collision.
+ * @param {Phaser.Physics.Arcade.Types.ArcadeColliderType} object2 - The second object to check for collision.
  * @param {ArcadePhysicsCallback} collideCallback - The callback to invoke when the two objects collide.
  * @param {ArcadePhysicsCallback} processCallback - The callback to invoke when the two objects collide. Must return a boolean.
  * @param {any} callbackContext - The scope in which to call the callbacks.
@@ -71,7 +71,7 @@ var Collider = new Class({
          * The first object to check for collision.
          *
          * @name Phaser.Physics.Arcade.Collider#object1
-         * @type {ArcadeColliderType}
+         * @type {Phaser.Physics.Arcade.Types.ArcadeColliderType}
          * @since 3.0.0
          */
         this.object1 = object1;
@@ -80,7 +80,7 @@ var Collider = new Class({
          * The second object to check for collision.
          *
          * @name Phaser.Physics.Arcade.Collider#object2
-         * @type {ArcadeColliderType}
+         * @type {Phaser.Physics.Arcade.Types.ArcadeColliderType}
          * @since 3.0.0
          */
         this.object2 = object2;

src/physics/arcade/ArcadePhysics.js

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

src/physics/arcade/Body.js

@@ -11,61 +11,6 @@ var GetFastValue = require('../../utils/object/GetFastValue');
 var Group = require('../../gameobjects/group/Group');
 var IsPlainObject = require('../../utils/object/IsPlainObject');
 
-/**
- * @typedef {object} PhysicsGroupConfig
- * @extends GroupConfig
- *
- * @property {boolean} [collideWorldBounds=false] - Sets {@link Phaser.Physics.Arcade.Body#collideWorldBounds}.
- * @property {number} [accelerationX=0] - Sets {@link Phaser.Physics.Arcade.Body#acceleration acceleration.x}.
- * @property {number} [accelerationY=0] - Sets {@link Phaser.Physics.Arcade.Body#acceleration acceleration.y}.
- * @property {boolean} [allowDrag=true] - Sets {@link Phaser.Physics.Arcade.Body#allowDrag}.
- * @property {boolean} [allowGravity=true] - Sets {@link Phaser.Physics.Arcade.Body#allowGravity}.
- * @property {boolean} [allowRotation=true] - Sets {@link Phaser.Physics.Arcade.Body#allowRotation}.
- * @property {number} [bounceX=0] - Sets {@link Phaser.Physics.Arcade.Body#bounce bounce.x}.
- * @property {number} [bounceY=0] - Sets {@link Phaser.Physics.Arcade.Body#bounce bounce.y}.
- * @property {number} [dragX=0] - Sets {@link Phaser.Physics.Arcade.Body#drag drag.x}.
- * @property {number} [dragY=0] - Sets {@link Phaser.Physics.Arcade.Body#drag drag.y}.
- * @property {boolean} [enable=true] - Sets {@link Phaser.Physics.Arcade.Body#enable enable}.
- * @property {number} [gravityX=0] - Sets {@link Phaser.Physics.Arcade.Body#gravity gravity.x}.
- * @property {number} [gravityY=0] - Sets {@link Phaser.Physics.Arcade.Body#gravity gravity.y}.
- * @property {number} [frictionX=0] - Sets {@link Phaser.Physics.Arcade.Body#friction friction.x}.
- * @property {number} [frictionY=0] - Sets {@link Phaser.Physics.Arcade.Body#friction friction.y}.
- * @property {number} [velocityX=0] - Sets {@link Phaser.Physics.Arcade.Body#velocity velocity.x}.
- * @property {number} [velocityY=0] - Sets {@link Phaser.Physics.Arcade.Body#velocity velocity.y}.
- * @property {number} [angularVelocity=0] - Sets {@link Phaser.Physics.Arcade.Body#angularVelocity}.
- * @property {number} [angularAcceleration=0] - Sets {@link Phaser.Physics.Arcade.Body#angularAcceleration}.
- * @property {number} [angularDrag=0] - Sets {@link Phaser.Physics.Arcade.Body#angularDrag}.
- * @property {number} [mass=0] - Sets {@link Phaser.Physics.Arcade.Body#mass}.
- * @property {boolean} [immovable=false] - Sets {@link Phaser.Physics.Arcade.Body#immovable}.
- */
-
-/**
- * @typedef {object} PhysicsGroupDefaults
- *
- * @property {boolean} setCollideWorldBounds - As {@link Phaser.Physics.Arcade.Body#setCollideWorldBounds}.
- * @property {number} setAccelerationX - As {@link Phaser.Physics.Arcade.Body#setAccelerationX}.
- * @property {number} setAccelerationY - As {@link Phaser.Physics.Arcade.Body#setAccelerationY}.
- * @property {boolean} setAllowDrag - As {@link Phaser.Physics.Arcade.Body#setAllowDrag}.
- * @property {boolean} setAllowGravity - As {@link Phaser.Physics.Arcade.Body#setAllowGravity}.
- * @property {boolean} setAllowRotation - As {@link Phaser.Physics.Arcade.Body#setAllowRotation}.
- * @property {number} setBounceX - As {@link Phaser.Physics.Arcade.Body#setBounceX}.
- * @property {number} setBounceY - As {@link Phaser.Physics.Arcade.Body#setBounceY}.
- * @property {number} setDragX - As {@link Phaser.Physics.Arcade.Body#setDragX}.
- * @property {number} setDragY - As {@link Phaser.Physics.Arcade.Body#setDragY}.
- * @property {boolean} setEnable - As {@link Phaser.Physics.Arcade.Body#setEnable}.
- * @property {number} setGravityX - As {@link Phaser.Physics.Arcade.Body#setGravityX}.
- * @property {number} setGravityY - As {@link Phaser.Physics.Arcade.Body#setGravityY}.
- * @property {number} setFrictionX - As {@link Phaser.Physics.Arcade.Body#setFrictionX}.
- * @property {number} setFrictionY - As {@link Phaser.Physics.Arcade.Body#setFrictionY}.
- * @property {number} setVelocityX - As {@link Phaser.Physics.Arcade.Body#setVelocityX}.
- * @property {number} setVelocityY - As {@link Phaser.Physics.Arcade.Body#setVelocityY}.
- * @property {number} setAngularVelocity - As {@link Phaser.Physics.Arcade.Body#setAngularVelocity}.
- * @property {number} setAngularAcceleration - As {@link Phaser.Physics.Arcade.Body#setAngularAcceleration}.
- * @property {number} setAngularDrag - As {@link Phaser.Physics.Arcade.Body#setAngularDrag}.
- * @property {number} setMass - As {@link Phaser.Physics.Arcade.Body#setMass}.
- * @property {boolean} setImmovable - As {@link Phaser.Physics.Arcade.Body#setImmovable}.
- */
-
 /**
  * @classdesc
  * An Arcade Physics Group object.
@@ -82,8 +27,8 @@ var IsPlainObject = require('../../utils/object/IsPlainObject');
  *
  * @param {Phaser.Physics.Arcade.World} world - The physics simulation.
  * @param {Phaser.Scene} scene - The scene this group belongs to.
- * @param {(Phaser.GameObjects.GameObject[]|PhysicsGroupConfig|GroupCreateConfig)} [children] - Game Objects to add to this group; or the `config` argument.
- * @param {PhysicsGroupConfig|GroupCreateConfig} [config] - Settings for this group.
+ * @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.
  */
 var PhysicsGroup = new Class({
 
@@ -145,7 +90,7 @@ var PhysicsGroup = new Class({
          * This should be either `Phaser.Physics.Arcade.Image`, `Phaser.Physics.Arcade.Sprite`, or a class extending one of those.
          *
          * @name Phaser.Physics.Arcade.Group#classType
-         * @type {GroupClassTypeConstructor}
+         * @type {Phaser.GameObjects.Group.Types.GroupClassTypeConstructor}
          * @default ArcadeSprite
          * @since 3.0.0
          */
@@ -165,7 +110,7 @@ var PhysicsGroup = new Class({
          * Default physics properties applied to Game Objects added to the Group or created by the Group. Derived from the `config` argument.
          *
          * @name Phaser.Physics.Arcade.Group#defaults
-         * @type {PhysicsGroupDefaults}
+         * @type {Phaser.Physics.Arcade.Types.PhysicsGroupDefaults}
          * @since 3.0.0
          */
         this.defaults = {