Класс: Phaser.ArraySet
Конструктор
new ArraySet(list)
ArraySet — это структура данных Set (элементы должны быть уникальными в наборе), которая также сохраняет порядок.
Это позволяет легко добавлять или удалять конкретные элементы из набора.
Равенство элементов (и уникальность) определяется поведением Array.indexOf.
В основном используется подсистемой ввода.
Параметры
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
list | Array.<any> | <optional> | (новый массив) | Базовый массив: если указан, элементы в списке должны быть уникальными, согласно |
- Исходный код: utils/ArraySet.js (Строка 19)
Общедоступные свойства
- Исходный код: utils/ArraySet.js (Строка 231)
- Array.<any>
- Исходный код: utils/ArraySet.js (Строка 32)
- Исходный код: utils/ArraySet.js (Строка 256)
- Исходный код: utils/ArraySet.js (Строка 26)
- Исходный код: utils/ArraySet.js (Строка 217)
first :any
Возвращает первый элемент и сбрасывает курсор к началу.
list : Array.<any>
Базовый массив.
Тип
next :any
Возвращает следующий элемент (на основе курсора) и продвигает курсор.
position : integer
Текущее положение курсора, установленное first и next.
total : integer
Количество элементов в ArraySet. То же, что и list.length.
Общедоступные методы
- Source code: utils/ArraySet.js (Line 38)
- Source code: utils/ArraySet.js (Line 159)
- Source code: utils/ArraySet.js (Line 95)
- Source code: utils/ArraySet.js (Line 70)
- Source code: utils/ArraySet.js (Line 57)
- Source code: utils/ArraySet.js (Line 119)
- Source code: utils/ArraySet.js (Line 185)
- Source code: utils/ArraySet.js (Line 108)
- Source code: utils/ArraySet.js (Line 138)
add(item) → {any}
Добавляет новый элемент в конец списка.
Если элемент уже существует в списке, он не перемещается.
Parameters
| Name | Type | Description |
|---|---|---|
item | any | Элемент для добавления в этот список. |
Returns
Добавленный элемент.
callAll(key, parameter)
Вызывает функцию для всех элементов этого списка, используя элемент в качестве контекста для обратного вызова.
Если свойство key присутствует, оно должно быть функцией.
Функция вызывается с элементом в качестве контекста.
Parameters
| Name | Type | Argument | Description |
|---|---|---|---|
key | string | Имя свойства с функцией для вызова. | |
parameter | * | <repeatable> | Дополнительные параметры, которые будут переданы в обратный вызов. |
exists(item) → {boolean}
Проверяет наличие элемента в этом списке.
Parameters
| Name | Type | Description |
|---|---|---|
item | any | Элемент, для которого нужно получить индекс в списке. |
Returns
True, если элемент найден в списке, иначе false.
getByKey(property, value) → {any}
Получает элемент из набора на основе свойства, строго равного заданному значению.
Возвращает null, если не найдено.
Parameters
| Name | Type | Description |
|---|---|---|
property | string | Свойство для проверки по значению. |
value | any | Значение для проверки, если свойство строго равно. |
Returns
Найденный элемент или null, если ничего не совпало.
getIndex(item) → {integer}
Получает индекс элемента в списке или -1, если он не находится в списке.
Parameters
| Name | Type | Description |
|---|---|---|
item | any | Элемент, для которого нужно получить индекс в списке. |
Returns
Индекс элемента или -1, если не найден.
remove(item) → {any}
Удаляет указанный элемент из этого списка, если он существует.
Parameters
| Name | Type | Description |
|---|---|---|
item | any | Элемент, который нужно удалить из списка. |
Returns
item - Удаленный элемент.
removeAll(destroy)
Удаляет всех членов из этого ArraySet и, при необходимости, уничтожает его.
Parameters
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
destroy | boolean | <optional> | false | Вызвать |
reset()
Удаляет все элементы.
setAll(key, value)
Устанавливает свойство key для всех членов этого списка.
Parameters
| Name | Type | Description |
|---|---|---|
key | any | Свойство элемента для установки. |
value | any | Значение для установки свойства. |
© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.ArraySet.html