--- name: debug-widget-1622b96f652b description: "DebugContainer debug widget implementation and updates. Use when adding a new debug widget to the debug panel, creating or modifying debug categories, wiring ElementBinding or DebugWidgetVisibilityBinding, using IDebugContainerBuilder, calling TryAddWidget or AddCustomMarker, displaying live runtime data in the debug panel, or adding colored status indicators to the profiling/debug UI. Also applies when passing IDebugContainerBuilder through StaticContainer to a plugin or system." user-invocable: false --- # Debug Container Widget Implementation ## Sources - `docs/debug-container-and-widgets.md` — Full architecture reference (file structure, lifecycle, all element types, builder API) Read the doc above for detailed type inventories and UXML structure. This skill focuses on the implementation workflow and patterns you need to get a widget working. --- ## Quick Reference: Key Files | Purpose | Path | |---------|------| | Categories + interface | `Assets/DCL/PerformanceAndDiagnostics/DebugUtilities/Builders/IDebugContainerBuilder.cs` | | Fluent builder API | `Assets/DCL/PerformanceAndDiagnostics/DebugUtilities/Builders/DebugWidgetBuilder.cs` | | Convenience shortcuts | `Assets/DCL/PerformanceAndDiagnostics/DebugUtilities/Builders/BuilderExtensions.cs` | | ElementBinding\ | `Assets/DCL/PerformanceAndDiagnostics/DebugUtilities/UIBindings/ElementBinding.cs` | | Visibility binding | `Assets/DCL/PerformanceAndDiagnostics/DebugUtilities/UIBindings/DebugWidgetVisibilityBinding.cs` | | Null builder (no-op) | `Assets/DCL/PerformanceAndDiagnostics/DebugUtilities/Builders/NullDebugContainerBuilder.cs` | | StaticContainer (DI root) | `Assets/DCL/Infrastructure/Global/StaticContainer.cs` | --- ## Implementation Checklist ### Step 1: Add a Category (if needed) Check if an existing category in `IDebugContainerBuilder.Categories` fits. If not, add one to the `Categories` static class inside `IDebugContainerBuilder`: ```csharp // IDebugContainerBuilder.cs → public static class Categories { ... } public static readonly WidgetName MY_WIDGET = "My Widget".AsWidgetName(); ``` The type **must** be `WidgetName`, not `string` or `const string`. Every existing category uses this exact pattern — `public static readonly WidgetName`. The `AsWidgetName()` extension method (defined in the same file) wraps the string in the type-safe `WidgetName` struct. Using `const string` or plain `string` will not match the `GetOrAddWidget(WidgetName)` overload and breaks the convention used by all other categories in the class. ### Step 2: Choose an Integration Pattern There are three patterns. Pick the one that matches your situation: **Pattern A — System creates widget directly.** The system receives `IDebugContainerBuilder` as a constructor parameter (source-generated into `InjectToWorld`). Widget creation happens in the constructor. Best when the system owns both the data and the display. **Pattern B — Plugin creates bindings, system consumes.** The plugin creates `ElementBinding` + `DebugWidgetVisibilityBinding` in `InitializeAsync`, builds the widget, then passes the bindings to the system via `InjectToWorld`. Best when the plugin already manages the lifecycle and the system just writes values. **Pattern C — Non-system helper class.** A standalone class builds and updates the widget. Best for complex multi-widget scenarios (e.g. multiple room widgets). ### Step 3: Create Bindings and Build the Widget Regardless of pattern, the widget construction looks the same: ```csharp // Create bindings as fields private readonly ElementBinding myBinding = new (string.Empty); private readonly DebugWidgetVisibilityBinding myVisibility = new (true); // Build widget (in constructor or InitializeAsync) debugBuilder.TryAddWidget(IDebugContainerBuilder.Categories.MY_WIDGET) ?.SetVisibilityBinding(myVisibility) .AddCustomMarker("Label:", myBinding); ``` `TryAddWidget` returns `null` when debug is disabled (`NullDebugContainerBuilder`), so the `?.` chain is essential — never remove it. #### Available Builder Methods Read `BuilderExtensions.cs` for the full list. The most common: | Method | Use Case | |--------|----------| | `AddCustomMarker(string label, ElementBinding)` | Live text with optional rich text color tags | | `AddMarker(string label, ElementBinding, Unit)` | Formatted numeric (time ns, bytes, bits) | | `AddToggleField(string label, EventCallback, bool)` | Toggle a runtime setting | | `AddSingleButton(string text, Action)` | Trigger an action | | `AddFloatSliderField(string, ElementBinding, min, max)` | Tune a float parameter | | `AddIntSliderField(string, ElementBinding, min, max)` | Tune an int parameter | | `AddControlWithLabel(string, IDebugElementDef?, DebugHintDef?)` | Custom left-label + right-element row | | `AddControl(new DebugLineChartDef(...), null)` | Full-width sparkline chart (auto-scaled, `LineChartBuffer` ring binding, current value formatted via `DebugLongMarkerDef.Unit`) | For the complete element definition types, check the `Declarations/` folder — one `Debug*Def.cs` per element kind. Line charts in particular: see `DebugLineChartDef` / `DebugLineChartElement` and use `ElementBinding` with a reused `float[]` ring (re-pushing the same backing array each frame is allocation-free). ### Step 4: Wire IDebugContainerBuilder Through DI `IDebugContainerBuilder` is a global resource on `StaticContainer`. It does **not** flow through `InjectToWorld`'s shared dependencies. You must pass it explicitly: 1. **Add it to your plugin's constructor:** ```csharp public MyPlugin(..., IDebugContainerBuilder debugBuilder) { this.debugBuilder = debugBuilder; } ``` 2. **Pass it in StaticContainer where the plugin is instantiated** (search for your plugin name in `StaticContainer.cs`, usually in the `ECSWorldPlugins` array): ```csharp new MyPlugin(..., container.DebugContainerBuilder), ``` If using Pattern A (system creates widget), add `IDebugContainerBuilder` as a constructor parameter on the system. The source generator will include it in the generated `InjectToWorld` method. Then pass it from the plugin's `InjectToWorld`: ```csharp MyDebugSystem.InjectToWorld(ref builder, debugBuilder); ``` ### Step 5: Update Bindings at Runtime In your system's `Update()`, write values to bindings behind a visibility guard: ```csharp protected override void Update(float t) { // ... compute your values ... if (visibilityBinding.IsExpanded) { string color = currentValue >= threshold ? "red" : "green"; myBinding.Value = $"{currentValue} / {threshold}"; } } ``` The visibility guard skips string formatting when the widget is collapsed or the debug panel is closed. This matters because `Update()` runs every frame across multiple worlds. ### Step 6: Required Usings ```csharp using DCL.DebugUtilities; using DCL.DebugUtilities.UIBindings; ``` Both namespaces live in the `DebugUtilities` assembly (`GUID:4725c02394ab4ce19f889e4e8001f989`). The `DCL.Plugins` assembly already references it, so any code compiled into that assembly (including `.asmref` files pointing to `DCL.Plugins`) can use these without asmdef changes. If your system lives in a different assembly, add the GUID to that assembly's references. --- ## Performance Rules 1. **Always guard with `visibilityBinding.IsExpanded`** before updating bindings. String interpolation and `$""` formatting allocate — skip them when nobody is looking. 2. **Use `IsExpanded`** (not `IsConnectedAndExpanded`) unless the widget creation was conditional and the binding might not be connected. 3. **No LINQ** in Update — standard ECS performance constraint applies here too. 4. **Binding.Value set is lazy** — it marks a dirty flag and the UI picks it up on the next UIElements binding pass. No need to call `.SetAndUpdate()` from a system's `Update()` — that's for one-shot updates outside the frame loop. --- ## Colored Status Indicators The established pattern for budget/threshold indicators uses Unity rich text: ```csharp // Two-state: green/red string color = value >= limit ? "red" : "green"; binding.Value = $"{value} / {limit}"; // Three-state: green/yellow/red (see DebugViewProfilingSystem for FPS example) string color = value >= high ? "green" : value >= low ? "yellow" : "red"; ``` This works because `AddCustomMarker` renders `ElementBinding` through a label that supports rich text tags. --- ## Panel Layout States The container has three runtime states; widgets must render correctly in all three. The state is driven entirely by USS classes on `#Panel` — never hardcode pixel dimensions in widget UXML/USS. | State | USS class on `#Panel` | Trigger | What changes | |---|---|---|---| | Minimized (default) | (none) | Initial state, or close→reopen with maximized pref off | `width: 300px`, `max-height: 500px` | | Maximized | `debug-panel--maximized` | User clicks the square header button (between title and ✖) | `width: 450px` baseline, `max-height: 90%`, top margin clears the connection panel; non-header text +30%; chart plot height +50%; `DebugControl` columns shift to 65/35 with label wrapping enabled; left-edge resize handle becomes visible | | Wide | `debug-panel--maximized debug-panel--wide` | Drag width past `2 × baselineMaximizedWidth` | `#Parent` switches to `flex-direction: row; flex-wrap: wrap;` with each `DebugWidget` at `width: 50%`. Resize is clamped to `Screen.width * 0.7`. | Persisted state lives in `DCLPrefKeys.DEBUG_PANEL_MAXIMIZED` (bool) and `DEBUG_PANEL_MAXIMIZED_WIDTH` (float). The baseline width is read at runtime from `mainPanel.resolvedStyle.width` after the maximized class is applied — don't duplicate that 450 px constant in C#. **Implications when adding a widget:** - Use percent or `flex` layouts, not fixed `width: NNNpx`. Existing elements all stretch via `align-self: stretch` or percent flex-basis — match that. - Don't hardcode font sizes on text labels you create — inherit from `.unity-text-element` (12 px → 16 px when maximized via the `.debug-panel--maximized .unity-text-element` rule). - If your widget contains a category foldout, use class `debug-text--header` so it stays readable at 12 px in maximized mode (the rule re-pins headers). - A widget should look reasonable at 300, 450, 600, and 900+ px panel widths. --- ## Reference Implementations When in doubt, read these existing implementations: | Pattern | File | What it shows | |---------|------|---------------| | A (system-direct) | `PerformanceAndDiagnostics/Profiling/ECS/DebugViewProfilingSystem.cs` | Multiple widgets, visibility guards, colored markers, sliders, toggles | | A (system-direct) | `Rendering/GPUInstancing/Systems/DebugGPUInstancingSystem.cs` | Toggle + slider, settings sync, cleanup on dispose | | B (plugin-creates) | `PluginSystem/World/ParticleSystemPlugin.cs` + `SDKComponents/ParticleSystem/Systems/ParticleSystemBudgetSystem.cs` | Plugin creates bindings in InitializeAsync, system writes them | | C (helper class) | `Multiplayer/Connections/Systems/Debug/DebugWidgetRoomDisplay.cs` | Non-system class, decorator pattern, multiple widget instances | | Charts + appended widget | `PerformanceAndDiagnostics/Profiling/ECS/DebugViewCurrentSceneSystem.cs` | `DebugLineChartDef`/`LineChartBuffer` usage, appending rows to an existing category, gating Update on `widgetEnabled` (skip all work when `TryAddWidget` returned null), reactive subscription to `IScenesCache.CurrentScene` | --- Source attribution: decentraland Original project: https://github.com/decentraland/unity-explorer/blob/9a03ce0931a819ca98557660d4d7531009ce100c/.claude/skills/debug-widget/SKILL.md License: Apache-2.0 License information: https://www.apache.org/licenses/LICENSE-2.0 Original upstream instructions; downloaded from Mega AI Hub. ## Upstream license notice Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. # Mega AI Hub resource metadata Creator / publisher: decentraland Original project: https://github.com/decentraland/unity-explorer/blob/9a03ce0931a819ca98557660d4d7531009ce100c/.claude/skills/debug-widget/SKILL.md Attribution basis: Source repository record Fields of work: Development & Engineering Roles: Backend Developer, DevOps / SRE, Full-Stack Developer Specialties: API, Frontend, Mobile, React Tools: Debug Container Country applicability: Country not specified Classification basis: Source catalog labels Instruction SHA-256: acd49245f96d25d63d501c6e4f7867b6775104b594d4d23420a089ecfab350e3