Renamed file

Author: photonstorm

CHANGELOG.md

@@ -32,6 +32,7 @@ being passed to the simulation. The default value is 1 to remain consistent with
 * The RTree library (rbush) used by Phaser 3 suffered from violating CSP policies by dynamically creating Functions at run-time in an eval-like manner. These are now defined via generators. Fix #3441 (thanks @jamierocks @Colbydude)
 * BaseSound has had its `rate` and `detune` properties removed as they are always set in the overriding class.
 * BaseSound `setRate` and `setDetune` from the 3.3.0 release have moved to the WebAudioSound and HTML5AudioSound classes respectively, as they each handle the values differently.
+* The file `InteractiveObject.js` has been renamed to `CreateInteractiveObject.js` to more accurately reflect what it does and to avoid type errors in the docs.
 
 
 

src/input/InteractiveObject.js src/input/CreateInteractiveObject.jssrc/input/InteractiveObject.js renamed to src/input/CreateInteractiveObject.js

@@ -4,8 +4,6 @@
  * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
  */
 
-//  Phaser.Input.InteractiveObject
-
 /**
  * @callback HitAreaCallback
  *
@@ -18,7 +16,7 @@
  */
 
 /**
- * @typedef {object} InteractiveObject
+ * @typedef {object} Phaser.Input.InteractiveObject
  *
  * @property {Phaser.GameObjects.GameObject} gameObject - [description]
  * @property {boolean} enabled - [description]
@@ -40,16 +38,16 @@
 /**
  * [description]
  *
- * @method Phaser.Input.Pointer#positionToCamera
+ * @function Phaser.Input.CreateInteractiveObject
  * @since 3.0.0
  *
  * @param {Phaser.GameObjects.GameObject} gameObject - [description]
  * @param {*} hitArea - [description]
  * @param {HitAreaCallback} hitAreaCallback - [description]
  *
- * @return {InteractiveObject} [description]
+ * @return {Phaser.Input.InteractiveObject} [description]
  */
-var InteractiveObject = function (gameObject, hitArea, hitAreaCallback)
+var CreateInteractiveObject = function (gameObject, hitArea, hitAreaCallback)
 {
     return {
 
@@ -83,4 +81,4 @@ var InteractiveObject = function (gameObject, hitArea, hitAreaCallback)
     };
 };
 
-module.exports = InteractiveObject;
+module.exports = CreateInteractiveObject;

src/input/InputPlugin.js

@@ -11,7 +11,7 @@ var DistanceBetween = require('../math/distance/DistanceBetween');
 var Ellipse = require('../geom/ellipse/Ellipse');
 var EllipseContains = require('../geom/ellipse/Contains');
 var EventEmitter = require('eventemitter3');
-var InteractiveObject = require('./InteractiveObject');
+var CreateInteractiveObject = require('./CreateInteractiveObject');
 var PluginManager = require('../boot/PluginManager');
 var Rectangle = require('../geom/rectangle/Rectangle');
 var RectangleContains = require('../geom/rectangle/Contains');
@@ -23,7 +23,7 @@ var TriangleContains = require('../geom/triangle/Contains');
  * [description]
  *
  * @class InputPlugin
- * @extends EventEmitter
+ * @extends Phaser.Events.EventEmitter
  * @memberOf Phaser.Input
  * @constructor
  * @since 3.0.0
@@ -1075,7 +1075,7 @@ var InputPlugin = new Class({
         {
             var gameObject = gameObjects[i];
 
-            gameObject.input = InteractiveObject(gameObject, shape, callback);
+            gameObject.input = CreateInteractiveObject(gameObject, shape, callback);
 
             this.queueForInsertion(gameObject);
         }
@@ -1171,7 +1171,7 @@ var InputPlugin = new Class({
 
             if (width !== 0 && height !== 0)
             {
-                gameObject.input = InteractiveObject(gameObject, new Rectangle(0, 0, width, height), callback);
+                gameObject.input = CreateInteractiveObject(gameObject, new Rectangle(0, 0, width, height), callback);
 
                 this.queueForInsertion(gameObject);
             }