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

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

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

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

Живой запуск

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

Исходный код

class Example extends Phaser.Scene
{
    gamepad;
    sprite;

    preload ()
    {
        this.load.setBaseURL('https://raw.githubusercontent.com/phaserjs/examples/master/public/');
        this.load.image('sky', 'assets/skies/lightblue.png');
        this.load.image('elephant', 'assets/sprites/elephant.png');
    }

    create ()
    {
        this.add.image(0, 0, 'sky').setOrigin(0);

        const text = this.add.text(10, 10, 'Press a button on the Gamepad to use', { font: '16px Courier', fill: '#00ff00' });

        this.input.gamepad.once('down', function (pad, button, index)
        {

            text.setText(`Playing with ${pad.id}`);

            this.gamepad = pad;

            this.sprite = this.add.image(400, 300, 'elephant');

        }, this);
    }

    update ()
    {
        if (this.gamepad)
        {
            if (this.gamepad.left)
            {
                this.sprite.x -= 4;
                this.sprite.flipX = false;
            }
            else if (this.gamepad.right)
            {
                this.sprite.x += 4;
                this.sprite.flipX = true;
            }

            if (this.gamepad.up)
            {
                this.sprite.y -= 4;
            }
            else if (this.gamepad.down)
            {
                this.sprite.y += 4;
            }
        }
    }
}

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

const game = new Phaser.Game(config);

Настройка проекта и загрузка ассетов

Первым делом необходимо настроить конфигурацию игры, включив поддержку геймпадов. Это делается в объекте config. Также в методе preload загружаются необходимые изображения.

const config = {
    type: Phaser.AUTO,
    parent: 'phaser-example',
    width: 800,
    height: 600,
    input: {
        gamepad: true // Ключевая настройка, активирующая систему геймпадов
    },
    scene: Example
};

preload ()
{
    this.load.setBaseURL('https://raw.githubusercontent.com/phaserjs/examples/master/public/');
    this.load.image('sky', 'assets/skies/lightblue.png');
    this.load.image('elephant', 'assets/sprites/elephant.png');
}

Ожидание подключения геймпада

В методе create мы подготавливаем сцену и устанавливаем слушатель на событие первого нажатия любой кнопки на любом подключенном геймпаде. Это стандартный паттерн для "оживления" управления.

create ()
{
    this.add.image(0, 0, 'sky').setOrigin(0);
    const text = this.add.text(10, 10, 'Press a button on the Gamepad to use', { font: '16px Courier', fill: '#00ff00' });

    this.input.gamepad.once('down', function (pad, button, index)
    {
        text.setText(`Playing with ${pad.id}`);
        this.gamepad = pad; // Сохраняем ссылку на активный геймпад
        this.sprite = this.add.image(400, 300, 'elephant'); // Создаем управляемый спрайт
    }, this);
}

Обратите внимание на использование this.input.gamepad.once. Метод once гарантирует, что обработчик сработает только один раз, после первого нажатия. Объект геймпада pad сохраняется в свойство сцены this.gamepad для дальнейшего использования в игровом цикле.

Обработка ввода в игровом цикле

Основная логика управления вынесена в метод update, который вызывается на каждом кадре. Мы проверяем состояние осей (или кнопок-стрелок) сохраненного геймпада и перемещаем спрайт.

update ()
{
    if (this.gamepad) // Проверяем, был ли геймпад выбран
    {
        if (this.gamepad.left)
        {
            this.sprite.x -= 4;
            this.sprite.flipX = false;
        }
        else if (this.gamepad.right)
        {
            this.sprite.x += 4;
            this.sprite.flipX = true;
        }

        if (this.gamepad.up)
        {
            this.sprite.y -= 4;
        }
        else if (this.gamepad.down)
        {
            this.sprite.y += 4;
        }
    }
}

Свойства this.gamepad.left, right, up, down имеют логический тип и возвращают true, когда соответствующее направление нажато на крестовине или левом стике. Это позволяет легко реализовать дискретное движение. Здесь также управляется отзеркаливание спрайта (flipX) при движении вправо и влево.

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

Всего несколько строк кода — и ваша игра на Phaser уже поддерживает геймпады! Этот пример — отличная основа для экспериментов. Попробуйте обрабатывать другие кнопки (pad.A, pad.B), использовать аналоговые значения с осей (pad.axes) для плавного управления скоростью или настроить вибрацию (pad.vibration) для тактильной отдачи. Не забудьте про обработку события gamepadconnected для более сложных сценариев с несколькими контроллерами.