О чем этот пример
В игровом процессе часто требуется запускать логику в строго определённый момент анимации: удар мечом, выпадение предмета, звуковой эффект. Ручной расчёт времени через `delay` или `setTimeout` ненадёжен и усложняет код. Событие `ANIMATION_UPDATE` в Phaser 3 позволяет привязать выполнение любого кода к конкретному кадру анимации, обеспечивая идеальную синхронизацию визуала и игровой логики. Эта статья покажет, как использовать это событие на практическом примере: рыцарь атакует, и на определённом кадре его анимации из стопки "выстреливает" цветок. Вы научитесь создавать отзывчивые и визуально точные игровые механики.
Версия Phaser: код и демо в этой статье рассчитаны на Phaser 3.90.0.
Живой запуск
Ниже встроен рабочий билд примера. Оригинальный источник: GitHub.
Исходный код
class Example extends Phaser.Scene
{
constructor ()
{
super();
this.flowers = [];
}
preload ()
{
this.load.setBaseURL('https://raw.githubusercontent.com/phaserjs/examples/master/public/');
this.load.atlas('knight', 'assets/animations/knight.png', 'assets/animations/knight.json');
this.load.image('bg', 'assets/skies/clouds.png');
this.load.spritesheet('tiles', 'assets/tilemaps/tiles/fantasy-tiles.png', { frameWidth: 64, frameHeight: 64 });
}
create ()
{
// The background and floor
this.add.image(400, 16, 'bg').setOrigin(0.5, 0);
for (let i = 0; i < 13; i++)
{
this.add.image(64 * i, 536, 'tiles', 1)
.setOrigin(0);
}
// Our flowers
for (let i = 0; i < 8; i++)
{
const flower = this.add.image(500, 472 - (i * 52), 'tiles', 31).setOrigin(0);
this.flowers.push(flower);
}
this.add.text(400, 8, 'Click to play. Update Event on frame0004', { color: '#ffffff' })
.setOrigin(0.5, 0);
// Our attack animation
const attackConfig = {
key: 'attack',
frames: this.anims.generateFrameNames('knight', { prefix: 'attack_B/frame', start: 0, end: 12, zeroPad: 4 }),
frameRate: 16
};
this.anims.create(attackConfig);
// Our coin animation
const coinConfig = {
key: 'coin',
frames: this.anims.generateFrameNumbers('tiles', { start: 42, end: 47 }),
frameRate: 12,
repeat: -1
};
this.anims.create(coinConfig);
const lancelot = this.add.sprite(300, 536, 'knight', 'attack_C/frame0000')
lancelot.setOrigin(0.5, 1);
lancelot.setScale(8);
// Event handler for when the animation updates on our sprite
lancelot.on(Phaser.Animations.Events.ANIMATION_UPDATE, function (anim, frame, sprite, frameKey) {
// We can run our effect when we get frame0004:
if (frameKey === 'attack_B/frame0004')
{
this.releaseItem();
}
}, this);
// And a click handler to start the animation playing
this.input.on('pointerdown', function () {
lancelot.play('attack', true);
});
}
releaseItem ()
{
if (this.flowers.length === 0)
{
return;
}
const flower = this.flowers.pop();
this.tweens.add({
targets: flower,
x: 864,
ease: 'Quad.out',
duration: 500
});
}
}
const config = {
type: Phaser.AUTO,
parent: 'phaser-example',
width: 800,
height: 600,
backgroundColor: '#026bc6',
pixelArt: true,
scene: Example
};
const game = new Phaser.Game(config);
Подготовка сцены и загрузка ассетов
В методе preload загружаются необходимые ресурсы. Обратите внимание на загрузку атласа анимаций для рыцаря и тайлов для окружения.
preload ()
{
this.load.setBaseURL('https://raw.githubusercontent.com/phaserjs/examples/master/public/');
this.load.atlas('knight', 'assets/animations/knight.png', 'assets/animations/knight.json');
this.load.image('bg', 'assets/skies/clouds.png');
this.load.spritesheet('tiles', 'assets/tilemaps/tiles/fantasy-tiles.png', { frameWidth: 64, frameHeight: 64 });
}В create создаётся статичный фон, пол из плиток и вертикальная стопка из 8 цветков (спрайтов с кадра 31 из тайлсета). Массив this.flowers хранит ссылки на эти объекты для дальнейшего управления.
Создание анимаций
Перед использованием анимации её необходимо создать и зарегистрировать в менеджере анимаций сцены (this.anims). В примере создаются две анимации.
// Анимация атаки рыцаря
const attackConfig = {
key: 'attack',
frames: this.anims.generateFrameNames('knight', { prefix: 'attack_B/frame', start: 0, end: 12, zeroPad: 4 }),
frameRate: 16
};
this.anims.create(attackConfig);
// Циклическая анимация монеты (не используется в основном сценарии, но создана)
const coinConfig = {
key: 'coin',
frames: this.anims.generateFrameNumbers('tiles', { start: 42, end: 47 }),
frameRate: 12,
repeat: -1
};
this.anims.create(coinConfig);Анимация attack строится из кадров атласа knight по их именам (frame0000...frame0012). Метод generateFrameNames генерирует массив конфигураций кадров. Анимация coin создаётся из последовательности кадров (номера 42-47) в спрайтшите tiles.
Создание спрайта и подписка на событие ANIMATION_UPDATE
Создаётся спрайт lancelot. Ключевой момент — подписка на событие Phaser.Animations.Events.ANIMATION_UPDATE для этого спрайта.
const lancelot = this.add.sprite(300, 536, 'knight', 'attack_C/frame0000');
lancelot.setOrigin(0.5, 1);
lancelot.setScale(8);
// Обработчик события обновления кадра анимации
lancelot.on(Phaser.Animations.Events.ANIMATION_UPDATE, function (anim, frame, sprite, frameKey) {
// Проверяем, что текущий кадр — это нужный нам frame0004
if (frameKey === 'attack_B/frame0004')
{
this.releaseItem();
}
}, this);Событие срабатывает каждый раз, когда анимация на спрайте переключает кадр. Обработчик получает:
* anim — ссылку на объект анимации.
* frame — данные о текущем кадре.
* sprite — спрайт, на котором воспроизводится анимация.
* frameKey — строковый ключ (имя) текущего кадра.
Внутри обработчика мы проверяем frameKey и вызываем метод releaseItem() только на конкретном кадре attack_B/frame0004.
Запуск анимации и побочный эффект
Анимация запускается по клику мыши. Метод releaseItem() отвечает за визуальный эффект "выстрела" цветка.
// Обработчик клика для запуска анимации
this.input.on('pointerdown', function () {
lancelot.play('attack', true);
});
releaseItem ()
{
// Если цветки закончились, выходим
if (this.flowers.length === 0)
{
return;
}
// Извлекаем последний цветок из массива
const flower = this.flowers.pop();
// Запускаем твин на перемещение цветка за правую границу экрана
this.tweens.add({
targets: flower,
x: 864,
ease: 'Quad.out',
duration: 500
});
}По клику lancelot.play('attack', true) запускает анимацию атаки с начала (true означает, что анимация стартует с первого кадра, игнорируя текущий прогресс). Когда анимация достигает кадра frame0004, срабатывает событие и вызывается releaseItem(). Этот метод "выталкивает" один спрайт из массива this.flowers и анимирует его вылет с помощью твина (this.tweens.add).
Конфигурация игры и инициализация
Стандартная конфигурация игры Phaser 3. Ключевой параметр pixelArt: true предотвращает размытие пиксельной графики при масштабировании.
const config = {
type: Phaser.AUTO,
parent: 'phaser-example',
width: 800,
height: 600,
backgroundColor: '#026bc6',
pixelArt: true,
scene: Example
};
const game = new Phaser.Game(config);Что попробовать дальше
Событие ANIMATION_UPDATE — это мощный и точный инструмент для синхронизации игровых событий с анимацией. В отличие от временных задержек, этот подход гарантирует, что эффект сработает именно тогда, когда это видит игрок.
**Идеи для экспериментов:**
1. **Комбо-система:** На разные кадры атаки назначьте разные эффекты (например, на frame0004 — выпадение монеты, на frame0008 — ударная волна).
2. **Звуковое сопровождение:** В обработчике события, в зависимости от frameKey, проигрывайте разные звуковые эффекты (замах, удар, звон).
3. **Сложные цепочки:** Запускайте из обработчика другие анимации на соседних спрайтах (например, анимацию получения урона у врага).
4. **Управление скоростью:** Меняйте frameRate текущей анимации (anim.frameRate) в ответ на игровые события (эффект замедления времени).