インターフェースとスクリプタブル・オブジェクトを利用した抽象化処理の実装例①

　具体的な実装例を元に、２回の手順に分けて抽象化について学習を行います。

　処理の内容としては、アクションゲームなどにおける必殺技について、分岐処理を無くして抽象化していく方法の実装例です。

　インターフェースを利用し、かつ、スクリプタブル・オブジェクトを利用することで、
処理の抽象化しつつ、必殺技の設定自体は可視化をしていくという手法になっています。

　抽象化の処理は難しいため、なるべく学習しやすいような内容を考えました。

　今回は、スクリプタブル・オブジェクトと一緒に利用することで
抽象化の処理を見えるようにして学習するのが、この教材のポイントです。

　ここで抽象化の処理に慣れることで、スクリプタブル・オブジェクトを使わない、一般的な抽象化の処理も学習していけると思います。

設計

　インターフェースとスクリプタブル・オブジェクトの関係性についてまとめます。

　ISpecialSkill インターフェース
　　　↓
　SpecialSkillBase　親クラス(必殺技の元。インターフェース実装、スクリプタブル・オブジェクト継承)
　　　↓
　必殺技の名前のクラス　子クラス(各必殺技。親クラスの継承。このクラスをスクリプタブル・オブジェクトとして作成する)

　上記の関係性です。

　このイメージを最初に作ってから、実際にスクリプトを作成していきます。
そのため、処理を書いていく、作っていくためには、設計部分がとても大切になります。

インターフェースを作成する

　必殺技の処理を書くためのメソッドと、後処理を書くためのメソッドの２つを定義しておきます。

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

public interface ISpecialSkill
{
    void BeforeSpecialSkill();

    void AfterSpecialSkill();
}

　後処理については、必殺技の処理が終わったあとに片付けの処理が必要な場合に備えたものです。

　このメソッドを定義しておくことで、このインターフェースを実装したクラスは、この２つのメソッドを必ずクラス内に書かなければなりません。

親クラスを作成する

　
　「必殺技」であることを定義するためのクラスです。

　このクラス、あるいはこのクラスを親として継承している子クラスを「必殺技のクラス」として認識できるようにします。
これが抽象化に向けたポイントの１つです。

　先ほどのインターフェースを実装してクラスを作成します。
子クラスにおいて共通化する変数やメソッドがない場合には、このクラスは不要で、直接インターフェースを実装して問題ありません。

　今回の必殺技については、必殺技という範疇でみた中で共通している設定項目や参照したいクラスなどがあるため、
その部分を抜き出して、親クラスに実装しています。

　このような設計にしておくことで、すべての子クラスで共通の必殺技の設定項目を持たせることが出来ます。

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

using UnityEngine;

/// <summary>
/// 親クラス。このクラスを「必殺技」として定義する
/// </summary>
public class SpecialSkillBase : ScriptableObject, ISpecialSkill
{
    // メンバ変数には、すべての必殺技で共通化して管理しておきたい情報を書いておく
    protected GameManager gameManager;
    protected EnemyGenerator enemyGenerator;
    
    public int maxSpecialSkillCount;  // 使用回数
    public int intervalKillCountSpecialSkill;  //必殺技発動に必要な敵Kill数
    public float specialSkillDuration;

　　// TODO 他にも必殺技において共通で設定しておきたい項目があれば、このクラス内に書いておく

    
    /// <summary>
    /// 必殺技共通の初期設定
    /// </summary>
    /// <param name="gameManager"></param>
    /// <param name="enemyGenerator"></param>
    public void SetUpSpecialSkillBase(GameManager gameManager, EnemyGenerator enemyGenerator) {

        this.gameManager = gameManager;
        this.enemyGenerator = enemyGenerator;

        Debug.Log("SpecialSkillBase 設定しました");

　　　　// TODO このメソッドはコンストラクタメソッドの意味合いを持ちます。そのため、他にも初期設定したい情報がある場合には引数に追加してください。

    }

    public virtual void BeforeSpecialSkill() {
    
        // 子クラスで振る舞いを変える
    }
    
    public virtual void AfterSpecialSkill() {
    
        // 子クラスで振る舞いを変える
    }
}

　親クラスにインターフェースに書いてあるメソッドを実装していますが、ここでは処理の内容は記述しません。
必殺技の内容については、子クラス内に各メソッドを実装して振る舞いを変える形で必殺技の内容を記述します。

　このクラスが大切なポイントは、プログラムに「必殺技」の定義を認識させるように利用することを前提に作られている部分です。

SpecialSkillBase クラスを継承した子クラスを作成する

　各子クラスは、親クラスである SpecialSkillBase クラスを継承しています。
つまりこれら子クラスは「必殺技の中の、○○という技」としての位置づけになります。個別の必殺技を作る形です。
そして、その親クラスに定義されている２つの仮想メソッドを上書きし、各必殺技の効果となる処理を書いています。

　ここではサンプルとして、３つの必殺技を用意しています。そのため、３つの子クラスを作成します。

