О чем этот пример
Пространственный или 3D-звук — мощный инструмент для погружения игрока в атмосферу игры. Он позволяет аудиоисточникам "находиться" в определённой точке игрового мира, изменяя громкость и панораму в зависимости от положения слушателя. В Phaser для этого используется Web Audio API. В этой статье мы разберём пример, где источник звука следует за курсором мыши, и научимся управлять его параметрами для создания реалистичного звукового ландшафта.
Версия Phaser: код и демо в этой статье рассчитаны на Phaser 3.90.0.
Живой запуск
Ниже встроен рабочий билд примера. Оригинальный источник: GitHub.
Исходный код
class Example extends Phaser.Scene
{
preload ()
{
this.load.setBaseURL('https://raw.githubusercontent.com/phaserjs/examples/master/public/');
this.load.audio('theme', [
'assets/audio/gemattack-maintheme.m4a'
]);
this.load.image('speaker', 'assets/sprites/speakers/middle.png');
}
create ()
{
this.image = this.add.image(400, 400, 'speaker');
this.music = this.sound.add('theme');
this.sound.setListenerPosition(400, 300);
this.text = this.add.text(400, 100, 'Loading...', {
fontFamily: 'serif',
fontSize: 40,
color: '#fff',
align: 'center'
});
this.text.setOrigin(0.5);
this.add.rectangle(400, 300, 4, 4, 0xff0000);
this.enableInput(this);
}
enableInput ()
{
this.text.setText('Click to start');
this.input.once('pointerdown', () => {
this.music.play({
loop: true,
source: {
x: 400,
y: 300,
refDistance: 50,
follow: this.image
}
});
this.input.on('pointermove', pointer => {
this.image.x = pointer.worldX;
this.image.y = pointer.worldY;
this.text.setText(`Audio source at x: ${pointer.worldX} y: ${pointer.worldY}`);
});
});
}
}
const config = {
type: Phaser.AUTO,
parent: 'phaser-example',
width: 800,
height: 600,
scene: Example
};
const game = new Phaser.Game(config);
Подготовка сцены и загрузка ресурсов
Всё начинается в методах preload и create нашей сцены. Здесь мы загружаем необходимые аудиофайлы и спрайты, а также настраиваем начальное состояние.
preload ()
{
this.load.setBaseURL('https://raw.githubusercontent.com/phaserjs/examples/master/public/');
this.load.audio('theme', [
'assets/audio/gemattack-maintheme.m4a'
]);
this.load.image('speaker', 'assets/sprites/speakers/middle.png');
}
Метод preload загружает аудиотрек с псевдонимом 'theme' и изображение динамика ('speaker'). Базовый URL упрощает указание путей.
create ()
{
this.image = this.add.image(400, 400, 'speaker');
this.music = this.sound.add('theme');
this.sound.setListenerPosition(400, 300);
this.text = this.add.text(400, 100, 'Loading...', {
fontFamily: 'serif',
fontSize: 40,
color: '#fff',
align: 'center'
});
this.text.setOrigin(0.5);
this.add.rectangle(400, 300, 4, 4, 0xff0000);
this.enableInput(this);
}
В create мы размещаем спрайт динамика в точке (400, 400), создаём аудиообъект this.music из загруженного трека. Ключевой момент — установка позиции слушателя через this.sound.setListenerPosition(400, 300). Это "уши" игрока в нашем мире. Красный квадрат визуализирует эту точку. Текстовое поле будет показывать координаты, а вызов this.enableInput(this) активирует управление.
Запуск звука и настройка пространственных свойств
Вся магия пространственного звука активируется по клику мыши в методе enableInput. Именно здесь мы указываем, что наш звук должен быть привязан к координатам.
this.music.play({
loop: true,
source: {
x: 400,
y: 300,
refDistance: 50,
follow: this.image
}
});
При вызове play мы передаём объект конфигурации. Параметр loop: true заставляет трек играть бесконечно. Самое важное — объект source. В нём:
- `xиy` — начальные координаты источника звука в мире (здесь они совпадают с позицией слушателя, поэтому звук будет максимально громким и в центре).
- refDistance — эталонная дистанция. Это расстояние, на котором громкость звука не ослабляется (равна 1). Чем меньше значение, тем быстрее звук затихает с удалением.
- follow — объект (наш спрайт динамика), за которым будет следовать позиция источника звука. Это связывает аудио с визуальным объектом.
Динамическое управление источником звука
После старта воспроизведения мы подписываемся на движение мыши, чтобы перемещать источник звука по экрану и обновлять интерфейс.
this.input.on('pointermove', pointer => {
this.image.x = pointer.worldX;
this.image.y = pointer.worldY;
this.text.setText(`Audio source at x: ${pointer.worldX} y: ${pointer.worldY}`);
});
Обработчик события pointermove обновляет координаты спрайта this.image на мировые координаты курсора (pointer.worldX, pointer.worldY). Поскольку в конфигурации play мы указали follow: this.image, позиция аудиоисточника автоматически синхронизируется с позицией спрайта. Текст на экране обновляется для наглядности. Теперь, перемещая мышь, вы физически перемещаете источник звука в пространстве: при приближении к слушателю (красной точке) громкость растёт и звук становится моно, при удалении — затихает и смещается в стереопанораме.
Конфигурация игры и важные замечания
Инициализация игры стандартна, но стоит помнить о ключевых моментах работы с Web Audio API.
const config = {
type: Phaser.AUTO,
parent: 'phaser-example',
width: 800,
height: 600,
scene: Example
};
const game = new Phaser.Game(config);
Важно: пространственный звук через Web Audio API в большинстве браузеров требует жеста пользователя (например, клика) для первого запуска любого аудио. В нашем примере это учтено — воспроизведение начинается только после клика. Также убедитесь, что используете поддерживаемые браузером аудиоформаты (например, предоставляя несколько форматов в массиве, как в preload).
Что попробовать дальше
Пространственный звук в Phaser — это прямой путь к повышению immersion в вашей игре. Всего несколько строк кода позволяют оживить звуковое сопровождение, сделав его частью игрового мира. Для экспериментов попробуйте:
1. Изменить параметр refDistance, чтобы сделать затухание звука более резким или плавным.
2. Заставить источник звука следовать не за курсором, а за игровым персонажем или врагом.
3. Создать несколько независимых аудиоисточников (например, фоновые звуки природы) с разными позициями и настроить их громкость через volume в конфиге play.
4. Динамически перемещать самого слушателя с помощью this.sound.setListenerPosition в зависимости от камеры.
