複数用意したプレイヤーキャラクターをボタンで変更する - i-school

設計とロジックについて

　キャラ変更用のボタンを画面上に設置し、そのボタンを押すと操作するプレイヤーキャラクター(以下、キャラ)を変更できるようにします。

https://gyazo.com/2cfced95fb0da5a165983070783ccada

　まず現在使用中のキャラの情報を、キャラの通し番号とクラスで保持できるようにしておきます。

　使用中のキャラの番号を用いて、変更先となるキャラの番号を照合し、キャラの変更を行います。
キャラの変更と同時に、使用中のキャラのクラスを上書きして、変更になったキャラと操作できるキャラが異なることを防ぎます。
　
　主な手法としましては、始めからキャラをヒエラルキーに設置しておいてSetActiveメソッドを使ってキャラを切り替える方法と、キャラをインスタンスする方法がありますので
今回はインスタンスする方法で実装を行います。

ボタンを押す　=>　変更先となるキャラを設定する　=>　インスタンスする　=>　変更元のキャラを破棄する　=>　カメラに変更先のキャラを登録する

以上が主な処理の流れになります。　

実装の手順について

　以下の順番で実装を行っていきます。

１．キャラ変更用のボタンを２つ作成する
２．GameDataスクリプトを修正する
３．DataBaseManagerスクリプトを修正する
４．UIManagerスクリプトを修正する
５．MainCameraContollerスクリプトを修正する
６．ChangeCharactersスクリプトを新しく作成する

　新しい技術としては、大きく以下のようなものがあります。

・指定したコルーチンメソッドが終了するまで、その次の処理を行わないように待機させる方法
・ボタンクラスにスクリプトから引数付のコルーチンメソッドを登録する方法（ヒエラルキーから直接ボタンに設定しないようにする方法）
・GameObject型ではなくて自作クラスを用いてプレファブを生成して変数に代入して使用する方法
・ボタンの活性化/非活性化の方法

１．キャラ変更用のボタンを２つ作成する

　以下の画像を参考にして、Canvas内にボタンを２つ作成してください。どちらもキャラ変更に使用するものです。
変更するキャラを番号で管理する処理のため、１つボタンは番号を１つ進める処理、もう１つのボタンは番号を１つ戻す処理を登録して使用します。

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

※　以下の各スクリプトは、特別記載がない限りは今回の部分で使用する内容のみの追加掲載になります。ご自分のスクリプトに適宜追加して利用してください。

　現在使用しているキャラの通し番号と、キャラの情報(クラス)を管理するための変数をそれぞれ用意します。
どちらもpublic修飾子の変数ですが、InitializePlayerメソッドにて、それらに初期設定を行っていますので、インスペクターで指定する必要はありません。

GameData.cs

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

public class GameData : MonoBehaviour
{
    public static GameData instance;
    
    (省略)

    [Header("使用中のキャラの番号")]
    public int currentCharaNumber;            // ☆追加。配列と対応させるため、0から設定対象

    [Header("使用中のキャラ")]
    public PlayerBase currentChara;           // ☆追加。各ゲームのPlayerキャラ用のクラスを適宜指定してください。
                                              // 例えば、PlayerControllerがPlayer用のモデルについているクラスならば、PlayerBaseをそのクラスに変更してください。

    private void Awake()
    {
        if(instance == null)
        {
            instance = this;
            DontDestroyOnLoad(this.gameObject);
        }
        else
        {
            Destroy(this.gameObject);
        }
        // Playerの初期設定
        InitializePlayer();
    }

    /// <summary>
    /// Playerの初期設定
    /// </summary>
    private void InitializePlayer() {
        // 使用するキャラの初期値をセット
        currentCharaNumber = 0;

　　　　// ヒエラルキーにいるキャラを取得して登録（GetComponentするクラスは、currentChara と同じクラスになるように適宜変更してください。）
        currentChara = GameObject.FindGameObjectWithTag("Player").GetComponent<PlayerBase>();

         (省略)
    }
}

３．DataBaseManagerスクリプトを修正する

　ゲームで操作できるキャラのプレファブを配列に用意しておきます。
この配列の要素数の番号と、GameDataで用意した通し番号の変数とを紐づけて、操作できるキャラをインスタンスします。

DataBaseManager.cs

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using System;
using System.Runtime.InteropServices.WindowsRuntime;

public class DataBaseManager : MonoBehaviour
{
    public static DataBaseManager instance;
  
    [Header("登場するキャラを登録")]
    public PlayerBase[] charas;             // ☆　追加。PlayerBaseについては、GameDataと同じで使用しているPlayer用のクラスに適宜変更してください

