Fix "object" types in Actions

This commit is contained in:
orblazer 2018-03-20 23:36:41 +01:00
parent 5a518f2e5f
commit e60d573912
4 changed files with 12 additions and 11 deletions

View file

@ -18,7 +18,7 @@
* *
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action. * @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
* @param {CallCallback} callback - The callback to be invoked. It will be passed just one argument: the item from the array. * @param {CallCallback} callback - The callback to be invoked. It will be passed just one argument: the item from the array.
* @param {object} context - The scope in which the callback will be invoked. * @param {*} context - The scope in which the callback will be invoked.
* *
* @return {array} The array of objects that was passed to this Action. * @return {array} The array of objects that was passed to this Action.
*/ */

View file

@ -18,7 +18,7 @@
* @param {object} compare - The comparison object. Each property in this object will be checked against the items of the array. * @param {object} compare - The comparison object. Each property in this object will be checked against the items of the array.
* @param {integer} [index=0] - An optional offset to start searching from within the items array. * @param {integer} [index=0] - An optional offset to start searching from within the items array.
* *
* @return {object} The first object in the array that matches the comparison object, or `null` if no match was found. * @return {?(object|Phaser.GameObjects.GameObject)} The first object in the array that matches the comparison object, or `null` if no match was found.
*/ */
var GetFirst = function (items, compare, index) var GetFirst = function (items, compare, index)
{ {

View file

@ -18,7 +18,7 @@
* @param {object} compare - The comparison object. Each property in this object will be checked against the items of the array. * @param {object} compare - The comparison object. Each property in this object will be checked against the items of the array.
* @param {integer} [index=0] - An optional offset to start searching from within the items array. * @param {integer} [index=0] - An optional offset to start searching from within the items array.
* *
* @return {object} The last object in the array that matches the comparison object, or `null` if no match was found. * @return {?(object|Phaser.GameObjects.GameObject)} The last object in the array that matches the comparison object, or `null` if no match was found.
*/ */
var GetLast = function (items, compare, index) var GetLast = function (items, compare, index)
{ {

View file

@ -16,6 +16,15 @@ var NOOP = require('../utils/NOOP');
* @param {Phaser.Sound.BaseSound[]} sounds - [description] * @param {Phaser.Sound.BaseSound[]} sounds - [description]
*/ */
/**
* Audio sprite sound type.
*
* @typedef {Phaser.Sound.BaseSound} AudioSpriteSound
*
* @property {object} spritemap - Local reference to 'spritemap' object form json file generated by audiosprite tool.
*/
/** /**
* @classdesc * @classdesc
* The sound manager is responsible for playing back audio via Web Audio API or HTML Audio tag as fallback. * The sound manager is responsible for playing back audio via Web Audio API or HTML Audio tag as fallback.
@ -174,14 +183,6 @@ var BaseSoundManager = new Class({
*/ */
add: NOOP, add: NOOP,
/**
* Audio sprite sound type.
*
* @typedef {Phaser.Sound.BaseSound} AudioSpriteSound
*
* @property {object} spritemap - Local reference to 'spritemap' object form json file generated by audiosprite tool.
*/
/** /**
* Adds a new audio sprite sound into the sound manager. * Adds a new audio sprite sound into the sound manager.
* *