|
Window Framework for UI Toolkit v2.0.x
|
See what the running windowing system actually knows before changing its configuration.
The Controller Debugger is an Editor-only diagnostic window. It shows the current controller singleton, selected built-in/baseline theme, preferences and registered WindowFrame instances. Search the list, inspect a window's state and geometry, and use the existing controller actions when you intentionally want to change something.
It is not a second controller, an end-user theme editor, a profiler, or part of the standalone demo's runtime UI.
Choose Tools > Garage-Ware Games > Window Framework > Controller Debug Window.
The window opens as Controller Debugger. Its mode badge reports PLAY MODE or EDIT MODE, and its controller badge indicates whether the singleton is available.
CONTROLLER NOT FOUND** is a useful state, not proof that the debugger itself is broken. The tool queries WindowFrameController.Instance; an inactive, not-yet-initialized, or absent host is not a live singleton. It does not create a replacement controller or infer one from every object with that component.
Turn Auto-Refresh off when you want a stable displayed snapshot while inspecting it, then request another refresh when needed. This does not pause the game or freeze the actual window state.
The window count is the controller's registered collection count, not a count of only search results. No Windows Match Filter means the current filter found none; clear the filter before diagnosing missing registration.
Refresh rebuilds the diagnostic cards. Throttling reduces how often that work happens; it is not a measured zero-allocation or zero-overhead guarantee.
The current system grid includes:
Tooltip/menu values are read from their current preference keys with the linked ThemeData defaults as fallback. Those preferences can differ from the author's baseline values. They are displayed here, not edited as a general property grid.
Active Theme refers to the built-in/baseline collection state. It is not a complete imported player-theme catalog or the player's stable identity. For editing/default/active roles see 3. Editing, Active, and Default Are Different; for player identities and issues see Player Themes.
The list uses the controller's ActiveWindowFrames collection. Despite the section's Active Windows name, a card can be INACTIVE: registered instances are not necessarily focused, visible or on-screen.
Each card shows:
Capability chips report the configured properties, not a complete effective-permission evaluation. Locked/fullscreen state, other flags, parent layout and application behavior can still affect interaction.
Resolved geometry needs real layout. Creation-time defaults, minimums and current size are different values; a number in the grid is not necessarily a screen-space/world-coordinate position. Use 4. Choose Size and Starting Position to understand ownership and timing.
Empty IDs appear as N/A. Memory requires eligible concrete application windows and appropriate stable IDs, not just setting a checkbox. The controller and per-window memory policies both matter; see 9. Remember Window Layouts.
Use inspection first, then the action that matches your intention. See 5. Set Window Permissions and 8. Show, Hide, Activate, and Close for actual window policy and cleanup.
Ping Controller** highlights/selects the singleton's GameObject; when none exists, it reports that instead of creating one.
Open Settings Window** uses the existing framework settings presentation. It is an action on your running UI, not a settings page embedded within the debugger.
Reopen Windows** invokes the existing saved-window reconstruction path. It depends on eligible records, resolvable types and supported construction; it is not a general command to rebuild every custom interface or recover application document data. Review 9. Remember Window Layouts before using it repeatedly.
Apply Tooltips** installs the existing tooltip behavior on eligible framework content. It does not manufacture tooltip text or replace application ownership of dynamically added content. See 1. Add Contextual Help With Tooltips.
Theme Manager** opens/focuses the existing authoring manager. Use that interface for project/theme/default/application-sheet configuration, as described in Theme Studio and Manager and Stylesheet Setup and Theme Structure.
Clear Preferences** asks for confirmation, then calls the controller's existing preference-clearing path and refreshes the display. Cancel leaves the operation unrequested.
Use it only when deliberately resetting the relevant WindowFramework preferences. It is not a fix for missing references, invalid player JSON, broken imports, or an unsupported selector. It does not authorize deleting theme assets/player folders or changing controller MemoryEnabled.
Keep evidence of your existing configuration before a reset, and understand which defaults will be used afterward. For diagnosis, start with Troubleshooting rather than clearing state to make a warning disappear.
The system grid reports whether the telemetry feature symbol is defined and whether the current controller toggle also indicates logging enabled. The current EMITTING/OFF display uses those conditions; actual output still depends on the instrumented operation and channel configuration.
Enable Telemetry Symbol / Disable Telemetry Symbol** changes the relevant feature define through the existing Editor configuration action. This is a project/build-setting change and can cause recompilation. It is not the Auto-Refresh toggle and is not a switch for all logging in Unity.
The controller's DebugTelemetryEnabled and selected channels govern the supported runtime diagnostic output. Disabled telemetry is not an unconditional guarantee that every API call, argument evaluation or diagnostic cost disappears.
Do not enable unrelated experimental/compatibility symbols to force the asset into an unsupported Unity/package version. This page documents the existing diagnostic feature; it does not change defines or enable telemetry for you.
Do not infer that an empty list means a missing stylesheet, or that a theme mismatch is a window-memory failure. Each diagnostic describes a particular part of the configuration.
If the displayed state and documented checks do not explain the problem, collect a focused report using If the Checks Do Not Explain the Problem. Continue to Troubleshooting for symptom-based guidance, or Windows and Layout, Theme Studio and Manager and Player Themes for the owning workflows.