Класс: Phaser.Animation

Конструктор

new Animation(game, parent, name, frameData, frames, frameRate, loop)

Параметры

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

Свойства

currentFrame : Phaser.Frame

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

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

delay : number

Задержка в мс между кадрами анимации, основанная на заданной частоте кадров.

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

enableUpdate : boolean

Получает или задаёт, будет ли эта анимация отправлять события onUpdate при изменении кадра.

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

frame : number

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

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

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

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

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

game : Phaser.Game

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

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

isFinished : boolean

Состояние завершения анимации. Устанавливается в true после завершения воспроизведения, false во время воспроизведения.

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

isPaused : boolean

Состояние паузы анимации.

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

isPlaying : boolean

Состояние воспроизведения анимации. Устанавливается в false после завершения воспроизведения, true во время воспроизведения.

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

isReversed : boolean

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

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

killOnComplete : boolean

Должен ли родитель этой анимации быть уничтожен при завершении анимации?

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

loop : boolean

Состояние циклического воспроизведения анимации.

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

loopCount : number

Количество раз, когда анимация была повторена с момента последнего запуска.

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

name : string

Пользовательское имя, заданное этой анимации.

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

onComplete : Phaser.Signal

Это событие срабатывает, когда воспроизведение этой анимации завершается. Если анимация настроена на циклическое воспроизведение, это событие никогда не срабатывает, вместо этого следует прослушивать событие onLoop.

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

onLoop : Phaser.Signal

Это событие срабатывает, когда эта анимация циклически повторяется.

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

onStart : Phaser.Signal

Это событие срабатывает, когда воспроизведение этой анимации начинается.

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

onUpdate : Phaser.Signal | null

Это событие срабатывает, когда анимация меняет кадр.
По умолчанию это событие отключено из-за его интенсивности. Включите его с помощью: Animation.enableUpdate = true.
Обратите внимание, что событие отправляется только с текущим кадром. В среде с низкой частотой кадров анимации
автоматически будут пропускать кадры, чтобы попытаться компенсировать время, поэтому не полагайтесь на то,
что вы получите идеально последовательный набор кадров от этого события.

Тип

• Phaser.Signal | null

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

paused : boolean

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

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

reversed : boolean

Получает и устанавливает состояние isReversed этой анимации.

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

speed : number

Получает или задаёт текущую скорость анимации в кадрах в секунду. Изменение этого значения во время воспроизведения анимации вступит в силу с следующего кадра. Значение должно быть больше 0.

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

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

<static> generateFrameNames(prefix, start, stop, suffix, zeroPad) → {Array.<string>}

Очень полезная функция для создания массивов данных анимации, использующих имена кадров, а не номера.
Например, представьте, что у вас есть 30 кадров с именами: «explosion_0001-large» до «explosion_0030-large»
Вы можете использовать эту функцию для их генерации, выполнив: Phaser.Animation.generateFrameNames('explosion_', 1, 30, '-large', 4);

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
prefix	string			Начальная часть имени файла. Если имя файла было 'explosion_0001-large', то префикс будет 'explosion_'.
start	number			Число, с которого начинать последовательный счёт. Если ваши кадры имеют имена «explosion_0001» до «explosion_0034», то начальное значение равно 1.
stop	number			Число, до которого считать. Если ваши кадры имеют имена «explosion_0001» до «explosion_0034», то значение стопа равно 34.
suffix	string	<optional>	''	Конечная часть имени файла. Если имя файла было 'explosion_0001-large', то суффикс будет '-large'.
zeroPad	number	<optional>	0	Количество нулей для заполнения минимальных и максимальных значений. Если ваши кадры имеют имена «explosion_0001» до «explosion_0034», то zeroPad равен 4.

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

Array.<string> -

Массив имён кадров.

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

complete()

Вызывается внутри, когда воспроизведение анимации завершается.
Устанавливает состояния isPlaying и isFinished и отправляет событие onAnimationComplete, если оно существует у родителя, и локальное событие onComplete.

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

destroy()

Очищает эту анимацию для удаления. Сбрасывает все значения и ссылки.

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

next(quantity)

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

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
quantity	number	<optional>	1	Количество кадров для перехода.

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

onPause()

Вызывается, когда игра переходит в состояние паузы.

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

onResume()

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

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

play(frameRate, loop, killOnComplete) → {Phaser.Animation}

Запускает эту анимацию.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
frameRate	number	<optional>	null	Частота кадров для воспроизведения анимации. Скорость задаётся в кадрах в секунду. Если не указано, используется ранее заданная частота кадров анимации.
loop	boolean	<optional>	false	Анимация должна быть циклической после воспроизведения. Если не указано, используется ранее установленное значение цикла анимации.
killOnComplete	boolean	<optional>	false	Если установлено в true, когда анимация завершается (происходит только если loop=false), родительский Sprite будет уничтожен.

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

Phaser.Animation -

• Ссылка на этот экземпляр Animation.

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

previous(quantity)

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

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
quantity	number	<optional>	1	Количество кадров для перемещения назад.

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

restart()

Возвращает анимацию к первому кадру и перезапускает её.

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

reverse() → {Phaser.Animation}

Изменяет направление анимации.

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

Phaser.Animation -

Экземпляр анимации.

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

reverseOnce() → {Phaser.Animation}

Изменяет направление анимации только для текущей/следующей анимации.
После вызова события onComplete этот метод будет вызван снова и вернёт
обратное состояние.

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

Phaser.Animation -

Экземпляр анимации.

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

setFrame(frameId, useLocalFrameIndex)

Устанавливает воспроизведение этой анимации на заданный кадр с заданным идентификатором.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
frameId	строка | число	<необязательно>		Идентификатор кадра для установки. Может быть именем кадра, индексом спрайта кадра или индексом кадра локального к анимации.
useLocalFrameIndex	логическое значение	<необязательно>	false	Если вы предоставляете число для frameId, следует ли использовать числовые индексы frameData или индексы кадров, локальные к анимации, с индексом 0?

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

stop(resetFrame, dispatchComplete)

Останавливает воспроизведение этой анимации и устанавливает ее в состояние завершения. Если указан resetFrame, воспроизведение остановится, а кадр будет установлен на первый в анимации.
Если dispatchComplete имеет значение true, будут отправлены события завершения, иначе они будут проигнорированы.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
resetFrame	логическое значение	<необязательно>	false	Если true, после остановки анимации значение currentFrame будет установлено на первый кадр в этой анимации.
dispatchComplete	логическое значение	<необязательно>	false	Отправить события Animation.onComplete и parent.onAnimationComplete?

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

update()

Обновляет эту анимацию. Вызывается автоматически менеджером анимации.

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

updateFrameData(frameData)

Изменяет объект FrameData, используемый этой анимацией.

Параметры

Имя	Тип	Описание
frameData	Phaser.FrameData	Объект FrameData, содержащий все кадры, используемые этой анимацией.

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