    (省略)

　修正が完了したら、DataBaseManagerゲームオブジェクトのインスペクターを確認します。
追加した配列のCharas変数が表示されていますので、こちらのSizeを 0 から、ゲーム中に登場させるキャラの数に変更します。
その後、それぞれの値に各キャラのプレファブをPrefabsフォルダからドラッグアンドドロップしてアサインします。

４．UIManagerスクリプトを修正する

　UIManagerでは、キャラ変更ボタンの管理を行います。ボタンを押した際に、最後に作成するChangeCharactersクラスのメソッドを呼び出して
キャラ変更へとつなげる役割を持っています。

　キャラ変更用の２つのボタンについては、いずれかを選択した時点で、キャラ変更が終了するまでの間、両方のボタンを押せないように制御を入れています。

「キャラ変更が終了するまで」という状態は、bool型などの変数を用意して管理することもできますが、今回はOnClickChangeCharaメソッドをコルーチン化し、
キャラ変更を行う処理(ChangeCharactersクラスのChangeCharaメソッド)の呼び出しを yield return 付のStartCoroutine処理にすることによって、この処理が終了するまで
下の処理にはいかないように制御しています。

またボタンによって呼び出されるOnClickChangeCharaメソッドはコルーチンメソッドであるため、Startメソッド内で、それぞれのボタンにメソッドと引数を登録しています。
(UnityEditorのButtonコンポーネントにあるOnClickイベントは使わずに、スクリプトから呼び出すメソッドを設定します)

UIManager.cs

using System.Collections;
using System.Collections.Generic;
using UnityEditorInternal;
using UnityEngine;
using UnityEngine.UI;

public class UIManager : MonoBehaviour
{
     (省略)

    public Button btnChnageCharaPrev;          　// ☆　追加。キャラ変更の戻る用ボタン
    public Button btnChangeCharaNext;          　// ☆　追加。キャラ変更の進む用ボタン

    public ChangeCharacters changeCharacters;  　// ☆　追加。キャラ変更用のクラス

    private bool isClickable;                    // ☆　追加。ボタンの重複クリック防止用 

    void Start() {
        playerHpbar.value = 1.0f;

///* 以下を追加 *///

        // キャラ変更ボタンにメソッドを登録
        btnChnageCharaPrev.onClick.AddListener(()=> StartCoroutine(OnClickPlayerChange(-1)));
        btnChangeCharaNext.onClick.AddListener(()=> StartCoroutine(OnClickPlayerChange(1)));
        
        // キャラ変更ボタンを押せるようにする
        InactivateCharaChangeButtons(true);

///* ここまで追加 *///

    }

    (省略)

///* 以下を追加 *///

    /// <summary>
    /// キャラ変更ボタンを押した際の処理(引数の値は違うが、どちらのボタンもここの処理になる)
    /// </summary>
    /// <param name="amount">キャラの番号を進めたり、戻したりする</param>
    /// <returns></returns>
    private IEnumerator OnClickPlayerChange(int amount) {
        // キャラ変更中の場合には処理を行わない
        if (!isClickable) {
            yield break;
        }

        // キャラを変更するため、キャラ変更のボタンを押しても処理を行えなくする
        InactivateCharaChangeButtons(false);

        // ChangeCharactersクラスに用意したキャラ変更処理を呼び出す(yield return 付の StartCoroutine処理は、このChangeCharaメソッドの処理が終わるまで、下の処理にはいかないことを補償する)
        yield return StartCoroutine(changeCharacters.ChangeChara(amount));        

        // 再度ボタンを押したときに、キャラ変更処理ができるようにする
        InactivateCharaChangeButtons(true);
    }

