オブジェクトのプーリングと再利用

UnityEngine.Pool

UnityEngine.Pool

Pooling and reusing GameObjects （ゲームオブジェクトのプールと再利用）

オブジェクトプールの作成

ObjectPool<T>

ObjectPool<T>

T

ObjectPool<T>

ObjectPool<T>

• プールの開始容量。
• プールを拡張できる最大容量。
• 同じオブジェクト インスタンスをプールに二重解放しないようにコレクションの安全性チェックを実行するかどうか。
• 一連の C#

  Action<T>

  デリゲート。Unity がプールで以下のキーアクションを実行するときに呼び出すコールバックです。
  • プールからオブジェクトを取得するときに呼び出すコールバックバック
  • オブジェクトをプールに返すときに呼び出すコールバックバック
  • 新しいオブジェクトインスタンスがリクエストされ、プールが空の場合に、インスタンスの作成時に呼び出されるコールバック
  • オブジェクトインスタンスを破棄するときに呼び出されるコールバック

プールからのオブジェクトの取得

ObjectPool<T>.Get

ObjectPool

actionOnGet

ObjectPool

createFunc

ObjectPool<T>.Get

Get(out PooledObject<T> pooledObject)

PooledObject

PooledObject<T>.Get

プールへのオブジェクトの返却

ObjectPool<T>.Release

ObjectPool

actionOnRelease

ObjectPool

actionOnDestroy

collectionCheck

true

使用済みオブジェクトをリセットする

actionOnGet

actionOnRelease

Update

例: 砲弾のプール

ObjectPool<T>

1. ゲームの開始時に非アクティブの砲弾オブジェクトのプールを作成します。プールされたオブジェクトの新規作成、プールからのオブジェクトの取得、プールへのオブジェクトの解放、プールが満杯になったオブジェクトの破棄時にコールバックとして呼び出すために必要なデリゲートをコンストラクターに提供します。
2. 発射物が必要な場合 (例えば、ユーザーが武器を発射する場合)、

   ObjectPool<T>.Get

   を使用してプールから非アクティブの発射物を取得します。対応する

   actionOnGet

   コールバックから、取得したオブジェクトをアクティブ化し、位置や向きなどの関連プロパティを初期化します。
3. 砲弾が不要になったとき (例えば、ターゲットに当たったとき、または範囲外になったとき)、

   ObjectPool<T>.Release

   とともにプールに戻します。発射体には専用のプールへのリファレンスを渡すのが一般的です。そうすることで、発射後に自身をリリースできます。対応する

   actionOnRelease

   コールバックから、返されたオブジェクトを非アクティブにし、速度やアニメーションステートなどの関連プロパティをリセットします。

ObjectPool<T>

