Modding guide

How to make UI: a HUD element, a menu, and a structure's own screen

11 min readASA DevKit as of November 2026 (UE 5.8.1); ASE where noted

UI in ARK is Unreal's widget system with ARK's own parent classes on top. This page makes a HUD element, a menu from the radial wheel, and a structure's own screen. No video in my library covers this on ASA, so I worked it out from the kit's own widgets.

  • You'll make: a HUD readout, a menu, and a structure screen that talks to the server
  • Time: about an hour for the first menu; an afternoon with gamepad and server tests
  • Level: intermediate (you've made a buff and a structure)
  • You'll need: a registered mod, and a buff or structure to open it from

Three rules before you start

Widgets only exist on clients. A widget is a screen element: text, a button, a panel. A dedicated server has no screen. Modders report that creating a widget there can crash it.

The root widget's parent is Primal UI. That's the one you add to the screen. Its parts, like rows and buttons, use Primal User Widget or a plain User Widget. Vanilla's Fishtank menu follows this split.

Clients can't change the game. A button press reaches the server through an actor the player owns (step 6).

The process

  1. Make the root widget and reparent it to Primal UI. Right-click → User Interface → Widget Blueprint. Then File → Reparent Blueprint.

    Show me how
    • Primal UI is a child of Primal User Widget, then Unreal's User Widget, so every UMG feature still works.
    • Modders report a root widget without Primal UI crashes when added. Primal UI on every child causes trouble too, because each one tries to handle input.
    • ARK's menu switches are on the root element in the Designer, under Details.
    Setting What it does
    Capture Mouse Input (bCaptureMouseInput) Shows the cursor and takes input while open, and gives it back on close. Tick it for menus
    Escape Closes Menu Escape closes the widget
    Close On Player Die Closes it when the player dies
    Is Gameplay UI Vanilla's Fishtank and Medical Stand menus set it. I haven't confirmed what it changes
    Use BP Init For Objects Lets the HUD's Show UI Scene node pass objects to it (step 5)
    Force Virtual Cursor Enabled Gives gamepad and console players a cursor while it's open. Without it they can't click anything in your menu. Tick it for menus
    Force HUD Hidden Hides the HUD while it's open
  2. Lay it out with anchors, not fixed positions. Anchor each panel to its corner or edge. Then test at two screen sizes.

    Show me how
    • Canvas Panel at the root, then anchor each child. Alignment 0.5, 0.5 centers a panel on its anchor.
    • Switch the Designer's Screen Size between 1080p, 1440p and ultrawide. Modders found widgets placed with Set Anchors or raw positions ran off screen above 1080p in the live game.
    • A Scale Box around the main panel keeps its proportions. One modder still saw it miss the edges on ultrawide, so anchor HUD pieces to the screen edges instead.
    • Primal UI also has its own scaling switches, Scale Screen Resolution and Ignore UI Scaling. Vanilla HUDs add themselves with BP Process Splitscreen And Add To Viewport, which takes a Z-order. I haven't confirmed what each switch changes, so test with the game's UI scale slider.
  3. For a HUD element, create it from a buff on the player. A default buff reaches every player. The buff creates the widget on its owner's client only.

    Show me how
    • Register the buff in the Mod Data Asset's Additional Default Buffs for the player pawn (How to make a buff).
    • In the buff's Begin Play: Is Owning Client → Branch. Only the owner continues, so nearby players don't each create a copy.
    • Get Owner Controller → Create Widget with that controller as Owning Player → Add to Viewport. Don't use Get Player Controller with index 0; on a listen host it returns the host.
    • After a restart the owner's controller can be None for a moment. Retry on a short timer.
    • A HUD element shouldn't take input. Leave Capture Mouse Input off and set the root to Not Hit-Testable.
    • Remove it when the buff ends. Keep a reference so you never add it twice.
    • For simple text or bars, override the buff's BP Draw Buff Status HUD or BP Get HUD Elements instead. Modders report those only draw while the buff's icon is visible.
    • For a world-wide display, a replicated singleton can add the widget on each client.
  4. For a menu, open it from a multi-use entry on the client side. Add the entry in Get Multi Use Entries. Create the widget in Client Do Multi Use.

    Show me how
    • Make Multi Use Entry: a Use Index that's large and odd, like 73591, so you don't clash with vanilla or other mods. Tick Client Side Only (bClientSideOnly) for an entry that only opens UI. Modders found Client Do Multi Use never fired without it.
    • Return the array with your entry in it. An empty return shows nothing.
    • BP Try Multi Use runs on the server. Never create a widget there.
    • In BP Client Do Multi Use: Switch on Int on the use index → Create Widget → Add to Viewport. Use the For PC input as the Owning Player.
    • Inside the widget, a Close button calls Close With Animation. That's what the vanilla Piano, Fishtank and Medical Stand menus call.
    • For a player menu with no structure, put the entries on a default buff. Tick the buff's Allow Multi Use Entries From Self (bAllowMultiUseEntriesFromSelf) and BP Add Multi Use Entries. Then the entry appears in the player's own wheel. My multi-use video covers both (see Watch).
  5. For a structure's screen, pass the structure into the widget. Add an exposed variable for it. Fill it when you create the widget.

    Show me how
    • In the widget, add a variable of your structure's type. Tick Instance Editable and Expose on Spawn. It appears as a pin on Create Widget; plug in self from the structure.
    • Vanilla's Saloon Piano builds its menu this way, in Client Do Multi Use.
    • A second route: Get Shooter HUD → BP Show UI Scene. It takes the widget class, two objects and two numbers. The widget receives them in BP Init For Objects if Use BP Init For Objects is on. I haven't tested this route on a mod structure.
    • Storage structures also have a UI Scene Template. The Cooking Pot and Tinkering Desk fill it with native screens; whether a custom Primal UI works there is unconfirmed.
    • Call Force HUD Hidden while it's open, as the Fishtank does, and undo it on close.
  6. Send the player's choice to the server through something the player owns. The widget can't call the server itself. Use the player's buff or a net exec command.

    Show me how
    • Through the buff: Give the widget an exposed reference to the buff that opened it, and pass self. The button calls a Run on Server event on the buff. The player owns their buff, so it arrives.
    • Through the controller (net exec): The button calls Client Send Net Exec Command To Server on the owning player, with the structure as the target. The structure handles it in BP Server Handle Net Exec Command, as the vanilla Piano does.
    • The server can reply the same way. The Fishtank handles BP Client Handle Net Exec Command.
    • A Run on Server event on the structure never fires: the client doesn't own it (Works in PIE, not on a server).
    • Check everything again on the server: distance, tribe, admin, cost. A client can send any values.
  7. Close it cleanly and support gamepads. Let Capture Mouse Input restore input. Toggle the virtual cursor when the gamepad state changes.

    Show me how
    • With Capture Mouse Input on, don't also call Set Input Mode or Show Mouse Cursor. Mixing them is the usual cause of stuck input.
    • If you must set input yourself, undo all of it on close: Set Input Mode Game Only, hide the cursor, flush input. Vanilla's remote camera does UI Only on open and Game Only on close.
    • Gamepad: override On Gamepad Active Changed BP. Branch on the active flag into Enable Virtual Cursor or Disable Virtual Cursor on the owning player. Without it, console players get stuck.
    • Turn the virtual cursor off as the menu closes. One modder's gamepad camera stared at the floor until they did.
    • Clean up in Removed From Viewport: clear references, undo Force HUD Hidden. Escape fires it. Remove From Parent is fine for child widgets.

Keep widgets cheap

This is Unreal's general advice from Epic's own talks. It applies to ARK's widgets unchanged, but I haven't measured it in the kit.

  • Avoid property bindings for HUD values. A bound text or progress bar re-runs its function every frame while the widget is on screen. Set the value from an event when it changes, or from a slow timer.
  • Bind to an event only once. Event Construct runs every time the widget is added to the screen. A bind made there stacks each time the menu reopens, so the event fires twice, then three times. Bind on the first open, or unbind in Destruct.
  • Collapsed, not Hidden: A Hidden widget still takes part in layout, children included. Collapsed skips it.
  • Not Hit-Testable (Self & All Children) on everything nobody clicks: text, images, frames.
  • Delete an Event Tick you don't use. A widget that implements Tick ticks every frame, even with nothing connected.
  • One Canvas Panel, at the root: Nested canvas panels cost more than Overlays and boxes; use those inside it. Child widgets you add into a menu shouldn't start with their own canvas.
  • Create widgets when they open, not up front. In Epic's 5.8 profiling talk, a game that pre-built every structure's menu had half its 761,000 objects in UI.
  • Few 3D widget components: Each one ticks and redraws; 2,800 of them took 3.6 s to set up. Use Niagara for floating damage numbers.

How the pieces connect

This Field or call Points at
Mod Data Asset Additional Default Buffs your buff
Buff or structure BP Client Do Multi Use your Primal UI widget
Your widget an exposed variable the buff or structure
Your widget a buff event or a net exec command the server

Everything else hangs off those four links.

The settings that matter

What you want Where
Cursor and input while open Capture Mouse Input
A cursor for gamepad and console players Force Virtual Cursor Enabled
Close on Escape or death Escape Closes Menu, Close On Player Die
Objects passed in when it opens Use BP Init For Objects
The HUD out of the way Force HUD Hidden
A multi-use entry that only opens UI Client Side Only, on the entry

All but the last are on the root widget; step 1's table says what each does.

Common mistakes

My widget never shows

You created it in Try Multi Use, which runs on the server. Or the entry array isn't returned, or the entry isn't Client Side Only (step 4).

It works in the DevKit but not in the live game

PIE runs server and client in one process. Server-side widget code still draws there. Create widgets only where Is Owning Client or Can Run Cosmetic Events is true.

It shows for the host only

You used Get Player Controller 0, or a client event on an actor nobody owns. Both land on the host. Use the For PC pin or the buff's owner controller.

Every player sees my HUD, or it appears twice

Each nearby client has a copy of the player's buff. Branch on Is Owning Client. Keep a reference so a second Begin Play doesn't add another (How to make a buff).

Input is stuck after I close my menu

You set the input mode or cursor yourself. Use Capture Mouse Input instead, or restore Game Only on close (step 7).

Console players can't leave my menu

There's no virtual cursor. Add the gamepad branch in step 7.

My menu stops working after the player hides the HUD

Modders report that hiding and showing the HUD breaks a menu opened from the wheel. Force the HUD hidden while your menu is open.

The DevKit crashed when I stopped PIE

A widget with a virtual cursor was still open. Close your menu before you stop PIE.

The E key stopped working

An input node in a buff consumes the Use key. Use the widget's key events instead (lessons §8).

Check it worked

  1. In PIE as two clients, the menu opens only for the player who used it.
  2. A button changes something on the server, and the other client sees it.
  3. After closing, the player can move, look and open their inventory.
  4. With a gamepad, the cursor moves and the menu closes.
  5. On a local dedicated server, the HUD element returns after a respawn (Testing your mod).

Watch

Go deeper

Sources

Where this page's information comes from

Applies to: ASA DevKit as of November 2026 (UE 5.8.1); ASE where noted

the DevKit's own classes and vanilla widgets, the community Discord and creators' videos (see Sources)

Esc

↑ ↓ move↵ openCtrl ↵ new tab