Spec-Zone.ru › Phaser

Класс: Phaser.AnimationManager

Конструктор

new AnimationManager(sprite)

Менеджер анимации используется для добавления, воспроизведения и обновления анимаций Phaser.
Любой объект игры, такой как Phaser.Sprite, поддерживающий анимацию, содержит один экземпляр AnimationManager.

Параметры
Имя Тип Описание
sprite Phaser.Sprite

Ссылка на объект игры, который владеет этим AnimationManager.

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

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

currentAnim : Phaser.Animation

Текущая отображаемая анимация, если есть.

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

currentFrame : Phaser.Frame

Текущая отображаемая рамка анимации, если есть.
Это свойство устанавливается только после запуска анимации. До этого момента оно остается установленным как null.

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

frame : число

Получение или установка текущего индекса кадра и обновление кэша текстур для отображения.

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

[только для чтения] frameData : Phaser.FrameData

Текущие данные кадров анимации.

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

frameName : строка

Получение или установка текущего имени кадра и обновление кэша текстур для отображения.

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

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

Общее количество кадров в загруженных данных FrameData или -1, если FrameData не загружено.

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

game : Phaser.Game

Ссылка на текущую игру.

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

isLoaded : логическое

Устанавливается в true после загрузки данных анимации.

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

name : строка

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

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

paused : логическое

Получение и установка состояния паузы текущей анимации.

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

sprite : Phaser.Sprite

Ссылка на родительский Sprite, который владеет этим AnimationManager.

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

updateIfVisible : логическое

Должны ли данные анимации продолжать обновляться, даже если Sprite.visible установлено в false.

Значение по умолчанию
  • true
Исходный код: animation/AnimationManager.js (Строка 46)

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

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

Используются ли заданные кадры с числовыми индексами (по умолчанию) или строками?

Возвращаемое значение
Phaser.Animation -

Объект Animation, который был создан.

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

destroy()

Уничтожает все ссылки, содержащиеся в этом AnimationManager.
Перебирает список анимаций, сохранённых в этом менеджере, и вызывает destroy для каждой из них.

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

getAnimation(name) → {Phaser.Animation}

Возвращает анимацию, ранее добавленную по имени.

Параметры
Имя Тип Описание
name string

Имя возвращаемой анимации, например, "fire".

Возвращаемое значение
Phaser.Animation -

Экземпляр Animation, если найден, в противном случае null.

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

next(quantity)

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

Параметры
Имя Тип Аргумент По умолчанию Описание
quantity number <необязательно>
1

Количество кадров для перехода.

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

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 будет уничтожен.

Возвращаемое значение
Phaser.Animation -

Ссылка на воспроизводимый экземпляр Animation.

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

previous(quantity)

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

Параметры
Имя Тип Аргумент По умолчанию Описание
quantity number <необязательно>
1

Количество кадров для перемещения назад.

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

refreshFrame()

Обновляет данные текущего кадра для родительского Sprite и также сбрасывает данные текстуры.

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

stop(name, resetFrame)

Остановить воспроизведение анимации. Если указано имя, то останавливается именно эта анимация, в противном случае останавливается текущая анимация.
Свойство currentAnim объекта AnimationManager автоматически устанавливается в заданную анимацию.

Параметры
Имя Тип Аргумент По умолчанию Описание
name string <необязательно>
null

Имя останавливаемой анимации, например, "fire". Если не указано, останавливается текущая анимация.

resetFrame boolean <необязательно>
false

При остановке анимации текущий кадр должен быть установлен на первый кадр анимации (true) или приостановлен на последнем отображённом кадре (false)

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

<internal> update() → {boolean}

Основная функция обновления вызывается циклом обновления спрайтов. Она отвечает за обновление кадров анимации и срабатывание связанных событий.

Возвращаемое значение
boolean -

True, если был установлен новый кадр анимации, иначе false.

Внутреннее:
  • Этот член является внутренним (защищенным) и может быть изменён или удалён в будущем.
Исходный код: animation/AnimationManager.js (Строка 315)

validateFrames(frames, useNumericIndex) → {boolean}

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

Параметры
Имя Тип Аргумент По умолчанию Описание
frames Массив

Массив кадров для проверки.

useNumericIndex boolean <необязательно>
true

Проверять кадры по числовому индексу (true) или строковому индексу (false).

Возвращаемое значение
boolean -

True, если все заданные кадры валидны, иначе false.

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

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

Spec-Zone.ru

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