PhantomRose　スクリプト⑦

　カードの効果関連機能のソースコードを提示します。

カード関連クラスの整理

　カードの周りのクラスが多いので、整理しておきます。

１．CardController
　　　カードのプレハブにアタッチして、カードの見た目を整えたり、CardData や、今回作成する CardEffect を管理するクラスです。

２．CardType
　　　カードの種類を登録しておく enum です。

３．CardData
　　　スクリプタブル・オブジェクトで管理する、カードのデータ用のクラス
　　　なお、name 変数の名称は、CardEffectBase クラスを継承しているサブクラス(Attack とか Recovery とか)と同じ
　　　英語の名称にしておいてください。

４．CardDataSO
　　　　スクリプタブル・オブジェクトを作成するためのクラスです。
　　　　このクラス内の List で CardData を一元管理し、データベース化を行ってカードデータを管理します。

　ここまでが現在作成済のクラスです。

　今回は上記に加えて、以下のクラスを作成します。

１．ICommand
　　　カードの効果を実行するためのメソッドを持つインターフェースです。
　　　こちらを実装することで、すべてのカードは同じメソッドを使い、カードの効果を実行し、振る舞いを変える設計です。

２．CardEffectBase
　　　カードの効果を登録するための親クラスです。
　　　抽象クラスとして設計しますので、必ず、サブ(子)クラスを作成して継承して利用します。

３．CardEffectBase クラスを継承しているサブ(子)クラス(Attack とか Recovery とか)
　　　実際にゲーム内で利用されるカードの処理が書かれます。

４．CardEffectFactory
　　　【３】で作成したサブクラスを生成するためのファクトリーパターンを利用したクラスです。
　　　このクラス内でカードの効果を生成します。

　このほかにもまだ多くのカード関連のクラスを作成していきます。
例えば手札を管理するクラス、カードの効果を実行していくクラス、などがあります。

＜設計のポイント＞

　カードの効果用のクラス(２と３)はどれも MonoBehaviour を継承していません。
そのため、Instantiate メソッドを使って、ゲームオブジェクトのように生成は出来ません。
　　　
　代わりに new キーワードを利用するか、リフレクションという機能を使って生成します。
今回はリフレクションを利用します。
　　　
　CardEffectFactory クラスは static クラスです。ゲーム実行時に、見えないですが自動生成されます。
static ですので、どのクラスからでもアクセスできます。
ここはカードのインスタンス生成を担当するクラスです。
　　　
　生成だけを担当するクラスを用意して、専門的に利用することをファクトリー(工場)デザインパターンといいます。
　
　どのようなことをするかというと、

【CardData の name と同じ名称の CardEffectBase クラスを継承しているサブクラス(Attack とか Recovery とか)を動的にインスタンスします。】

　例えば、CardData の name に Attack と登録しておいて、その名前のクラスが存在するか、すべてのフォルダを検索します。
該当するクラスがあったとき、リフレクションの機能を使ってインスタンスを生成させます。
　　　
　リフレクションにはいくつかの機能がありますが、文字列を Type 型に変換することで、同名のクラスをインスタンス出来ます。
このようにして、カードの効果自体をインスタンスとして生成します。
　　　
　このインスタンスに MonoBehaviour クラスを継承せず、ゲームオブジェクトにアタッチしない構造にしているのは、処理の負荷を低減させたいためです。
　　　
　カードを４枚セットして、さらに、そのカードにクラスをアタッチして、という処理を行うことも可能ですが、
その場合、ゲームオブジェクトに効果も紐づく形になるため、融通が利きにくく、すべて Instantiate メソッドや GetComponent を挟むので全体的に処理も重くなります。
　　　
　今回の場合、CardController に CardData という見えないデータ情報と、CardEffectBase から派生した Attack や Recovery といった効果も見えないインスタンスの状態で管理します。
アタッチは不要ですし、Instantiate も GetComponent も不要になります。
　　　
　なお、リフレクション自体も重い処理ですが、検索+生成のみで終わるので、トータルで見ると、今回はこちらの方が軽い処理です。

１．ICommand

　カードの効果を実行するためのメソッドを持つインターフェースです。
こちらを実装することで、すべてのカードは同じメソッドを使い、カードの効果を実行し、振る舞いを変える設計です。

ICommand.cs

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

using System.Threading;
using Cysharp.Threading.Tasks;

