キャラ選択機能の実装②

　前回に引き続きまして、キャラ選択機能の実装を行います。

　新しい処理が多くある場合、その都度調べて、理解を深めてから進めてください。
教材の通りに実装できることと、実際に自分で考えて最初から作れるようになることとでは、まったく異なります。
その場合、理解度の差が大きく出ますので、しっかりと復習を行うようにしましょう。

　以下は完成時のサンプル動画です。こちらを目標にして制作しましょう。

＜完成動画＞

CharacterBase スクリプトの作成

　キャラの制御を行うクラスの基底クラスです。
いわゆる CharacterController クラスのような位置付けのクラスです。

　今回はここにはフォーカスしていませんので、クラスを制作するのみに留めています。
実際には自分のプロジェクトに合わせてカスタマイズして実装してください。

CharacterBase.cs

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

using UnityEngine;

public class CharacterBase : MonoBehaviour
{
    // TODO キャラのデータ設定、キャラの基本動作制御など
    
}

クラスの考え方　ー複数のデータを関連して管理する方法ー

　例えば、プレイヤーの情報やアイテムの情報などデータを扱う場合に、複数のデータを１つのまとまりとして管理できる方法があると扱いが楽になります。

　以下のように、野球選手やサッカー選手１名分をデータとして扱うことを考えてみてください。

＜野球選手の場合＞

　・背番号
　・得意な守備位置
　・打率
　・走力
　　　　など

＜サッカー選手の場合＞

　・ポジション・役割(ゴールキーパー、ディフェンダー、ミッドフィルダー、フォワード)
　・体格
　・シュート力
　・ドリブル力
　・走力
　　　　など

　このように、１つの選手のデータを管理するにあたっては複数の情報が必要ですが、それらはバラバラになっていては関連性が分かりません。

　プログラムではこのようなデータを管理するためにクラスが用意されています。
　
　クラスの役割は変数の宣言とメソッドの宣言が行えることですが、変数の部分を、それぞれの選手の情報を扱う値として利用します。

　このような観点で選手用のデータを管理するためのクラスを作成し、その中に関連している複数のデータを変数として宣言して管理することで、
１つのクラスで選手の情報を表現することができます。

　野球選手を例にすると、このようなクラスになります。

public class BaseBallPlayerData {

    public int uniform number;          // 背番号
　  public string defensivePositon;     // 得意な守備位置
　  public float battingAverage;        // 打率   
　  public float runSpeed;              // 走力

}

　このようにクラスを活用することで、１つの情報を構成するために必要な複数のデータを管理することが可能になります。

　この考え方をベースに、今回の場合には、キャラ関係のデータを管理するためのクラスと、それを束ねてデータベースにする機能を作成していきます。
　

コレクション機能

　先ほど野球選手のデータを BaseBallPlayerData クラスとして表現しました。

　このクラスには選手１名分のデータを管理することができます。ですが、野球やサッカー、それ以外のものの多くは、１つのデータだけでは情報が足りません。
少なくても野球の場合には９名(相手も必要なので１８名)分の BaseBallPlayerData が必要になります。
なぜなら、BaseBallPlayerData には１名分のデータしか管理出来ませんので、それを人数分用意しなければならない訳です。

　こうしたとき、同名のクラス群を１つのまとまりとして管理できる入れ物のようなものがあると扱いが楽になります。
９名分の BaseBallPlayerData クラスの変数を９個用意したのでは管理していることにはなりません。

　BaseBallPlayerData クラス９名分を１つの変数でまとめて管理してくれるものとして、C# ではコレクションという機能を利用することで実現できます。

　C# のコレクションには、List、Dectionary という機能が用意されています。(配列はコレクションではないので注意してください。)

＜各クラスを１つずつ宣言　→　これは１つの変数にまとまっていない＞

　BaseBallPlayerData player0;
  BaseBallPlayerData player1;
  BaseBallPlayerData player2;

　　　　：

  BaseBallPlayerData player8;

　
　　↓

＜コレクション機能を使い、１つの変数で同クラスの異なるデータを表現する＞

　List<BaseBallPlayerData> playerList;　　// List

　Unity ではこのうち、ScriptableObject クラスと List の機能を活用して作成できるスクリプタブル・オブジェクトという機能が用意されています。
このスクリプタブル・オブジェクトの機能を利用することで、データベースを作成することができます。

