強制横スクロールゲーム　手順１６ - i-school

　引き続き空中床以外のゲームオブジェクトを作成して、ゲーム内容にバリエーションを持たせて行きます。

この手順では、ゲームの目的の１つであるコイン集めに使用するコインのゲームオブジェクトと、コインとキャラと接触した際の処理について実装していきます。

手順１６　－コインの設置・移動・キャラとの接触処理の実装－

２７．コインを設置する
２８．スクリプトを使って、コインを獲得できるようにする

＜実行動画　コインと接触して通過した際に、CoinPointが Coin スクリプトで設定した値分だけ加算される。またコインのゲームオブジェクトが破壊される＞
https://gyazo.com/82dae1bb1a516aa3dd3f4efa32aa8655

　新しく学習する内容は以下になります。

・OnTriggerEnter2Dメソッド

２７．コインを設置する

設計

　先ほどに引き続き、空中床以外のゲームオブジェクトを作成して、ゲーム内に登場させましょう。
今度はコインのゲームオブジェクトを作成します。このコインをたくさん集めていくことがゲームの目的になります。

コインとコイン用のアニメーションクリップを作成する

　キャラのアニメーションクリップを作成したときの手順と同じように、複数の画像をまとめて選択して、ヒエラルキーにドラッグアンドドロップします。
こうすることで常にアニメーションしているコインを作成することが出来ます。

ファイルの場所　ファイルの場所　Assets/UnityChan2D/Demo/Sprites/Coin_0.png から Coin_2.png までの３ファイル

選択時のインスペクター画像

　選択したファイルをそのままヒエラルキーにドラッグアンドドロップします。
先ほどと同じように、複数の画像をまとめて設置したため、画像をアニメーションクリップとして保存するための Create New Animation ウインドウが開きます。

Create New Animation ウインドウ

　ファイル名を coin.anim に変更して保存を選択してください。

　ヒエラルキーに coin_0 ゲームオブジェクトが作成されます。

ヒエラルキー画像

SceneビューとGameビュー画像

ゲームを実行して動作を確認する

　作成されたゲームオブジェクトにはアニメーションクリップが設定されています。ゲームを実行して、アニメーションが再生されるか確認します。

＜実行動画　コインがアニメーションするか確認する＞
https://gyazo.com/31afb799e499ff1143cb89bbf815f36a

coin_0 ゲームオブジェクトの名前を Coin に変更する

　名前を Coin に変更してください。

ヒエラルキー画像

Coin ゲームオブジェクトに Coin Tag を設定する

　Coin ゲームオブジェクトに Tag の設定を行います。
初期値は Untagged(Tagなし) になっていますので、新しく Coin という Tag を追加して、それを Coin ゲームオブジェクトに設定します。

　この Tag の情報を if 文の条件式として利用することで、コインなのか、あるいは違うオブジェクトなのかを判断することが可能になります。

Coin ゲームオブジェクト　インスペクター画像　Tag 変更前

　↓

Coin ゲームオブジェクト　インスペクター画像　Tag 変更後

Coin ゲームオブジェクトの設定を行う

　キャラより少し小さい位の大きさになっていますが、そのままで問題ありません、
もしも大きさを変更するのであれば、 Coin ゲームオブジェクトの Transform コンポーネントの Scale の値に変更してください。
SpriteRenderer コンポーネントと Animator コンポーネントは作成と同時にアタッチされていますが、こちらは変更箇所はありません。

インスペクター画像①

　新しくコンポーネントを１つ追加します。
インスペクターの一番下にある Add Compnent ボタンを押して、CapsuleCollider2D コンポーネント、あるいは BoxCollider2D コンポーネントのいずれか１つを追加します。
この手順では BoxCollider2D コンポーネントを追加しています。

　追加したコライダー・コンポーネントの Edit Collider ボタンを押して、Sceneビューで画像に見合った大きさのコライダーに調整してください。

インスペクター画像②　BoxCollider2D コンポーネント(CapsuleCollider2D コンポーネントの場合も操作は同じです)

Sceneビューのコライダー編集画像

　以上で設定は終了です。

Coin ゲームオブジェクトに MoveObject スクリプトをアタッチして設定する

