３Ｄグラフィック　２Ｄ横スクロールアクション　手順１０

　２回に分けて、プレイヤーのキャラクターの移動アニメ処理を実装します。
　以下の内容で順番に実装を進めていきます。

＜実装動画(手順１０まで実装したときのもの)＞

動画ファイルへのリンク

手順１０　ープレイヤーの移動と移動アニメの同期処理の実装ー

　新しい学習内容は、以下の通りです。

　・TryGetComponent メソッドと out キーワード宣言
　・Mathf.Approximately メソッド
　・Animator.SetFloat メソッド
　・Vector2.Set メソッド
　・Vector2.Normalize メソッドを利用した正規化処理

１６．PlayerController スクリプトを修正して、キャラの移動している方向を取得し、その後、移動アニメと同期させる処理を実装する

１．設計

　実装動画を確認してみてください。このような動画になる挙動を行うためにはどうすればよいか、考えてみましょう。

　ポイントは次の点です。

　・キャラの移動方向に合わせて、その移動方向のキャラの移動アニメが再生される

　今回は実装していませんが、停止中のアニメを用意して足踏みを止めるようにしてもいいと思います。

　Animator こちらにて製作したアニメの遷移処理は、ゲームオブジェクトの Animator コンポーネント内にある Controller プロパティの部分で制御されています。
このコンポーネントは複数の画像をまとめてヒエラルキーにドラッグアンドドロップした際には、自動的に追加されます。

Animator コンポーネント

　Controller プロパティに登録されている情報が、先ほど Animator ビューで設定した情報になります。
そのため、この Controller を変更することによって、異なるアニメの遷移を行うようになります。
　
　また Animator ビューの Parameters に設定した情報を操作するためにも、この Animator コンポーネントが必要になりますので、
アニメの制御を行う場合には、この Animator コンポーネントをスクリプト内で変数に取得して、それを利用するという方法で制御を行います。

　Blend Tree の Speed 部分でキャラのアニメが値の変化に合わせて Blend Tree の Walks と Runs が自動的に切り替わったと思います。

　つまり、キャラのキー入力の情報を、Spped の部分と同期させることができれば、
そのままキャラの移動アニメにも適用することができるということになります。

　これが今回の移動アニメとキャラの移動とを同期させるロジックになります。

　プレイヤー用のキャラの制御は PlayerController スクリプトにおいて行っていますので、
以上の制御処理を PlayerController スクリプトに実装して、キャラの移動と移動アニメとを同期させていきます。

　今回は実装例をそのまま掲載していますが、今後、自分で移動アニメなどの実装を行う場合も、同じような考え方で実装が出来ます。
どの処理とどの処理がつながっているのか、Unity の制御をどのようにすればスクリプトから行えるようになるのか、
設計の考え方、ロジックの作り方を覚えていって、自分のゲームにも活用できるようにしてください。

２．PlayerController スクリプトを修正する

　それでは実装をしてみましょう。
BlendTree の Palameter には Animator コンポーネントが持つ SetFloat メソッドを利用することで float 型の情報を送って制御することが出来ます。
そのためには Animator コンポーネントの情報を取得しておく必要がありますので、変数を用意しておくことから始めます。

PlayerController.cs

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

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

public class PlayerController : MonoBehaviour {

    private Rigidbody rb;


////*　新しい変数の宣言を１つ追加　*////


    private Animator anim;


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


    private float horizontal;　　　　// 左右移動のキー入力用

    [SerializeField]
    private float moveSpeed = 3.0f;

    [SerializeField, Header("ジャンプ力")]
    private float jumpPower;

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

    [SerializeField, Header("接地判定")]
    private bool isGround;

    [SerializeField, Header("攻撃力")]
    private int attackPower;


    void Start () {
        // Rigidbody コンポーネントを取得して rb 変数に代入
        TryGetComponent(out rb);


////*　ここから処理を追加　*////


        if (!TryGetComponent(out anim)) {
            Debug.Log("Animator 取得出来ませんでした");
        }


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


    }

    void Update() {

        // 左右のキー入力の受付を行い、情報を取得
        horizontal = Input.GetAxis("Horizontal");


////*　TODO の実装　*////


        // アニメの同期設定
        if (anim) {
            SyncMoveAnimation();
        }


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


	//  Linecastでキャラの足元に地面があるか接地の判定。地面用のゲームオブジェクトがある時は true、ない時は false を返す
	isGround = Physics.Linecast(
			transform.position + transform.up * 1,
			transform.position - transform.up * 0.3f,
			groundLayer);

        // ジャンプ
　　　　Jump();

	// 攻撃
	Attack();
    }

    void FixedUpdate() {

        // 攻撃アニメ再生中は、以下の処理しない
        if (anim.GetCurrentAnimatorStateInfo(0).IsName("Attack")) {
	    return;
        }

        // rb 変数が null ではない(情報が取得できている)なら
        if(rb != null) {

　　　　　　// 移動
            Move();
        }
    }

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