　なお、コレクション機能はあくまでも複数の同クラスの情報をまとめて管理することがメインです。
そのため、コレクション機能を使えばそれがデータベースになる、ということではありません。
あくまでも Unity の用意している ScriptableObject クラスと List を活用することでデータベースを作成しています。

　この部分の認識を間違えないようにしてください。

参考サイト

MicroSoft
コレクション

　知らない単語が出てきたときには積極的に、ネットに公開されている公式のマニュアル、わかりやすくまとめた記事などを見つけて調べてみてください。

スクリプタブル・オブジェクト

　ScriptableObject(スクリプタブル・オブジェクト)は、Unityエディタ上で簡単にデータを管理できる機能です

　スクリプタブル・オブジェクトを作成するためには、専用のスクリプトを作成する必要があります。その作成方法を学習します。

　今回作成するスクリプタブル・オブジェクトはキャラ関連のデータを管理する目的で作成を行います。
そのため、スクリプト内には、キャラ関連のデータをまとめるための CharaData クラスを用意します。

　CharaData クラスは、キャラ関連のデータを１つにまとめている情報群です。
キャラの通し番号、キャラの画像など、これらを１つのデータ群としてまとめて管理するためのクラスになります。

　この CharaData クラスは、ゲームに登場するキャラの数だけ用意することになりますので、それを管理するために List 機能を利用します。

　この２つの情報を管理して完成するのがスクリプタブル・オブジェクトになります。
そのためにクラスとして、CharaDataSO クラスを作成します。

　どのような構成になっているかはスクリプト作成後に説明をしていますので、そちらをしっかりと学習しておいてください。
真似をして作ってみたり、復習を重ねていくことでプログラムは理解が深まり、処理のイメージがわくようになり、書けるようになります。

CharaData スクリプトの作成

　キャラのデータ、および、キャラなどのデータを登録するためのクラスを作成します。
クラスは継承しませんので、MonoBehaviour クラスは削除してください。

　MonoBehaviour クラスを継承しないクラスとして作成することで、
ゲームオブジェクトに紐づかない、データ管理のみのクラスとして制作しておきます。

　スクリプタブル・オブジェクトを作成した際、インスペクターから CharaData クラスの情報を設定できるように
[System.Serializable] 属性をクラスの上に付与してください。

CharaData.cs

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

using UnityEngine;

[System.Serializable]　　//　←　クラスに System.Serializable 属性を付与する
public class CharaData
{
    public int id;
    public string name;
    public Sprite sprite;  // キャラの画像
    public CharacterBase CharacterPrefab;  // 生成するキャラ

    public int hp;
    public float moveSpeed;
    public float jumpPower;
}

　スクリプトを作成したらセーブします。

[System.Serializable（シリアライザブル）]属性

　入れ子になっているクラスの１行上には上記の宣言があります。[ ]で宣言された設定値は「属性」と呼ばれる情報になり、特別な意味を持ちます。

　今回利用している[System.Serializable]属性は、Systemに含まれている設定値であり、こちらを宣言することで入れ子クラスの情報をインスペクターに表示することが出来ます。
これを書き忘れてしまうと、インスペクターに CharaData が表示されず、データをインスペクターから登録することが出来ません。

using System; を宣言している場合には [Serializable] とだけ記述すれば適用されます。

宣言していない場合には [System.Serializable] と記述する必要があります。

CharaDataSO スクリプトの作成

　スクリプタブル・オブジェクトを作成するために必要な CharaDataSO スクリプトを作成します。
スクリプタブル・オブジェクト専用の ScriptableObject クラスを継承し、[CreateAssetMenu] 属性を記述することで作成可能になります。
　
　スクリプタブル・オブジェクトでは、指定したデータを複数のデータとしてまとめて管理することが出来ます。
そのため、データベースとしての役割を果たすことが可能になっています。

　今回指定して管理したいデータはキャラ関連のデータです。
そのため、スクリプタブル・オブジェクト内に必要な情報は以下の２つです。

　１．キャラ関連の情報単位でのデータ(キャラデータの通し番号、サムネイルに使う画像などのデータ群)を扱うクラス
　２．キャラ関連のデータをまとめる List(リスト)と ScriptableObject を継承したクラス

　このうち１は先ほど作成した CharaData が当たります。
ここでは２のスクリプトを作成します。

