スクリプタブル・オブジェクトを利用したキャラデータの管理と実装例①

設計

　
　プレファブに用意したプレイヤー用のキャラのゲームオブジェクトは、攻撃力やHPなどのデータを保持しています。
もしも外見が同じキャラであってもこれらの値が変化するような場合、また新しくプレファブを用意するのでは大変です。

　この手順では、キャラのデータをデータベース化して用意し、それを、現在選択しているキャラに応じて攻撃力などのデータを動的にゲーム内に反映できる機能を追加します。
またこの機能を敵側にも利用して、敵のデータもプレファブから設定するのではなく、データベースを参照して変更するようにします。

　データベースにはスクリプタブル・オブジェクトを利用します。

実装の手順

　設計に基づき、以下の手順で実装を行います。

＜今回＞

　１．MonoBehaviour クラスを継承しない、CharaType スクリプトを作成する
　２．CharaDataList スクリプタブル・オブジェクトを作成する
　３．GameData スクリプトを修正する

＜次の手順＞

　４．Enemy スクリプトを修正して、CharaDataList に登録されているキャラのデータをゲーム内に反映する処理を追加する
　５．GameManager スクリプトを修正して、CharaDataList に登録されているキャラのデータをゲーム内に反映する処理を追加する
　６．PlayerController スクリプトを修正して、CharaDataList に登録されているキャラのデータをゲーム内に反映する処理を追加する
　７．ゲームを実行して動作を確認する

新しく学習する内容

　新しく学習する内容です。

　・MonoBehaviour クラスを継承しないenumの作り方
　・List.Findメソッド

１．MonoBehaviour クラスを継承しない、CharaType スクリプトを作成する

　ゲーム内に登場するキャラの分類を列挙子として登録します。
ここでは仮に以下のような内容で作成していますが、最初にプレイアブルキャラの種類、次に敵の種類を登録します。
自分のゲーム内容に合わせた名前を登録してください。

CharaType.cs

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

public enum CharaType {
    Player_A,
    Player_B,
    Player_C,
    Enemy_A,
    Enemy_B,
    Enemy_C
}

　このスクリプト・ファイルは MonoBehaviour クラスを継承していませんのでゲームオブジェクトにアタッチすることはできませんが
「CharaType.列挙子」と書くことによって、他のクラスから自由に参照することが出来ます。(CharaType.Player_A、CharaType.Enemy_C、というように)

２．CharaDataList スクリプトを作成し、スクリプタブル・オブジェクトを作成する

１．設計

　ゲーム内で利用するキャラの情報を１つのクラス CharaData にまとめて宣言します。
またそれをListにして管理を行えるようにします。

２．CharaDataList スクリプトを作成する

　ネスト(入れ子)になっている CharaData クラスがキャラのデータを扱います。
プレイヤー側と敵側で同じ内容に統一しておくことで、１つの CharaData クラスで両方の情報を登録できます。

　１つの CharaData に１つ分のキャラの情報を代入します。つまり、プレイアブルキャラの情報を２つ用意したい場合には
CharaData クラスが２つ用意する必要があります。それをListである charaDatas 変数が管理している設計です。

CharaDataList.cs

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

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

[CreateAssetMenu(fileName = "CharaDataList", menuName = "Create CharaDataList")]
public class CharaDataList : ScriptableObject
{
    public List<CharaData> charaDatas = new List<CharaData>();

    [Serializable]
    public class CharaData {　　　　　// キャラのデータ。必要な値を追加する
        public int no;
        public int hp;
        public float moveSpeed;
        public float jumpPower;
        public int attackPower;
        public CharaType charaType;
    }
}

３．CharaDataList スクリプトを元にスクリプタブル・オブジェクトを作成する

　CharaDataList スクリプトを元にスクリプタブル・オブジェクトを作成します。

　Unityの左上のメニューから Assets => Create => Create CharaData を選択してください。
新しくスクリプタブル・オブジェクトが作成されます。名前はそのままで問題ありません。

＜手順動画＞
https://gyazo.com/0a3beaf71c33136886deca1d28389c6b

フォルダ画像

４．スクリプタブル・オブジェクトの設定を行う

　CharaDataList スクリプタブル・オブジェクトの設定を行います。
CharaDataList スクリプタブル・オブジェクトを選択するとインスペクターで設定を行えます。

CharaDataList スクリプタブル・オブジェクト　インスペクター画像

　Listになっていますので、Size を 0 => 3 に変更し、３つ程、キャラのデータを登録してみてください。
また CharaType については Enum ですので、プルダウンメニューより登録されている列挙子から選択するようになります。

Size を変更した際のインスペクター画像

CharaData をいれた際のインスペクター画像(自分のデータに合わせて設定してください)

　以上で設定は完了です。

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

１．設計

　ゲーム内でプレイヤーが使用するキャラを選択した際に、GameDataに新しく用意した currentCharaNo 変数に登録を行うようにします。
こうすることで、選択シーンにおいて選択したキャラの情報を、ゲームのバトルシーンに遷移した際にも参照して利用することが可能になります。

　この情報を元にしてスクリプタブル・オブジェクト(データベース)から必要なキャラの情報を取得して利用するようにします。
例えば、プレイヤーがキャラ２を選択した場合には、currentCharaNo 変数には 1 を登録します。その値とデータベースの CharaData の持つ no 変数とを照合し、
合致した no 変数を持つ CharaData をキャラの情報としてゲーム内で利用するように反映処理を行います。

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

　新しく変数を４つ宣言します。内容については各変数のコメントを参照してください。
またメソッドを３つ追加して、データベースを扱うために必要な処理を追加しています。