・すべての敵を倒す
・すべての敵の動きを止める
・プレイヤーの分身キャラを生成する

　先ほども説明があったように、SpecialSkillBase クラスを継承していることで、
それを継承している子クラスは「必殺技」としてプログラムに認識をさせます。

　どの必殺技までかを特定させず、「必殺技であるか、どうか」だけを認識させるようにします。
これも抽象化に向けたポイントです。

RovescioData スクリプトを作成する

　すべての敵を倒す必殺技の処理です。

　親クラスに実装されている BeforeSpecialSkill メソッドを override して、すべての敵を倒す処理を記述しています。

　演出用のエフェクトには別記事にて紹介している EffectManager の機能を利用しています。

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

using UnityEngine;

[CreateAssetMenu(fileName = "RovescioData", menuName = "Create SpecialSkillBaseRovescio")]
public class RovescioData : SpecialSkillBase　　//　←　継承。このクラスは、「必殺技」として認識させる
{
    /// <summary>
    /// 必殺技の中身を書く
    /// </summary>
    public override void BeforeSpecialSkill() {
        //TODO 演出

        //シーン上に生成されている全ての敵を破壊する
        for (int i = 0; i < enemyGenerator.enemiesList.Count; i++)
        {
            EnemyController enemies = enemyGenerator.enemiesList[i];

            //演出(パーティクル生成)
            Instantiate(EffectManager.instance.GetParticleFromName(ParticleName.Rovescio), enemies.transform.position, Quaternion.identity);

            Destroy(enemies.gameObject);

            //Listから必殺技で倒した敵を削除する(
            enemyGenerator.enemiesList.ReSkill(enemies);

            //敵キル数をカウントアップ
            gameManager.AddKillEnemyCount();
        }

        //エネミーのListを全て削除する
        enemyGenerator.enemiesList.Clear();

        Debug.Log("Rovescioが発動されました");
    }

    /// <summary>
    /// 必殺技が終わった後の処理を書く
    /// </summary>
    public override void AfterSpecialSkill() {
        Debug.Log("Rovescioが終了しました");
    }
}

MezzanotteData スクリプトを作成する

　全ての敵の移動を停止させる必殺技です。

　処理の内容は先ほどのクラスと同様で、親クラスにあるメソッドを override して、停止させる処理を記述しています。

　先ほどの子クラスとの違いは、このクラスでのみ利用する変数があるため、新しい変数の追加を行っている部分です。

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

using System.Collections.Generic;
using UnityEngine;

[CreateAssetMenu(fileName = "MezzanotteData", menuName = "Create SpecialSkillBaseMazzanotte")]
public class MezzanotteData : SpecialSkillBase　　//　←　継承。このクラスは、「必殺技」として認識させる
{
    private List<ParticleSystem> particleMezzanotteList = new();
    
    public override void BeforeSpecialSkill() {

        // TODO 演出

        // シーン上に生成されている全ての敵の移動とアニメーションを停止する
        for (int i = 0; i < enemyGenerator.enemiesList.Count; i++)
        {
            EnemyController enemies = enemyGenerator.enemiesList[i];

            // パーティクル生成
            ParticleSystem generatedParticleMezzanotte = Instantiate(EffectManager.instance.GetParticleFromName(ParticleName.Mezzanotte), enemies.transform.position, Quaternion.identity);

            // パーティクルとエネミーを親子関係にする
            generatedParticleMezzanotte.transform.SetParent(enemies.transform);

            // 生成したパーティクルをListに追加
            particleMezzanotteList.Add(generatedParticleMezzanotte);

            enemies.PauseSkill();
            enemies.PauseAnimation();
        }

        Debug.Log("Mezzanotteが発動されました");
    }

    public override void AfterSpecialSkill() {

        foreach (EnemyController enemy in enemyGenerator.enemiesList)
        {
            enemy.ResumeSkill();
            enemy.ResumeAnimation();
        }

        foreach (ParticleSystem particle in particleMezzanotteList)
        {
　　　　　　// null ならこの処理は中断して、次のパーティクルを止める処理へ
　　　　　　if(particle == null) continue;

            particle.Stop();
        }
        particleMezzanotteList.Clear();

        Debug.Log("Mezzanotteが終了しました");
    }
}

MagiaData スクリプトを作成する

　プレイヤーの分身を作成します。

　このクラスの場合も変数の追加を行っています。

　このように、各子クラスでのみ利用する変数をそれぞれのクラスに記述していくことで、処理に必要な変数のみを子クラスに記述することが出来ます。

　また今回は追加していませんが、子クラスでのみ利用できるメソッドを定義することも出来ます。

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

using System.Collections.Generic;
using UnityEngine;

[CreateAssetMenu(fileName = "MagiaData", menuName = "Create SpecialSkillBaseMagia")]
public class MagiaData : SpecialSkillBase　　//　←　継承。このクラスは、「必殺技」として認識させる
{
    [SerializeField] private MagiaCharaGenerator magiaCharaGenerator;

