Класс: Phaser.AnimationManager
Конструктор
new AnimationManager(sprite)
Менеджер анимации используется для добавления, воспроизведения и обновления анимаций Phaser.
Любой объект игры, такой как Phaser.Sprite, поддерживающий анимацию, содержит один экземпляр AnimationManager.
Параметры
| Имя | Тип | Описание |
|---|---|---|
sprite | Phaser.Sprite | Ссылка на объект игры, который владеет этим AnimationManager. |
- Исходный код: animation/AnimationManager.js (Строка 15)
Общедоступные свойства
- Исходный код: animation/AnimationManager.js (Строка 40)
- Исходный код: animation/AnimationManager.js (Строка 34)
- Исходный код: animation/AnimationManager.js (Строка 500)
- Исходный код: animation/AnimationManager.js (Строка 436)
- Исходный код: animation/AnimationManager.js (Строка 531)
- Исходный код: animation/AnimationManager.js (Строка 449)
- Исходный код: animation/AnimationManager.js (Строка 25)
- Исходный код: animation/AnimationManager.js (Строка 52)
- Исходный код: animation/AnimationManager.js (Строка 483)
- Исходный код: animation/AnimationManager.js (Строка 463)
- Исходный код: animation/AnimationManager.js (Строка 20)
- Значение по умолчанию
- true
- Исходный код: animation/AnimationManager.js (Строка 46)
currentAnim : Phaser.Animation
Текущая отображаемая анимация, если есть.
currentFrame : Phaser.Frame
Текущая отображаемая рамка анимации, если есть.
Это свойство устанавливается только после запуска анимации. До этого момента оно остается установленным как null.
frame : число
Получение или установка текущего индекса кадра и обновление кэша текстур для отображения.
[только для чтения] frameData : Phaser.FrameData
Текущие данные кадров анимации.
frameName : строка
Получение или установка текущего имени кадра и обновление кэша текстур для отображения.
[только для чтения] frameTotal : число
Общее количество кадров в загруженных данных FrameData или -1, если FrameData не загружено.
game : Phaser.Game
Ссылка на текущую игру.
isLoaded : логическое
Устанавливается в true после загрузки данных анимации.
name : строка
Возвращает текущее имя анимации, если оно задано.
paused : логическое
Получение и установка состояния паузы текущей анимации.
sprite : Phaser.Sprite
Ссылка на родительский Sprite, который владеет этим AnimationManager.
updateIfVisible : логическое
Должны ли данные анимации продолжать обновляться, даже если Sprite.visible установлено в false.
Общедоступные методы
- Исходный код: animation/AnimationManager.js (Строка 170)
- Исходный код: animation/AnimationManager.js (Строка 404)
- Исходный код: animation/AnimationManager.js (Строка 371)
- Исходный код: animation/AnimationManager.js (Строка 339)
- Исходный код: animation/AnimationManager.js (Строка 253)
- Исходный код: animation/AnimationManager.js (Строка 355)
- Исходный код: animation/AnimationManager.js (Строка 392)
add(name, frames, frameRate, loop, useNumericIndex) → {Phaser.Animation}
Добавляет новую анимацию с заданным ключом. При необходимости устанавливаются кадры, частота кадров и цикличность.
Анимации, добавленные таким образом, воспроизводятся с помощью функции play.
Параметры
| Имя | Тип | Аргумент | По умолчанию | Описание |
|---|---|---|---|---|
name | string | Уникальное (в рамках данного Sprite) имя анимации, например, "run", "fire", "walk". | ||
frames | Array | <необязательно> | null | Массив чисел/строк, соответствующих кадрам, добавляемым в эту анимацию в определенном порядке. Например, [1, 2, 3] или ['run0', 'run1', run2]). Если null, то будут использованы все кадры. |
frameRate | number | <необязательно> | 60 | Скорость воспроизведения анимации. Скорость указывается в кадрах в секунду. |
loop | boolean | <необязательно> | false | Определяет, будет ли анимация циклической или воспроизводится только один раз. |
useNumericIndex | boolean | <необязательно> | true | Используются ли заданные кадры с числовыми индексами (по умолчанию) или строками? |
Возвращаемое значение
Объект Animation, который был создан.
destroy()
Уничтожает все ссылки, содержащиеся в этом AnimationManager.
Перебирает список анимаций, сохранённых в этом менеджере, и вызывает destroy для каждой из них.
getAnimation(name) → {Phaser.Animation}
Возвращает анимацию, ранее добавленную по имени.
Параметры
| Имя | Тип | Описание |
|---|---|---|
name | string | Имя возвращаемой анимации, например, "fire". |
Возвращаемое значение
Экземпляр Animation, если найден, в противном случае null.
next(quantity)
Переходит к следующему кадру на заданное количество кадров в текущей анимации, учитывая значение цикличности.
Параметры
| Имя | Тип | Аргумент | По умолчанию | Описание |
|---|---|---|---|---|
quantity | number | <необязательно> | 1 | Количество кадров для перехода. |
play(name, frameRate, loop, killOnComplete) → {Phaser.Animation}
Воспроизводит анимацию, основанную на заданном ключе. Анимация должна быть предварительно добавлена с помощью animations.add.
Если запрашиваемая анимация уже воспроизводится, этот запрос будет проигнорирован.
Если вам нужно перезапустить уже выполняемую анимацию, сделайте это непосредственно в самом объекте Animation.
Параметры
| Имя | Тип | Аргумент | По умолчанию | Описание |
|---|---|---|---|---|
name | string | Имя воспроизводимой анимации, например, "fire", "walk", "jump". | ||
frameRate | number | <необязательно> | null | Частота кадров для воспроизведения анимации. Скорость указывается в кадрах в секунду. Если не указано, используется ранее установленная частота кадров анимации. |
loop | boolean | <необязательно> | false | Необходимо ли циклическое воспроизведение анимации после воспроизведения. Если не указано, используется ранее установленное значение loop анимации. |
killOnComplete | boolean | <необязательно> | false | Если установлено в значение true, то при завершении анимации (только если loop=false) родительский Sprite будет уничтожен. |
Возвращаемое значение
Ссылка на воспроизводимый экземпляр Animation.
previous(quantity)
Перемещает назад на заданное количество кадров в текущей анимации, учитывая значение цикличности.
Параметры
| Имя | Тип | Аргумент | По умолчанию | Описание |
|---|---|---|---|---|
quantity | number | <необязательно> | 1 | Количество кадров для перемещения назад. |
refreshFrame()
Обновляет данные текущего кадра для родительского Sprite и также сбрасывает данные текстуры.
stop(name, resetFrame)
Остановить воспроизведение анимации. Если указано имя, то останавливается именно эта анимация, в противном случае останавливается текущая анимация.
Свойство currentAnim объекта AnimationManager автоматически устанавливается в заданную анимацию.
Параметры
| Имя | Тип | Аргумент | По умолчанию | Описание |
|---|---|---|---|---|
name | string | <необязательно> | null | Имя останавливаемой анимации, например, "fire". Если не указано, останавливается текущая анимация. |
resetFrame | boolean | <необязательно> | false | При остановке анимации текущий кадр должен быть установлен на первый кадр анимации (true) или приостановлен на последнем отображённом кадре (false) |
- Исходный код: animation/AnimationManager.js (Строка 296)
- Внутреннее:
- Этот член является внутренним (защищенным) и может быть изменён или удалён в будущем.
- Исходный код: animation/AnimationManager.js (Строка 315)
- Исходный код: animation/AnimationManager.js (Строка 219)
<internal> update() → {boolean}
Основная функция обновления вызывается циклом обновления спрайтов. Она отвечает за обновление кадров анимации и срабатывание связанных событий.
Возвращаемое значение
True, если был установлен новый кадр анимации, иначе false.
validateFrames(frames, useNumericIndex) → {boolean}
Проверка, являются ли кадры в заданном массиве валидными и существуют ли они.
Параметры
| Имя | Тип | Аргумент | По умолчанию | Описание |
|---|---|---|---|---|
frames | Массив | Массив кадров для проверки. | ||
useNumericIndex | boolean | <необязательно> | true | Проверять кадры по числовому индексу (true) или строковому индексу (false). |
Возвращаемое значение
True, если все заданные кадры валидны, иначе false.
© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.AnimationManager.html