２Ｄタイルマップ　発展５

　プレイヤーの後ろを追従するパーティメンバーを用意し、プレイヤーの進行方向に合わせて追従させる機能を実装します。
追従するメンバーについても、進行方向に応じたアニメの同期も行います。

＜実装動画＞

　以下の内容で順番に実装を進めていきます。

発展５　ープレイヤーの進行方向に合わせて追従するパーティメンバーの機能ー

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

　・Tween.Kill メソッド

１．設計

　２Ｄゲームにおけるパーティメンバーの表現については、キャラクターが１名の時もあれば、
複数名のキャラがリーダーを追従している表現が用いられるケースがあります。

　今回は複数のパーティメンバーを用意し、リーダー役のキャラクターの移動に合わせて、
常に進行方向の後方に位置するように制御を行います。また、向いている方向のアニメの同期も行います。

　最初に提示している動画のような状態を目標に実装にチャレンジしましょう。

　このて順ではプレイヤーの移動処理は実装しません。事前に別途実装しておく必要があります。

　必要なオブジェクトとしては、パーティメンバー用のゲームオブジェクトを複数用意します。
あるいは、すでにあるゲームオブジェクトをそのまま利用します。

　この教材ではすでにあるリーダー役のゲームオブジェクトをそのまま利用してますが、変えておいた方がパーティメンバーとしての臨場感が増すでしょう。

　必要なスクリプトとしては、パーティメンバーの管理を行うためのマネージャー役のスクリプトを用意します。
それ以外はいままでのスクリプトを流用し、改良して対応します。

　ただし、説明上、必要になるスクリプトはすべて紹介します。
処理の内容を見直して、必要なもの以外は作成しなくても問題ありません。

２．プレイヤーのゲームオブジェクト(リーダー役)の子オブジェクトとして、パーティメンバー用のゲームオブジェクトを作成する

　任意の画像を使って、パーティメンバーとなるゲームオブジェクトを作成してください。
名前は任意ですが、PartyMember や PartyChara のように、わかりやすいものし、最後に通し番号を付けて、何人目であるかを明確に出来るようにしておいてください。

　後程、スクリプトをアタッチしてから複製しますので、今は１つだけ作成しておいてください。

　位置については、プレイヤーのゲームオブジェクトからみて、後方になるように配置してください。

ヒエラルキー画像

インスペクター画像

Sceneビュー画像

３．enum の PlayerDirection を作成する

　プレイヤーの向いている方向を示すための enum を作成します。
ここでは１つのファイルとして作成していますが、他のスクリプトに一緒に書いても問題ありません。

　すでに作成済の場合には、この手順は不要です。

PlayerDirection.cs

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

public enum PlayerDirection 
{
    Front,
    Back,
    Right,
    Left
}

　この情報を利用して、リーダー役のゲームオブジェクトの進行方向の情報をパーティメンバーにも参照させます。

４．PlayerAnimation スクリプトを作成する

　パーティメンバーのアニメの同期用のコントローラー・スクリプトを作成します。
ここでは MonoBehaviour を継承した状態で作成しています。

　すでに作成済の場合には、この手順は不要です。

PlayerAnimation.cs

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

using UnityEngine;

[RequireComponent(typeof(Animator))]
public class PlayerAnimation : MonoBehaviour
{
    private Animator anim;


    /// <summary>
    /// 初期設定の処理を実行する
    /// </summary>
    public void SetUpPlayer() {
        TryGetComponent(out anim);
    }

    /// <summary>
    /// キャラの向いている方向と移動アニメの同期
    /// </summary>
    public Vector2 SyncMoveAnimation(Vector2 moveDirection) {
        
        // 向いている方向を更新
        Vector2 lookDirection = moveDirection;

        lookDirection.Set(moveDirection.x, moveDirection.y);

        // 正規化
        lookDirection.Normalize();

        // キー入力の値と Blend Tree で設定した移動アニメ用の値を確認し、移動アニメを再生
        anim.SetFloat("Look X", lookDirection.x);
        anim.SetFloat("Look Y", lookDirection.y);

        return lookDirection;
    }
   
