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

В разработке игр часто возникает задача: нужно не просто обнаружить столкновение объекта с плиткой на карте, но и понять, с какой именно плиткой оно произошло. Например, игрок должен умирать от соприкосновения с лавой или шипами, но безопасно стоять на обычной земле. Этот пример показывает мощный и эффективный подход к реализации такой логики с помощью физического движка Matter и Tilemap в Phaser. Мы научимся присваивать плиткам специальные метки, конвертировать карту в физические тела и точно определять опасные столкновения.

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

Живой запуск

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

Исходный код


class Example extends Phaser.Scene
{
    controls;

    preload ()
    {
        this.load.setBaseURL('https://raw.githubusercontent.com/phaserjs/examples/master/public/');
        this.load.spritesheet('balls', 'assets/sprites/balls.png', { frameWidth: 17, frameHeight: 17 });
        this.load.tilemapTiledJSON('map', 'assets/tilemaps/maps/tileset-collision-shapes.json');
        this.load.image('kenny_platformer_64x64', 'assets/tilemaps/tiles/kenny_platformer_64x64.png');
    }

    create ()
    {
        const map = this.make.tilemap({ key: 'map' });
        const tileset = map.addTilesetImage('kenny_platformer_64x64');
        const layer = map.createLayer(0, tileset, 0, 0);

        // Set colliding tiles before converting the layer to Matter bodies!
        layer.setCollisionByProperty({ collides: true });

        // Convert the layer. Any colliding tiles will be given a Matter body. If a tile has collision
        // shapes from Tiled, these will be loaded. If not, a default rectangle body will be used. The
        // body will be accessible via tile.physics.matterBody.
        this.matter.world.convertTilemapLayer(layer);

        this.matter.world.setBounds(map.widthInPixels, map.heightInPixels);
        this.cameras.main.setBounds(0, 0, map.widthInPixels, map.heightInPixels);

        this.cameras.main.setScroll(95, 100);

        // Change the label of the Matter body on the tiles that should kill the bouncing balls. This
        // makes it easier to check Matter collisions.
        layer.forEachTile(tile =>
        {
            // In Tiled, the platform tiles have been given a "type" property which is a string
            if (tile.properties.type === 'lava' || tile.properties.type === 'spike')
            {
                tile.physics.matterBody.body.label = 'dangerousTile';
            }
        });

        // Drop bouncy, Matter balls on pointer down. Apply a custom label to the Matter body, so that
        // it is easy to find the collision we care about.
        this.input.on('pointerdown', function ()
        {
            const worldPoint = this.input.activePointer.positionToCamera(this.cameras.main);
            for (let i = 0; i < 5; i++)
            {
                const x = worldPoint.x + Phaser.Math.RND.integerInRange(-5, 5);
                const y = worldPoint.y + Phaser.Math.RND.integerInRange(-5, 5);
                const frame = Phaser.Math.RND.integerInRange(0, 5);
                this.matter.add.image(x, y, 'balls', frame, { restitution: 1, label: 'ball' });
            }
        }, this);

        // Loop over all the collision pairs that start colliding on each step of the Matter engine.
        this.matter.world.on('collisionstart', function (event)
        {
            for (let i = 0; i < event.pairs.length; i++)
            {
                // The tile bodies in this example are a mixture of compound bodies and simple rectangle
                // bodies. The "label" property was set on the parent body, so we will first make sure
                // that we have the top level body instead of a part of a larger compound body.
                const bodyA = this.getRootBody(event.pairs[i].bodyA);
                const bodyB = this.getRootBody(event.pairs[i].bodyB);

                if ((bodyA.label === 'ball' && bodyB.label === 'dangerousTile') ||
                    (bodyB.label === 'ball' && bodyA.label === 'dangerousTile'))
                {
                    const ballBody = bodyA.label === 'ball' ? bodyA : bodyB;
                    const ball = ballBody.gameObject;

                    // A body may collide with multiple other bodies in a step, so we'll use a flag to
                    // only tween & destroy the ball once.
                    if (ball.isBeingDestroyed)
                    {
                        continue;
                    }
                    ball.isBeingDestroyed = true;

                    this.matter.world.remove(ballBody);

                    this.tweens.add({
                        targets: ball,
                        alpha: { value: 0, duration: 150, ease: 'Power1' },
                        onComplete: (ball => { ball.destroy(); }).bind(this, ball)
                    });
                }
            }
        }, this);

        const cursors = this.input.keyboard.createCursorKeys();
        const controlConfig = {
            camera: this.cameras.main,
            left: cursors.left,
            right: cursors.right,
            up: cursors.up,
            down: cursors.down,
            speed: 0.5
        };
        this.controls = new Phaser.Cameras.Controls.FixedKeyControl(controlConfig);

        const help = this.add.text(16, 16, 'Left-click to drop balls.\nTry dropping the balls on the spikes or lava.', {
            fontSize: '18px',
            padding: { x: 10, y: 5 },
            backgroundColor: '#ffffff',
            fill: '#000000'
        });
        help.setScrollFactor(0);
    }

    update (time, delta)
    {
        this.controls.update(delta);
    }

    getRootBody (body)
    {
        if (body.parent === body) { return body; }
        while (body.parent !== body)
        {
            body = body.parent;
        }
        return body;
    }
}

