๐จ Common UI Foundation Overview
Short Description
The Common UI Foundation is a state-driven UI framework that integrates with CommonUI and the Signal Bridge for reactive, themeable, and cross-platform interfaces.
Long Description
Building modern UIs requires more than just widgets. The Common UI Foundation provides the orchestration layer needed to manage UI states (e.g., "In-Game", "Main Menu", "Inventory"), handle dynamic theming (colors, fonts, sounds), and bridge hardware input to conceptual gameplay actions. It is designed to work seamlessly with Unreal's CommonUI plugin while adding Gorgeous-specific optimizations.
๐ Quick Start for Beginners
Getting your first UI element up and running with the foundation is simple:
- Inherit: Create a new Widget Blueprint and inherit from
UGorgeousCommonWidget. - Bind: In the Class Defaults, set a Binding Tag (e.g.,
UI.Element.PlayerHealth). - Theme: In the Graph, use the On Theme Applied event to set your colors or fonts using values from the
Themedata asset. - Register: In
NativeConstruct, callRegisterWidgeton theUGorgeousUIFoundationSubsystem.
๐ Core Pillars
- Technical Deep-Dive: Architecture, registration flow, and transition lifecycle. [PINNED]
- UI Processors: Flyweight logic and automatic property mapping.
- Subsystem & API: Core manager methods and widget interfaces.
- UI States: Data-driven layout and input management.
- Dynamic Theming: Swap visual and audio styles at runtime.
- Input Bridging: Device-agnostic input mapping.
- Base Widgets: Standardized components for consistent behavior.
๐ค Subsystem Coordination
The UGorgeousUIFoundationSubsystem is the central brain that tracks the active UI state and applies theme updates to registered widgets.
// Push a new UI state
UISubsystem->PushUIState(InGameMenuState);