О чем этот пример

В играх часто требуется, чтобы окончание одного действия запускало цепочку других событий. Например, завершение анимации атаки может вызвать вылет снаряда или появление эффекта. Phaser предоставляет для этого удобное событие `ANIMATION_COMPLETE`. Эта статья покажет, как подписаться на это событие у спрайта и использовать его для запуска сложных последовательностей действий, делая вашу игру более динамичной и отзывчивой.

Версия 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.text(400, 8, 'Click to play animation', { color: '#ffffff' }).setOrigin(0.5, 0);

        //  Our attack animation
        const animConfig = {
            key: 'attack',
            frames: this.anims.generateFrameNames('knight', { prefix: 'attack_A/frame', start: 0, end: 13, zeroPad: 4 }),
            frameRate: 12
        };

        this.anims.create(animConfig);

        const lancelot = this.add.sprite(400, 536, 'knight', 'attack_A/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_COMPLETE, function () {
            this.releaseItem();
        }, this);

        //  And a click handler to start the animation playing
        this.input.on('pointerdown', function () {
            lancelot.play('attack', true);
        });
    }

    releaseItem() {
        const item = this.add.image(500, 500, 'tiles', 54);

        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);

Подготовка анимации и спрайта

Перед тем как обрабатывать события, нужно создать саму анимацию и спрайт, который будет её проигрывать. В методе create сцены мы определяем конфигурацию анимации и регистрируем её в менеджере анимаций сцены с помощью this.anims.create. Затем создаём спрайт, который будет проигрывать эту анимацию, и настраиваем его точку начала отсчёта (origin) и масштаб.

const animConfig = {
    key: 'attack',
    frames: this.anims.generateFrameNames('knight', { prefix: 'attack_A/frame', start: 0, end: 13, zeroPad: 4 }),
    frameRate: 12
};

this.anims.create(animConfig);

const lancelot = this.add.sprite(400, 536, 'knight', 'attack_A/frame0000')
lancelot.setOrigin(0.5, 1);
lancelot.setScale(8);

Подписка на событие завершения анимации

Ключевой момент — это подписка спрайта на событие Phaser.Animations.Events.ANIMATION_COMPLETE. Это событие генерируется каждый раз, когда проигрывание анимации на этом конкретном спрайте доходит до конца. В качестве обработчика мы указываем метод releaseItem текущей сцены. Обратите внимание на третий аргумент this в вызове метода on. Он определяет контекст (this) внутри функции-обработчика, гарантируя, что вызов this.releaseItem() будет корректно ссылаться на экземпляр сцены.

lancelot.on(Phaser.Animations.Events.ANIMATION_COMPLETE, function () {
    this.releaseItem();
}, this);

Запуск анимации и реакция на событие

Чтобы запустить цепочку, анимацию нужно проиграть. В примере это происходит по клику мыши. При каждом клике спрайт lancelot начинает проигрывать анимацию attack с начала (true — второй параметр метода play). Когда последний кадр анимации будет отображён, у спрайта сработает событие ANIMATION_COMPLETE, которое вызовет привязанный метод releaseItem.

this.input.on('pointerdown', function () {
    lancelot.play('attack', true);
});

Выполнение действий по завершению: метод releaseItem

Метод releaseItem демонстрирует, какое действие можно выполнить после анимации. Здесь создаётся новый игровой объект — изображение (image), которое представляет собой выпускаемый предмет. Затем для этого предмета создаётся твин — плавная анимация изменения свойств. Твин перемещает предмет вверх и одновременно по горизонтали по траектории "йо-йо" (вперёд-назад). По завершении твина (onComplete) предмет уничтожается, чтобы не накапливать неиспользуемые объекты в памяти.

releaseItem() {
    const item = this.add.image(500, 500, 'tiles', 54);

    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();
        }
    });
}

Что попробовать дальше

Событие ANIMATION_COMPLETE — это мощный инструмент для создания причинно-следственных связей в игре. Оно позволяет чётко разделять код анимации и код последующих игровых логик. Для экспериментов попробуйте

  1. Запускать разные события в зависимости от того, какая анимация завершилась
  2. Использовать событие ANIMATION_UPDATE для синхронизации действий с конкретными кадрами (например, для нанесения урона в середине взмаха мечом)
  3. Создавать целые цепочки анимаций, где завершение одной автоматически запускает следующую