Phaser3をかじる

2021年1月9日

PhaserはHTML5ゲームを作成するために使用できる2Dゲームフレームワークだそうだ。初めのリリースが2013年だが、2020年も更新されている。チュートリアルをひとつやってみた。

初めてのPhaser3ゲームを作る

トップページの[LEARN]をクリックして開くページで[Making your first Game]というチュートリアルをやってみた。このチュートリアルはとても親切で200行ほどのコードを10段階に分けて説明してくれている。残念ながら日本語版がないがブラウザの翻訳機能を使えば内容は理解できる。zipファイルをダウンロードすればコードを入力しなくても大丈夫だ。part10.htmlが完成版だ。

Local

phaser3を動かすのにローカルでもWebサーバーが必要とのことで、いつもWordPressで使っているLocalで動かしてみた。サイトを作るとPhaserではいらないWordPressがインストールされるがhtmlも動く。ローカル環境にWebサーバー環境がない人はLocalで試すのも手だ。

Localで作ったサイトのコンテンツがあるフォルダ(設定によるがapp/public等)以下に置いて、サイトを開き、URLを?以降の代わりに置いたhtmlファイルまでのパスを書けば動く。

コード

  • 衝突判定コードを自分で書かかなくていいのは嬉しい。
  • part10.htmlまでの解説を読んだので、コードを少し修正してみた。GameOverになると止まってしまうので、その後に最初から開始できるようにしてみた。具体的にはrestart()を追加してみた。restart()の中でthis.physics.resume();がエラーになったので外に出した。自分で追加した関数はthisが使えないようだ。
  • 星を取るゲームなので背景も夜にする等、絵もちょっと変えてみた。
  • overlapとcolliderは何が違うのかと思い動きを確認した。どちらも星は消える。星が下にあるときにplayerが星に向かって落ちるときに動きが違った。collliderだと星にぶつかって跳ね返り、overlapだと跳ね返らなかった。
  • ←↑→[space]キーを使うのでPCでしか動作しない。

左右矢印キーで移動、上矢印キーでジャンプできる。星を集めるとScoreに加算される。爆弾にふれるとゲームオーバー。[Space]キーでまた最初からできる。

<!DOCTYPE html> 
<html lang="ja"> 
<head> 
    <meta charset="UTF-8" />
    <link rel="icon" type="image/png" href="favicon.png">
    <title>はじめのPhaser3ゲーム作成チュートリアル</title>
    <!-- チュートリアルはここ： https://phaser.io/tutorials/making-your-first-phaser-3-game -->
    <!--script src="//cdn.jsdelivr.net/npm/phaser@3.11.0/dist/phaser.js"></script-->
    <script src="js/phaser.js"></script>
    <style type="text/css">
        body {
            margin: 0;
        }
    </style>
</head>
<body>

<script type="text/javascript">

let config = {
    type: Phaser.AUTO, // 自動(WEBGLが使えなければCANVASを使う)
    width: 800, // 横幅
    height: 600, // 高さ
    physics: { // 物理の設定
        default: 'arcade', // 標準的な物理エンジン
        arcade: { // arcadeエンジンの設定
            gravity: { y: 300 }, // 重力
            debug: false // デバッグモード
        }
    },
    scale: {
        autoCenter: Phaser.Scale.CENTER_HORIZONTALLY, // 中央配置
    },
    scene: {
        preload: preload, // ゲーム開始前に画像のロード等で呼ぶ関数
        create: create, // 初期化関数
        update: update, // ゲーム中定期的に呼ばれる関数
        restart: restart // ここに書けばthisが使えるかもと思い追加してみたが、関係なかった
    }
};

let player;
let stars;
let bombs;
let platforms;
let cursors;
let score = 0;
let gameOver = false;
let scoreText;
let gameOverText;
let restartText;

let game = new Phaser.Game(config);

// 開始前に画像の読み込み等を行う
function preload ()
{
    // 画像
    this.load.image('sky', 'assets/sky.png');
    this.load.image('ground', 'assets/platform.png');
    this.load.image('star', 'assets/star.png');
    this.load.image('bomb', 'assets/bomb.png');

　　// スプレッドシート
    this.load.spritesheet('dude', 'assets/dude.png', { frameWidth: 32, frameHeight: 48 });
}

