Rename all setInteractive() arguments, and docs

Author: samme

src/gameobjects/GameObject.js

@@ -442,18 +442,27 @@ var GameObject = new Class({
      *
      * You can also provide an Input Configuration Object as the only argument to this method.
      *
+     * @example
+     * sprite.setInteractive();
+     *
+     * @example
+     * sprite.setInteractive(new Phaser.Geom.Circle(45, 46, 45), Phaser.Geom.Circle.Contains);
+     *
+     * @example
+     * graphics.setInteractive(new Phaser.Geom.Rectangle(0, 0, 128, 128), Phaser.Geom.Rectangle.Contains);
+     *
      * @method Phaser.GameObjects.GameObject#setInteractive
      * @since 3.0.0
      *
-     * @param {(Phaser.Types.Input.InputConfiguration|any)} [shape] - Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.
-     * @param {Phaser.Types.Input.HitAreaCallback} [callback] - A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.
+     * @param {(Phaser.Types.Input.InputConfiguration|any)} [hitArea] - Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not given it will try to create a Rectangle based on the texture frame.
+     * @param {Phaser.Types.Input.HitAreaCallback} [callback] - The callback that determines if the pointer is within the Hit Area shape or not. If you provide a shape you must also provide a callback.
      * @param {boolean} [dropZone=false] - Should this Game Object be treated as a drop zone target?
      *
      * @return {this} This GameObject.
      */
-    setInteractive: function (shape, callback, dropZone)
+    setInteractive: function (hitArea, hitAreaCallback, dropZone)
     {
-        this.scene.sys.input.enable(this, shape, callback, dropZone);
+        this.scene.sys.input.enable(this, hitArea, hitAreaCallback, dropZone);
 
         return this;
     },

src/gameobjects/zone/Zone.js

@@ -237,20 +237,20 @@ var Zone = new Class({
      * @method Phaser.GameObjects.Zone#setDropZone
      * @since 3.0.0
      *
-     * @param {object} shape - A Geometry shape instance, such as Phaser.Geom.Ellipse, or your own custom shape.
-     * @param {Phaser.Types.Input.HitAreaCallback} callback - A function that will return `true` if the given x/y coords it is sent are within the shape.
+     * @param {object} hitArea - A Geometry shape instance, such as Phaser.Geom.Ellipse, or your own custom shape.
+     * @param {Phaser.Types.Input.HitAreaCallback} hitAreaCallback - A function that will return `true` if the given x/y coords it is sent are within the shape.
      *
      * @return {this} This Game Object.
      */
-    setDropZone: function (shape, callback)
+    setDropZone: function (hitArea, hitAreaCallback)
     {
-        if (shape === undefined)
+        if (hitArea === undefined)
         {
             this.setRectangleDropZone(this.width, this.height);
         }
         else if (!this.input)
         {
-            this.setInteractive(shape, callback, true);
+            this.setInteractive(hitArea, hitAreaCallback, true);
         }
 
         return this;

src/input/InputPlugin.js

@@ -862,13 +862,13 @@ var InputPlugin = new Class({
      * @since 3.0.0
      *
      * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to be enabled for input.
-     * @param {(Phaser.Types.Input.InputConfiguration|any)} [shape] - Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.
-     * @param {Phaser.Types.Input.HitAreaCallback} [callback] - The 'contains' function to invoke to check if the pointer is within the hit area.
+     * @param {(Phaser.Types.Input.InputConfiguration|any)} [hitArea] - Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.
+     * @param {Phaser.Types.Input.HitAreaCallback} [hitAreaCallback] - The 'contains' function to invoke to check if the pointer is within the hit area.
      * @param {boolean} [dropZone=false] - Is this Game Object a drop zone or not?
      *
      * @return {this} This Input Plugin.
      */
-    enable: function (gameObject, shape, callback, dropZone)
+    enable: function (gameObject, hitArea, hitAreaCallback, dropZone)
     {
         if (dropZone === undefined) { dropZone = false; }
 
@@ -880,7 +880,7 @@ var InputPlugin = new Class({
         else
         {
             //  Create an InteractiveObject and enable it
-            this.setHitArea(gameObject, shape, callback);
+            this.setHitArea(gameObject, hitArea, hitAreaCallback);
         }
 
         if (gameObject.input && dropZone && !gameObject.input.dropZone)
@@ -2120,14 +2120,14 @@ var InputPlugin = new Class({
      * @since 3.0.0
      *
      * @param {(Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[])} gameObjects - An array of Game Objects to set the hit area on.
-     * @param {(Phaser.Types.Input.InputConfiguration|any)} [shape] - Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.
-     * @param {Phaser.Types.Input.HitAreaCallback} [callback] - The 'contains' function to invoke to check if the pointer is within the hit area.
+     * @param {(Phaser.Types.Input.InputConfiguration|any)} [hitArea] - Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.
+     * @param {Phaser.Types.Input.HitAreaCallback} [hitAreaCallback] - The 'contains' function to invoke to check if the pointer is within the hit area.
      *
      * @return {this} This InputPlugin object.
      */
-    setHitArea: function (gameObjects, shape, callback)
+    setHitArea: function (gameObjects, hitArea, hitAreaCallback)
     {
-        if (shape === undefined)
+        if (hitArea === undefined)
         {
             return this.setHitAreaFromTexture(gameObjects);
         }
@@ -2145,12 +2145,12 @@ var InputPlugin = new Class({
         var customHitArea = true;
 
         //  Config object?
-        if (IsPlainObject(shape))
+        if (IsPlainObject(hitArea))
         {
-            var config = shape;
+            var config = hitArea;
 
-            shape = GetFastValue(config, 'hitArea', null);
-            callback = GetFastValue(config, 'hitAreaCallback', null);
+            hitArea = GetFastValue(config, 'hitArea', null);
+            hitAreaCallback = GetFastValue(config, 'hitAreaCallback', null);
             draggable = GetFastValue(config, 'draggable', false);
             dropZone = GetFastValue(config, 'dropZone', false);
             cursor = GetFastValue(config, 'cursor', false);
@@ -2161,21 +2161,21 @@ var InputPlugin = new Class({
 
             if (pixelPerfect)
             {
-                shape = {};
-                callback = this.makePixelPerfect(alphaTolerance);
+                hitArea = {};
+                hitAreaCallback = this.makePixelPerfect(alphaTolerance);
             }
 
             //  Still no hitArea or callback?
-            if (!shape || !callback)
+            if (!hitArea || !hitAreaCallback)
             {
                 this.setHitAreaFromTexture(gameObjects);
                 customHitArea = false;
             }
         }
-        else if (typeof shape === 'function' && !callback)
+        else if (typeof hitArea === 'function' && !hitAreaCallback)
         {
-            callback = shape;
-            shape = {};
+            hitAreaCallback = hitArea;
+            hitArea = {};
         }
 
         for (var i = 0; i < gameObjects.length; i++)
@@ -2188,7 +2188,7 @@ var InputPlugin = new Class({
                 continue;
             }
 
-            var io = (!gameObject.input) ? CreateInteractiveObject(gameObject, shape, callback) : gameObject.input;
+            var io = (!gameObject.input) ? CreateInteractiveObject(gameObject, hitArea, hitAreaCallback) : gameObject.input;
 
             io.customHitArea = customHitArea;
             io.dropZone = dropZone;

src/input/typedefs/InputConfiguration.js

@@ -3,7 +3,7 @@
  * @since 3.0.0
  *
  * @property {any} [hitArea] - The object / shape to use as the Hit Area. If not given it will try to create a Rectangle based on the texture frame.
- * @property {function} [hitAreaCallback] - The callback that determines if the pointer is within the Hit Area shape or not.
+ * @property {Phaser.Types.Input.HitAreaCallback} [hitAreaCallback] - The callback that determines if the pointer is within the Hit Area shape or not.
  * @property {boolean} [draggable=false] - If `true` the Interactive Object will be set to be draggable and emit drag events.
  * @property {boolean} [dropZone=false] - If `true` the Interactive Object will be set to be a drop zone for draggable objects.
  * @property {boolean} [useHandCursor=false] - If `true` the Interactive Object will set the `pointer` hand cursor when a pointer is over it. This is a short-cut for setting `cursor: 'pointer'`.