　ヒエラルキーの Coin ゲームオブジェクトに MoveObject スクリプトをドラッグアンドドロップしてアタッチします。
MoveSpeed 変数の値を 0.01 に設定してください。この値は空中床のゲームオブジェクトと同じ値にしていますが、自由に調整してください。

Coin ゲームオブジェクト　インスペクター画像

ゲームを実行して動作を確認する

　以上でコインのゲームオブジェクトが完成です。

　MoveSpeed を設定しましたので、ゲームを実行してみましょう。
空中床のゲームオブジェクトと同じ値を設定していますので、画面の左側に向かって移動をすれば成功です。

＜実行動画　コインが画面の左側に移動する＞
https://gyazo.com/e3e9a017a3f6a155a4981df32060df60

２８．スクリプトを使って、コインを獲得できるようにする

設計

　ゲームにコインが登場するようになりましたので、キャラとコインとを接触させることで、コインを獲得できるようにしていきます。

　
　コインとキャラの接触についてですが、こちらもコライダー同士の接触を行うことで判定を行うようにします。
ただし、敵とキャラのようにコライダー同士が接触してしまうと、コインとキャラとが別々の位置に留まってしまうため、見た目的にもコインを獲得出来ません。

　Unityのコライダーの接触判定には、接触して判定を行う方法と、もう１つ、接触して通過をした際に判定を行う方法とがあります。
今回は２つ目の、接触して通過をする際に判定を取る方法で設計を行います。

　この判定処理は、OnTriggerEnter2D メソッドを記述する実装するが出来ます。この処理の中で、OnCollisionEnter2D メソッドと同じように
コインに専用の Tag を設定しておいて、その Tag のときにだけ、コインのゲームオブジェクトを通過した際に、コインを獲得したことにする処理を実装します。

　コインを獲得する、ということはゲーム的な言い回しですが、これを実際の処理として考えていくと、次のような内容になります。

１．キャラがコインのゲームオブジェクトと接触して通過する
　　↓
２．コインのゲームオブジェクトの持つ「得点」をプレイヤーに加算する
　　↓
３．コインのゲームオブジェクトを破壊する

　【１】の処理については先ほど説明をしました OnTriggerEnter2D メソッドによって処理を実装出来ます。
　
　【２】の処理ですが、コインのゲームオブジェクトには、「得点」という要素は持っていません。
OnTriggerEnter2D メソッド内でコインのゲームオブジェクト自体の情報は取得できていますので、これを利用して、
コインのゲームオブジェクトに、新しくスクリプトを１つ作成してアタッチし、そのスクリプトに「得点」用の変数を設定しておきます。

　そして、この「得点」用の変数をプレイヤーに加算するということになりますので、PlayerController スクリプトにも、得点加算用の変数を新しく用意して
コインのスクリプトからこの値を受け取って、加算していくように設計を行います。

　【３】の処理については、OnTriggerEnter2D メソッド内でコインのゲームオブジェクトの情報を取得できていますので、これを利用して、コインのゲームオブジェクトを破壊します。
　

Coin スクリプトを作成する

　宣言フィールドでは１つの変数を宣言します。この変数を利用して、コインと接触した際に獲得できるポイントを設定します。
public 修飾子で宣言していますので、インスペクターより値の変更が可能です。

Coin.cs

　<=　クリックすると開きます

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class Coin : MonoBehaviour
{
    public int point;
}

Coin　ゲームオブジェクトに Coin スクリプトをアタッチして設定を行う

　ヒエラルキーにある Coin ゲーオブジェクトに作成した Coin スクリプトをドラッグアンドドロップしてアタッチしてください。

　Coin ゲームオブジェクトのインスペクターを確認し、Coin スクリプトの Point 変数に値を設定します。
自由な値を設定してください。今回は 100 で設定しています。

　この値がコインと接触した際に獲得できるコインのポイントになります。この値の合計値を PlayerController スクリプトで管理します。

Coin ゲームオブジェクト　インスペクター画像

PlayerController スクリプトを修正して、コインとの接触処理を追加する

　宣言フィールドに public 修飾子で coinPoint 変数を宣言します。
コインと接触して通過した際に、コインの持つ Coin スクリプトに設定されている point 変数の値を加算していきます。

　また、コインとの接触・通過の処理を OnTriggerEnter2D メソッドを記述して判定できるように処理を追加します。
　

PlayerController.cs

