Input typedefs

Author: photonstorm

src/actions/SetHitArea.js

@@ -16,7 +16,7 @@
  *
  * @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
  * @param {*} 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 {HitAreaCallback} hitAreaCallback - 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.Input.Types.HitAreaCallback} hitAreaCallback - A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.
  *
  * @return {(array|Phaser.GameObjects.GameObject[])} The array of Game Objects that was passed to this Action.
  */

src/gameobjects/GameObject.js

@@ -159,7 +159,7 @@ var GameObject = new Class({
          * Not usually set directly. Instead call `GameObject.setInteractive()`.
          *
          * @name Phaser.GameObjects.GameObject#input
-         * @type {?Phaser.Input.InteractiveObject}
+         * @type {?Phaser.Input.Types.InteractiveObject}
          * @default null
          * @since 3.0.0
          */
@@ -386,8 +386,8 @@ var GameObject = new Class({
      * @method Phaser.GameObjects.GameObject#setInteractive
      * @since 3.0.0
      *
-     * @param {(Phaser.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 {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.Input.Types.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.Input.Types.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 {boolean} [dropZone=false] - Should this Game Object be treated as a drop zone target?
      *
      * @return {this} This GameObject.

src/gameobjects/group/typedefs/GroupCreateConfig.js

@@ -40,7 +40,7 @@
  * @property {?number} [setAlpha.value=0] - The alpha value of each new Game Object.
  * @property {?number} [setAlpha.step=0] - Increment each Game Object's alpha from the previous by this amount, starting from `setAlpha.value`.
  * @property {?*} [hitArea] - A geometric shape that defines the hit area for the Game Object.
- * @property {?HitAreaCallback} [hitAreaCallback] - A callback to be invoked when the Game Object is interacted with.
+ * @property {?Phaser.Input.Types.HitAreaCallback} [hitAreaCallback] - A callback to be invoked when the Game Object is interacted with.
  * @property {?(false|Phaser.Actions.Types.GridAlignConfig)} [gridAlign=false] - Align the new Game Objects in a grid using these settings.
  *
  * @see Phaser.Actions.GridAlign

src/gameobjects/zone/Zone.js

@@ -236,7 +236,7 @@ var Zone = new Class({
      * @since 3.0.0
      *
      * @param {object} shape - A Geometry shape instance, such as Phaser.Geom.Ellipse, or your own custom shape.
-     * @param {HitAreaCallback} callback - A function that will return `true` if the given x/y coords it is sent are within the shape.
+     * @param {Phaser.Input.Types.HitAreaCallback} callback - A function that will return `true` if the given x/y coords it is sent are within the shape.
      *
      * @return {Phaser.GameObjects.Zone} This Game Object.
      */

src/input/CreateInteractiveObject.js

@@ -4,38 +4,6 @@
  * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
  */
 
-/**
- * @callback HitAreaCallback
- *
- * @param {any} hitArea - The hit area object.
- * @param {number} x - The translated x coordinate of the hit test event.
- * @param {number} y - The translated y coordinate of the hit test event.
- * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object that invoked the hit test.
- *
- * @return {boolean} `true` if the coordinates fall within the space of the hitArea, otherwise `false`.
- */
-
-/**
- * @typedef {object} Phaser.Input.InteractiveObject
- *
- * @property {Phaser.GameObjects.GameObject} gameObject - The Game Object to which this Interactive Object is bound.
- * @property {boolean} enabled - Is this Interactive Object currently enabled for input events?
- * @property {boolean} draggable - Is this Interactive Object draggable? Enable with `InputPlugin.setDraggable`.
- * @property {boolean} dropZone - Is this Interactive Object a drag-targets drop zone? Set when the object is created.
- * @property {(boolean|string)} cursor - Should this Interactive Object change the cursor (via css) when over? (desktop only)
- * @property {?Phaser.GameObjects.GameObject} target - An optional drop target for a draggable Interactive Object.
- * @property {Phaser.Cameras.Scene2D.Camera} camera - The most recent Camera to be tested against this Interactive Object.
- * @property {any} hitArea - The hit area for this Interactive Object. Typically a geometry shape, like a Rectangle or Circle.
- * @property {HitAreaCallback} hitAreaCallback - The 'contains' check callback that the hit area shape will use for all hit tests.
- * @property {number} localX - The x coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.
- * @property {number} localY - The y coordinate that the Pointer interacted with this object on, relative to the Game Object's top-left position.
- * @property {(0|1|2)} dragState - The current drag state of this Interactive Object. 0 = Not being dragged, 1 = being checked for drag, or 2 = being actively dragged.
- * @property {number} dragStartX - The x coordinate that the Pointer started dragging this Interactive Object from.
- * @property {number} dragStartY - The y coordinate that the Pointer started dragging this Interactive Object from.
- * @property {number} dragX - The x coordinate that this Interactive Object is currently being dragged to.
- * @property {number} dragY - The y coordinate that this Interactive Object is currently being dragged to.
- */
-
 /**
  * Creates a new Interactive Object.
  * 
@@ -48,9 +16,9 @@
  *
  * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to which this Interactive Object is bound.
  * @param {any} hitArea - The hit area for this Interactive Object. Typically a geometry shape, like a Rectangle or Circle.
- * @param {HitAreaCallback} hitAreaCallback - The 'contains' check callback that the hit area shape will use for all hit tests.
+ * @param {Phaser.Input.Types.HitAreaCallback} hitAreaCallback - The 'contains' check callback that the hit area shape will use for all hit tests.
  *
- * @return {Phaser.Input.InteractiveObject} The new Interactive Object.
+ * @return {Phaser.Input.Types.InteractiveObject} The new Interactive Object.
  */
 var CreateInteractiveObject = function (gameObject, hitArea, hitAreaCallback)
 {

src/input/InputManager.js

@@ -690,7 +690,7 @@ var InputManager = new Class({
      * @private
      * @since 3.10.0
      * 
-     * @param {Phaser.Input.InteractiveObject} interactiveObject - The Interactive Object that called this method.
+     * @param {Phaser.Input.Types.InteractiveObject} interactiveObject - The Interactive Object that called this method.
      */
     setCursor: function (interactiveObject)
     {
@@ -710,7 +710,7 @@ var InputManager = new Class({
      * @private
      * @since 3.10.0
      * 
-     * @param {Phaser.Input.InteractiveObject} interactiveObject - The Interactive Object that called this method.
+     * @param {Phaser.Input.Types.InteractiveObject} interactiveObject - The Interactive Object that called this method.
      */
     resetCursor: function (interactiveObject)
     {
@@ -1590,7 +1590,7 @@ var InputManager = new Class({
      * @method Phaser.Input.InputManager#pointWithinInteractiveObject
      * @since 3.0.0
      *
-     * @param {Phaser.Input.InteractiveObject} object - The Interactive Object to check against.
+     * @param {Phaser.Input.Types.InteractiveObject} object - The Interactive Object to check against.
      * @param {number} x - The translated x coordinate for the hit test.
      * @param {number} y - The translated y coordinate for the hit test.
      *

src/input/InputPlugin.js

@@ -209,7 +209,7 @@ var InputPlugin = new Class({
          * Internal event propagation callback container.
          *
          * @name Phaser.Input.InputPlugin#_eventContainer
-         * @type {Phaser.Input.EventData}
+         * @type {Phaser.Input.Types.EventData}
          * @private
          * @since 3.13.0
          */
@@ -723,8 +723,8 @@ var InputPlugin = new Class({
      * @since 3.0.0
      *
      * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object to be enabled for input.
-     * @param {(Phaser.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 {HitAreaCallback} [callback] - The 'contains' function to invoke to check if the pointer is within the hit area.
+     * @param {(Phaser.Input.Types.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.Input.Types.HitAreaCallback} [callback] - 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 {Phaser.Input.InputPlugin} This Input Plugin.
@@ -1654,19 +1654,6 @@ var InputPlugin = new Class({
         return CreatePixelPerfectHandler(textureManager, alphaTolerance);
     },
 
-    /**
-     * @typedef {object} Phaser.Input.InputConfiguration
-     *
-     * @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 {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'`.
-     * @property {string} [cursor] - The CSS string to be used when the cursor is over this Interactive Object.
-     * @property {boolean} [pixelPerfect=false] - If `true` the a pixel perfect function will be set for the hit area callback. Only works with texture based Game Objects.
-     * @property {integer} [alphaTolerance=1] - If `pixelPerfect` is set, this is the alpha tolerance threshold value used in the callback.
-     */
-
     /**
      * Sets the hit area for the given array of Game Objects.
      *
@@ -1684,8 +1671,8 @@ 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.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 {HitAreaCallback} [callback] - The 'contains' function to invoke to check if the pointer is within the hit area.
+     * @param {(Phaser.Input.Types.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.Input.Types.HitAreaCallback} [callback] - The 'contains' function to invoke to check if the pointer is within the hit area.
      *
      * @return {Phaser.Input.InputPlugin} This InputPlugin object.
      */
@@ -1772,7 +1759,7 @@ var InputPlugin = new Class({
      * @param {number} x - The center of the circle.
      * @param {number} y - The center of the circle.
      * @param {number} radius - The radius of the circle.
-     * @param {HitAreaCallback} [callback] - The hit area callback. If undefined it uses Circle.Contains.
+     * @param {Phaser.Input.Types.HitAreaCallback} [callback] - The hit area callback. If undefined it uses Circle.Contains.
      *
      * @return {Phaser.Input.InputPlugin} This InputPlugin object.
      */
@@ -1797,7 +1784,7 @@ var InputPlugin = new Class({
      * @param {number} y - The center of the ellipse.
      * @param {number} width - The width of the ellipse.
      * @param {number} height - The height of the ellipse.
-     * @param {HitAreaCallback} [callback] - The hit area callback. If undefined it uses Ellipse.Contains.
+     * @param {Phaser.Input.Types.HitAreaCallback} [callback] - The hit area callback. If undefined it uses Ellipse.Contains.
      *
      * @return {Phaser.Input.InputPlugin} This InputPlugin object.
      */
@@ -1818,7 +1805,7 @@ var InputPlugin = new Class({
      * @since 3.0.0
      *
      * @param {(Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[])} gameObjects - An array of Game Objects to set as having an ellipse hit area.
-     * @param {HitAreaCallback} [callback] - The hit area callback. If undefined it uses Rectangle.Contains.
+     * @param {Phaser.Input.Types.HitAreaCallback} [callback] - The hit area callback. If undefined it uses Rectangle.Contains.
      *
      * @return {Phaser.Input.InputPlugin} This InputPlugin object.
      */
@@ -1880,7 +1867,7 @@ var InputPlugin = new Class({
      * @param {number} y - The top-left of the rectangle.
      * @param {number} width - The width of the rectangle.
      * @param {number} height - The height of the rectangle.
-     * @param {HitAreaCallback} [callback] - The hit area callback. If undefined it uses Rectangle.Contains.
+     * @param {Phaser.Input.Types.HitAreaCallback} [callback] - The hit area callback. If undefined it uses Rectangle.Contains.
      *
      * @return {Phaser.Input.InputPlugin} This InputPlugin object.
      */
@@ -1907,7 +1894,7 @@ var InputPlugin = new Class({
      * @param {number} y2 - The y coordinate of the second point of the triangle.
      * @param {number} x3 - The x coordinate of the third point of the triangle.
      * @param {number} y3 - The y coordinate of the third point of the triangle.
-     * @param {HitAreaCallback} [callback] - The hit area callback. If undefined it uses Triangle.Contains.
+     * @param {Phaser.Input.Types.HitAreaCallback} [callback] - The hit area callback. If undefined it uses Triangle.Contains.
      *
      * @return {Phaser.Input.InputPlugin} This InputPlugin object.
      */

src/input/InputPluginCache.js

@@ -10,14 +10,6 @@ var GetValue = require('../utils/object/GetValue');
 //  These are the source objects, not instantiated.
 var inputPlugins = {};
 
-/**
- * @typedef {object} InputPluginContainer
- *
- * @property {string} key - The unique name of this plugin in the input plugin cache.
- * @property {function} plugin - The plugin to be stored. Should be the source object, not instantiated.
- * @property {string} [mapping] - If this plugin is to be injected into the Input Plugin, this is the property key map used.
- */
-
 /**
  * @namespace Phaser.Input.InputPluginCache
  */
@@ -56,7 +48,7 @@ InputPluginCache.register = function (key, plugin, mapping, settingsKey, configK
  * 
  * @param {string} key - The key of the input plugin to get.
  *
- * @return {InputPluginContainer} The input plugin object.
+ * @return {Phaser.Input.Types.InputPluginContainer} The input plugin object.
  */
 InputPluginCache.getPlugin = function (key)
 {

src/input/events/GAMEOBJECT_DOWN_EVENT.js

@@ -30,6 +30,6 @@
  * 
  * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.
  * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object the pointer was pressed down on.
- * @param {Phaser.Input.EventData} event - The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.
+ * @param {Phaser.Input.Types.EventData} event - The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.
  */
 module.exports = 'gameobjectdown';

src/input/events/GAMEOBJECT_MOVE_EVENT.js

@@ -30,6 +30,6 @@
  * 
  * @param {Phaser.Input.Pointer} pointer - The Pointer responsible for triggering this event.
  * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object the pointer was moved on.
- * @param {Phaser.Input.EventData} event - The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.
+ * @param {Phaser.Input.Types.EventData} event - The Phaser input event. You can call `stopPropagation()` to halt it from going any further in the event flow.
  */
 module.exports = 'gameobjectmove';