Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-14 17:07:43 +00:00
Code Issues Projects Releases Packages Wiki Activity

Updated jsdocs

Browse source
This commit is contained in:
Richard Davey 2018-03-17 17:16:26 +00:00
parent ccbf399dc2
commit 389669e21b
3 changed files with 46 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
src/actions/Call.js
View file

@ -5,24 +5,24 @@
*/
/**
* [description]
* Takes an array of objects and passes each of them to the given callback.
*
* @function Phaser.Actions.Call
* @since 3.0.0
*
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
* @param {function} callback - [description]
* @param {object} thisArg - [description]
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
* @param {function} 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.
*
* @return {array} The array of Game Objects that was passed to this Action.
* @return {array} The array of objects that was passed to this Action.
*/
var Call = function (items, callback, thisArg)
var Call = function (items, callback, context)
{
for (var i = 0; i < items.length; i++)
{
var item = items[i];
callback.call(thisArg, item);
callback.call(context, item);
}
return items;

22
src/actions/GetFirst.js
View file

@ -4,26 +4,26 @@
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
// compare = Object:
// {
// scaleX: 0.5,
// scaleY: 1
// }
/**
* [description]
* Takes an array of objects and returns the first element in the array that has properties which match
* all of those specified in the `compare` object. For example, if the compare object was: `{ scaleX: 0.5, alpha: 1 }`
* then it would return the first item which had the property `scaleX` set to 0.5 and `alpha` set to 1.
*
* To use this with a Group: `GetFirst(group.getChildren(), compare, index)`
*
* @function Phaser.Actions.GetFirst
* @since 3.0.0
*
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
* @param {object} compare - [description]
* @param {integer} index - [description]
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be searched by this action.
* @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.
*
* @return {array} The array of Game Objects that was passed to this Action.
* @return {object} The first object in the array that matches the comparison object, or `null` if no match was found.
*/
var GetFirst = function (items, compare, index)
{
if (index === undefined) { index = 0; }
for (var i = index; i < items.length; i++)
{
var item = items[i];

48
src/actions/GridAlign.js
View file

@ -6,47 +6,55 @@
var AlignIn = require('../display/align/in/QuickSet');
var CONST = require('../display/align/const');
var GetValue = require('../utils/object/GetValue');
var GetFastValue = require('../utils/object/GetFastValue');
var NOOP = require('../utils/NOOP');
var Zone = require('../gameobjects/zone/Zone');
var tempZone = new Zone({ sys: { queueDepthSort: NOOP }}, 0, 0, 1, 1);
/**
* [description]
* @typedef {object} GridAlignConfig
*
* @property {integer} [width=-1] - The width of the grid in items (not pixels). -1 means lay all items out horizontally, regardless of quantity.
* If both this value and height are set to -1 then this value overrides it and the `height` value is ignored.
* @property {integer} [height=-1] - The height of the grid in items (not pixels). -1 means lay all items out vertically, regardless of quantity.
* If both this value and `width` are set to -1 then `width` overrides it and this value is ignored.
* @property {boolean} [cellWidth=1] - The width of the cell, in pixels, in which the item is positioned.
* @property {integer} [cellHeight=1] - The height of the cell, in pixels, in which the item is positioned.
* @property {integer} [position=0] - The alignment position. One of the Phaser.Display.Align consts such as `TOP_LEFT` or `RIGHT_CENTER`.
* @property {number} [x=0] - Optionally place the top-left of the final grid at this coordinate.
* @property {number} [y=0] - Optionally place the top-left of the final grid at this coordinate.
*/
/**
* Takes an array of Game Objects, or any objects that have public `x` and `y` properties,
* and then aligns them based on the grid configuration given to this action.
*
* @function Phaser.Actions.GridAlign
* @since 3.0.0
*
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
* @param {object} options - [description]
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
* @param {GridAlignConfig} options - The GridAlign Configuration object.
*
* @return {array} The array of Game Objects that was passed to this Action.
* @return {array} The array of objects that were passed to this Action.
*/
var GridAlign = function (items, options)
{
var width = GetValue(options, 'width', -1);
var height = GetValue(options, 'height', -1);
var cellWidth = GetValue(options, 'cellWidth', 1);
var cellHeight = GetValue(options, 'cellHeight', cellWidth);
var position = GetValue(options, 'position', CONST.TOP_LEFT);
var x = GetValue(options, 'x', 0);
var y = GetValue(options, 'y', 0);
if (options === undefined) { options = {}; }
// var centerX = GetValue(options, 'centerX', null);
// var centerY = GetValue(options, 'centerY', null);
var width = GetFastValue(options, 'width', -1);
var height = GetFastValue(options, 'height', -1);
var cellWidth = GetFastValue(options, 'cellWidth', 1);
var cellHeight = GetFastValue(options, 'cellHeight', cellWidth);
var position = GetFastValue(options, 'position', CONST.TOP_LEFT);
var x = GetFastValue(options, 'x', 0);
var y = GetFastValue(options, 'y', 0);
var cx = 0;
var cy = 0;
var w = (width * cellWidth);
var h = (height * cellHeight);
// If the Grid is centered on a position then we need to calculate it now
// if (centerX !== null && centerY !== null)
// {
//
// }
tempZone.setPosition(x, y);
tempZone.setSize(cellWidth, cellHeight);