|
Window Framework for UI Toolkit v2.0.x
|
| NGWG | Garage-Ware Games namespace root. Groups the namespaces used by this package. Namespace qualification distinguishes type names; it does not by itself guarantee dependency isolation or compatibility with other packages |
| NExtensions | Shared UI Toolkit utility controls supplied with the package. Includes SlideToggleControl and editor-only texture preview/sample asset types. These provide controls, not automatic documentation generation. SlideToggleControl is used by framework settings; editor texture tools remain behind the editor assembly boundary. See wfw_utilities_experimental and wfw_editor_uibuilder |
| CSlideToggleControl | Represents a custom UI component that functions as a toggle control with sliding animation. Original file from the Unity documentation with only minor compatability modifications made |
| CTextureAsset | Editor sample ScriptableObject containing one borrowed project texture reference |
| CTextureAssetEditor | Sample UI Toolkit inspector cloning an assigned texture-asset UXML tree |
| CTexturePreviewElement | Editor-only bindable Texture2D picker with an image preview |
| NWindowFramework | Core WindowFramework controls, controller and configuration/data APIs. Contains WindowFrame, cards/modal presentation, tooltip/context-menu controls, theme data, persistence records and supporting utilities. Managed runtime windows use the UIDocument linked to the configured WindowFrameController. Application content, input arbitration and business data remain consumer-owned. See wfw_installation and wfw_window_lifetime |
| NDemo | Demonstration windows, page data, tutorial launchers and appearance extensions. Examples illustrate integration and retain documented sample limitations. They are not production inventory, gameplay hotbar, authentication or input-management systems. See wfw_demo_integration and wfw_demo_bootstrap |
| CDemoControl | DemoControl is a MonoBehaviour class used exclusively for the demo scene of the Window Framework. It demonstrates the initialization and usage of various window types, including the startup menu, demo control window, and escape menu functionality |
| CDemoControlWindow | DemoControlWindow is a demonstration class for the Window Framework. It creates a control panel window that showcases the framework's capabilities, such as opening example windows, managing window memory, and customizing window properties. This class is intended for demonstration purposes and is not part of a functional game |
| CDemoPageData | Demo-only ScriptableObject holding ordered UXML page references and an optional assigned changelog |
| CDemoPages | Serialized demo menu entry borrowing project icon and UXML assets |
| CEscapeMenuWindow | EscapeMenuWindow is a class that represents a fullscreen escape menu window. It provides options for resuming the game, accessing settings, and quitting the application. Hides header/footer and requests fullscreen. It does not set Locked=true or disable AllowMove/AllowResize in this constructor. Resume and Settings call ordinary CloseWindow with AllowClose=true; this sample is not a gameplay pause/input-blocking service. Quit explicitly stops Editor Play Mode or calls Application.Quit in a player |
| CInventoryWindowExample | InventoryWindowExample is a class that represents a scrollable inventory window. It demonstrates the use of a ScrollView to display a list of simulated inventory slots. This window is designed to showcase the flexibility of the Window Framework |
| CLogViewerContentExample | Example of a log viewer Content Element using the ScrollView component to show a list of text entries To use Content Elements like this in your own code just create a new class that extends the element your want to use (VisualElement, ScrollView, etc.) and then add the content you want to show in the constructor |
| CToolbarWindowExample | This is a simple example of a toolbar window that can be used to show the flexibility of the WindowFramework for UI Toolkit |
| CUXMLBasedDemoWindow | Demo help/content window instantiating VisualTreeAsset pages from DemoPageData |
| NEditor | Editor-only theme authoring, inspectors, debugging and preparation tooling. Includes Theme Manager/Studio, source inspection/preservation, file transactions and preparation lifecycle. Editor selection is distinct from runtime configured selection; UnityEditor-dependent tools are not player controls. See wfw_theme_manager and wfw_source_authoring_api |
| CDeveloperThemeMappingCompiler | Reads player-setting metadata and supported variable mappings from the configured source order |
| CDeclaration | |
| CValue | |
| CPlayerThemeIdentityUtility | Assigns missing built-in IDs explicitly to a selected theme configuration asset |
| CThemeFolderAssetService | Editor-only copying of theme source folders and their appearance assets |
| CThemeListView | Represents a custom UI element for managing and displaying a list of themes in the Unity Editor. This class extends the VisualElement class and provides functionality to display and manage themes defined in WindowFrameThemeData |
| CThemeManagerWindow | Represents a custom editor window in Unity, used for managing themes within the Window Framework |
| CThemePreparationLifecycle | Maintains freshness of derived portable values in opted-in theme configurations |
| CThemePreparationService | Read-only preparation of supported shipped 2.0 root values |
| CThemeRepositoryAssetService | Complete production repository copy and setup wiring, shared by the eventual UI and regression tests |
| COperation | |
| CScheduledCreation | |
| CThemeRepositoryCreateRequest | Complete input for one production repository copy and setup-wiring operation |
| CThemeRepositoryCreateResult | Validated output of the combined production operation; no automatic Manager or scene selection |
| CThemeRepositorySetupValidation | Read-only preflight checks for the Theme Manager's project repository setup form |
| CThemeRepositorySetupView | Guided setup and explicit validated repository creation inside the existing Theme Manager |
| CThemeSourceFileTransaction | Commits a small set of theme source files with staging and rollback on failure |
| CWrite | Describes one validated write and its expected original contents |
| CThemeSourceGraph | Read-only ordered source graph for preparation of shipped 2.0 theme tokens |
| CScopedDeclaration | |
| CThemeSourceRegions | Defines explicit source ownership for editable USS and TSS theme files |
| CThemeStudioView | Unified commercial-grade WYSIWYG Theme Studio view. Provides a synchronized 3-pane interface: Theme Master List, Design Token Inspector, and Live Preview Canvas. Supports live editing of 2.0 themes and 1-click upgrading of legacy 1.0 themes |
| CThemeAssetTokenRow | Encapsulates a dual-type (Texture2D / VectorImage) asset token field row with Resources/ validation |
| CThemeTokenSourceResolver | Resolves already ordered authoritative root-token declarations for editor preparation |
| CThemeUpgradeConverter | Converts effective 1.0 source declarations using private versioned defaults |
| CResult | Converted source and explicit preservation diagnostics; no files are written |
| CWindowFrameControllerDebugWindow | Modern 2.0 Editor Window for inspecting and diagnosing the runtime state of the WindowFrameController, active window frames, system preferences, and theme bindings |
| CWindowFrameControllerEditor | Custom editor class for the WindowFrameController component, designed using UI Toolkit |
| CWindowFrameThemeDataEditor | Editor inspector launcher for the Theme Manager, not a full configuration property inspector |
| CWindowFrameworkEditorConfigHelper | This class is used to remove the define symbol that enables the Addressables support in the Window Framework when the Addressables package is removed while still having the support enabled |
| NExperimental | Unsupported interaction experiments retained as source examples. Not recommended for production. Click logging, random recoloring and experimental icon reparenting are not validated application actions or inventory-transfer implementations. See wfw_utilities_experimental for known limitations |
| CClickDetector | This is an example of a custom VisualElement that detects click events. Taken from the Unity documentation examples |
| CDoubleClickActivator | Unsupported sample manipulator recoloring its target on a right-button double-click |
| CIconDragger | Experimental icon reparenting manipulator, not a production inventory-transfer API |
| NFormElements | Reusable UI Toolkit settings controls. Contains TooltipSettingsFormElement, ContextMenuSettingsFormElement, ThemeSelectorFormElement and WindowBehaviorSettingsFormElement. UXML registration supports design-time authoring; runtime usage still requires configured controller/theme data and styling. Controls edit preferences/selection, not authored stylesheet palettes. See wfw_settings_forms |
| CContextMenuSettingsFormElement | Represents a user interface element for configuring context menu settings within the window framework. This form element allows customization of various context menu behaviors, such as fade time and delay |
| CThemeSelectorFormElement | Custom UI Toolkit form element displaying an interactive list of registered themes with previews, active indicators, and runtime switching |
| CThemeLineItem | |
| CTooltipSettingsFormElement | Custom UI Toolkit form element for configuring framework tooltip behaviors, delays, and animation styles. Can be dropped into any settings view, inspector, or game options screen |
| CWindowBehaviorSettingsFormElement | Custom UI Toolkit form element for configuring window snapping, docking, and positioning behaviors. Can be dropped into any settings view, inspector, or game options screen |
| NManipulators | Window and content interaction manipulators. Provides dragging, directional resizing, configurable click activation, tooltip and context-menu activation. Each manipulator has specific target, permission and lifecycle requirements; they are not interchangeable on arbitrary visual elements. See wfw_resize_geometry, wfw_tooltips and wfw_context_menus |
| CClickActivatorConfigurable | A configurable mouse manipulator that provides flexible click event handling with customizable activation criteria |
| CContextMenuActivator | A mouse manipulator that enables context menu functionality for any VisualElement in Unity's UI Toolkit |
| CTooltipManipulator | A sophisticated pointer manipulator that manages tooltip behavior for UI elements within the Window Framework |
| CWindowFrameDragger | A mouse manipulator that enables drag-and-move functionality for WindowFrame elements in Unity's UI Toolkit |
| CWindowFrameResizer | A mouse manipulator that provides 8-directional edge and corner resizing functionality for WindowFrame elements in Unity's UI Toolkit |
| NTelemetry | Optional structured framework diagnostics and interaction observation. Emits diagnostic Unity logs with channel filtering and method-specific compilation guards. It is not a remote analytics/backend service or a universal zero-overhead guarantee. See wfw_diagnostics |
| CWindowFrameTelemetry | Static dispatcher for the WindowFramework Debug Telemetry System. Emits structured, machine-readable (AI/LLM-parseable) JSON diagnostic logs without decorative formatting |
| CInteractionObserver | |
| COperationScope | Pairs operation begin and exit even when the caller returns early or throws |
| NTests | |
| NEditor | |
| NControlsData | |
| CControlDefaultsTests | Locks accepted construction defaults of the framework's controls and data types |
| NDemoContent | |
| CDemoContentTests | Locks accepted Demo content: page list, asset references, Custom Controls page and help-menu styling |
| NPlayerThemeCatalog | |
| CPlayerThemeCatalogTests | Locks the accepted portable catalog: every key, token, kind and bound |
| NPlayerThemeFiles | |
| CPlayerThemeExportTests | Locks accepted Copy export: a complete, importable, folder-named theme copy |
| CPlayerThemeManifestTests | Locks accepted theme.json parsing: schema, recovery of invalid values, rejection of unknown keys and unsafe paths |
| CPlayerThemeNamingAndReportTests | Locks accepted portable folder naming and player-facing report redaction |
| NSettingsForms | |
| CSettingsFormsTests | Locks accepted settings-form behavior: preference keys, defaults, clamping and form layout |
| NThemeAssets | |
| CThemeAssetsTests | Locks accepted theme artwork: cursor sets, centered dragline cursors, arrows and image locality |
| NThemePreparation | |
| CThemePreparationTests | Locks accepted theme preparation output for every supplied modern theme |
| NThemeRepository | |
| CThemeRepositoryTests | Locks the accepted shipped repository: identity, stylesheet composition and theme list |
| NThemeStudio | |
| CThemeStudioTests | Locks the accepted Theme Studio form built for the shipped repository |
| NThemeUpgrade | |
| CThemeUpgradeTests | Locks the accepted v1.0 → 2.0 conversion of the supplied legacy template |
| NVisualScripting | |
| CVisualScriptingTests | Locks accepted Visual Scripting node signatures and event names (preview feature) |
| NRuntime | |
| NInteractionsRuntime | |
| CInteractionsRuntimeTests | Locks accepted runtime tooltip, context-menu and modal-queue behavior in the existing Demo scene |
| NShared | |
| CDemoSceneFixture | Base for Play Mode suites that exercise the existing Demo scene at runtime |
| NThemingRuntime | |
| CThemingRuntimeTests | Locks accepted runtime theming in the existing Demo scene |
| NWindowRuntime | |
| CWindowRuntimeTests | Locks accepted runtime window behavior in the existing Demo scene |
| NTheming | Prepared and portable player-theme data, validation and appearance application. Contains configured snapshots, catalog/runtime selection, bounded folder import/export, validation reports, reversible bindings and compiled extension contracts. Player data does not execute loose USS, UXML or code. Borrowed project resources and decoded folder-owned images have distinct lifetimes. See wfw_prepared_theme_workflow, wfw_portable_import_export and wfw_portable_bindings |
| NJson | Framework-owned bounded JSON parser, writer and data nodes. Describes WindowFramework's own implementation, not Unity's internal JSON API or a new network service. Strict parsing and deep-copy access support portable manifests and opaque extension sections without an external serializer dependency. See wfw_extension_data_api |
| CJsonArray | Opaque extension array, preserving order and value types |
| CJsonNode | Framework-owned JSON data node. No code execution, reflection or type activation |
| CJsonObject | Ordered object with ordinal, case-sensitive unique keys |
| CReader | |
| CJsonParseException | Strict syntax error with safe source coordinates, never input payload |
| CJsonProperty | One named object value; obtained from an independently owned object tree |
| CJsonValue | Scalar JSON value. Construction refuses nonfinite numeric output |
| CDeveloperThemeDefinition | Build-prepared developer settings derived from the configured USS graph |
| CRule | One expanded property consumer or competing declaration in source order |
| CSetting | One annotated setting, with a derived default and portable value type |
| CDeveloperThemeSelector | Supported selector matching for application-owned prepared developer mappings |
| CIPlayerThemeAssetExtension | Optional raster-asset capability for compiled purchaser theme extensions |
| CIPlayerThemeExtension | Compiled purchaser-defined handler for one namespaced portable theme section |
| CIPlayerThemeRecoveryExtension | Compiled purchaser-defined handler for one namespaced portable theme section |
| CPlayerThemeButtonBinding | Applies resolved player button tokens to one explicitly owned UI Toolkit button |
| CPlayerThemeCatalog | Owns a bounded discovery snapshot of valid player theme folders |
| CRejectedEntry | One rejected folder and its fatal validation explanation |
| CPlayerThemeExporter | Creates a new independently editable player theme from resolved framework values |
| CPlayerThemeExtensionRegistry | Application-owned registry of compiled portable theme extension handlers |
| CLease | |
| CPlayerThemeFolder | Owns a completely validated manifest and decoded raster assets from one player folder |
| CPlayerThemeManifest | Validated data-only portable manifest with preserved purchaser extension sections |
| CPlayerThemeNaming | Portable Windows-safe theme folder naming shared by UI and direct export callers |
| CPlayerThemeReport | Creates bounded player-facing diagnostics without exposing exception payloads or filesystem paths |
| CPlayerThemeRuntime | Owns a runtime player catalog and selection leases for explicit UI scopes |
| CPlayerThemeScopeBinding | Owns reversible player-theme mappings for a bounded framework visual subtree |
| CPlayerThemeSelection | Resolves stable identity without silently falling back to index zero or a palette |
| CPlayerThemeStateBinding | Applies state-specific surface colours to framework tabs and context-menu rows |
| CPlayerThemeSurfaceBinding | Maps resolved semantic tokens onto one explicitly scoped framework surface |
| CPlayerThemeTokenCatalog | Canonical friendly-key mapping for portable framework theme data |
| CEntry | One friendly key, authoritative token and numeric validation bounds |
| CPlayerThemeValues | Holds resolved player theme values keyed by canonical framework semantic token |
| CPreparedThemeSnapshot | Build-prepared supported values embedded in the existing theme configuration |
| CEntry | One serialized derived catalog value; validation is deferred to TryGetValues |
| CCardElement | A content-sized presentation card with a fixed header/footer and a scrolling body |
| CContextMenuConfig | Configuration class for a runtime context menu |
| CContextMenuItem | Used to define the items that will be displayed in the context menu |
| CExtensions | Visual-tree ancestor lookup and sample placeholder construction utilities |
| CTooltipStrings | TooltipStrings is a static class that provides a collection of constant strings. These strings are used as a tooltip for various UI fields and elements within the window framework editor UI. The tooltips provide a shared location for descriptive information to guide users in understanding the purpose of specific fields or actions without having to clutter the code with reused text |
| CWindowFrame | Represents a customizable window frame for UI elements in Unity. Provides functionality for resizing, moving, locking, and saving window state. Includes support for themes, tooltips, and context menus |
| CWindowFrameContextMenu | A sophisticated context menu implementation for the Window Framework that provides dynamic menu creation with fade animations and intelligent positioning |
| CWindowFrameController | The WindowFrameController is the central management component for the Window Framework system. It serves as a singleton that manages window frames, themes, tooltips, context menus, and persistent data |
| CWindowFrameData | Represents the serializable data structure for storing and loading window frame configuration and state information. This class contains all the essential properties needed to persist window settings between application sessions |
| CWindowFrameDataEntry | Represents a KeyValue-value pair entry for window frame data storage, designed for serialization compatibility |
| CWindowFramePositionDrawer | Editor UI Toolkit nine-position grid for serialized WindowFramePosition values |
| CWindowFrameSettingsView | Represents the settings view for the Window Framework. Provides UI controls for adjusting framework settings such as context menu and tooltip behavior, as well as theme management. This view is designed to be used at runtime and can be extended to suit specific project requirements |
| CWindowFrameTheme | Represents an individual theme definition within the Window Framework. Encapsulates theme metadata, styling stylesheets, and visual preview iconography |
| CWindowFrameThemeData | Represents a theme data asset for configuring and managing window frame themes in the Window Framework system. This class is a ScriptableObject that provides functionality for managing themes, tracking the active theme, and applying changes to the window frame styles |
| CWindowFrameThemeList | Serializable container encapsulating a list of WindowFrameTheme definitions |
| CWindowFrameTooltip | Represents a tooltip element that displays contextual information for UI elements. The tooltip can be styled dynamically based on the current theme and supports fade-in and fade-out animations |
| CWindowFrameworkConstants | Package-level paths, package names, and scripting define symbol constants. Runtime PlayerPrefs keys and framework baseline defaults reside directly on WindowFrameThemeData |
| CWindowFrameworkData | Represents the configuration and runtime data for the Window Framework system, enabling management of UI-related settings such as tooltips, context menus, and theme preferences |
| CWindowModal | Fullscreen blocking surface presenting an ordered queue of content-sized cards |
| CCardEntry | |
| CWindowTabEntry | Represents an individual tab entry within a nested tabbed WindowFrame container |