　CharaDataSO スクリプトを作成します。
このスクリプトを利用することで、CharaData を束ねたスクリプタブル・オブジェクトをアセットとして作成することが出来ます。

　[CreateAssetMenu]属性の付与と、ScriptableObject クラスを継承することを忘れないようにしてください。

　また CharaData の List 内から、指定した ID のデータを取得するためのメソッドを用意しておきます。

CharaDataSO.cs

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

using System.Collections.Generic;
using UnityEngine;

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

    /// <summary>
    /// ID によるキャラの検索と取得
    /// </summary>
    /// <param name="searchId"></param>
    /// <returns></returns>
    public CharaData GetCharaDataFromId(int searchId) {
        return charaDataList.Find(data => data.id == searchId);
    }
}

　スクリプトを作成したらセーブします。

＜List.Find メソッド＞

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

Find の場合

    /// <summary>
    /// ID によるキャラの検索と取得
    /// </summary>
    /// <param name="searchId"></param>
    /// <returns></returns>
    public CharaData GetCharaDataFromId(int searchId) {
        return charaDataList.Find(data => data.id == searchId);
    }

foreach で同じ処理を書いた場合

  foreach (CharaData data in charaDataList) {
      if (data.id == searchId) {
          return data;
      }
  }

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

参考サイト

Samurai Blog様
【C#入門】Listの要素を検索するFindの使い方(FindAll/FindIndex)

CharaDataSO スクリプトの構造について

　処理の内容について、順番に確認していきます。

　１．キャラ関連の情報単位でのデータ(キャラデータの通し番号、サムネイルに使う画像などのデータ群)を扱うクラス
　２．キャラ関連のデータをまとめる List(リスト)と ScriptableObject を継承したクラス

１．キャラ関連の情報単位でのデータ(キャラデータの通し番号、サムネイルに使う画像などのデータ群)を扱うクラス

利点は、１つの CharaData クラス内には１つ分のキャラ関連の全データが登録できることです。

そのため、キャラデータの通し番号用、キャラの画像用というように変数を個別に作る必要はなく、
CharaData の id、CharaData の sprite という形で CharaData を参照して利用できる部分です。

　例えば、CharaData.id と記述すれば、それはその CharaData クラスに登録されている id の値を参照することになります。

　ここからはピリオドによる参照処理が増えていきますので、しっかりと処理を読み解いていきましょう。

[System.Serializable]　　//　←　クラスに System.Serializable 属性を付与する
public class CharaData
{
    public int id;
    public string name;
    public Sprite sprite;  // キャラの画像
    public CharacterBase CharacterPrefab;  // 生成するキャラ

    public int hp;
    public float moveSpeed;
    public float jumpPower;
}

　このようにキャラ関連の情報に必要になるデータをクラスとしてまとめておくことで管理と利用が容易になります。

　また、管理する情報を増やしたい(キャラの攻撃力、必殺技の名前など)場合には、
この CharaData クラス内に型と変数を追記すれば、好きなだけ増やすことも出来ます。

２．キャラ関連のデータをまとめる List(リスト)と ScriptableObject を継承したクラス

　CharaData クラスにはキャラ関連の情報をまとめて登録できるようにしました。
このデータはキャラ関連１つ分ですので、もしも複数のデータを用意して登録したい場合、
この CharaData クラスを複数用意して、それを管理するための変数が必要になります。

　こういった１つの同じデータ群をまとまったものをコレクションといいます。
C# にはコレクションを管理する方法として、Dictinary(ディクショナリー) と List(リスト) があります。

　List クラスは <T> にジェネリック型（任意の型）を指定して、同じデータ型をまとめて管理するコレクション機能を持つクラスです。
配列と異なり、要素を自由に追加・削除できます。(要素数が可変する)
List はサイズ(長さ)が可変可能な配列のイメージです。

　List を利用する場合には配列と同様に初期化が可能ですが、Listでは初期化時に要素数の宣言が不要です。

＜配列の初期化＞

  CharaData [] charaDatas = new CharaData [3];       // <=  要素数の宣言が必要

＜List の初期化①＞

  List<CharaData> charaDataList = new List<CharaData>();   // <=  要素数の宣言が不要

＜List の初期化②　こちらでも初期化できます＞

  List<CharaData > charaDataList = new ();   // <=  要素数の宣言が不要

　そのため基本的には、予め要素数の確定しているデータを扱う場合には配列を、要素数が未確定であったり可変長であるデータについてはListを利用するように考えてください。