　<=　クリックすると開きます。

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class PlayerController : MonoBehaviour
{
    private string horizontal = "Horizontal";    // キー入力用の文字列指定
    private string jump = "Jump";

    private Rigidbody2D rb;                      // コンポーネントの取得用
    private Animator anim;

    private float scale;                         // 向きの設定に利用する
    private float limitPosX = 9.5f;              // 横方向の制限値
    private float limitPosY = 4.45f;             // 縦方向の制限値

    public bool isFirstGenerateBallon;          // 初めてバルーンを生成したかを判定するための変数

    public float moveSpeed;                      // 移動速度
    public float jumpPower;                      // ジャンプ・浮遊力

    public bool isGrounded;

    public GameObject[] ballons;                 // GameObject型の配列。インスペクターからヒエラルキーにある Ballon ゲームオブジェクトを２つアサインする
    public int maxBallonCount;                   // バルーンを生成する最大数
    public Transform[] ballonTrans;              // バルーンの生成位置の配列
    public GameObject ballonPrefab;              // バルーンのプレファブ

    public float generateTime;                   // バルーンを生成する時間
    public bool isGenerating;                    // バルーンを生成中かどうかを判定する。false なら生成していない状態。true は生成中の状態

    public float knockbackPower;                 // 敵と接触した際に吹き飛ばされる力


////* ここから追加 *////


    public int coinPoint;                        // コインを獲得すると増えるポイントの総数


////* ここまで *////


    [SerializeField, Header("Linecast用 地面判定レイヤー")]
    private LayerMask groundLayer;

    [SerializeField]
    private StartChecker startChecker;


    void Start() {
        // 必要なコンポーネントを取得して用意した変数に代入
        rb = GetComponent<Rigidbody2D>();
        anim = GetComponent<Animator>();

        scale = transform.localScale.x;

　　　　// 配列の初期化(バルーンの最大生成数だけ配列の要素数を用意する)
        ballons = new GameObject[maxBallonCount];
    }

    void Update() {

        // 地面接地  Physics2D.Linecastメソッドを実行して、Ground Layerとキャラのコライダーとが接地している距離かどうかを確認し、接地しているなら true、接地していないなら false を戻す
        isGrounded = Physics2D.Linecast(transform.position + transform.up * 0.4f, transform.position - transform.up * 0.9f, groundLayer);

        // Sceneビューに Physics2D.LinecastメソッドのLineを表示する
        Debug.DrawLine(transform.position + transform.up * 0.4f, transform.position - transform.up * 0.9f, Color.red, 1.0f);

        // ballons変数の最初の要素の値が空ではないなら = バルーンが１つ生成されるとこの要素に値が代入される = バルーンが１つあるなら
        if (ballons[0] != null) {

            // ジャンプ
            if (Input.GetButtonDown(jump)) {
                Jump();
            }

            // 接地していない(空中にいる)間で、落下中の場合
            if (isGrounded == false && rb.velocity.y < 0.15f) {

                // 落下アニメを繰り返す
                anim.SetTrigger("Fall");
            }
        } else {
            Debug.Log("バルーンがない。ジャンプ不可");
        }

        // Velocity.y の値が 5.0f を超える場合(ジャンプを連続で押した場合)
        if(rb.velocity.y > 5.0f) {

            // Velocity.y の値に制限をかける(落下せずに上空で待機できてしまう現象を防ぐため)
            rb.velocity = new Vector2(rb.velocity.x, 5.0f);
        }

        // 地面に接地していて、バルーンが生成中ではない場合
        if (isGrounded == true && isGenerating == false) {

            // Qボタンを押したら
            if (Input.GetKeyDown(KeyCode.Q)) {

                // バルーンを１つ作成する
                StartCoroutine(GenerateBallon());
            }
        }
    }

    /// <summary>
    /// ジャンプと空中浮遊
    /// </summary>
    private void Jump() {

        // キャラの位置を上方向へ移動させる(ジャンプ・浮遊)
        rb.AddForce(transform.up * jumpPower);

　　　　// Jump(Up + Mid) アニメーションを再生する
　　　　anim.SetTrigger("Jump");  
    }

    void FixedUpdate() {
        // 移動
        Move();    
    }

    /// <summary>
    /// 移動
    /// </summary>
    private void Move() {

        // 水平(横)方向への入力受付
        float x = Input.GetAxis(horizontal);

        // x の値が 0 ではない場合 = キー入力がある場合
        if (x != 0) {

            // velocity(速度)に新しい値を代入して移動
            rb.velocity = new Vector2(x * moveSpeed, rb.velocity.y);

　　　　　　// temp 変数に現在の localScale 値を代入
            Vector3 temp = transform.localScale;

            // 現在のキー入力値 x を temp.x に代入
            temp.x = x;

            // 向きが変わるときに小数になるとキャラが縮んで見えてしまうので整数値にする            
            if (temp.x > 0) {

                //  数字が0よりも大きければすべて1にする
                temp.x = scale;

            } else {    
                //  数字が0よりも小さければすべて-1にする
                temp.x = -scale;
            }

　　　　　　// キャラの向きを移動方向に合わせる
            transform.localScale = temp;

            // 待機状態のアニメの再生を止めて、走るアニメの再生への遷移を行う
            anim.SetBool("Idle", false);
            anim.SetFloat("Run", 0.5f);
            
        } else {    
　　　　　　//  左右の入力がなかったら横移動の速度を0にしてピタッと止まるようにする
            rb.velocity = new Vector2(0, rb.velocity.y);
            
            //  走るアニメの再生を止めて、待機状態のアニメの再生への遷移を行う
            anim.SetFloat("Run", 0.0f);
            anim.SetBool("Idle", true);
        }

        // 現在の位置情報が移動範囲の制限範囲を超えていないか確認する。超えていたら、制限範囲内に収める
        float posX = Mathf.Clamp(transform.position.x, -limitPosX, limitPosX);
        float posY = Mathf.Clamp(transform.position.y, -limitPosY, limitPosY);

        // 現在の位置を更新(制限範囲を超えた場合、ここで移動の範囲を制限する)
        transform.position = new Vector2(posX, posY);
    }

　　/// <summary>
    /// バルーン生成
    /// </summary>
    /// <returns></returns>
    private IEnumerator GenerateBallon() {

        // すべての配列の要素にバルーンが存在している場合には、バルーンを生成しない
        if (ballons[1] != null) {
            yield break;
        }

        // 生成中状態にする
        isGenerating = true;

        // isFirstGenerateBallon 変数の値が false、つまり、ゲームを開始してから、まだバルーンを１回も生成していないなら
        if (isFirstGenerateBallon == false) {
            
            // 初回バルーン生成を行ったと判断し、true に変更する = 次回以降はバルーンを生成しても、if 文の条件を満たさなくなり、この処理には入らない
            isFirstGenerateBallon = true;

　　　　　　Debug.Log("初回のバルーン生成");

            // startChecker 変数に代入されている StartChecker スクリプトにアクセスして、SetInitialSpeed メソッドを実行する
            startChecker.SetInitialSpeed();
        }

　　　　// １つめの配列の要素が空なら
        if (ballons[0] == null) {

            // 1つ目のバルーン生成を生成して、1番目の配列へ代入
            ballons[0] = Instantiate(ballonPrefab, ballonTrans[0]);
            ballons[0].GetComponent<Ballon>().SetUpBallon(this);

        } else {

            // 2つ目のバルーン生成を生成して、2番目の配列へ代入
            ballons[1] = Instantiate(ballonPrefab, ballonTrans[1]);
            ballons[1].GetComponent<Ballon>().SetUpBallon(this);

        }

        // 生成時間分待機
        yield return new WaitForSeconds(generateTime);

        // 生成中状態終了。再度生成できるようにする
        isGenerating = false;
    }

　　private void OnCollisionEnter2D(Collision2D col) {

        // 接触したコライダーを持つゲームオブジェクトのTagがEnemyなら 
        if (col.gameObject.tag == "Enemy") {

            // キャラと敵の位置から距離と方向を計算
            Vector3 direction = (transform.position - col.transform.position).normalized;

            // 敵の反対側にキャラを吹き飛ばす
            transform.position += direction * knockbackPower;
        }
    }

    /// <summary>
    /// バルーン破壊
    /// </summary>
    public void DestroyBallon() {

        // TODO 後程、バルーンが破壊される際に「割れた」ように見えるアニメ演出を追加する

        if (ballons[1] != null) {
            Destroy(ballons[1]);
        } else if (ballons[0] != null){
            Destroy(ballons[0]);
        }
    }


////* 新しいメソッドを１つ追加　ここから *////


　　// IsTriggerがオンのコライダーを持つゲームオブジェクトを通過した場合に呼び出されるメソッド
    private void OnTriggerEnter2D(Collider2D col) {

        // 通過したコライダーを持つゲームオブジェクトの Tag が Coin の場合
        if (col.gameObject.tag == "Coin") {

            // 通過したコインのゲームオブジェクトの持つ Coin スクリプトを取得し、point 変数の値をキャラの持つ coinPoint 変数に加算
            coinPoint += col.gameObject.GetComponent<Coin>().point;

　　　　　　// 通過したコインのゲームオブジェクトを破壊する
            Destroy(col.gameObject);
        }
    }


////* ここまで *////


}