    /// <summary>
    /// ボタンの連打防止処理
    /// </summary>
    /// <param name="isSwitch"></param>
    private void InactivateCharaChangeButtons(bool isSwitch) {
        // ボタンを押せるか、押せないか制御
        isClickable = isSwitch;

        // ボタンの表示の活性化/非活性化
        btnChnageCharaPrev.interactable = isSwitch;
        btnChangeCharaNext.interactable = isSwitch;
    }

///* ここまで追加 *///

}

　修正が完了したら、UIManagerゲームオブジェクトのインスペクターを確認します。
新しく変数が３つ追加されていますので、Btn～の方には、【１】で用意した各ボタンをヒエラルキーからドラッグアンドドロップしてアサインします。(同じ名前になるようにアサインしましょう)

　もう１つのChangeCharactersの方はまだ作成していませんので、こちらは作成してからアサインしてください。

＜補足＞

　InactivateCharaChangeButtonメソッドのように、複数回呼び出される可能性のある処理は、このようにメソッド単位でまとめて制御するようにします。
bool型の引数を用意することで、設定の切り替えを動的に行えるようにしています。isSwitch = trueならば、各ボタンのinteractableもtrueになる、というようにです。

　このような制御を行うことで、true/falseのために、２つのメソッドを作る必要がなくなります。

　今後も、スクリプト内の処理をすべて書いてからでもよいので、重複している処理はないか、あるのであれば、それはメソッドに処理をまとめて管理した方が利便性が高くないか、
という観点でコードを確認してみてください。そのようにコードを読み直すことで、さらに書き直すことができればスキルが上達します。

５．MainCameraContollerスクリプトを修正する

　StartメソッドでのPlayerの検索方法をTagに変更しています。
キャラが変更されるということは、カメラの追従対象を変更しなければなりません。
そのため、SetUpCharaメソッドを用意し、キャラの変更に合わせてカメラの追従対象のキャラも変更を行うようにします。

　カメラの追従処理はUpdateメソッドにおいて行われています。そのため、一時的であってもキャラがいない状態が出来てしまう(chara変数にPlayer情報がなくなる)と
追従対象がなくなるため、エラーが発生してゲームが停止します。これを、Chara変数にPlayerが取得出来るときだけUpdate内の追従処理を行うことで回避しています。

MainCameraController.cs

using UnityEngine;

public class MainCameraController : MonoBehaviour
{
    private GameObject chara;

    private Vector3 offset;

    void Start()
    {
        chara = GameObject.FindGameObjectWithTag("Player");
        offset = transform.position - chara.transform.position;
    }

    void Update()
    {
        if (chara != null) {    // ☆　if文による条件を追加します。キャラがいなくなった場合に処理が動いてしまうとエラーになってしまうためです。
            this.transform.position = chara.transform.position + offset;
        }
    }

///* 以下を追加 *///

    /// <summary>
    /// キャラの情報をセットする
    /// </summary>
    /// <param name="gameObject"></param>
    public void SetUpChara(GameObject gameObject) {
        chara = gameObject;
    }

///* ここまで追加 *///

}

６．ChangeCharactersスクリプトを新しく作成する

　このスクリプトは新しく作成します。各キャラ変更のボタンから呼び出されるメソッドです。
処理の詳細はコメントを確認してください。

ChangeCharacters.cs

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

public class ChangeCharacters : MonoBehaviour
{
    public MainCameraController mainCameraController;

    public float waitTime;

    /// <summary>
    /// キャラ変更
    /// </summary>
    /// <param name="amount"></param>
    /// <returns></returns>
    public IEnumerator ChangeChara(int amount) {
        // 選択中のキャラの番号を増減する
        GameData.instance.currentCharaNumber += amount;

        // キャラ変更できる最大値と最小値を確認
        if (GameData.instance.currentCharaNumber >= DataBaseManager.instance.charas.Length) {
            // 最大値を超えたら0にする
            GameData.instance.currentCharaNumber = 0;
        } else if (GameData.instance.currentCharaNumber < 0) {
            // 最小値を下回ったら最大値にする
            GameData.instance.currentCharaNumber = DataBaseManager.instance.charas.Length - 1;
        }

        // 前のキャラの情報を保存
        PlayerBase oldChara = GameData.instance.currentChara;

        // 新しいキャラの生成位置を前のキャラの位置に設定する
        Transform charaTran = oldChara.transform;

        // 新しいキャラを生成して、現在選択中のキャラ情報を新しくキャラに上書き登録
        GameData.instance.currentChara = Instantiate(DataBaseManager.instance.charas[GameData.instance.currentCharaNumber], charaTran.position, Quaternion.identity);

        // 前のキャラを破棄
        Destroy(oldChara.gameObject);

        // カメラに新しいキャラを設定
        mainCameraController.SetUpChara(GameData.instance.currentChara.gameObject);

        yield return new WaitForSeconds(waitTime);
    }
}

　作成した後はヒエラルキーに Create Empty で新しいゲームオブジェクトを作成し、名前を ChangeCharacters に変更して
作成した ChangeCharacters のスクリプトをアタッチします。その後、まずはUIManagerゲームオブジェクトのインスペクターを確認し、ChangeCharacters変数にアサインします。

　続いて、ChangeCharacters ゲームオブジェクトのインスペクターを確認してください。アサイン情報が２つ表示されます。

　１つはMainCameraControllerです。こちらは MainCamera ゲームオブジェクトにアタッチされていると思いますので、それをドラッグアンドドロップしてアサインします。

　もう１つはキャラ変更ボタンを押した後の待機時間の設定です。どちらかのキャラ変更ボタンを押した場合、ここで設定した時間だけ両方のボタンが押せなくなります。
値は適宜調整してください。

　ゲームを実行して、それぞれのキャラ変更ボタンを押してみてください。キャラが切り替わり、カメラも追従するようになっていれば完成です。