О чем этот пример
Анимации в играх редко работают изолированно. Часто нужно синхронизировать действие персонажа с выбросом предметов, звуковыми эффектами или другими визуальными событиями. Встроенное событие `ANIMATION_REPEAT` в Phaser позволяет точно отслеживать момент, когда циклическая анимация начинает новый круг, и запускать в ответ любой нужный код. В этой статье мы разберем практический пример, где рыцарь при каждом новом замахе мечом выбрасывает монету, и научимся создавать такие синхронизированные взаимодействия.
Версия Phaser: код и демо в этой статье рассчитаны на Phaser 3.90.0.
Живой запуск
Ниже встроен рабочий билд примера. Оригинальный источник: GitHub.
Исходный код
class Example extends Phaser.Scene
{
constructor ()
{
super();
}
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 (var i = 0; i < 13; i++)
{
this.add.image(64 * i, 536, 'tiles', 1).setOrigin(0);
}
this.add.image(576, 472, 'tiles', 27).setOrigin(0);
this.add.image(576, 408, 'tiles', 27).setOrigin(0);
this.add.image(576, 344, 'tiles', 57).setOrigin(0);
this.add.text(400, 8, 'Click to repeat animation', { color: '#ffffff' }).setOrigin(0.5, 0);
// Our attack animation
const attackConfig = {
key: 'attack',
frames: this.anims.generateFrameNames('knight', { prefix: 'attack_C/frame', start: 0, end: 13, zeroPad: 4 }),
frameRate: 16,
repeat: -1
};
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 completes on our sprite
lancelot.on(Phaser.Animations.Events.ANIMATION_REPEAT, function () {
this.releaseItem();
}, this);
// And a click handler to start the animation playing
this.input.once('pointerdown', function () {
lancelot.play('attack');
});
}
releaseItem ()
{
const item = this.add.sprite(600, 370).play('coin');
this.tweens.add({
targets: item,
props: {
y: {
value: -64,
ease: 'Linear',
duration: 3000,
},
x: {
value: '+=128',
ease: 'Sine.inOut',
duration: 500,
yoyo: true,
repeat: 4
}
},
onComplete: function () {
item.destroy();
}
});
}
}
const config = {
type: Phaser.AUTO,
parent: 'phaser-example',
width: 800,
height: 600,
backgroundColor: '#026bc6',
pixelArt: true,
scene: Example
};
const game = new Phaser.Game(config);
Подготовка ассетов и создание сцены
Код начинается с загрузки всех необходимых ресурсов: атласа анимации рыцаря, фонового изображения и тайлов для земли и декораций. Ключевой момент — установка pixelArt: true в конфигурации игры. Эта настройка отключает сглаживание пиксельной графики, сохраняя четкость спрайтов при масштабировании, что особенно важно для стилизованных 2D-игр.
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 расставляется статичный фон, платформа и декорации в виде колонн. Обратите внимание на использование метода .setOrigin() для точного позиционирования. Например, setOrigin(0.5, 0) для фона выравнивает его по верхнему краю, а setOrigin(0) для тайлов пола задает точкой отсчета их левый верхний угол.
Создание циклических анимаций
Далее определяются две анимации. Одна для атаки рыцаря, вторая — для вращающейся монеты. Обе создаются с параметром repeat: -1, что делает их бесконечно повторяющимися. Однако в примере воспроизведение атаки запускается только по клику, а не автоматически.
const attackConfig = {
key: 'attack',
frames: this.anims.generateFrameNames('knight', { prefix: 'attack_C/frame', start: 0, end: 13, zeroPad: 4 }),
frameRate: 16,
repeat: -1
};
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);Разница в генерации кадров важна: для атласа ('knight') используются имена кадров (generateFrameNames), а для спрайтшита ('tiles') — их номера (generateFrameNumbers). Рыцарь добавляется на сцену как спрайт (this.add.sprite) с масштабом 8, и его точка привязки (origin) устанавливается в (0.5, 1), то есть по центру внизу спрайта. Это позволяет ставить его на платформу, используя координату Y низа сцены.
Магия события ANIMATION_REPEAT
Сердце примера — обработчик события Phaser.Animations.Events.ANIMATION_REPEAT. Это событие генерируется каждый раз, когда циклическая анимация завершает одну полную итерацию и начинает следующую. Мы вешаем слушатель этого события непосредственно на спрайт lancelot.
lancelot.on(Phaser.Animations.Events.ANIMATION_REPEAT, function () {
this.releaseItem();
}, this);Третий аргумент this в вызове .on определяет контекст, в котором будет выполнена функция-обработчик. Благодаря ему, внутри function ключевое слово this будет указывать на экземпляр сцены (Example), что дает доступ к ее методам, в частности, к releaseItem. Анимация атаки запускается однократно по клику мыши с помощью this.input.once и lancelot.play('attack'). После старта она будет бесконечно повторяться, и на каждом повторе вызывать наш обработчик.
Создание и анимация выброшенного предмета
Метод releaseItem создает визуальный отклик на событие повтора. В указанной позиции создается спрайт, которому сразу же проигрывается анимация монеты с помощью .play('coin').
releaseItem ()
{
const item = this.add.sprite(600, 370).play('coin');
this.tweens.add({
targets: item,
props: {
y: { value: -64, ease: 'Linear', duration: 3000 },
x: { value: '+=128', ease: 'Sine.inOut', duration: 500, yoyo: true, repeat: 4 }
},
onComplete: function () { item.destroy(); }
});
}Запускается твин, который управляет движением монеты. Он анимирует два свойства одновременно:
1. **Координата Y**: линейно (Linear) движется вверх за 3 секунды, пока не скроется за верхним краем экрана.
2. **Координата X**: совершает колебательное движение вправо-влево. Параметры yoyo: true и repeat: 4 заставляют твин повториться 4 раза, каждый раз возвращаясь к начальному значению X, создавая эффект "маятника".
После завершения всей анимации твина срабатывает callback onComplete, который уничтожает спрайт монеты, предотвращая утечку памяти.
Что попробовать дальше
Событие ANIMATION_REPEAT — мощный инструмент для синхронизации игровых процессов с визуальным рядом. Оно идеально подходит для создания ритмичных действий: выстрелов в такт анимации перезарядки, следов от шагов, периодического урона от area-of-effect атак. Для экспериментов попробуйте изменить код: пусть при каждом повторении проигрывается случайный звук из набора, меняется цвет подсветки или создается не одна, а несколько монет с разной траекторией полета. Вы можете привязать подобный обработчик и к событию ANIMATION_COMPLETE, если нужно среагировать на окончание нецикличной анимации.