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

В игровых проектах часто требуется тонкий контроль над звуковыми эффектами: проигрывание отдельных клипов, постановка на паузу и возобновление. Phaser предоставляет для этого мощный API. В этой статье разберем практический пример, который демонстрирует работу с аудио-спрайтами, маркерами и кнопками управления. Вы научитесь создавать гибкую систему управления звуком, которую можно адаптировать под любую игру.

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

Живой запуск

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

Исходный код


class Example extends Phaser.Scene
{
    pauseResumeButtonText;
    pauseResumeButton;
    fx;

    markers = [
        { name: 'charm', start: 0, duration: 2.7, config: {} },
        { name: 'curse', start: 4, duration: 2.9, config: {} },
        { name: 'fireball', start: 8, duration: 5.2, config: {} },
        { name: 'spell', start: 14, duration: 4.7, config: {} },
        { name: 'soundscape', start: 20, duration: 18.8, config: {} }
    ];

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

        this.load.spritesheet('button', 'assets/ui/flixel-button.png', { frameWidth: 80, frameHeight: 20 });

        this.load.bitmapFont('nokia', 'assets/fonts/bitmap/nokia16black.png', 'assets/fonts/bitmap/nokia16black.xml');

        this.load.audio('sfx', [
            'assets/audio/SoundEffects/magical_horror_audiosprite.ogg',
            'assets/audio/SoundEffects/magical_horror_audiosprite.mp3'
        ]);
    }

    create ()
    {
        const bg = this.add.image(400, 300, 'bg');
        bg.setScale(800 / bg.width, 600 / bg.height);

        this.fx = this.sound.add('sfx');

        for (let i = 0; i < this.markers.length; i++)
        {
            const marker = this.markers[i];

            this.fx.addMarker(marker);

            this.makeButton.call(this, marker.name, 680, 115 + i * 40);
        }

        this.makePauseResumeButton.call(this);


        this.input.on('gameobjectover', (pointer, button) =>
        {
            this.setButtonFrame(button, 0);
        });
        this.input.on('gameobjectout', (pointer, button) =>
        {
            this.setButtonFrame(button, 1);
        });
        this.input.on('gameobjectdown', (pointer, button) =>
        {
            if (button.name === 'pause')
            {
                if (this.fx.isPaused)
                {
                    this.fx.resume();
                }
                else if (this.fx.isPlaying)
                {
                    this.fx.pause();
                }
                else
                {
                    this.setButtonFrame(button, 0);
                    return;
                }

                this.setButtonFrame(button, 2);
            }
            else
            {
                this.fx.play(button.name);
                this.setButtonFrame(button, 2);
            }
        });
        this.input.on('gameobjectup', (pointer, button) =>
        {
            this.setButtonFrame(button, 0);
        });
    }

    updatePauseResumeButton ()
    {
        if (this.fx.isPaused)
        {
            this.pauseResumeButtonText.text = 'resume';
        }
        else if (this.fx.isPlaying)
        {
            this.pauseResumeButtonText.text = 'pause';
        }
        else
        {
            this.pauseResumeButtonText.text = 'stopped';
        }

        this.pauseResumeButtonText.x = 640 + (this.pauseResumeButton.width - this.pauseResumeButtonText.width) / 2;
    }

    makeButton (name, x, y)
    {
        const button = this.add.image(x, y, 'button', 0).setInteractive();
        button.name = name;
        button.setScale(2, 1.5);

        const text = this.add.bitmapText(x - 40, y - 8, 'nokia', name, 16);
        text.x += (button.width - text.width) / 2;
    }

    makePauseResumeButton ()
    {
        this.pauseResumeButton = this.add.image(680, 395, 'button', 1).setInteractive();
        this.pauseResumeButton.name = 'pause';
        this.pauseResumeButton.setScale(2, 1.5);

        this.pauseResumeButtonText = this.add.bitmapText(640, 387, 'nokia', '', 16);
    }

    setButtonFrame (button, frame)
    {
        button.frame = button.scene.textures.getFrame('button', frame);
    }
}

