親クラスを継承させたアイテムクラスを作成する - i-school

手順

　以下の手順に沿って実装を進めていきます。

１．enum(列挙型)を使ってゲームに登場するアイテムの種類とプレイヤーのコンディションの種類を登録する
２．アイテム用クラスの親クラスを設計して実装する
３．親クラスを継承した回復アイテム用の子クラスを設計して実装する
４．汎用的な扱いが可能なアイテム用のプレファブを新しく作成する
５．親クラスと子クラスのメソッド処理について（多態性）

１．enum(列挙型)を使ってゲームに登場するアイテムの種類とプレイヤーのコンディションの種類を登録する

　事前の準備としまして、enumを使ってゲームに登場するアイテムの種類とプレイヤーのコンディションの種類を登録しておきましょう。

ITEM_TYPE.cs

<= ＋ボタンを押すと開きますので、自分なりの実装を行った上で確認をしてみましょう。

/// <summary>
/// アイテムの種類
/// </summary>
public enum ITEM_TYPE {
    CONDITION_CHANGE,  // コンディションを変更する効果。持続アイテムの場合に使用を想定
    INSTANT,           // 即時効果でコンディションを変更しない効果。回復アイテムの場合に使用を想定
    TREASURE,          // 宝箱などのアイテムの場合の使用を想定
}

CONDITION_TYPE.cs

<= ＋ボタンを押すと開きます。自分のプロジェクトに合わせてプレイヤーのコンディションの種類を登録しておきます。

/// <summary>
/// コンディションの種類
/// </summary>
public enum CONDITION_TYPE {
    RECOVER,             // 回復
    MOVE_SPEED,          // 移動速度
    ATTACK_POWER,        // 攻撃力
    JUMP_POWER,          // ジャンプ力
    COUNT
}

　どちらもMonoBehaviourクラスの継承はありません。そのため、いずれのクラスからでも参照が可能です。

２．アイテム用クラスの親クラスを設計して実装する

　親となるクラスはMonobehaviourを継承したクラスになります。これがすべてのアイテムの親となるクラスになります。
親クラスは通常通り、新しいC#スクリプトを作成していく手順で作っていきます。

　子クラスでのみ実装が必要な情報と、親クラスに実装して子クラスで共通化する情報とがありますので
まずはその切り分けを行って、共通化できるもののみを親クラスに用意します。

　親クラスに用意するのは変数と関数になります。

　その場合、修飾子にはprotectedを使用します。これは親子間でのみ使用できることを許可する修飾子です。
またメソッドの場合にはそのあとにvirtualを記述します。こうすることで親クラスのメソッドとして成立します。

　外部で利用したい場合には通常通りpublic修飾子を使用します。

　親クラスで設定された修飾子の情報は子クラスでも引き継がれます。
例えば親クラスで public float x を作成していれば、それは子クラスでも public float x として扱われます。

ItemBase.cs

<= ＋ボタンを押すと開きます。親クラスとして共有化する情報はプロジェクトにより異なります。自分のプロジェクトに合ったものにアレンジしましょう。

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

/// <summary>
/// アイテム用親クラス
/// </summary>
public class ItemBase : MonoBehaviour
{
    [Header("アイテムの種類")]
    public ITEM_TYPE itemType;

    [Header("アイテムの効力")]
    public float efficacyPoint;

    [Header("アイテムの効果時間")]
    public float duration;

    protected PlayerController playerController;

    /// <summary>
    /// アイテム取得時の効果発動の準備用
    /// このメソッドを呼び出すと効果発動が自動的に呼ばれる
    /// </summary>
    protected virtual void PraparateItemEffect(PlayerController playerController) {
        this.playerController = playerController;
        
        // アイテムの効果発動
        TriggerItemEffect();
    }

    /// <summary>
    /// アイテム取得時の効果発動
    /// </summary>
    protected virtual void TriggerItemEffect() {
        // (TODO) 子クラス内に行わせたい処理を記載する

        // 最後にDestroyItemを呼び出すことでアイテムが破壊される

    }

    /// <summary>
    /// アイテム破壊用
    /// </summary>
    /// <param name="destroyTime"></param>
    protected virtual void DestroyItem(float destroyTime = 0) {
        Destroy(this.gameObject, destroyTime);
    }


　　// 以下は任意です。このプロジェクトではPlayer側がアイテムの当たり判定をおこなっているため記載不要ですが、
　　// アイテム側で当たり判定を取りたい場合には必要に応じてこのような当たり判定の処理も親クラスに記載します。

　　private void OnTriggerEnter(Collider col){
        // 処理例
        if(col.gameObject.TryGetComponent(out PlayerContoller playerContoller)){
            PraparateItemEffect(playerContoller);
        }
    }
}

３．親クラスを継承した回復アイテム用の子クラスを設計して実装する

　前回作成したItemRecoverクラスに、MonoBehaviourの代わりにItemBaseを継承させます。
これによって親クラスItemBase、子クラスItemRecoverという関連性が生まれます。

