Common UI Integration - NEW V 4.3
ACF uses Common UI with the Ascent UI Navigation System (ANS). Menus, HUD, and popups are pushed onto layer stacks managed by UANSUIPlayerSubsystem. Which widget opens on which layer is defined in the Widget Registry data asset.
Flow: Layers already in ANS_DefaultHUD_WBP → duplicate Widget Registry → map widgets to layers → open pages via SpawnWidgetByTag
You don't create layers from scratch. In the sample project,
ANS_DefaultHUD_WBPalready contains threeCommonActivatableWidgetStackwidgets and callsRegisterLayerfor each on Construct. Duplicate the HUD only if you need a custom layout — don't rip out the existing stacks.
Never edit sample assets directly. Duplicate
DA_ACFWidgetRegistryinto yourContent/YourGame/folder.
Before you start
Three pieces work together:
ANS_DefaultHUD_WBP— hosts the layer stacks and registers them with the subsystem. Already done in the sample.DA_ACFWidgetRegistry— mapsUI.Widget.*tags → widget class, target layer, pause, input lock. Also defines layer visibility rules (e.g. hide HUD when a menu opens).UANSUIPlayerSubsystem— game instance subsystem that pushes widgets onto the correct stack, handles pause/input lock, and layer show/hide.
Built-in layer tags (registered in the sample HUD):
UI.Layer.HUD → persistent overlays (compass, bars, prompts)
UI.Layer.Default → full-screen menus and pages (inventory, dialogue, pause)
UI.Layer.Popup → modals and popups on topBuilt-in widget tags (examples — full list in ANSUINavigationTags.h):
UI.Widget.InGameMenu, UI.Widget.PauseMenu, UI.Widget.DialogueWidget,
UI.Widget.ChestWidget, UI.Widget.Vendor, UI.Widget.HUD, ...Step 1 — The HUD layers (already set up)
Open ANS_DefaultHUD_WBP under /AscentCombatFramework/UITools/ (Content Browser).
The sample HUD already has:
Three
CommonActivatableWidgetStackwidgets in the widget tree (HUD / Default / Popup)On Construct: gets
ANS UI Player Subsystem→ callsRegister Layerfor each stack with the matchingUI.Layer.*tag
You do not need to add stacks or wire RegisterLayer unless you're building a completely custom HUD from scratch.
If you need your own HUD variant:
Duplicate
ANS_DefaultHUD_WBP→ save underContent/YourGame/UI/Keep the three stacks and the Register Layer calls intact
Point your player controller /
AACFHUDHUDClassto your duplicate
The engine uses CommonGameViewportClient (already configured in the sample).
Step 2 — Duplicate the Widget Registry
Content Browser →
/Game/FullSample/Integrations/Ultimate/UI/DA_ACFWidgetRegistryDuplicate (Ctrl+D) → save as e.g.
Content/YourGame/UI/DA_ACFWidgetRegistryOpen your copy — this is where you configure widgets and layer rules
The sample registry already maps tags like UI.Widget.PauseMenu → widget class, layer, pause flags. Use it as reference.
Step 3 — Assign your copy in Project Settings
Edit → Project Settings → Plugins → Ascent UI Settings
Widget Registry Asset → your duplicated
DA_ACFWidgetRegistryDefault Layer Tag →
UI.Layer.Default(must match a layer registered in your HUD)
Sample already points to the original — switch it to your copy after duplicating.
Step 4 — Configure the Widget Registry
Open your duplicated DA_ACFWidgetRegistry.
Widgets (category Widgets)
Each entry is a UI.Widget.* tag → FANSWidgetConfig:
Widget Class — must inherit
UCommonActivatableWidget(typicallyANSNavPageWidgetfor menus)Layer Tag — which stack to push onto (
UI.Layer.Default,UI.Layer.Popup, etc.). Empty = default layer.Pause Game — pause the game while open (menus:
true, HUD:false)Lock Game Input — UI-only input while open (menus:
true, HUD:false)
Example: a pause menu entry might use UI.Layer.Default, pause true, lock input true. A HUD overlay uses UI.Layer.HUD, both false.
Layers (category Layers)
Each entry is a UI.Layer.* tag → FANSUILayerConfig:
Hides Layers — when this layer has an active widget, hide the listed layers
Typical sample setup:
UI.Layer.Default → HidesLayers: [UI.Layer.HUD]Opening any Default-layer menu automatically hides the HUD stack until the menu closes.
Step 5 — Create a Nav Page widget
Full-screen menus in ACF are UANSNavPageWidget Blueprints (parent: ANSNavPageWidget).
Duplicate an existing sample page from
/AscentCombatFramework/UITools/(e.g. a menu or inventory page) or create Widget Blueprint → parentANSNavPageWidgetSave under
Content/YourGame/UI/Inside the page:
Add
ANSNavWidgetchildren for focusable items (buttons, list entries)Optional
ANSNavbarWidgetfor bottom action bar (Confirm, Back, etc.)Override
Get Desired Focus Target→ return the first focusableANSNavWidget
Optional: implement
Setup With Actor/Setup With Componentif the page needs context (chest, vendor, NPC)Bind
On Widget Removedfor cleanup when the page is popped (preferred overNativeDestruct)
For modals, parent ANSNavPopUpWidget instead and target UI.Layer.Popup in the registry.
Step 6 — Register your page in the Widget Registry
In your DA_ACFWidgetRegistry copy, add a row under Widgets:
Key: a
UI.Widget.*tag (use an existing one or add a custom tag underUI.Widgetin Gameplay Tags)Widget Class → your Nav Page Blueprint
Layer Tag →
UI.Layer.Default(or Popup for modals)Pause Game / Lock Game Input → usually
truefor menus
No Blueprint references needed at call sites — gameplay code uses the tag.
Step 7 — Open widgets at runtime
From any Blueprint, get the subsystem and spawn by tag:
Get Game Instance → Get Subsystem (ANS UI Player Subsystem)
→ Spawn Widget By Tag (UI.Widget.YourTag)Variants:
Spawn Widget By Tag With Actor— passes an actor to the page'sSetupWithActorSpawn Widget By Tag With Component— passes a component (e.g. storage, interactable)Spawn In Game Widget— push a class directly (bypasses registry; you set layer/pause manually)Go To Previous Widget— pop / back navigation on the current stackRemove In Game Widget— close a specific widget
Category: ANS on UANSUIPlayerSubsystem.
The subsystem reads your registry entry → spawns the class → pushes it onto the correct CommonActivatableWidgetStack → applies pause/input lock → runs layer visibility rules.
How it fits together
ANS_DefaultHUD_WBP (already in sample)
├─ Stack HUD ← RegisterLayer(UI.Layer.HUD)
├─ Stack Default ← RegisterLayer(UI.Layer.Default)
└─ Stack Popup ← RegisterLayer(UI.Layer.Popup)
▲
│ AddWidget()
│
UANSUIPlayerSubsystem ← reads DA_ACFWidgetRegistry
▲
│ SpawnWidgetByTag(UI.Widget.PauseMenu)
│
Your gameplay Blueprint (input, interactable, dialogue, etc.)When a Default-layer page opens, the registry's LayerConfigs can auto-hide HUD. When it closes, HUD comes back. Other stacks' active Nav Pages get navigation suspended while a higher layer is active.
Useful subsystem APIs
Layer control
Set Layer Visibility (LayerTag, bVisible)— show/hide an entire stack (cutscenes, photo mode)Hide All Layers— hide everything temporarily
Input / icons
Get Icon For UI Action,Get Icon For Key— platform prompt icons for navbarTry Get Actions From Key— Common UI input mapping
Navbar
Request Add Navbar Action/Remove/Set— dynamic bottom-bar actionsBroadcast Navbar Action Triggered
Events
On Focus Changed,On Notification Requested, navbar action delegates