    /// <summary>
    /// 移動アニメーションの停止
    /// </summary>
    public void SyncStopAnimation() {
        // 停止アニメーション用
        anim.SetFloat("Speed", 0);
    }
}

５．パーティメンバーのゲームオブジェクトに PlayerAnimation スクリプトをアタッチし、複製する

　先ほどリーダー役のゲームオブジェクトの子オブジェクトとして作成したパーティメンバーのゲームオブジェクトに
PlayerAnimation スクリプトをアタッチします。

　アタッチされていることをインスペクターで確認してから、複製して、メンバーを増やします。
何名でも構いませんが、合計２～４名位にしておくとよいでしょう。

　この教材ではメンバーは２名で進めていきます。

ヒエラルキー画像

Sceneビュー画像

インスペクター画像

６．PartyMember スクリプトを作成する

　パーティメンバーを管理し、リーダー役のゲームオブジェクトから取得した進行方向の情報を利用して、各メンバーに命令を出すためのマネージャー用のスクリプトです。
このスクリプトはどのゲームオブジェクトにアタッチしても問題ありませんが、管理のしやすさから、今回はプレイヤー役のゲームオブジェクトにアタッチします。

PartyMember.cs

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

using System.Collections.Generic;
using UnityEngine;
using DG.Tweening;

public class PartyMember : MonoBehaviour
{
    private PlayerAnimation[] partyMemberAnims;

    private PlayerDirection prevPlayerDirection;
    private List<Tween> tweenList = new();


    /// <summary>
    /// 初期設定
    /// </summary>
    /// <param name="startPlayerDirection"></param>
    public void SetUp(PlayerDirection startPlayerDirection) {

        // 初期の向いている方向の設定
        prevPlayerDirection = startPlayerDirection;
        
        // パーティメンバー分の配列の初期化
        partyMemberAnims = new PlayerAnimation[transform.childCount];
        
        // パーティメンバーがいるかどうか確認
        if (partyMemberAnims.Length == 0) {
            Debug.Log("PartyMember が誰も登録されていません。");
            return;
        }
        
        // パーティメンバーのアニメの同期処理の初期設定
        for(int i = 0; i < partyMemberAnims.Length; i++){
            partyMemberAnims[i] = transform.GetChild(i).GetComponent<PlayerAnimation>();

            if (partyMemberAnims[i] != null)
            {
                partyMemberAnims[i].SetUpPlayer();
            }
        }
    }

    /// <summary>
    /// パーティ内のメンバーの配置変更
    /// </summary>
    /// <param name="nextPlayerDirection"></param>
    public void ChangePartyMembersPosition(PlayerDirection nextPlayerDirection) {
        
        // 前と同じ方向に移動している場合には、処理しない
        if (prevPlayerDirection == nextPlayerDirection) {
            return;
        }

        // 前の移動処理が残っている場合
        if (tweenList.Count > 0) {
            foreach (var tween in tweenList) {
                // 停止する
                tween.Kill();
            }
            tweenList.Clear();
        }

        // メンバーの数だけ、配置変更
        for (int i = 0; i < partyMemberAnims.Length; i++) {

            // i をそのまま利用すると非同期処理内の配列の要素番号の指定がずれてしまい、処理が成功しないため変数を用意する
            int index = i;

　　　　　　// 次の進行方向の情報を PlayerDirection から Vector2 に変換
            Vector2 newPos = GetMemberDirection(nextPlayerDirection);

　　　　　　// DOTween の処理を Sequence を利用して処理するため初期化 
            Sequence sequence = DOTween.Sequence();
            
            // 最初に先頭のキャラの位置に移動する。この処理を List に追加
            tweenList.Add(sequence.Append(partyMemberAnims[index].transform.DOLocalMove(Vector3.zero, 0.25f)
                .SetEase(Ease.Linear)));
            
            // その後で新しい位置に移動する。この処理を List に追加
            tweenList.Add(sequence.Join(partyMemberAnims[index].transform.DOLocalMove(newPos * (index + 1), 0.25f)
                .SetEase(Ease.Linear))
                // 移動後、移動方向とアニメの同期をおこなう
                                .OnComplete(() => 
                {
                    partyMemberAnims[index].SyncMoveAnimation(-newPos);
                    tweenList.Clear();
                }));
        }

　　　　// 進行方向の情報を更新
        prevPlayerDirection = nextPlayerDirection;
    }