　なお、ゲームオブジェクトにアタッチするのは子クラス（ここではItemRecover）のみで大丈夫です。
　
　以下はItemRecoverを修正したスクリプトになります。

<= ＋ボタンを押すと開きますので、自分なりの実装を行った上で確認をしてみましょう。

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

public class ItemRecover : ItemBase　// <=　修正。継承するクラスをItemBaseに変更する
{
　　// 親クラスのメソッドを上書き
    protected override void TriggerItemEffect() {
        RecoverLife();
    }

    /// <summary>
    /// HP回復処理
    /// </summary>
    private void RecoverLife() {
        // PlayerのHPを回復　親クラスの持つefficacyPointをキャストして回復量として使用する
        playerController.hp += (int)efficacyPoint;

        // HPが最大値を超えないように制御
        playerController.hp = Mathf.Clamp(playerController.hp, 0, playerController.maxHp);

        // アイテム破壊
        DestroyItem();
    }
}

　子クラスの処理はこれだけです。他の必要な処理はすべて親クラスに記載されていますので、そちらで処理を行ってくれます。
そのため子クラスには、親クラスに足りない情報や、親クラスのメソッド内容に対して修正したい処理だけを記述すれば大丈夫です。

　子クラスにおいて親クラスのメソッドに変更を加えた場合、親クラスの処理は無視されます。これをオーバーライドといいます。
もしも親クラスのメソッドの処理に加えて、子クラスの処理を追加したい場合には、メソッド内に base.メソッド名(); を記述します。
詳しい使い方については長くなってしまうため別のページで行いますが、まずはご自分で継承について調べてみましょう。

　プレファブになっている回復用ゲームオブジェクトItemRecoverPrefabに、修正したItemRecoverクラスをアタッチします。
インスペクター上には継承している親の情報も表示されます。忘れずに設定を行いましょう。

回復アイテム用のマテリアルを作成する

　おなじような手順で、他のアイテム用クラスも修正し、親子関係を持つ作りに変更してみましょう。

４．アイテムの生成方法を修正する

　EnemyControllerスクリプトにある、アイテムの生成処理について修正を加えていきます。

　まずいままで回復アイテム用プレファブを登録していた宣言を、配列に変更します。その際、ItemBaseの配列に宣言を変えます。
ここにItemBaseを親クラスとして持つ各アイテムのプレファブをインスペクター上で登録しておきます。
登録されたアイテムのプレファブの中から１つがランダムで生成されるようになります。
　
EnemyController.cs

<= クリックすると開きます。宣言フィールドと修正したメソッドのみを記載してあります。

public ItemBase[] itemPrefabs;    // public ItemRecover itemRecoverから変更。親クラスがItemBaseであるアイテムのプレファブをこの配列に登録する

    /// <summary>
    /// アイテムの生成
    /// </summary>
    private void CreateDropItem() {
　　　　// アイテム用プレファブ配列に登録されているアイテムの中から、生成するアイテムをランダムで１つ決定　<= 追加（☆）
        int index = Random.Range(0, itemPrefabs.Length);　　　　　　　　　　　　　　　　　　　　　　　　// <= 追加（☆）

        // 生成の高さを調整
        Vector3 createPos = new Vector3(transform.position.x, transform.position.y + offset, transform.position.z);

        // 生成の向きを調整
        Quaternion createRot = new Quaternion(transform.rotation.x, 180, transform.rotation.z, 0);

        // アイテム生成(ItemBaseクラスで生成するが、生成されるゲームオブジェクトはランダムで選択されたアイテムになる)　// <= 変更（☆）
        ItemBase item = Instantiate(itemPrefabs[index], createPos, createRot);   　　　　　　　　　　　　　　　　　　　// <= 変更（☆）
    }

５．ItemBaseを利用した生成について

　まずアイテム生成時の手順が少し変わりました。以前は回復アイテム用のプレファブ（ItemRecoverクラス）を指定して、そのまま回復アイテムを生成していました。
ですがこの処理ですと、他のアイテムを生成するためには、アイテムごとに生成処理を変えなくてはならず、同じような処理であるのに冗長的な処理を増やしてしまいます。

　そこで今回はItemBaseクラスを指定して、アイテムを生成しています。
　生成されるゲームオブジェクトはItemBaseクラス型の配列に登録されているプレファブのゲームオブジェクトになっています。

　そのため、ItemBaseを指定して生成を行うのですが、実際には、そのItemBaseを継承している子クラスが生成されるゲームオブジェクトとなるため
異なるゲームオブジェクトを生成する処理にもかかわわず、同じ処理を書く必要がないうえ、生成されるアイテムを自動的に変えることが出来ます。

　アイテム取得時にはPraparateItemEffectメソッドをPlayerControllerより呼び出します。
このメソッドを経由して、TriggerItemEffectメソッドが呼ばれて、子クラスでオーバーライドして実装した処理が行われます。