Spec-Zone.ru › Phaser

Класс: Phaser.ArrayUtils

Конструктор

new ArrayUtils()

Утилитарные функции для работы с массивами.

Исходный код: utils/ArrayUtils.js (Строка 13)

Публичные методы

<static> findClosest(value, arr) → {number}

Определяет ближайшее значение в массиве к заданному.
Результат всегда будет в диапазоне [first_value, last_value].

Parameters
Name Type Description
value number

Искомое значение

arr Array.<number>

Входной массив, который обязательно должен быть отсортированным.

Returns
number -

Наиболее близкое найденное значение.

Source code: utils/ArrayUtils.js (Line 172)

<static> getRandomItem(objects, startIndex, length) → {object}

Возвращает случайный элемент из заданного массива.

Возвращает null, если нет элементов в массиве в указанном диапазоне
или если нет элемента для выбранного индекса.

Parameters
Name Type Description
objects Array.<any>

Массив объектов.

startIndex integer

Необязательное смещение от начала массива. Значение по умолчанию 0 (начало массива).

length integer

Необязательное ограничение на количество выбираемых элементов.

Returns
object -

Случайный выбранный объект.

Source code: utils/ArrayUtils.js (Line 27)

<static> removeRandomItem(objects, startIndex, length) → {object}

Удаляет случайный объект из заданного массива и возвращает его.

Возвращает null, если нет элементов в массиве в указанном диапазоне
или если нет элемента для выбранного индекса.

Parameters
Name Type Description
objects Array.<any>

Массив объектов.

startIndex integer

Необязательное смещение от начала массива. Значение по умолчанию 0 (начало массива).

length integer

Необязательное ограничение на количество выбираемых элементов.

Returns
object -

Случайный удаленный объект.

Source code: utils/ArrayUtils.js (Line 51)

<static> rotate(array) → {any}

Этот метод устарел и не должен использоваться. Он может быть удален в будущем.

Перемещает элемент с начала массива в конец, сдвигая все элементы.
"Поворот" происходит влево.

До: [ A, B, C, D, E, F ]
После: [ B, C, D, E, F, A ]

См. также Phaser.ArrayUtils.rotateRight

Parameters
Name Type Description
array Array.<any>

Массив для поворота. Массив изменяется.

Returns
any -

Повернутое значение.

Устарело:
  • Пожалуйста, используйте Phaser.ArrayUtils.rotate вместо этого.
Source code: utils/ArrayUtils.js (Line 239)

<static> rotateLeft(array) → {any}

Перемещает элемент с начала массива в конец, сдвигая все элементы.
"Поворот" происходит влево.

До: [ A, B, C, D, E, F ]
После: [ B, C, D, E, F, A ]

См. также Phaser.ArrayUtils.rotateRight

Parameters
Name Type Description
array Array.<any>

Массив для поворота. Массив изменяется.

Returns
any -

Повернутое значение.

Source code: utils/ArrayUtils.js (Line 217)

<static> rotateMatrix(matrix, direction) → {Array.<Array.<any>>}

Поворачивает заданную матрицу (массив массивов).

Основано на процедуре из http://jsfiddle.net/MrPolywhirl/NH42z/.

Parameters
Name Type Description
matrix Array.<Array.<any>>

Массив для поворота; эта матрица может быть изменена.

direction number | string

Угол поворота: градусы (90, -90, 270, -270, 180) или строковая команда ('rotateLeft', 'rotateRight' или 'rotate180').

Returns
Array.<Array.<any>> -

Повернутая матрица. Источник матрицы должен быть отброшен для возвращенной матрицы.

Source code: utils/ArrayUtils.js (Line 132)

<static> rotateRight(array) → {any}

Перемещает элемент с конца массива в начало, сдвигая все элементы.
"Поворот" происходит вправо.

До: [ A, B, C, D, E, F ]
После: [ F, A, B, C, D, E ]

См. также Phaser.ArrayUtils.rotateLeft.

Parameters
Name Type Description
array Array.<any>

Массив для поворота. Массив изменяется.

Returns
any -

Сдвинутое значение.

Source code: utils/ArrayUtils.js (Line 195)

<static> shuffle(array) → {Array.<any>}

Стандартная реализация перемешивания массива Fisher-Yates, которая изменяет массив на месте.

Parameters
Name Type Description
array Array.<any>

Массив для перемешивания.

Returns
Array.<any> -

Исходный массив, теперь перемешанный.

Исходный код: utils/ArrayUtils.js (Строка 80)

<static> transposeMatrix(array) → {Array.<Array.<any>>}

Транспонирует элементы заданной матрицы (массива массивов).

Параметры
Имя Тип Описание
array Array.<Array.<any>>

Матрица для транспонирования.

Возвращает
Array.<Array.<any>> -

Новая транспонированная матрица

Исходный код: utils/ArrayUtils.js (Строка 101)

numberArray(start, end) → {Array.<number>}

Создает массив, представляющий диапазон чисел (обычно целых чисел) в [start, end].
Это эквивалентно numberArrayStep(start, end, 1).

Параметры
Имя Тип Описание
start number

Минимальное значение, с которого начинается массив.

end number

Максимальное значение, которое содержит массив.

Возвращает
Array.<number> -

Массив числовых значений.

Исходный код: utils/ArrayUtils.js (Строка 262)

numberArrayStep(start, end, step) → {Array}

Создает массив чисел (положительных и/или отрицательных), начиная с start,
вплоть до, но не включая end, с шагом step.

Если start меньше end, создается массив нулевой длины, если не указан отрицательный step.

Некоторые значения для start и end (например, NaN/undefined/null) в настоящее время приводятся к 0;
для обеспечения совместимости в будущем, убедитесь, что вы передаете фактические числа.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
start number

Начало диапазона.

end number <необязательно>

Конец диапазона.

step number <необязательно>
1

Значение для приращения или уменьшения.

Возвращает
Array -

Возвращает новый массив чисел.

Исходный код: utils/ArrayUtils.js (Строка 284)
Пример
Phaser.ArrayUtils.numberArrayStep(4);
// => [0, 1, 2, 3]

Phaser.ArrayUtils.numberArrayStep(1, 5);
// => [1, 2, 3, 4]

Phaser.ArrayUtils.numberArrayStep(0, 20, 5);
// => [0, 5, 10, 15]

Phaser.ArrayUtils.numberArrayStep(0, -4, -1);
// => [0, -1, -2, -3]

Phaser.ArrayUtils.numberArrayStep(1, 4, 0);
// => [1, 1, 1]

Phaser.ArrayUtils.numberArrayStep(0);
// => []

© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.ArrayUtils.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API