arcade-physics/lib/utils/array/GetFirst.js

Use Arcade Physics without Phaser.

"use strict";
/* eslint-disable no-prototype-builtins */
/**
 * @author       Richard Davey <rich@photonstorm.com>
 * @copyright    2020 Photon Storm Ltd.
 * @license      {@link https://opensource.org/licenses/MIT|MIT License}
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.GetFirst = void 0;
const SafeRange_1 = require("./SafeRange");
/**
 * Returns the first element in the array.
 *
 * You can optionally specify a matching criteria using the `property` and `value` arguments.
 *
 * For example: `getAll('visible', true)` would return the first element that had its `visible` property set.
 *
 * Optionally you can specify a start and end index. For example if the array had 100 elements,
 * and you set `startIndex` to 0 and `endIndex` to 50, it would search only the first 50 elements.
 *
 * @function Phaser.Utils.Array.GetFirst
 * @since 3.4.0
 *
 * @param {array} array - The array to search.
 * @param {string} [property] - The property to test on each array element.
 * @param {*} [value] - The value to test the property against. Must pass a strict (`===`) comparison check.
 * @param {number} [startIndex=0] - An optional start index to search from.
 * @param {number} [endIndex=array.length] - An optional end index to search up to (but not included)
 *
 * @return {object} The first matching element from the array, or `null` if no element could be found in the range given.
 */
const GetFirst = (array, property, value, startIndex = 0, endIndex) => {
    if (endIndex === undefined) {
        endIndex = array.length;
    }
    if ((0, SafeRange_1.SafeRange)(array, startIndex, endIndex)) {
        for (let i = startIndex; i < endIndex; i++) {
            const child = array[i];
            if (!property ||
                (property && value === undefined && child.hasOwnProperty(property)) ||
                (property && value !== undefined && child[property] === value)) {
                return child;
            }
        }
    }
    return null;
};
exports.GetFirst = GetFirst;
//# sourceMappingURL=GetFirst.js.map