＜OnTriggerEnter2Dメソッド＞

　Unityの MonoBehaviour クラスの持つメソッドの１つです。
このメソッドが記述されたスクリプトのアタッチされてるコライダーを持つゲームオブジェクト（キャラ）が、他のコライダーを持つゲームオブジェクトを通過した際に接触判定を行うメソッドです。
その際に Collider2D 型の変数に接触して通過したゲームオブジェクトの情報を取得し、メソッド内で利用できる状態にしてくれます。

　通常コライダーを持つオブジェクト同士は接触しますが、いずれか片方のゲームオブジェクトのコライダーの IsTrigger のスイッチがオンになっている場合、
コライダーを持つゲームオブジェクトを通過することができます。その際に、このメソッドが接触判定を行います。

    // IsTriggerがオンのコライダーを持つゲームオブジェクトを通過した場合に呼び出されるメソッド
    private void OnTriggerEnter2D(Collider2D col) {

        // 通過したコライダーを持つゲームオブジェクトの Tag が Coin の場合
        if (col.gameObject.tag == "Coin") {

            // 通過したコインのゲームオブジェクトの持つ Coin スクリプトを取得し、point 変数の値をキャラの持つ coinPoint 変数に加算
            coinPoint += col.gameObject.GetComponent<Coin>().point;

　　　　　　// 通過したコインのゲームオブジェクトを破壊する
            Destroy(col.gameObject);
        }
    }