参考サイト

.net column様
【初期化の方法】C#で配列やリストを初期化するには？

　public 修飾子にて List を宣言することで、インスペクター上でサイズの変更が可能です。

　例えばデータを３つ分作って登録したい場合には、インスペクターで List のサイズを 3 に設定すれば
CharaData クラスが 3 つ、Element 0 ～ Element 2 として作成されますので、ここにキャラ関連のデータを１つずつ、合計３つ分登録することが出来ます。

＜CharaData クラスを扱う List＞

    public List<CharaData> charaDataList = new ();

スクリプタブル・オブジェクトの作成と設定

　CharaDataSO スクリプトを元に CharaData SO スクリプタブル・オブジェクトを作成します。
CharaDataSO スクリプトに用意してある CharaData 型の List である CharaDataList 変数がデータベースの役割を持っています。

＜クラスのリスト化によるデータベース作成＞

　CharaData クラスは１つのデータ情報を扱うことが出来ます。今回であればキャラ関連の１つ分の情報です。
そのため複数のキャラ関連の情報を扱う必要がある今回のような場合には、その分だけ CharaData クラスを追加して作成しなければなりません。

　それらを管理するために CharaData 型の List を作り、まとめて管理を出来るようにしています。
ここで大切なことは、１つ１つの別の変数に個別に CharaData が存在していたのではまとめて管理していることにはなりません。
CharaData のリストとはすなわち、CharaData をまとめて扱っているデータの集合体になりますので、ここにデータベースとして役割を成立させることが出来ます。

　それでは作成しましょう。

　Asset フォルダ内で Create → Create CharaDataSO を選択して、新しいスクリプタブル・オブジェクトのアセットを作成します。
予め Datas フォルダなどを作成しておいて、その中で作成すると管理しやすくなります。
その場合には、Datas フォルダ内で右クリックをしてメニューを開き、Create → Create CharaDataSO を選択します。

　フォルダ内に CharaDataSO スクリプタブル・オブジェクトのアセットが作成されます。名前はそのままで問題ありません。

メニュー

Datas フォルダ

　このアイコンの形が違うファイルがスクリプタブル・オブジェクトになります。
これはアセットとして取り扱われるようになる情報であることを示しています。

登録

　作成された CharaDataSO スクリプタブル・オブジェクトを選択してインスペクターを確認します。
CharaDataSO スクリプトにて宣言した CharaDataList 変数がインスペクターに表示されて、 Sizeが 0 になっています。
これがスクリプタブル・オブジェクトの中身です。

　Size に任意の数を入力すると、同数の Element が作成されます。これが List で管理する CharaData クラスの情報群になります。

　CharaDataSO スクリプタブル・オブジェクトのアセットを選択し、インスペクターから CharaData にキャラの情報を登録します。

　まずはデータを２つ分登録しておきたいと思います。
CharaDataList 変数の Size を 2 に変更してください。Element 0 ～ 1 が下に作成されます。

　Element とは List の要素(中身)のことです。
そのため、Element １つが CharaData １つになります。Element の番号は 0 から始まります。

　以上のことから、１つの Element には１つの CharaData クラスの内容を設定できるようになっています。
このとき、CharaData クラスの上に [Serializable] 属性を宣言しているので、CharaData クラスの内容がインスペクターに表示されています。
[Serializable] 属性を活用することによって、インスペクターから情報を１つずつ、CharaData 単位で登録出来るようになっています。

　まずは id 変数を 0 から連番で設定し、同じ番号を使わないようにしてください。
　各数値やキャラは任意ですが、No の値だけは異なる番号で設定してください。できれば 0 から連番が理想です。
この番号はデータ用の個体番号として利用する可能性がありますので、同じ番号を重複して設定してしまうと、
同じ番号の個体が複数存在することになり、番号によってデータを特定することが出来なくなります。

　name 変数にはキャラの名前を登録します。

　sprite 変数には、キャラの画像をアサインします。任意の画像をインポートしてアサインしてください。

　それ以外の部分は一旦、設定なしで問題ありません。

インスペクター画像(サンプル。このキャラのようにする必要はありません)

　以上でスクリプタブル・オブジェクトは完成です。

GameData スクリプトの作成

　ゲーム内のデータを保持するクラスです。