// 初期化
function create ()
{
    //  A simple background for our game
    this.add.image(400, 300, 'sky');

    // 静的グループで地面を作る
    //  The platforms group contains the ground and the 2 ledges we can jump on
    platforms = this.physics.add.staticGroup();

    //  Here we create the ground.
    //  Scale it to fit the width of the game (the original sprite is 400x32 in size)
    platforms.create(400, 568, 'ground').setScale(2).refreshBody();

    //  Now let's create some ledges
    platforms.create(600, 400, 'ground');
    platforms.create(50, 250, 'ground');
    platforms.create(750, 220, 'ground');

    // Spriteでplayerを作る
    // The player and its settings
    player = this.physics.add.sprite(100, 450, 'dude');

    //  Player physics properties. Give the little guy a slight bounce.
    player.setBounce(0.2); // 少しバウンドする
    player.setCollideWorldBounds(true); // 衝突判定する

    //  Our player animations, turning, walking left and walking right.
    this.anims.create({
        key: 'left',
        frames: this.anims.generateFrameNumbers('dude', { start: 0, end: 3 }),
        frameRate: 10,
        repeat: -1
    });

    this.anims.create({
        key: 'turn',
        frames: [ { key: 'dude', frame: 4 } ],
        frameRate: 20
    });

    this.anims.create({
        key: 'right',
        frames: this.anims.generateFrameNumbers('dude', { start: 5, end: 8 }),
        frameRate: 10,
        repeat: -1
    });

    //  Input Events
    cursors = this.input.keyboard.createCursorKeys();

    //  Some stars to collect, 12 in total, evenly spaced 70 pixels apart along the x axis
    stars = this.physics.add.group({
        key: 'star',
        repeat: 11,
        setXY: { x: 12, y: 0, stepX: 70 }
    });

    // 個々でバウンド率を変える
    stars.children.iterate(function (child) {

        //  Give each star a slightly different bounce
        child.setBounceY(Phaser.Math.FloatBetween(0.6, 0.9));

    });

    // 爆弾
    bombs = this.physics.add.group();

    //  The score
    scoreText = this.add.text(16, 16, 'score: 0', { fontSize: '32px', fill: '#fff' });

    // ゲームオーバー表示を追加する
    gameOverText = this.add.text(400,300, '', {fontSize: '64px', fill: '#f00' });
    gameOverText.setOrigin(0.5);
    restartText = this.add.text(400,350, '', {fontSize: '32px', fill: '#fff' });
    restartText.setOrigin(0.5);

    // 衝突判定する
    //  Collide the player and the stars with the platforms
    this.physics.add.collider(player, platforms);
    this.physics.add.collider(stars, platforms);
    this.physics.add.collider(bombs, platforms);

    // overlapは重なったときに跳ね返らない
    // colliderは重なったときに跳ね返る
    // playerとstartsをcolliderにした場合はplayerが星の上から落ちるときに跳ね返る

    // playerとstarsが重なったらcollectStarを呼ぶ
    //  Checks to see if the player overlaps with any of the stars, if he does call the collectStar function
    this.physics.add.overlap(player, stars, collectStar, null, this);

    // playerとbombsが重なったらhitBombを呼ぶ
    this.physics.add.collider(player, bombs, hitBomb, null, this);
}

// ゲームオーバー後のゲーム開始処理
function restart()
{
    // ゲームオーバーフラグクリア
    gameOver = false;

    // ゲームオーバー文字を消す
    gameOverText.setText('');
    restartText.setText('');

    // スコアをクリア
    score = 0;
    scoreText.setText('Score: ' + score);

    // プレイヤーが赤くなっているのを元に戻す
    player.setTint(0xffffff);

    // 爆弾をdisable&clear
    bombs.children.iterate(function(bomb) {
        bomb.disableBody(true, true);
    });
    bombs.clear();

    // startsリセット
    stars.children.iterate(function (star) {
        star.enableBody(true, star.x, 0, true, true);
    });

}

// 更新
function update ()
{
    if (gameOver)
    {
　　　　if (cursors.space.isDown) {
            restart();

　　　　    // 物理エンジン再開
            // restart()の中ではthisが使えないようだったのでここでresumeする
    　　　　this.physics.resume();
        }
        return;
    }

    if (cursors.left.isDown)
    {
        player.setVelocityX(-160);

        player.anims.play('left', true);
    }
    else if (cursors.right.isDown)
    {
        player.setVelocityX(160);

        player.anims.play('right', true);
    }
    else
    {
        player.setVelocityX(0);

        player.anims.play('turn');
    }

    // UPキーでplayerが地面に接しているとき
    if (cursors.up.isDown && player.body.touching.down)
    {
        player.setVelocityY(-330);
    }
}

// playerとstartが重なったらスコアを加算
// すべてなくなったらstartsをenableし、bombsを生成する
function collectStar (player, star)
{
    star.disableBody(true, true);

    //  Add and update the score
    score += 10;
    scoreText.setText('Score: ' + score);

    if (stars.countActive(true) === 0)
    {
        //  A new batch of stars to collect
        stars.children.iterate(function (child) {

            child.enableBody(true, child.x, 0, true, true);

        });

        // playerとは反対側に生成
        let x = (player.x < 400) ? Phaser.Math.Between(400, 800) : Phaser.Math.Between(0, 400);

        let bomb = bombs.create(x, 16, 'bomb');
        bomb.setBounce(1);
        bomb.setCollideWorldBounds(true);
        bomb.setVelocity(Phaser.Math.Between(-200, 200), 20);
        bomb.allowGravity = false;

    }
}

function hitBomb (player, bomb)
{
    this.physics.pause();

    player.setTint(0xff0000);

    player.anims.play('turn');

    gameOver = true;
    gameOverText.setText('Game Over');
    restartText.setText('Restart: Hit Space Key');
}

</script>

</body>
</html>

他のチュートリアル

他にもたくさんチュートリアルがあるのでそのうちまた試したい。古いチュートリアルからやろうかとも思ったが、Phaser2とPhaser3ではコードの書き方が異なるようなので、古いのからやるのはやめた。

phaser3