　SetUpPlayableCharaData メソッドを実行することで、playableCharaData 変数に今回のバトルで利用する CharaData を取得して代入します。
取得する際には GetCharaData メソッドが実行されて、その戻り値を利用しています。

　SetUpCurrentCharaNo メソッドを実行することで、currentCharaNo 変数に、今回のバトルで使用するキャラの番号を登録します。
現在はまだ未使用ですが、このメソッドをキャラ選択時に呼び出すことによって、GameDataにキャラの番号を登録できます。
この処理を行わないと、データベースに登録してある CharaData の番号と照合が出来ないため、ゲーム内にデータベースの反映が行えません。

　そのため今回は、ゲーム開始前に currentCharaNo 変数の値を直接インスペクターで操作を行って、データベースが反映されるかをチェックしておきます。

GameData.cs

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

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

public class GameData : MonoBehaviour
{
    public static GameData instance;

    public int currentStageNo;

    public int battleTime;


////* ここから追加 *////
    
    [Header("使用するキャラの番号")]    
    public int currentCharaNo;                               // 選択したキャラの番号を登録する。デバッグ時には、ゲーム開始前にここに値を登録して確認する

    [Header("キャラデータのデータベース")]
    public CharaDataList charaDataList;                      // CharaDataList スクリプタブル・オブジェクトをドラッグアンドドロップしてアサインする

    [Header("現在使用中のキャラのキャラデータ")]
    public CharaDataList.CharaData playableCharaData;        // 選択したキャラの番号と同じ CharaData の内容を代入。CharaData クラスは CharaDataList クラスの子クラスなので、親クラス.子クラス の書式で型を定義する

    [Header("プレイヤーとして使用可能なキャラ数")]
    public int usePlayableCharaCount;                        // プレイヤーが操作できるキャラのデータの総数をここに登録する

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


    void Awake() {
        if (instance == null) {
            instance = this;
            DontDestroyOnLoad(gameObject);
        } else {
            Destroy(gameObject);
        }
    }


////* ここからメソッドを３つ追加 *////

    /// <summary>
    /// 使用キャラの情報(CharaData)を設定
    /// </summary>
    /// <param name="charaNo"></param>
    public void SetUpPlayableCharaData(int charaNo) {
        playableCharaData = GetCharaData(charaNo);
    }

    /// <summary>
    /// CharaDetaの取得
    /// </summary>
    /// <param name="charaNo"></param>
    /// <returns></returns>
    public CharaDataList.CharaData GetCharaData(int charaNo) {
        return charaDataList.charaDatas.Find(x => x.no == charaNo);
    }

    /// <summary>
    /// 使用するキャラの番号を設定(未使用。このメソッドを呼び出すことでバトルに使用するキャラの番号の登録を行う)
    /// </summary>
    /// <param name="charaNo"></param>
    public void SetUpCurrentCharaNo(int charaNo) {
        currentCharaNo = charaNo;
    }

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

}

３．＜List.Findメソッド＞

　Listには Find というメソッドがあります。
List 内の要素を先頭から検索して、指定した条件に合致した最初の要素１つを取り出して戻り値として返してくれる処理です。
これは foreach 文で記述する内容と同じ処理を１行で処理できます。

  charaDataList.charaDatas.Find(x => x.no == charaNo);

  foreach (CharaDataList.CharaData charaData in charaDataList.charaDatas) {
      if(charaData.no == charaNo) {
          return charaData;
      }
  }

　この２つの処理は同じ内容になります。
最初に合致した値が対象になりますので、まとめて複数取得したい場合や、合致する条件を満たす要素が複数ある場合には、この処理だけでは実装できません。

参考サイト

Samurai Blog様
【C#入門】Listの要素を検索するFindの使い方(FindAll/FindIndex)
https://www.sejuku.net/blog/45252

４．GameData ゲームオブジェクトの設定を行う

　スクリプトを修正したので、GameData ゲームオブジェクトを選択して、インスペクターから設定を行います。

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

　playableCharaData 変数はゲームの実行時に代入される情報になりますので、他の３つの情報についてアサインを行います。

　currentCharaNo 変数には、プレイアブルキャラの番号を登録します。デバッグを行いますので、最初は 0 のままで構いません。

　charaDataList 変数には CharaDataList スクリプタブル・オブジェクトをドラッグアンドドロップしてアサインします。

　usePlayableCharaCount 変数には、プレイアブルキャラの総数を登録します。
今回はスクリプタブル・オブジェクトに２つ分のプレイヤブルキャラの情報を登録したので 2 を設定します。

　
＜手順動画　スクリプタブル・オブジェクトのアサイン＞
https://gyazo.com/718a6a05cddadbc7766b99c44ba16dac

GameData ゲームオブジェクト　アサイン後　インスペクター画像

５．スクリプタブル・オブジェクトの読み解き方

　CharaData クラスをListで管理していますので、CharaData クラスの情報に対してアクセスしたい場合には、
スクリプタブル・オブジェクトの代入されている変数の指定後に、そのスクリプタブル・オブジェクトの管理しているListの変数を指定し、それから個別のCharaData の指定を行う書式になります。

charaDataList.charaDatas[参照したいCharaDataの要素番号].CharaData クラスの持つ変数

　また、CharaData クラスは CharaDataList クラスの子クラスですので、単体では型として書けません。
必ず親クラスである CharaDataList を付けて書く必要があります。

宣言する場合

CharaDataList.CharaData chara

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

　次は　です。

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

印刷する

コメント（0）

スクリプタブル・オブジェクトを利用したキャラデータの管理と実装例① - i-school 先頭へ

コメントをかく

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

i-school