HUD API reference

This page is a compact API map for common runtime entry points.

Manager access and lifecycle

Main manager classes:

• UPulseGlobalHUDManager
• UPulsePlayerHUDManager

Shared operations from IPulseHUDManagerInterface:

1. InitializeHUD(...)
2. DeinitializeHUD()
3. FindStackContainer(StackTag)
4. PushWidgetToStack(...)
5. PushModal(...)
6. PushSimpleModal(...)
7. PushConfirmModal(...)

Stack tags

Defined in Pulse::HUD::Stack:

Tag	Purpose
Pulse.HUD.Stack.Main	Required core stack in HUD widget
Pulse.HUD.Stack.Notification	Notification stack
Pulse.HUD.Stack.Modal	Modal stack (must use queue container)

Push parameter structs

Struct	Used by	Key fields
FPulseHUDPushParams	PushWidgetToStack	Widget, WidgetClass
FPulseHUDModalPushParams	PushModal	ModalWidget, ModalWidgetClass, style/container/metadata
FPulseHUDSimpleModalPushParams	PushSimpleModal	ModalClass, ModalContent, ModalContentClass
FPulseHUDConfirmModalPushInfo	PushConfirmModal	ModalClass, confirm/cancel text/content/button overrides
FPulseHUDModalPushBase	shared modal push base	ModalStyle, ModalContainerClass, ModalMetadata

Blueprint helpers (UPulseHUDHelpers)

Useful helper methods:

1. IsValidHUDHandle(...)
2. HUDHandleToString(...)
3. GetHUDFromWidget(...)
4. GetTypedParent(...)
5. CreateModalMetadata(...)
6. ReleaseModalMetadata(...)
7. MakeSimpleModalPushParamsByInstance(...)
8. MakeSimpleModalPushParamsByClass(...)

Input manager API (UPulsePlayerInputManager)

Function	Purpose
AddInputContext(Context, Priority)	Applies a prioritized input context and returns a handle
RemoveInputContext(Handle)	Removes one context and reapplies resolved input state

Interaction-to-HUD bridge

For interaction prompt UI, use:

• UMVVMPulseInteract

Primary fields:

1. InteractAbility
2. SelectedInteractable
3. bIsInteracting
4. FocusedInteractables (optional full list mode)

Primary read methods:

• GetInteractTime()
• GetSelectedInteractableActor()
• GetSelectedInteractableComponent()
• HasSelectedInteractable()