Phaser.js: всё об играх и разработке

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

Работа с таймерами — неотъемлемая часть геймдева. В Phaser 3 класс `TimeEvent` позволяет создавать повторяющиеся или отложенные действия, но важно уметь их корректно останавливать. Неуправляемые события могут продолжать выполняться в фоне, даже если объект, к которому они привязаны, уничтожен, что ведет к утечкам памяти и неожиданным багам. В этой статье разберем, как использовать метод `remove()` для контролируемого завершения таймеров, основываясь на официальном примере из репозитория Phaser.

Версия Phaser: код и демо в этой статье рассчитаны на Phaser 3.90.0.

Живой запуск

Ниже встроен рабочий билд примера. Оригинальный источник: GitHub.

Исходный код

class Example extends Phaser.Scene
{
    timedEvent;
    c = 0;
    text;
    image;

    preload ()
    {
        this.load.setBaseURL('https://raw.githubusercontent.com/phaserjs/examples/master/public/');
        this.load.image('einstein', 'assets/pics/ra-einstein.png');
    }

    create ()
    {
        this.image = this.add.image(400, 300, 'einstein');

        this.text = this.add.text(32, 32);

        this.timedEvent = this.time.addEvent({ delay: 500, callback: this.onEvent, callbackScope: this, loop: true });
    }

    update ()
    {
        this.text.setText(`Event.progress: ${this.timedEvent.getProgress().toString().substr(0, 4)}\nEvent removed at 10: ${this.c}`);
    }

    onEvent ()
    {
        this.image.rotation += 0.04;

        this.c++;

        if (this.c === 10)
        {
            this.timedEvent.remove(false);
        }
    }
}

const config = {
    type: Phaser.CANVAS,
    width: 800,
    height: 600,
    backgroundColor: '#2d2d2d',
    parent: 'phaser-example',
    scene: Example
};

const game = new Phaser.Game(config);

Подготовка сцены и создание события

В примере создается простая сцена с изображением и текстовым полем. Основная логика работы с таймером сосредоточена в методах create() и onEvent().

В методе `create()` инициализируется событие таймера с помощью `this.time.addEvent()`. Ключевые параметры:
- `delay: 500` — интервал между вызовами в миллисекундах.
- `callback: this.onEvent` — функция, которая будет выполняться каждые 500 мс.
- `callbackScope: this` — контекст, в котором вызывается callback (обычно сама сцена).
- `loop: true` — событие будет повторяться бесконечно, пока его не остановят.

Это событие сохраняется в свойство this.timedEvent, чтобы позже им можно было управлять.

this.timedEvent = this.time.addEvent({ delay: 500, callback: this.onEvent, callbackScope: this, loop: true });

Логика колбэка и условие остановки

Функция `onEvent()` вызывается каждые 500 миллисекунд. При каждом вызове она выполняет две задачи:
1. Поворачивает изображение (`this.image.rotation += 0.04`).
2. Увеличивает счетчик `this.c` на единицу.

Когда счетчик достигает значения 10, срабатывает условие, и событие останавливается с помощью метода remove(). Аргумент false указывает, что событие должно быть немедленно удалено из менеджера времени, не дожидаясь следующего срабатывания.

if (this.c === 10)
{
    this.timedEvent.remove(false);
}

Важно: после вызова remove() событие больше не будет вызывать колбэк, и его нельзя перезапустить. Для паузы с возможностью возобновления используется метод paused.

Визуализация прогресса в реальном времени

В методе update(), который вызывается на каждом кадре рендеринга, обновляется текстовое поле. Оно отображает два значения: 1. Event.progress — прогресс до следующего срабатывания события (от 0 до 1). Метод getProgress() возвращает это значение. 2. Event removed at 10 — текущее значение счетчика this.c.

this.text.setText(`Event.progress: ${this.timedEvent.getProgress().toString().substr(0, 4)}\nEvent removed at 10: ${this.c}`);

После удаления события (c === 10) прогресс застынет, а текст продолжит отображать конечное состояние счетчика, наглядно демонстрируя, что колбэк больше не выполняется.

Конфигурация игры и запуск

Код завершается стандартной для Phaser 3 конфигурацией игры. Обратите внимание, что в scene передается класс Example, который мы описали.

const config = {
    type: Phaser.CANVAS,
    width: 800,
    height: 600,
    backgroundColor: '#2d2d2d',
    parent: 'phaser-example',
    scene: Example
};

const game = new Phaser.Game(config);

Эта конфигурация создает игровой холст размером 800x600 пикселей с темно-серым фоном и запускает нашу сцену.

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

Метод remove() — надежный способ полностью остановить и очистить событие таймера в Phaser 3. Это критически важно для управления ресурсами, особенно при переключении сцен или уничтожении игровых объектов. Для экспериментов попробуйте: изменить условие удаления (например, по клику мыши), использовать remove(true) для автоматического удаления после следующего срабатывания или создать несколько независимых событий с разными задержками и условиями остановки.