Класс: Phaser.FrameData

Конструктор

new FrameData()

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

Общедоступные свойства

[только для чтения] total : число

Общее количество кадров в этом наборе FrameData.

Исходный код: animation/FrameData.js (Строка 267)

Общедоступные методы

addFrame(frame) → {Phaser.Frame}

Добавляет новый кадр в эту коллекцию FrameData. Обычно вызывается Animation.Parser, а не напрямую.

Параметры

Имя	Тип	Описание
frame	Phaser.Frame	Кадр для добавления в этот набор FrameData.

Возвращает

Phaser.Frame -

Только что добавленный кадр.

Исходный код: animation/FrameData.js (Строка 31)

checkFrameName(name) → {boolean}

Проверяет, существует ли кадр с заданным именем.

Параметры

Имя	Тип	Описание
name	string	Имя кадра, который вы хотите проверить.

Возвращает

boolean -

True, если кадр найден, иначе false.

Исходный код: animation/FrameData.js (Строка 89)

clone() → {Phaser.FrameData}

Создает копию этого FrameData, включая копии (не ссылки) всех содержащихся в нем кадров.

Возвращает

Phaser.FrameData -

Клон этого объекта, включая клоны содержащихся в нем объектов Frame.

Исходный код: animation/FrameData.js (Строка 107)

destroy()

Уничтожает эту коллекцию FrameData, обнуляя массивы _frames и _frameNames.

Исходный код: animation/FrameData.js (Строка 251)

getFrame(index) → {Phaser.Frame}

Получает кадр по его числовому индексу.

Параметры

Имя	Тип	Описание
index	number	Индекс кадра, который вы хотите получить.

Возвращает

Phaser.Frame -

Кадр, если найден.

Исходный код: animation/FrameData.js (Строка 53)

getFrameByName(name) → {Phaser.Frame}

Получает кадр по его имени.

Параметры

Имя	Тип	Описание
name	string	Имя кадра, который вы хотите получить.

Возвращает

Phaser.Frame -

Кадр, если найден.

Исходный код: animation/FrameData.js (Строка 71)

getFrameIndexes(frames, useNumericIndex, output) → {Array}

Возвращает все индексы кадров в этом наборе FrameData.
Индексы кадров возвращаются в выходной массив, или, если он не предоставлен, в новый объект Array.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
frames	Array	<optional>		Массив, содержащий индексы кадров для извлечения. Если не определен или массив пуст, то возвращаются все кадры в FrameData.
useNumericIndex	boolean	<optional>	true	Используются ли заданные кадры числовые индексы (по умолчанию) или строки? (false)
output	Array	<optional>		Если задано, результаты будут добавлены в конец этого массива, иначе будет создан новый массив.

Возвращает

Array -

Массив всех индексов кадров, соответствующих заданным именам или идентификаторам.

Исходный код: animation/FrameData.js (Строка 204)

getFrameRange(start, end, output) → {Array}

Возвращает диапазон кадров на основе заданных начального и конечного индексов кадров и возвращает их в массиве.

Параметры

Имя	Тип	Аргумент	Описание
start	number		Начальный индекс кадра.
end	number		Конечный индекс кадра.
output	Array	<optional>	Если задано, результаты будут добавлены в конец этого массива, иначе будет создан новый массив.

Возвращает

Array -

Массив кадров между начальным и конечным значениями индекса или пустой массив, если ничего не найдено.

Исходный код: animation/FrameData.js (Строка 135)

getFrames(frames, useNumericIndex, output) → {Array}

Возвращает все кадры в этом наборе FrameData, где индекс кадра найден во входном массиве.
Кадры возвращаются в выходной массив, или, если он не предоставлен, в новый объект Array.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
frames	Array	<optional>		Массив, содержащий индексы кадров для извлечения. Если массив пуст или не определен, то возвращаются все кадры в FrameData.
useNumericIndex	boolean	<optional>	true	Используются ли заданные кадры числовые индексы (по умолчанию) или строки? (false)
output	Array	<optional>		Если задано, результаты будут добавлены в конец этого массива, иначе будет создан новый массив.

Возвращает

Array -

Массив всех кадров в этом наборе FrameData, соответствующих заданным именам или идентификаторам.

Исходный код: animation/FrameData.js (Строка 157)