        // 移動方向にスピードを掛けて移動
        rb.velocity = new Vector3(horizontal * moveSpeed, rb.velocity.y, 0);

        // キー入力がない場合
        if (horizontal == 0) {
            // 停止
            rb.velocity = new Vector3(0, rb.velocity.y, 0);
        }
    }

    /// <summary>
    /// ジャンプ
    /// </summary>
    private void Jump() {

        // 地面のゲームオブジェクトに接地していたとき、ジャンプ用のボタンを押したら
	if (Input.GetButtonDown("Jump") && isGround) {

	    // 接地判定をfalse
            isGround = false;

	    // AddForceにて上方向へ力を加える
	    rb.AddForce(Vector3.up * jumpPower);
		
	    //  TODO ジャンプアニメを再生

        }
    }

    /// <summary>
    /// 通常攻撃
    /// </summary>
    private void Attack() {

	if (Input.GetButtonDown("Action")) {
	    //  TODO 攻撃アニメを再生

            Debug.Log("敵に対して " + attackPower + " のダメージを与える")
	}
    }


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


    /// <summary>
    /// 移動アニメの同期
    /// </summary>
    private void SyncMoveAnimation() {

        if (!Mathf.Approximately(horizontal, 0.0f)) {
            lookDirection.Set(horizontal, 0);
            lookDirection.Normalize();

　　　　　　// 向きの制御
            anim.SetFloat("LookX", lookDirection.x);


　　　　　　// TODO ダッシュ有無に応じてアニメの再生速度を調整


　　　　　　// 移動アニメ再生
            anim.SetFloat("Speed", lookDirection.sqrMagnitude);
        } else {

　　　　　　// アニメ停止
            anim.SetFloat("Speed", 0);
        }
    }


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


}

　スクリプトを修正したらセーブを行います。

３．＜TryGetComponent メソッドと out キーワード宣言＞

　Unity2019.2以降に追加されたメソッドです。処理結果として bool 型で戻り値を返してくれます。
このときの処理結果というのは、指定したコンポーネントの型の取得を行い、それが取得できればtrue、取得できなければfalseが戻ります。

　また out キーワードによる宣言があります。
　out キーワード宣言を行うと、out を付けた引数で指定した変数はメソッド内で必ず結果が入ることが保証されるものです。
そのため、処理結果の戻り値が true の場合には必ず、この out の後に宣言した変数内に型が代入されます。

　端的にいうならば、GetComponent メソッドの処理に加えて、その処理の成否判定(コンポーネントが取得出来たか、出来なかったか)を同時に行ってくれるメソッドになります。

＜実装例①＞

  TryGetComponent(out anim);

＜実装例②　戻り値を活用＞

　if (!TryGetComponent(out anim)) {
  　　Debug.Log("Animator 取得出来ませんでした");
  }
}

　今回は実装例①の処理として利用しています。スクリプト内に TryGetComponent メソッドを直接記述した場合、GetComponent メソッドと同様に、
このスクリプトがアタッチしているゲームオブジェクトのコンポーネントから指定されている種類のコンポーネントを取得してます。
それを out キーワード後の anim 変数に代入しています。GetComponent メソッドのように<型引数>を指定していないのは、anime 変数によって型を推論することが可能であるためです。

　out キーワード以降にはゲームオブジェクトから取得したい型と変数を宣言します。今回のように事前に変数の宣言をしている場合には、変数のみを用意しておくことが出来ます。

　もしもこの TryGetComponent メソッドの処理結果が実行可能ならば、つまり、ゲームオブジェクトに Animator コンポーネントがアタッチされているのであれば、
out として用意した anim 変数に Animator コンポーネントの情報が代入されます''。また、true の値が、それとは別に処理結果として戻ります。

　TryGetComponent メソッドの処理結果が false の場合には Animator コンポーネントの取得ができなかったため、anim 変数は null のままで、false が処理結果として戻ります''。

　なお TryGetComponent メソッドには複数の書式があります。こちらは下記のリファレンスを参照してください。

参考

Unity公式スクリプトリファレンス
Component.TryGetComponent
https://docs.unity3d.com/ScriptReference/Component...

４．＜Mathf.Approximately メソッド＞

　bool 型の戻り値を持つメソッドです。
　２つの float 値を比較し、それらが互いに小さな値 (Epsilon) の範囲内にある場合に true で返します。
厳密な値ではなく「大体等しいかどうか」を判断するようなケースで利用できます。

  if (!Mathf.Approximately(horizontal, 0.0f)) {
　　　// 処理
  }

　今回のケースの場合、horizontal の値と 0.0f を比べて、horizontal の値が 0.0 f ではないか、0.0f に近い値でなければ、false になります。
その場合に、if 文内の処理が実行されることになります。つまり、キー入力された値が 0 に近い値でなければ移動していると考えて、if 文内の処理を行うようにしています。
これは float 型のように細かく動く、浮動小数点の値の場合、特定値(0.046303f などの値)を１つとして限定することが難しいためです。
float 型の値を条件式として比較する場合には注意してください。

