スクリプタブル・オブジェクトとオブジェクトプールを活用したエフェクト複数種管理①

　複数回の手順に分けて学習を行います。

　Unity の用意しているスクリプタブル・オブジェクトとオブジェクトプールの機能を利用し、
複数種類のエフェクトをスクリプタブル・オブジェクトとオブジェクトプールを活用して効率的に管理する手法を実装していきます。

　新しい学習内容は、以下の通りです。

　・抽象化（インターフェース、抽象クラス、クラスの継承）

　なお、処理内では非同期処理として UniTask を採用しています。

１．エフェクト用のアセットをダウンロードしてUnityにインポートする

１．設計

　まずはゲーム内のどの場面でエフェクトを再生するかを想定し、どの位の種類のエフェクトが必要になることを把握します。
例えば、以下のような種類です。左側が想定するファイル名、右側がエフェクトを再生する場面です。

＜エフェクト・リスト＞

　１．Hit       --  攻撃命中時
　２．Damage  　--  敵からの攻撃の被弾時
　３．ItemGet　 --  アイテム取得時
　４．LevelUp　 --　レベルアップ時

　このようにリスト化して書き出しておくと管理しやすくなります。

　今後、エフェクトを利用する場面が増えたり、変更したい、といった場合には、上記に追加をして検討してください。

２．アセットストアより、エフェクトを再生する場面をイメージして、任意のアセットを探して Unity にインポートする

　エフェクトにはパーティクルシステム、あるいは Animator を利用して作成されたアセットを利用します。
アセットストアより任意のアセット Unity インポートして、ゲーム内でエフェクトを再生するための準備をします。

　頭の中で場面を思い浮かべながら、どんなエフェクトがよいか、確認しながら決めていきましょう。
先ほど提示した場面に合わせて、合計で３種類のエフェクト用のゲームオブジェクトを用意をしてください。
パーティクルでも Animator でもどちらでも問題ありません。

　また分割可能な画像を利用すればパーティクルの Texture Sheet Animation や、Animator 用の AnimationClip を作成可能です。

Unity公式マニュアル
パーティクルシステム
https://docs.unity3d.com/ja/current/Manual/class-P...

Unity公式マニュアル
Texture Sheet Animation モジュール
https://docs.unity3d.com/ja/current/Manual/PartSys...

　出来れば複数のアセットをインポートして、Unity 内で再生してみるとよいでしょう。

２．エフェクト用のクラスの作成を行う

１．設計

　エフェクトのプレハブの管理には、スクリプタブル・オブジェクトの機能と、オブジェクトプールの機能を利用します。

　複数の種類のエフェクトのプレハブをスクリプタブル・オブジェクトを利用することでデータベースとして管理し、必要な情報にアクセスできるようにします。

　生成されたエフェクトのプレハブはオブジェクトプールの機能を持たせ、繰り返し再利用できるようにします。

　そのために、まずはオブジェクトプールの機能を実装するための、エフェクトのプレハブ用のクラスを作成します。

　１．IPoolable インターフェース
　２．PoolBase 抽象クラス
　３．EffectPlayerBase クラス
　４．EffectPlayerBase クラスを継承したサブクラス

　１はインターフェース、２は抽象クラスですので、これらはエフェクトのプレハブにはアタッチできません。
そのため、３を作成し、これをエフェクトのプレハブにアタッチします。
　
　また各エフェクトのプレハブごとに処理のふるまいを変えたい場合には、４をそれぞれのエフェクトのプレハブごとに作成し、
３の代わりに４のみをアタッチして利用します。

２．IPoolable インターフェースの作成

　インターフェースです。実装したクラスにオブジェクトプール用の共通メソッドを提供します。

IPoolable.cs

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

/// <summary>
/// オブジェクトプールを利用して再利用されるクラスに実装するインターフェース
/// 使用用途としては、エフェクト、敵、弾、ドロップアイテム、フロート表示など
/// </summary>
public interface IPoolable {
    void Release();
}

３．PoolBase クラスの作成

　様々なオブジェクトプールに対応できる、汎用型の抽象クラスです。
抽象クラスですので、必ずほかのクラスに継承して利用します。

PoolBase.cs

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

using UnityEngine;
using UnityEngine.Pool;