/**
 * @author    Pavle Goloskokovic <pgoloskokovic@gmail.com> (http://prunegames.com)
 */

const config = {
    type: Phaser.AUTO,
    parent: 'phaser-example',
    width: 800,
    height: 600,
    scene: Example,
    pixelArt: true,
    audio: {
        noAudio: true
    }
};

const game = new Phaser.Game(config);

Загрузка и настройка аудио

Перед использованием звуков их необходимо загрузить. В методе preload используется this.load.audio() для загрузки аудио-файлов в форматах OGG и MP3. Это обеспечивает кросс-браузерную совместимость.

this.load.audio('sfx', [
    'assets/audio/SoundEffects/magical_horror_audiosprite.ogg',
    'assets/audio/SoundEffects/magical_horror_audiosprite.mp3'
]);

Ключевой момент — конфигурация аудио-системы в объекте config. Параметр audio: { noAudio: true } указывает Phaser создать аудио-контекст, даже если на устройстве отключен звук. Это предотвращает ошибки и позволяет управлять состоянием проигрывания программно.

const config = {
    // ... другие настройки ...
    audio: {
        noAudio: true
    }
};

Работа с аудио-маркерами

Аудио-спрайт — это один звуковой файл, содержащий несколько эффектов. Маркеры определяют временные отрезки для каждого эффекта внутри этого файла. В примере массив markers описывает пять различных звуков.

markers = [
    { name: 'charm', start: 0, duration: 2.7, config: {} },
    // ... другие маркеры ...
];

В методе create звук добавляется в аудио-менеджер с помощью this.sound.add('sfx'). После этого для каждого описания из массива создается маркер методом this.fx.addMarker(marker). Это позволяет в дальнейшем обращаться к звукам по их имени (например, 'charm'), а не по временным интервалам.

this.fx = this.sound.add('sfx');
for (let i = 0; i < this.markers.length; i++)
{
    const marker = this.markers[i];
    this.fx.addMarker(marker);
}

Создание интерактивных кнопок

Для каждого маркера создается кнопка вызова. Метод makeButton создает изображение кнопки из спрайтшита и добавляет к нему текстовую метку с именем эффекта.

makeButton (name, x, y)
{
    const button = this.add.image(x, y, 'button', 0).setInteractive();
    button.name = name;
    // ... настройка масштаба и текста ...
}

Особая кнопка pause/resume создается методом makePauseResumeButton. Её текст динамически меняется в зависимости от состояния звукового объекта (this.fx).

updatePauseResumeButton ()
{
    if (this.fx.isPaused)
    {
        this.pauseResumeButtonText.text = 'resume';
    }
    else if (this.fx.isPlaying)
    {
        this.pauseResumeButtonText.text = 'pause';
    }
    // ...
}

Обработка ввода и управление воспроизведением

Логика работы кнопок сосредоточена в обработчиках событий ввода. Событие gameobjectdown обрабатывает нажатие.

Для кнопок с маркерами оно запускает соответствующий звуковой эффект с помощью this.fx.play(button.name).

this.input.on('gameobjectdown', (pointer, button) =>
{
    // ...
    else
    {
        this.fx.play(button.name);
        this.setButtonFrame(button, 2);
    }
});

Для кнопки паузы логика проверяет текущее состояние объекта this.fx. Свойства isPaused и isPlaying позволяют определить, что нужно сделать: возобновить (resume) или приостановить (pause) воспроизведение.

if (button.name === 'pause')
{
    if (this.fx.isPaused)
    {
        this.fx.resume();
    }
    else if (this.fx.isPlaying)
    {
        this.fx.pause();
    }
}

Метод setButtonFrame изменяет кадр спрайта кнопки, обеспечивая визуальный feedback при наведении и нажатии.

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

Пример демонстрирует целостный подход к управлению звуком в Phaser. Вы можете использовать этот паттерн для создания аудио-меню, систем озвучки интерфейса или управления фоновой музыкой. Для экспериментов попробуйте: добавить управление громкостью для отдельных маркеров, реализовать остановку (stop) всех звуков или создать очередь на воспроизведение нескольких эффектов подряд.