You are viewing documentation for v1.1. Switch to current version โ†’

๐ŸŽจ 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:

  1. Inherit: Create a new Widget Blueprint and inherit from UGorgeousCommonWidget.
  2. Bind: In the Class Defaults, set a Binding Tag (e.g., UI.Element.PlayerHealth).
  3. Theme: In the Graph, use the On Theme Applied event to set your colors or fonts using values from the Theme data asset.
  4. Register: In NativeConstruct, call RegisterWidget on the UGorgeousUIFoundationSubsystem.

๐Ÿš€ Core Pillars

๐Ÿค 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);