参考サイト

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

Qiita @Hirai0827 様
全Unity使いはMathfのリファレンスを読め
https://qiita.com/Hirai0827/items/c8bc643c0bcfe5ca...

藍と淡々様
【Unity】知って得するMathfクラス
http://megumisoft.hatenablog.com/entry/2015/08/29/...

５．＜Animator.SetFloat メソッド＞

　Unityのアニメーションは、Animatorクラスによって様々なアニメーションの制御が行えます。

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

　今回はアニメーションの遷移のために、SetFloat メソッドを利用し、遷移の条件をこのメソッドの引数に指定してアニメーションの遷移を行っています。

　各メソッドの引数にはそれぞれ型の指定が異なりますが、いずれも第1引数は string 型です。この部分には、パラメータで設定した文字列を指定します。
文字列ですので大文字小文字は区別されます。パラメータに登録した文字列をこの第1引数に指定することでパラメータのもつ情報を変更することが出来ます。
そして、パラメータの値を変更する内容を第2引数に指定します。

　例えば、SetFloatであれば、第1引数に float 型のパラメータである "LookX" の文字列を指定し、第2引数に float 型の値を指定します。

　// 向きの制御
  anim.SetFloat("LookX", lookDirection.x);

　// 移動アニメ再生
  anim.SetFloat("Speed", lookDirection.sqrMagnitude);

　こうすることで、このパラメータの値をスクリプトから書き換えることができます。その結果として、条件が合致したアニメーションに遷移することが出来ます。

＜パラメータと Set～メソッドの関連性＞

参考サイト

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

６．＜Vector2.Set メソッド＞

　
　指定した Vector2 構造体に対して、引数に指定した x, y の値を代入することができるメソッドです。

  // 向いている方向を更新
  lookDirection.Set(horizontal, 0);

　処理的には下記と同じになります。

  // 向いている方向を更新
  lookDirection = new Vector2(horizontal, 0);

　Set メソッドの方が、新たに new Vector2 を宣言して値を代入するよりも処理が早い処理になります。
また Transform.position の代入にも利用できます。

  transform.position.Set(x, y, z);

参考サイト

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

ゲームの作り方れー＠DKRevel 様
UnityのVector3の使い方【スクリプト解説】
https://dkrevel.com/unity-explain/vector3/

７．＜Vector2.Normalize メソッドを利用した正規化処理＞

　
　正規化処理です。magnitude(マグニチュード。長さ)を１としたベクトル(単位ベクトル)を返します。戻り値は Vector3 型になります。

  // lookDirection 変数に対して正規化処理を行う
  lookDirection.Normalize();

　現在のベクトルの方向を維持したまま、magnitudeが１、あるいは０の単位ベクトルを作成することが出来ます。（ベクトルの値が小さいと０になります。）

　この正規化を行うことによって位置の遠近に関わらず、magnitude がすべて 1、あるいは 0 に統一された単位ベクトルの値となるため、
左と下の方向であれば -1、右と上の方向であれば 1の値がベクトルとして作成されます。値が 0 に近い場合には 0 がベクトルとして作成されます。

　今回の実装ではこの値を BlendTree の各値として利用することにより、''BlendTree の Palameter の設定値とこの正規化された値とがリンクして
移動アニメの切り替え処理が実装''出来ています。

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

TechProjin様
UnityのVector3でよく使うものまとめ
https://tech.pjin.jp/blog/2016/02/16/unity_vector3...

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

　ゲームを実行前に、ヒエラルキーにあるプレイヤー用のゲームオブジェクトを選択し、Animator ビューにしておきます。
Animator コンポーネントがアタッチされているゲームオブジェクトを選択している場合、
ゲームを実行すると、そのアニメの状態に合わせてリアルタイムにアニメの遷移処理を確認することが出来るためです。

　ゲームを実行して挙動を確認します。いままでと同じように移動アニメの制御が行われていれば成功です。

＜実装動画＞

動画ファイルへのリンク

　実装して完成、ではなくて、デバッグを行いながら修正箇所がないかどうかを考えることで、コーディング技術や設計技術を養っていくことが出来ます。

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

　次は　手順１１　－Skybox と Fog の設定－　です。

このページを編集するこのページを元に新規ページを作成

印刷する

コメント（0）

３Ｄグラフィック　２Ｄ横スクロールアクション　手順１０ - i-school 先頭へ

コメントをかく

名前	ユーザIDを使用しないで書き込む	ユーザーIDを使う	ログインする
画像コード	画像に記載されている文字を下のフォームに入力してください。
備考	「http://」を含む投稿は禁止されています。
本文
利用規約をご確認のうえご記入下さい

i-school