    [SerializeField] private int cloneCount;
    private List<MagiaChara> magiaCharasList = new();
    
    
    public override void BeforeSpecialSkill() {
        //TODO 演出

        // 
        for (int i = 0; i < cloneCount; i++)
        {
            MagiaChara chara = magiaCharaGenerator.GenerateMagiaCharas(i);
            chara.SetUpMagiaChara(gameManager, DataBaseManager.instance.charaDataSO.charaDatasList[i]);
            ParticleSystem particle = Instantiate(EffectManager.instance.GetParticleFromName(ParticleName.Magia), chara.transform.position, Quaternion.identity);
            particle.transform.SetParent(chara.transform);
            magiaCharasList.Add(chara);
        }

        Debug.Log("Magiaが発動されました");
    }

    public override void AfterSpecialSkill() {
        
        //リストに入っている全てのキャラ(Magiaで生成された全てのキャラ)をDestroyする
        for (int i = 0; i < magiaCharasList.Count; i++)
        {
            MagiaChara magiaChara = magiaCharasList[i];

            Destroy(magiaChara.gameObject);
        }
        //リストの中身を空にする
        magiaCharasList.Clear();

        Debug.Log("Magiaが終了しました");
    }
}

各子クラスのスクリプタブル・オブジェクトを作成する

　作成した子クラスはすべて SpecialSkillBase クラスを継承しています。
それぞれが固有の必殺技であるとともに、大きなくくりで見たときには「必殺技」として定義されています。

　SpecialSkillBase クラスにはスクリプタブル・オブジェクトが継承されていますので、
それを継承している子クラスもスクリプタブル・オブジェクトとしての機能を持っています。

　早速、子クラスをスクリプタブル・オブジェクトとして作成してみましょう。
全部で３つの子クラスがありますので、３つのスクリプタブル・オブジェクトを作成することが出来ます。

　下記はサンプルです。

メニュー

フォルダ

各子クラスによるスクリプタブル・オブジェクトのインスペクター

　これはすべて必殺技であり、それぞれが固有の必殺技のファイルとしての機能を持ちます。
同じ親クラスを継承しているので、すべての子クラスには共通する設定項目が用意されています。

CharaData スクリプトと CharaDataSO スクリプトを作成し、キャラのデータにスクリプタブル・オブジェクトを必殺技として登録する

　必殺技用のスクリプタブル・オブジェクトを作成しましたが、他のスクリプタブル・オブジェクトと同じで、変数にアサインしないとゲーム内では参照できません。

　ここではサンプルとして、キャラの情報用のクラスを作成し、その中に必殺技用の変数を作成して、スクリプタブル・オブジェクトを登録出来るようにします。

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

using UnityEngine;

/// <summary>
/// キャラの詳細データ
/// </summary>
[System.Serializable]
public class CharaData
{
    public string charaName;
    public int charaNo;

    // 必殺技用のスクリプタブル・オブジェクトをアサインする変数
    public SpecialSkillBase SpecialSkillBase;　　//　←　親クラスで指定している　=　固有の必殺技ではなく、「必殺技」であればアサインできるようにしている

　　// 必殺技の説明
    [Multiline] public string discription;

    public AnimatorOverrideController charaOverrideController;
}

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

using System.Collections.Generic;
using UnityEngine;

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

　上記のスクリプトを作成して、キャラ用の CharaDataSO スクリプタブル・オブジェクトを作成し、CharaData を登録できるようにします。

　CharaData 内にある SpecialSkillBase 変数の型は、先ほど作成した子クラスのスクリプタブル・オブジェクトの親クラスである SpecialSkillBase 型です。
この部分を子クラスで指定してしまうと、その子クラスしかアサイン出来ません。特定の技のみ、となるイメージです。

　ですが今回は SpecialSkillBase 型で変数を用意しているため、固有の必殺技ではなく、
もっと大きなくくりである「必殺技」であればアサインできるようにしている部分が重要なポイントです。

　このように「必殺技」なら何でもOKとしているので、親クラスを SpecialSkillBase 型で継承している各子クラスであれば、
どの子クラスのスクリプタブル・オブジェクトでもアサインして登録出来ます。

　子クラスのスクリプトではなく、子クラスから作成したスクリプタブル・オブジェクトをアサインします。
間違えないようにしてください。

　この手法において必殺技は CharaData 内にアサインして利用するため、視覚的に確認しやすく、そして自由に付け替えが可能です。

　また、CharaData クラス内の変数は、応用することで複数の必殺技を登録することも可能です。

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

　必殺技の情報が完成したので、次の手順では、ゲーム内で必殺技を実行する機能を作成します。
このとき、分岐処理を作って必殺技を特定する方法ではなく、抽象化を利用したメソッドの振る舞いを変える方法で処理の分岐を行います。

　次は　インターフェースとスクリプタブル・オブジェクトを利用した抽象化処理の実装例②　です。

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

印刷する

コメント（0）

インターフェースとスクリプタブル・オブジェクトを利用した抽象化処理の実装例① - i-school 先頭へ

コメントをかく

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

i-school