О чем этот пример
Визуальные фильтры в Phaser 3 — мощный инструмент для создания атмосферы в играх. В этой статье мы разберем конкретный пример — анимированный фильтр виньетирования — и покажем, как можно динамически управлять его параметрами в реальном времени. Это полезно для акцентов на объектах, плавных переходов сцены или создания драматического эффекта, управляемого кодом.
Версия 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.image('pic', 'assets/pics/anime-ai.jpg');
this.load.image('test', 'assets/sprites/phaser3-logo.png');
}
create ()
{
const bg = this.add.image(400, 300, 'pic').enableFilters();
const logo = this.add.image(400, 500, 'test').enableFilters();
const fx = bg.filters.internal.addVignette(0.5, 0.5, 0, 0.5);
const fx2 = logo.filters.internal.addVignette(0.5, 0.5, 0, 0.2, new Phaser.Display.Color(0, 0, 0, 0)); // Alpha vignette
const text = this.add.text(10, 10, 'FX.Vignette.radius: 0');
this.tweens.add({
targets: [ fx, fx2 ],
radius: 1,
duration: 4000,
yoyo: true,
loop: -1,
hold: 1000,
onUpdate: () => {
text.setText(`FX.Vignette.radius: ${fx.radius}`);
}
});
this.tweens.add({
targets: logo,
y: 550,
duration: 1000,
yoyo: true,
loop: -1,
ease: 'sine.inout'
});
}
}
const config = {
type: Phaser.AUTO,
width: 800,
height: 600,
backgroundColor: '#000000',
parent: 'phaser-example',
scene: Example
};
let game = new Phaser.Game(config);
Загрузка ресурсов и включение фильтров
В методе preload мы загружаем два изображения: фоновую картинку и логотип. Обратите внимание на использование setBaseURL для указания базового пути к ресурсам.
В create мы добавляем эти изображения на сцену и сразу вызываем для них метод .enableFilters(). Этот метод активирует систему фильтров для каждого конкретного игрового объекта (GameObject), делая доступным его внутренний менеджер фильтров filters.internal.
const bg = this.add.image(400, 300, 'pic').enableFilters();
const logo = this.add.image(400, 500, 'test').enableFilters();
Создание и настройка фильтров виньетки
После активации фильтров мы можем добавлять к объектам конкретные эффекты. Используем метод addVignette менеджера фильтров filters.internal.
Первый параметр — координата X центра виньетки (относительно объекта, где 0.5 — центр). Второй — координата Y центра. Третий параметр — radius (радиус) — определяет, насколько сильно эффект "съедает" края. Четвертый — strength (сила) — интенсивность затемнения.
Для фона мы создаем классическую черную виньетку с нулевым стартовым радиусом. Для логотипа создаем вторую виньетку, но с другим цветом — new Phaser.Display.Color(0, 0, 0, 0). Нулевое значение альфа-канала делает этот эффект невидимым, демонстрируя возможность создания виньетки любого цвета.
const fx = bg.filters.internal.addVignette(0.5, 0.5, 0, 0.5);
const fx2 = logo.filters.internal.addVignette(0.5, 0.5, 0, 0.2, new Phaser.Display.Color(0, 0, 0, 0));
Анимация параметров фильтра с помощью Tween
Здесь происходит магия динамического изменения. Мы создаем анимацию (Tween), которая будет воздействовать на оба созданных фильтра одновременно. Цель анимации — свойство radius.
Конфигурация tween:
- targets: массив объектов, свойства которых будут анимированы (наши фильтры fx и fx2).
- radius: целевое значение свойства (от 0 до 1).
- duration: длительность анимации в миллисекундах.
- yoyo: если true, анимация проигрывается в обратном порядке после завершения.
- loop: количество повторов (-1 для бесконечного цикла).
- hold: пауза в миллисекундах между повторениями.
- onUpdate: функция, вызываемая на каждом кадре обновления анимации. Здесь мы обновляем текст на экране, чтобы отображать текущее значение радиуса.
this.tweens.add({
targets: [ fx, fx2 ],
radius: 1,
duration: 4000,
yoyo: true,
loop: -1,
hold: 1000,
onUpdate: () => {
text.setText(`FX.Vignette.radius: ${fx.radius}`);
}
});
Дополнительная анимация для наглядности
Чтобы сделать пример более живым, мы добавляем вторую, независимую анимацию для логотипа. Она просто перемещает его вверх и вниз по оси Y.
Это демонстрирует важный принцип: фильтры привязаны к игровому объекту и следуют за ним, трансформируются и анимируются вместе с ним. Эффект виньетки будет всегда корректно отображаться на движущемся логотипе.
this.tweens.add({
targets: logo,
y: 550,
duration: 1000,
yoyo: true,
loop: -1,
ease: 'sine.inout'
});
Что попробовать дальше
Фильтр Vignette в Phaser — это не просто статичный эффект, а полноценный динамический параметр объекта, которым можно управлять через tweens и логику игры. Вы можете менять его радиус, силу, цвет и положение в реальном времени. Для экспериментов попробуйте: анимировать свойство strength для пульсирующего эффекта, привязать изменение радиуса к здоровью игрока для создания визуальной обратной связи или использовать разные цвета виньетки для обозначения зон с разным статусом (ядовитые, лечебные).