    /// <summary>
    /// メンバーの新しい向きの取得
    /// </summary>
    /// <param name="facePlayer"></param>
    /// <returns></returns>
    private Vector2 GetMemberDirection(FacePlayer facePlayer) {
        return facePlayer switch {
          FacePlayer.Back => Vector2.down,
          FacePlayer.Front => Vector2.up,
          FacePlayer.Left => Vector2.right,
          FacePlayer.Right => Vector2.left,
          _ => Vector2.zero
        };
    }
}

７．＜Tween.Kill メソッド＞

　DOTweenの処理を強制的に終了するには、Kill メソッドを実行します。
この処理を実行することで、今回であれば Sequence によって組み立てられた移動処理を終了させることが出来ます。

　ただし、変数にDOTweenの処理を代入していない場合、動いている DOTween の処理を一時停止したり、再開したり、強制的に終了させる処理が実行できません。

　この事態に対応するため、Tween 型の変数を宣言することで、DOTweenの処理内容を変数に代入することが出来ます。
また List で用意することで、複数の Tween 型をまとめて管理することが出来ます。

　Tween 型の変数に DOTween の処理を代入していることで、DOTweenの処理を一時停止させたり、再開したり、強制的に終了させることが出来るようになります。

　どのような場面で使用するかというと、無限ループの処理を終了させたり、処理を一時停止して、途中から再開したりできます。

　今回の場合は、移動の処理に DOTween を利用しています。
仮に移動処理中に次の移動の処理命令が来てしまった場合、DOLocalMove メソッドが重複してしまい、正常な移動処理ができなくなる恐れがあります。

　この状態を未然に防ぐためには、移動処理が残っている場合には前の処理を停止させて、新しい移動の命令のみを実行するように制御する必要があります。
そのためには、Tween 型の変数に移動の処理を代入しておく必要があるため、今回は Tween 型の List を用意して利用しています。

＜この DOTween の処理を Tween 型の List に代入しておく＞

// DOTween の処理を Sequence を利用して処理するため初期化 
Sequence sequence = DOTween.Sequence();
            
// 最初に先頭のキャラの位置に移動する。この処理を List に追加
tweenList.Add(sequence.Append(partyMemberAnims[index].transform.DOLocalMove(Vector3.zero, 0.25f)
    .SetEase(Ease.Linear)));
            
// その後で新しい位置に移動する。この処理を List に追加
tweenList.Add(sequence.Join(partyMemberAnims[index].transform.DOLocalMove(newPos * (index + 1), 0.25f)
    .SetEase(Ease.Linear))
    // 移動後、移動方向とアニメの同期をおこなう
    .OnComplete(() => 
    {
        partyMemberAnims[index].SyncMoveAnimation(-newPos);
        tweenList.Clear();
    }));

＜そうすることで、実行中の DOTween の処理を停止できる＞

// 前の移動処理が残っている場合
if (tweenList.Count > 0) {
　　foreach (var tween in tweenList) {
    　　// 停止する
        tween.Kill();
    }
    tweenList.Clear();
}

　DOTween は大変便利な機能ですが、非同期処理であるため、一度動き出してしまった処理は実行中には制御できない、ということを覚えておきましょう。
それを制御するためには、実行命令のタイミングで Tween 型の変数に代入しておくことで対応出来ます。こちらも合わせて覚えておきましょう。

８．リーダー役のゲームオブジェクトに PartyMember スクリプトをアタッチする

