Merge pull request Haruma-K#27 from Haruma-K/feature/override_builtin_cells

Feature that override built-in cells

Author: Haruma-K

Assets/UnityDebugSheet/Runtime/Core/Scripts/DebugSheet.cs

@@ -296,7 +296,8 @@ private AsyncProcessHandle PushPage(Type pageType, string prefabName, bool playA
                     debugPage.SetTitle(titleOverride);
 
                 var prefabContainer = debugPage.GetComponent<PrefabContainer>();
-                prefabContainer.Prefabs.AddRange(_cellPrefabs);
+                foreach (var cellPrefab in _cellPrefabs)
+                    prefabContainer.AddPrefab(cellPrefab);
 
                 onLoad?.Invoke((x.pageId, debugPage));
             }, loadAsync: false);

Assets/UnityDebugSheet/Runtime/Core/Scripts/PrefabContainer.cs

@@ -1,29 +1,34 @@
 using System;
 using System.Collections.Generic;
-using System.Linq;
 using UnityEngine;
 
 namespace UnityDebugSheet.Runtime.Core.Scripts
 {
     public sealed class PrefabContainer : MonoBehaviour
     {
+        // For Inspector
         [SerializeField] private List<GameObject> _prefabs = new List<GameObject>();
 
-        private readonly Dictionary<string, GameObject> _prefabNames = new Dictionary<string, GameObject>();
+        private readonly Dictionary<string, GameObject> _nameToPrefabMap = new Dictionary<string, GameObject>();
 
-        public List<GameObject> Prefabs => _prefabs;
-
-        public GameObject GetPrefab(string prefabName)
+        private void Awake()
         {
-            if (_prefabNames.TryGetValue(prefabName, out var prefab))
-                return prefab;
+            foreach (var prefab in _prefabs)
+                AddPrefab(prefab);
+        }
 
-            prefab = _prefabs.FirstOrDefault(x => x.name.Equals(prefabName, StringComparison.Ordinal));
+        public void AddPrefab(GameObject prefab)
+        {
+            // Add prefab to the map.
+            // If the same name prefab is already added, it will be overwritten.
+            _nameToPrefabMap[prefab.name] = prefab;
+        }
 
-            if (prefab == null)
-                throw new ArgumentException($"Prefab \"{prefabName}\" is not found.");
+        public GameObject GetPrefab(string prefabName)
+        {
+            if (!_nameToPrefabMap.TryGetValue(prefabName, out var prefab))
+                throw new ArgumentException($"Prefab '{prefabName}' is not found.");
 
-            _prefabNames.Add(prefabName, prefab);
             return prefab;
         }
 
@@ -41,4 +46,4 @@ public bool TryGetPrefab(string prefabName, out GameObject prefab)
             }
         }
     }
-}
+}

README.md

@@ -36,6 +36,7 @@ Hierarchical debug menu system for Unity that makes it easy to create intuitive
   - [Workflow in multiple scenes](#workflow-in-multiple-scenes)
   - [Exclude from the release builds](#exclude-from-the-release-builds)
   - [Custom Cells](#custom-cells)
+  - [Extending Built-in Cell Prefabs](#extending-built-in-cell-prefabs)
 - [Advanced Usage](#advanced-usage)
   - [Use async methods instead of coroutines](#use-async-methods-instead-of-coroutines)
   - [Hide Backdrop](#hide-backdrop)
@@ -456,6 +457,13 @@ Next, set this cell to **Cell Prefabs** on the **Debug Sheet**.
 All that remains is to add this cell to the page.
 Please refer to [the demo scene of the custom cells](Assets/Demo/03_CustomCells/Scenes/CustomCellsDemo.unity) for the actual implementation.
 
+### Extending Built-in Cell Prefabs
+You can extend built-in cell prefabs such as LabelCell and ButtonCell by following the steps below:
+
+1. Create a Prefab Variant of the built-in Prefab and make any desired modifications.
+2. Ensure the name of this Prefab is the same as the original Prefab.
+3. Set this Prefab in the **Cell Prefabs** of the **Debug Sheet** component.
+
 ## Advanced Usage
 
 ### Use async methods instead of coroutines

README_JA.md

@@ -46,6 +46,7 @@
   - [最小・最大サイズの調整](#%E6%9C%80%E5%B0%8F%E3%83%BB%E6%9C%80%E5%A4%A7%E3%82%B5%E3%82%A4%E3%82%BA%E3%81%AE%E8%AA%BF%E6%95%B4)
   - [デザインをカスタムする](#%E3%83%87%E3%82%B6%E3%82%A4%E3%83%B3%E3%82%92%E3%82%AB%E3%82%B9%E3%82%BF%E3%83%A0%E3%81%99%E3%82%8B)
   - [まとめて戻る](#%E3%81%BE%E3%81%A8%E3%82%81%E3%81%A6%E6%88%BB%E3%82%8B)
+  - [組み込みセルPrefabを拡張する](#%E7%B5%84%E3%81%BF%E8%BE%BC%E3%81%BF%E3%82%BB%E3%83%ABprefab%E3%82%92%E6%8B%A1%E5%BC%B5%E3%81%99%E3%82%8B)
 - [拡張パッケージ](#%E6%8B%A1%E5%BC%B5%E3%83%91%E3%83%83%E3%82%B1%E3%83%BC%E3%82%B8)
   - [Unityのシステム情報を表示する](#unity%E3%81%AE%E3%82%B7%E3%82%B9%E3%83%86%E3%83%A0%E6%83%85%E5%A0%B1%E3%82%92%E8%A1%A8%E7%A4%BA%E3%81%99%E3%82%8B)
   - [In-game Debug Console](#in-game-debug-console)
@@ -572,7 +573,14 @@ debugSheet.PushPage<DebugPage>(true, pageId: "MyPageId");
 ```
 
 なお、まとめて戻る際にスキップされるページについては、遷移前後のライフサイクルイベントは呼ばれず、破棄前のイベントだけ呼ばれます。  
-またスキップされるページの遷移アニメーションは再生されません。  
+またスキップされるページの遷移アニメーションは再生されません。
+
+### 組み込みセルPrefabを拡張する
+LabelCell や ButtonCell などの組み込みセルのPrefabは以下の手順で拡張することができます。
+
+1. 組み込みPrefabのPrefabバリアントを作成し、任意の変更を加える
+2. このとき、Prefabの名前は元のPrefabと同じにする
+3. このPrefabを **Debug Sheet** コンポーネントの **Cell Prefabs** に設定する
 
 ## 拡張パッケージ
 Unity Debug Sheet はどんなアプリケーションでも汎用的に使う機能を拡張パッケージとして提供しています。