Unity公式スクリプトリファレンス
~https://docs.unity3d.com/ja/current/ScriptReferenc...

ゲームを実行して動作を確認する

　スクリプトを修正したらセーブをして、ゲームを実行して動作を確認します。

　コインと接触してみましょう。敵の場合と異なり、コインを通過できますが、ちゃんと OnTriggerEnter2D メソッドが接触判定を行っているため、
PlayerController スクリプトの CoinPoint の値が加算されるとともに、コインのゲームオブジェクトが破壊されていれば成功です。

＜実行動画　コインと接触して通過した際に、CoinPointが Coin スクリプトで設定した値分だけ加算される。またコインのゲームオブジェクトが破壊される＞
https://gyazo.com/82dae1bb1a516aa3dd3f4efa32aa8655

　Coin ゲームオブジェクトを複製して、２つ、３つと続けてコインを獲得してみましょう。接触して通過するたびに、CoinPoint の値が上書きされず、どんどん加算されていれば成功です。

＜実行動画　コインを複数獲得してみる＞
https://gyazo.com/6b7019ca2cedc9f9930bbaf79ac84e96

　以上でこの手順は終了です。

　次は　手順１７　－ゲームオブジェクトのランダム自動生成処理の実装－　です。

２７．コインを設置する

設計

コインとコイン用のアニメーションクリップを作成する

ゲームを実行して動作を確認する

coin_0 ゲームオブジェクトの名前を Coin に変更する

Coin ゲームオブジェクトに Coin Tag を設定する

Coin ゲームオブジェクトの設定を行う

Coin ゲームオブジェクトに MoveObject スクリプトをアタッチして設定する

ゲームを実行して動作を確認する

２８．スクリプトを使って、コインを獲得できるようにする

設計

Coin スクリプトを作成する

Coin ゲームオブジェクトに Coin スクリプトをアタッチして設定を行う

PlayerController スクリプトを修正して、コインとの接触処理を追加する

＜OnTriggerEnter2Dメソッド＞

ゲームを実行して動作を確認する

Coin　ゲームオブジェクトに Coin スクリプトをアタッチして設定を行う