using System.Collections;    using System.Collections.Generic;    using UnityEngine;    using UnityEngine.Pool;    public class RevisedProjectile :MonoBehaviour    {        // Deactivate after delay        [SerializeField] private float timeoutDelay = 3f;        private IObjectPool<RevisedProjectile> objectPool;        // Public property to give the projectile a reference to its ObjectPool        public IObjectPool<RevisedProjectile> ObjectPool { set => objectPool = value; }        public void Deactivate()        {            StartCoroutine(DeactivateRoutine(timeoutDelay));        }        IEnumerator DeactivateRoutine(float 遅延)        {            yield return new WaitForSeconds(遅延);            // Reset the moving Rigidbody            Rigidbody rBody = GetComponent<Rigidbody>();            rBody.linearVelocity = new Vector3(0f, 0f, 0f);            rBody.angularVelocity = new Vector3(0f, 0f, 0f);            // Release the projectile back to the pool            objectPool.Release(this);        }    }

Get

using UnityEngine;    using UnityEngine.Pool;    using UnityEngine.Events;    public class RevisedGun :MonoBehaviour    {        [Tooltip("撃つプレハブ )        [SerializeField] private RevisedProjectile projectilePrefab;        [ツールチップ("発射力")]        [SerializeField] private float muzzleVelocity = 1500f;        [ツールチップ("ショットが表示される銃の終了位置")]        [SerializeField] private Transform muzzlePosition;        [Tooltip("射撃間隔 / 小さい = 発射率が高い")]        [SerializeField] private float cooldownWindow = 0.1f;        [SerializeField] private UnityEvent m_GunFired;        // Stack-based ObjectPool available with Unity 2021 and above        private IObjectPool<RevisedProjectile> objectPool;        // Throw an exception if we try to return an existing item, already in the pool        [SerializeField] private bool collectionCheck = true;        // Extra options to control the pool capacity and maximum size        [SerializeField] private int defaultCapacity = 20;        [SerializeField] private int maxSize = 100;        private float nextTimeToShoot;        private void Awake()        {            objectPool = new ObjectPool<RevisedProjectile>(CreateProjectile,                OnGetFromPool, OnReleaseToPool, OnDestroyPooledObject,                collectionCheck, defaultCapacity, maxSize);        }        // Invoked when creating an item to populate the object pool        private RevisedProjectile CreateProjectile()        {            RevisedProjectile projectileInstance = Instantiate(projectilePrefab);            projectileInstance.ObjectPool = objectPool;            return projectileInstance;        }        // Invoked when returning an item to the object pool        private void OnReleaseToPool(RevisedProjectile pooledObject)        {            pooledObject.gameObject.SetActive(false);        }        // Invoked when retrieving the next item from the object pool        private void OnGetFromPool(RevisedProjectile pooledObject)        {            pooledObject.gameObject.SetActive(true);        }        // Invoked when the maximum number of pooled items is exceeded (i.e. destroy the pooled object)        private void OnDestroyPooledObject(RevisedProjectile pooledObject)        {            Destroy(pooledObject.gameObject);        }        private void FixedUpdate()        {            // Invokes the Shoot method if the delay time is exceeded            if (Input.GetButton("Fire1") && Time.time > nextTimeToShoot && objectPool != null)            {                Shoot();            }        }        private void Shoot()        {            // Get a pooled object instead of instantiating            RevisedProjectile bulletObject = objectPool.Get();            if (bulletObject == null)                return;            // Align to gun barrel/muzzle position            bulletObject.transform.SetPositionAndRotation(muzzlePosition.position, muzzlePosition.rotation);            // Move projectile forward            bulletObject.GetComponent<Rigidbody>().AddForce(bulletObject.Transform.フォワード * muzzleVelocity, ForceMode.Acceleration);            // Turn off after a few seconds            bulletObject.Deactivate();            // Set cooldown delay            nextTimeToShoot = Time.time + cooldownWindow;            m_GunFired.Invoke();        }    }

プールされたオブジェクトのシーンアンロードの処理

object.DontDestroyOnLoad

transform.SetParent

OnDisable

OnDestroy

SceneManager.activeSceneChanged

ObjectPool<T>.Clear

コレクションタイプのプーリングと再利用

System.Collection

Clear

nearestNeighbors

List

// Bad C# script example. This Update method allocates a new `List` every frame.void Update() {    List<float> nearestNeighbors = new List<float>();    findDistancesToNearestNeighbors(nearestNeighbors);    nearestNeighbors.Sort();    // … use the sorted list somehow …}

List

List

// Good C# script example. This method re-uses the same List every frame.List<float> m_NearestNeighbors = new List<float>();void Update() {    m_NearestNeighbors.Clear();    findDistancesToNearestNeighbors(NearestNeighbors);    m_NearestNeighbors.Sort();    // … use the sorted list somehow …}

List

List

UnityEngine.Pool

List<T>

HashSet<T>

Dictionary<TKey, TValue>

ObjectPool<T>

CollectionPool<T>

追加リソース

• チュートリアルの学習:オブジェクトプールを使用してUnityのC#スクリプトのパフォーマンスを向上
• マネージメモリの概要
• リファレンスタイプの管理
• アレイの最適化
• 砲弾と爆発のインスタンス化。