エフェクト生成処理の実装例② - i-school

　エフェクトを生成し、破棄を行うサイクルは、同じエフェクトを繰り返し利用することを考えると大変勿体ない処理です。
そこでこの手順ではオブジェクトプールの機能を作成し、エフェクトを破棄して使い捨てるのではなくて、非表示にしておいて、再利用する仕組みを作成します。

　こちらの処理を実装するにあたり、事前準備が必要になります。

　　　=>　スクリプタブル・オブジェクトを利用したエフェクトの管理
　　　=>　エフェクト生成処理の実装例①

　先にこちらの処理を実装し、理解を深めておいてください。

　なおここで紹介しているオブジェクトプールは自作の機能です。
2022.1 以降バ－ジョンの Unity の場合には、Unity 内の機能の１つとしてオブジェクトプール機能が追加されていますので、自作せずに実装可能です。そちらを活用するとよいでしょう。

　その場合には、こちらの記事を活用してください。

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

設計

　オブジェクトプールを実装するために、EffectManager クラスを修正し、パーティクルを取得する際にオブジェクトプールを使用する方法を以下に示します。
オブジェクトプールは一度生成したパーティクルを再利用することで、パフォーマンスの向上が期待できます。

EffectObjectPool スクリプトを作成する

　まず、オブジェクトプール用のクラスを作成します。
これは使用されなくなったエフェクト用のパーティクルを保持し、必要な時に再利用するためのものです。

public class EffectObjectPool
{
    private Queue<ParticleSystem> pool = new Queue<ParticleSystem>();
    private Transform poolParent;

    /// <summary>
    /// コンストラクタ
    /// </summary>
    /// <param name="parent"></param>
    public EffectObjectPool(Transform parent)
    {
        poolParent = parent;
    }

    /// <summary>
    /// オブジェクトプールから再利用可能なパーティクルを取り出して、再表示する
    /// 存在しない場合には null を返し、生成をおこなってもらうようにする
    /// </summary>
    /// <returns></returns>
    public ParticleSystem GetEffect()
    {
        // オブジェクトプールの待機列にパーティクルがあるかを確認
        if (pool.Count > 0)
        {
            // オブジェクトプールから先頭のパーティクルを取り出します
            // これは待機列の先頭からパーティクルを取り出し、再利用するためのものです。取り出したパーティクルは待機列から削除
            var effect = pool.Dequeue();
            effect.gameObject.SetActive(true);
            return effect;
        }

        return null;
    }

    /// <summary>
    /// オブジェクトプールに返却されたパーティクルを再利用できる状態にする
    /// </summary>
    /// <param name="effect"></param>
    public void ReturnEffect(ParticleSystem effect)
    {
        // パーティクルを非表示
        effect.gameObject.SetActive(false);
        
        // パーティクルの親オブジェクトをpoolParentに設定します。
        // これにより、パーティクルはオブジェクトプール用の親オブジェクトの子オブジェクトになります。
        // これはオブジェクトプールの可視性を向上させ、シーンの階層構造を整理するためのものです。
        effect.transform.SetParent(poolParent);
        
        // パーティクルをオブジェクトプールの待機列に追加します。
        // Enqueueメソッドはキュー（待機列）に要素を追加するためのものです。
        // オブジェクトプールはこの待機列からパーティクルを再利用する際に、Dequeueメソッドを使って先頭の要素を取り出します。
        pool.Enqueue(effect);
    }
}

EffectManager スクリプトを修正し、オブジェクトプールの機能を追加する

　次に、EffectManagerクラスにオブジェクトプールを組み込みます。

public class EffectManager : MonoBehaviour
{
    public static EffectManager instance;

    [SerializeField] private EffectDataSO effectDataSO;


////*　変数を追加します　*////


    // オブジェクトプール用の親オブジェクト
    private Transform poolParent;

    // オブジェクトプール
    private Dictionary<EffectName, EffectObjectPool> effectObjectPools = new Dictionary<EffectName, EffectObjectPool>();


////*　ここまで　*////


    void Awake()
    {
        // シングルトンクラス化
        if (instance == null)
        {
            instance = this;
            DontDestroyOnLoad(gameObject);
        }
        else
        {
            Destroy(gameObject);
        }


////*　処理を追加します　*////


        // オブジェクトプール用の親オブジェクトを作成
        poolParent = new GameObject("EffectPool").transform;

        // パーティクルのデータを元にオブジェクトプールを初期化
        foreach (var effectData in effectDataSO.effectDataList)
        {
            effectObjectPools[effectData.effectName] = new EffectObjectPool(poolParent);
        }


////*　ここまで　*////


    }


////*　既存のメソッドの内容を修正する　*////


    /// <summary>
    /// 利用したいパーティクルを探して戻す
    /// </summary>
    /// <param name="searchEffectName"></param>
    /// <returns></returns>
    public ParticleSystem GetEffectFromName(EffectName searchEffectName)
    {
        var particlePool = effectObjectPools[searchEffectName];
        var effect = particlePool.GetEffect();

        if (effect == null)
        {
            var effectPrefab = effectDataSO.effectDataList.Find(effectData => effectData.effectName == searchEffectName).effectPrefab;
            effect = Instantiate(effectPrefab);
        }

        return effect;
    }


////*　ここまで　*////


////*　新しいメソッドを１つ追加　*////


    /// <summary>
    /// パーティクルをオブジェクトプールに戻す
    /// </summary>
    /// <param name="particle"></param>
    public void ReturnParticleToPool(ParticleSystem particle)
    {
        effectObjectPools[particle.GetComponent<EffectIdentifier>().effectName].ReturnEffect(particle);
    }



////*　ここまで　*////


}

　ここで、オブジェクトプール用にEffectObjectPoolクラスを作成し、オブジェクトプールの初期化やパーティクルの取得・返却を行うようにしました。

EffectIdentifierスクリプトを作成する

　パーティクルのPrefabにEffectIdentifierコンポーネントを追加します。
これはパーティクルがどのEffectNameに対応しているかを識別するために使用します。

public class EffectIdentifier : MonoBehaviour
{
    public EffectName effectName;
}

　これで、パーティクルの取得と返却がオブジェクトプールを利用するようになります。

利用方法

　エフェクトを使用したい時はGetEffectFromNameメソッドを呼び出し、不要になったパーティクルはReturnEffectToPoolメソッドでオブジェクトプールに戻します。

　この手法を利用することにより、必要になったエフェクトがない場合だけ、新しいパーティクルを作成し、
すでに不要となってオブジェクトプール内に待機しているエフェクトがある場合には、それを再利用することで、毎回のエフェクトの生成処理を止めて、効率化しています。