/// <summary>
/// オブジェクトプール化するための汎用の抽象クラス
/// </summary>
public abstract class PoolBase : MonoBehaviour {

    protected IObjectPool<PoolBase> objectPool;

    // ObjectPool への参照を与えるプロパティ
    public IObjectPool<PoolBase> ObjectPool { get => objectPool; set => objectPool = value; }
}

４．EffectPlayerBase クラスの作成

　抽象クラスである PoolBase を継承して、エフェクト用のベース（親）クラスを作成します。
PlayEffect メソッドを仮想メソッドとして用意し、具体的な処理のふるまいは各エフェクトに依存できるようにしています。
また IPoolable インターフェースによる Release メソッドも同様に仮想メソッドとして実装して、
オブジェクトプールへ戻る処理を共通化したうえで、ふるまいを変えられるように用意しています。

　メンバ変数には Index か enum でエフェクトのプレハブを特定するための情報を設定します。
これはどちらを利用しても問題ありませんので、自分の実装に合わせて作成してください。

　enum を利用する場合には、次の手順で実装しますので、実装の後にメンバ変数を追加してください。

EffectPlayerBase.cs

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

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

/// <summary>
/// エフェクトのプレハブにアタッチして ID / enum を設定する
/// PoolBase を継承してオブジェクトプールに対応させる
/// </summary>
public class EffectPlayerBase : PoolBase, IPoolable {

    public int eff_index;
    public EffectName effectName;


    /// <summary>
    /// エフェクトの再生
    /// Forget 付きで実行する
    /// </summary>
    /// <param name="duation"></param>
    /// <param name="targetPosition"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    public virtual async UniTask PlayEffect(float duation, Vector2 targetPosition, CancellationToken token) {

        //Debug.Log($"{this} エフェクト開始");

        // エフェクトの位置設定
        transform.position = targetPosition;

        // エフェクト表示時間分待機
        await UniTask.Delay((int)duation * 1000, cancellationToken : token);

        // オブジェクトプールに戻す
        Release();

        //Debug.Log($"{this} リリース完了");
    }

    /// <summary>
    /// オブジェクトプールに戻す
    /// </summary>
    public virtual void Release() {

        // TODO 重複して戻らないように判定を入れる

        ObjectPool.Release(this);

        // TODO ほかにも戻るタイミングで行いたい処理を追加する

    }
}

５．EffectPlayerBase クラスを継承したサブクラス

　サンプルとして、サブクラスを１つ提示しておきます。
PlayEffect メソッドのみ上書きしてふるまいを変え、Release メソッドは親クラスのメソッドをそのまま利用しています。

　この時点でこのサブクラスは、MonoBehaviour、PoolBase、そして EffectPlayerBase の機能を有していることになります。

LevelUpEffect.cs

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

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

public class LevelUpEffect : EffectPlayerBase
{
    [SerializeField] private float scaleRate;


    /// <summary>
    /// レベルアップ用のエフェクト再生
    /// </summary>
    /// <param name="duation"></param>
    /// <param name="targetPosition"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    public override async UniTask PlayEffect(float duation, Vector2 targetPosition, CancellationToken token) {

        // サイズ設定
        transform.localScale = Vector3.one * scaleRate;

        // エフェクトをプレイヤーの子にして追従させる
        transform.SetParent(PlayerManager.instance.transform);
        
        await base.PlayEffect(duation, targetPosition, token);

        // エフェクトを EffectManager の子に戻す
        transform.SetParent(EffectManager.instance.transform);
    }
}

３．エフェクト用のプレハブに EffectPlayerBase クラスをアタッチする

　いったん、すべてのエフェクト用のプレハブに EffectPlayerBase クラスをアタッチします。
Index については、一意の値を設定し、ほかのエフェクトのプレハブとは同じ数値にならないようにしておきます。

　各エフェクトごとにふるまいを変えたい場合には、EffectPlayerBase クラスをリムーブし、
EffectPlayerBase クラスを親クラスにした子クラスを作成して、それを再度プレハブにアタッチし直します。

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

　次は　スクリプタブル・オブジェクトとオブジェクトプールを活用したエフェクト複数種管理②　です。

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

印刷する

コメント（0）

スクリプタブル・オブジェクトとオブジェクトプールを活用したエフェクト複数種管理① - i-school 先頭へ

コメントをかく

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

i-school