/// <summary>
/// なにかのイベントを実行するためのインターフェース
/// 例えば、カードの効果を実行する、探索イベントを実行するなど、統一処理を作ってハンドルすることができる
/// </summary>
public interface ICommand
{
    UniTask ExecuteAsync(OwnerStatus status, CancellationToken token);

    int GetId();
}

２．CardEffectBase

　カードの効果用の親クラスです。
抽象クラスとして設計しますので、必ず、子クラスを作成して継承して利用します。

CardEffectBase.cs

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

using System.Threading;
using Cysharp.Threading.Tasks;

/// <summary>
/// カード効果用の抽象化された親クラス
/// </summary>
[System.Serializable]
public abstract class CardEffectBase : ICommand
{
    protected CardData cardData;

    /// <summary>
    /// コンストラクタ
    /// </summary>
    /// <param name="cardData"></param>
    public CardEffectBase(CardData cardData) {
        this.cardData = cardData;
    }

    /// <summary>
    /// カードの効果
    /// 子クラスで実装して振る舞いを変える
    /// </summary>
    /// <param name="token"></param>
    public abstract UniTask ExecuteAsync(OwnerStatus status, CancellationToken token);

    public int GetId() => cardData.id;

    // 上を丁寧に書いた場合
    // public int GetId() {
    //     return cardData.id;
    // }
}

３．子クラス(サブクラス)のサンプル

　ここでは CardEffectBase を継承し、Attack クラスを作成しています。

Attack.cs

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

using System.Threading;
using Cysharp.Threading.Tasks;
using UnityEngine;

public class Attack : CardEffectBase
{
    public override async UniTask ExecuteAsync(OwnerStatus status, CancellationToken token) {

        // TODO 攻撃の効果のメソッドを実行する
		
        Debug.Log("Attack");
    }

    /// <summary>
    /// コンストラクタ
    /// </summary>
    /// <param name="cardData"></param>
    public Attack(CardData cardData) : base(cardData) {}
}

４．CardEffectFactory

　サブクラスを生成するためのファクトリーパターンを利用したクラスです。
このクラス内でリフレクションの機能を利用し、カードの効果を生成します。

CardEffectFactory.cs

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

using System;
using UnityEngine;

/// <summary>
/// CardEffectBase を継承しているカードの効果用サブクラスを生成するファクトリークラス
/// </summary>
public static class CardEffectFactory
{
    /// <summary>
    /// カードの効果作成
    /// </summary>
    /// <param name="cardData"></param>
    /// <returns></returns>
    public static CardEffectBase CreateCardEffect(CardData cardData) {

        // stringからTypeを取得(namespace がある場合には、namespace からの正式名称でクラス名を指定する)
        Type type = Type.GetType(cardData.name);

        // クラスが見つからないか、CardEffectBaseを継承していない場合
        if (type == null || !typeof(CardEffectBase).IsAssignableFrom(type)) {
            Debug.Log("CardEffect null");
            return null;
        }

        // Typeからインスタンスを生成。第2引数には、コンストラクタ用の引数を指定できる(デフォルトのコンストラクタ不要でエラーも出ない)
        CardEffectBase cardEffect = (CardEffectBase)Activator.CreateInstance(type, cardData);
        return cardEffect;
    }
}

＜Activator.CreateInstance＞

　
　Activator クラスがリフレクションを行うためのクラスです。
変数に代入せずに利用できるメソッドがあり、その１つが、クラスをインスタンスするための CreateInstance メソッドです。
第1引数に指定した Type 型のインスタンスを生成し、(CardEffectBase) 型にキャストした上で左辺の変数に代入しています。
　このとき、キャストしている型は親クラスの CardEffectBase 型ですが、
実際に生成されるのは CardData の name で指定した Attack や Recovery といった子クラスになります。

　このファクトリークラスがあれば、今後はどんなカードの効果のクラスが増えていっても、
CardEffectBase クラスさえ継承していれば、このクラス内の処理を一切変えることなく、インスタンスが生成出来ます。
　これが継承をつかった抽象化の恩恵の１つです。
同時にゲーム内に必要な機能も作り出せていますし、カードの種類が増えても、このクラスは修正が不要という点が大きなポイントです。

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

印刷する

コメント（0）

PhantomRose　スクリプト⑦ - i-school 先頭へ

コメントをかく

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

i-school