　シングルトンクラスで、かつシーン遷移時にも破棄されないゲームオブジェクトとすることで
どのクラスからでも変数やメソッドにアクセスでき、シーン遷移後も利用することができるクラスとして設計します。

　enum を２つ作成していますが、こちらはクラス外部にて宣言していますので、
別ファイルとして作成しても問題ありません。

GameData.cs

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

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

/// <summary>
/// キャラのオーナーの種類
/// </summary>
public enum OwnerType {
    Player,
    Opponent
}

/// <summary>
/// シーンの名前
/// </summary>
public enum SceneName {
    CharaSelect,
    Battle
}

public class GameData : MonoBehaviour
{
    public static GameData instance;

    private CharaData playerChara;
    public CharaData PlayerChara => playerChara;　　// Get のみのプロパティ
    
    private CharaData opponentChara;
    public CharaData OpponentChara => opponentChara;　　// Get のみのプロパティ


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

    /// <summary>
    /// 選択したキャラのデータを保持
    /// </summary>
    /// <param name="type"></param>
    /// <param name="chooseCharaData"></param>
    public void SetSelectCharaId(OwnerType type, CharaData chooseCharaData) {
        if (type == OwnerType.Player) {
            playerChara = chooseCharaData;
        } else {
            opponentChara = chooseCharaData;
        }
    }

    /// <summary>
    /// 指定されたシーンへ遷移
    /// </summary>
    /// <param name="nextSceneName"></param>
    public void NextScene(SceneName nextSceneName) {
        SceneManager.LoadScene(nextSceneName.ToString());
    }
}

　内部データについてはプロパティを利用して外部クラスに提供しています。

＜enum(列挙)型＞

　C# には特定の値しか取らないデータに関して、あらかじめ登録しておいて、その範囲内でのみデータを扱うように指定が出来ます。
これを enum (読み方はいくつかありますが、イニュームが一般的です) というキーワードを利用することで作成できます。

enum をキーワードとして宣言し、その後に型名を書きます。その後、{　}ブロックの中に列挙子という形で登録したいデータを宣言します。

/// <summary>
/// キャラのオーナーの種類
/// </summary>
public enum OwnerType {
    Player,
    Opponent
}

/// <summary>
/// シーンの名前
/// </summary>
public enum SceneName {
    CharaSelect,
    Battle
}

　また enum の列挙子には日本語でも宣言できます。

/// <summary>
/// キャラのオーナーの種類
/// </summary>
public enum OwnerType {
    プレイヤー,
    対戦相手
}

参考サイト

MicroSoft
列挙型 (C# リファレンス)
https://docs.microsoft.com/ja-jp/dotnet/csharp/lan...

SamuraiBlog 様
【C#入門】enum(列挙型)の使い方総まとめ(文字列/int/foreach)
https://www.sejuku.net/blog/50547

＜シングルトンクラス＞

　シングルトンとは、数多くあるデザインパターンの１つです。そのクラスのインスタンスが必ず１つであることを保証するデザインパターンのことを言います。

　GameData クラスでは、このシングルトンを採用しています。つまり、ゲーム中を通じて、このGameData クラスが１つしか存在できないようになります。
実装例は複数ありますが、一番読みやすい方式で記述しています。

　このシングルトンによってインスタンスが１つか生成されないことが保証されますので、このGameData クラスへの参照は、いずれのクラスからであっても変数を介さずに参照を行えるようになります。

　例えば、Enemyというクラスがあり、そのEmenyクラスを持つゲームオブジェクトが５つあった場合、「どの」Enemyクラスであるかを確定できないと、対象となるEnemyクラスへは参照できません。
そのため、Enemy型の変数を用意して、その変数へ参照したいEnemyクラスを代入することによって、はじめてEnemyクラスの情報を扱うことができるようになります。

　ですがシングルトンであるGameData クラスの場合には、このインスタンスは常に１つしかないことが保証されていますので、「どの」という指定の部分が不要になります。
つまり変数への代入が不要になります。

　GameData という指定はすなわち、自動的にただ１つの GameData への参照が行われます。

GameData の作成

　ヒエラルキーにて Create Empty で新しいゲームオブジェクトを作成し、GameData スクリプトをアタッチします。

インスペクターキャラ

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

　→　次は キャラ選択機能の実装③ です。

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

印刷する

コメント（0）

キャラ選択機能の実装② - i-school 先頭へ

コメントをかく

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

i-school