const config = {
    type: Phaser.AUTO,
    width: 800,
    height: 600,
    backgroundColor: '#000000',
    parent: 'phaser-example',
    physics: {
        default: 'matter',
        matter: {
            gravity: { y: 1 },
            enableSleep: true
        }
    },
    scene: Example
};

const game = new Phaser.Game(config);

Подготовка Tilemap и задание свойств коллизии

В основе примера лежит Tilemap, созданный в редакторе Tiled. Ключевой шаг — настройка коллизии на уровне плиток перед их преобразованием в физические тела Matter.

const map = this.make.tilemap({ key: 'map' });
const tileset = map.addTilesetImage('kenny_platformer_64x64');
const layer = map.createLayer(0, tileset, 0, 0);

// Устанавливаем коллизию для плиток, у которых в Tiled задано свойство collides: true
layer.setCollisionByProperty({ collides: true });

Метод setCollisionByProperty анализирует данные Tilemap и активирует коллизию только для тех плиток, у которых в Tiled задано свойство collides со значением true. Это позволяет гибко определять, какие участки карты являются физически твердыми.

Затем весь слой конвертируется в тела Matter. Если в Tiled для плитки были заданы сложные формы коллизии (полигоны), они будут использованы. Если формы отсутствуют, тело будет создано как простой прямоугольник.

this.matter.world.convertTilemapLayer(layer);

Маркировка опасных плиток для точного определения

Простое столкновение с любой плиткой — это недостаточно. Нам нужно отличать безопасные поверхности от опасных (лава, шипы). В Tiled для таких плиток было задано строковое свойство type.

Мы проходим по всем плиткам слоя и для тех, у которых свойство type равно 'lava' или 'spike', изменяем label (метку) их Matter тела. Это ключевой момент для последующей фильтрации событий коллизии.

layer.forEachTile(tile =>
{
    if (tile.properties.type === 'lava' || tile.properties.type === 'spike')
    {
        tile.physics.matterBody.body.label = 'dangerousTile';
    }
});

Метка 'dangerousTile' будет присвоена корневому физическому телу плитки. Это позволяет нам в событии коллизии легко идентифицировать, что объект столкнулся именно с опасной поверхностью.

Создание объектов и обработка событий коллизии

В примере объекты (шары) создаются по клику мыши. Для их Matter тел также задается уникальная метка 'ball', чтобы отличать их от других возможных тел в мире.

this.input.on('pointerdown', function ()
{
    const worldPoint = this.input.activePointer.positionToCamera(this.cameras.main);
    for (let i = 0; i < 5; i++)
    {
        const x = worldPoint.x + Phaser.Math.RND.integerInRange(-5, 5);
        const y = worldPoint.y + Phaser.Math.RND.integerInRange(-5, 5);
        const frame = Phaser.Math.RND.integerInRange(0, 5);
        this.matter.add.image(x, y, 'balls', frame, { restitution: 1, label: 'ball' });
    }
}, this);

Движок Matter генерирует событие 'collisionstart' при начале столкновения любых двух тел. В обработчике этого события мы проверяем все пары (event.pairs).

this.matter.world.on('collisionstart', function (event)
{
    for (let i = 0; i < event.pairs.length; i++)
    {
        const bodyA = this.getRootBody(event.pairs[i].bodyA);
        const bodyB = this.getRootBody(event.pairs[i].bodyB);

Так как плитки могут иметь составные тела (compound bodies), мы используем вспомогательную функцию getRootBody, чтобы получить корневое тело, на котором была установлена метка 'dangerousTile'. Затем проверяем комбинацию меток.

if ((bodyA.label === 'ball' && bodyB.label === 'dangerousTile') ||
            (bodyB.label === 'ball' && bodyA.label === 'dangerousTile'))
        {
            const ballBody = bodyA.label === 'ball' ? bodyA : bodyB;
            const ball = ballBody.gameObject;

Если обнаружено столкновение шарика с опасной плиткой, тело шарика удаляется из физического мира (this.matter.world.remove), и запускается твин (анимация) его исчезновения перед окончательным уничтожением объекта.

Управление камерой и вспомогательные функции

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

const cursors = this.input.keyboard.createCursorKeys();
const controlConfig = {
    camera: this.cameras.main,
    left: cursors.left,
    right: cursors.right,
    up: cursors.up,
    down: cursors.down,
    speed: 0.5
};
this.controls = new Phaser.Cameras.Controls.FixedKeyControl(controlConfig);

В методе update происходит обновление этого контроллера.

update (time, delta)
{
    this.controls.update(delta);
}

Также определена важная вспомогательная функция getRootBody. Она проходит по цепочке родительских тел, пока не найдет корневое (то, у которого parent равен самому себе). Это гарантирует, что мы работаем с телом, которому была присвоена метка, даже если в событии коллизии участвует его часть.

getRootBody (body)
{
    if (body.parent === body) { return body; }
    while (body.parent !== body)
    {
        body = body.parent;
    }
    return body;
}

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

Пример демонстрирует мощную комбинацию Tilemap и физического движка Matter для создания интеллектуальной системы коллизии. Ключевые идеи: использование свойств плиток из Tiled для маркировки, присвоение меток (label) физическим телам и фильтрация событий коллизии по этим меткам. Для экспериментов можно попробовать: добавить другие типы плиток (например, "вода", замедляющая движение), реализовать восстановление здоровья при столкновении с "лечебными" плитками или создать сложные составные опасные зоны из нескольких плиток с одной общей меткой.