　リーダー役のゲームオブジェクトに PartyMember スクリプトをアタッチします。

　アサイン情報などはありませんので、正常にアタッチされているかを確認しておきましょう。
　

インスペクター画像

９．PlayerManager スクリプトを作成する

　リーダー役のゲームオブジェクトの制御を行うためのマネージャー用のスクリプトを作成します。
今回は必要な機能のみ、抜粋して掲載します。そのため、リーダー役のゲームオブジェクトの移動処理の記述はありません。

　このスクリプトも作成済の場合には、この手順はスキップしてください。

PlayerManager.cs

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

using System.Collections;
using System.Threading;
using UnityEngine;

[RequireComponent(typeof(PlayerAnimation))]
public class PlayerManager : MonoBehaviour
{
    private PlayerAnimation playerAnimation;
    
    private float horizontal;                    // x 軸(水平・横)方向の入力の値の代入用
    private float vertical;                      // y 軸(垂直・縦)方向の入力の値の代入用
    
    private Vector2 lookDirection = new (0, -1.0f);   // キャラの向きの情報の設定用
    
    private PartyMember partyMember;
    

    void Start() {

        TryGetComponent(out playerAnimation);

        if (TryGetComponent(out partyMember)) {
　　　　　　PlayerDirection startPlayerDirection = GetPlayerDirectionFromVector(lookDirection);
            partyMember.SetUp(startPlayerDirection);
        }
        else {
            Debug.Log("PartyMember 取得出来ません。");
        }
    }

    void Update() {
        
        // 移動用のキー入力
        {
            // InputManager の Horizontal に登録してあるキーが入力されたら、水平(横)方向の入力値として代入
            horizontal = Input.GetAxis("Horizontal");

            // InputManager の Vertical に登録してあるキーが入力されたら、水平(横)方向の入力値として代入
            vertical = Input.GetAxis("Vertical");
        }
        
        // いずれかのキー入力があるか確認
        if (!Mathf.Approximately(horizontal, 0.0f) || !Mathf.Approximately(vertical, 0.0f)) {

            // キャラの向いている方向と移動アニメの同期
            lookDirection = playerAnimation.SyncMoveAnimation(new Vector2(horizontal, vertical));
            
            PlayerDirection nextPlayerDirection = GetPlayerDirectionFromVector(lookDirection);
            
            // パーティキャラの位置と移動アニメの同期
            partyMember?.ChangePartyMembersPosition(nextPlayerDirection);
        }
    }

    /// <summary>
    /// 新しい向きの取得
    /// </summary>
    /// <param name="facePlayer"></param>
    /// <returns></returns>
　　public PlayerDirection GetPlayerDirectionFromVector(Vector2 lookDirection) 
　　{
    　　return lookDirection switch 
    　　{
        　　Vector2 up when up.y > 0 => PlayerDirection.Back,
        　　Vector2 down when down.y < 0 => PlayerDirection.Front,
        　　Vector2 right when right.x > 0 => PlayerDirection.Right,
        　　Vector2 left when left.x < 0 => PlayerDirection.Left,
        　　_ => PlayerDirection.Front,
    　　};
　　}
}

１０．リーダー役のゲームオブジェクトに PlayerManager スクリプトをアタッチする

　リーダー役のゲームオブジェクトに PlayerManager スクリプトをアタッチします。

　アサイン情報などはありませんので、正常にアタッチされているかを確認しておきましょう。
　

インスペクター画像

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

　スクリプトが多く、外部クラスのメソッドの呼び出し命令もありますので、デバッグを行う際には、しっかりとソースコードの処理を読み解いていからゲームを実行してください。
自分でソースコードにコメントを書いてみて、上手く言語化ができない部分については、復習を行うようにしましょう。

＜実装動画＞

動画ファイルへのリンク

　以上で完成です。

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

印刷する

コメント（0）

２Ｄタイルマップ　発展５ - i-school 先頭へ

コメントをかく

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

i-school