HUD API reference
Compact map of the runtime entry points of PulseHUD. See HUD system for how they work together.
Access
| C++ | Blueprint |
|---|---|
UPulseHUDSubsystem::Get(LocalPlayer) / Get(PlayerController) | Get HUD Subsystem (PlayerController) or Get Local Player Subsystem |
Pulse::UI::GetPlayerInputManager(PlayerController / LocalPlayer / World) (PulseFoundationUI) | Get Player Input Manager (PlayerController) |
Pulse::HUD::GetSettings() | — |
UPulseHUDSubsystem
| Area | Functions / events |
|---|---|
| HUD | GetHUDLayout, AddHUDHideRequest, RemoveHUDHideRequest, IsHUDHidden, OnHUDCreated / OnHUDCreatedNative, OnHUDHiddenChanged |
| Stacks | FindStack, PushWidgetToStack, PushWidgetToStack<T>(Tag, Class, InitFunc), PopStack, ClearStack |
| Modals | PushModal(Request), PushModal(Request, OnClosed), CloseAllModals, GetNumOpenModals |
| Compass | GetCompass (compass only markers: AddMarker, UpdateMarker, RemoveMarker, RemoveMarkersForActor of the compass), SetCompassVisible |
| Markers (compass, screen) | Shown from the marker registry of PulseFoundation (UPulseUIMarkerSubsystem: AddMarker, UpdateMarker, RemoveMarker, GetMarkerRecords, OnMarkerChanged); the HUD has GetWorldMarkerLayer |
| Tooltips | ShowTooltip(Data, Anchor, bFollowMouse, Delay), HideTooltip(Anchor) |
| Highlight | ShowHighlight(Target, Duration) → Handle, ClearHighlight(Handle) |
| Progress | PushProgress(Request), PushProgress(Request, OnCancelled) (C++), UpdateProgress(Handle, Progress, Text), PopProgress(Handle), HasProgress(Handle), OnProgressCancelled / OnProgressCancelledNative |
| Subtitles, hints | PushSubtitle(Speaker, Text, Duration), ShowHint(Hint), HasSeenHint, ResetSeenHints, SetHintStorage, GetHintStorage |
| Context menu | ShowContextMenu(Actions, Placement, OnClosed) (C++) |
| Notifications | PushNotification, DismissNotification, HasNotification |
UPulseHUDLibrary
GetHUDSubsystem, GetPlayerInputManager, PushWidgetToStack, PushModal, MakeConfirmModalRequest, MakeMessageModalRequest, GetModalConfirmResult, GetModalCancelResult, PushNotification, PushSubtitle, ShowHint, PushProgress, UpdateProgress, PopProgress, MakeContextMenuRequest, AddHUDHideRequest, RemoveHUDHideRequest. All take the (local) player controller (except the request makers).
Input contexts
FPulseInputContext, EPulseInputMode, EPulseShowMouseCursorMode, UPulsePlayerInputManager, IPulsePlayerInputManagerOwner and the input settings are part of PulseFoundation (module PulseFoundationUI, headers PulseUIInputTypes.h and PulsePlayerInputManager.h); their API is in the API reference of Pulse Foundation. Input context handles are FPulseHandle. UPulseHUDPresenter adds the input context of a layer with ApplyLayerInput after it pushed or found the widget.
Async nodes
| Node | Pins |
|---|---|
| Show Modal And Wait (PlayerController, Request) | OnClosed, OnConfirmed, OnCancelled, OnFailed (Modal, Result) |
| Wait For Modal Closed (Modal) | same |
| Push Widget To Stack Async (PlayerController, StackName, WidgetClass, bSuspendInputUntilComplete) | BeforePush, AfterPush, OnFailed (Widget) |
Gameplay tags
| Tag | C++ |
|---|---|
Pulse.HUD.Stack.Main | Pulse::HUD::Stack::Stack_Main |
Pulse.HUD.Stack.Modal | Pulse::HUD::Stack::Stack_Modal |
Pulse.HUD.Stack.Overlay | Pulse::HUD::Stack::Stack_Overlay |
Pulse.HUD.Notification.Default | Pulse::HUD::Notification::Area_Default |
Pulse.HUD.Notification.Subtitle | Pulse::HUD::Notification::Area_Subtitle |
Pulse.HUD.Notification.Hint | Pulse::HUD::Notification::Area_Hint |
Modal results: Pulse::HUD::Modal::Result_Confirm (Confirm), Pulse::HUD::Modal::Result_Cancel (Cancel).
Structs
| Struct | Purpose |
|---|---|
FPulseHUDModalRequest | Modal to show (MakeMessage, MakeConfirm, MakeContextMenu). |
FPulseHUDModalAction | Button of a modal. EPulseHUDModalActionRole: Confirm, Cancel, Neutral. |
FPulseHUDMarkerPresentation | Widget classes of a marker (CompassMarkerClass, WorldMarkerClass): as the presentation of a marker of the registry or per kind in FPulseHUDStyle::MarkerPresentationsByKind. The marker data (FPulseUIMarkerData), records (FPulseUIMarkerRecord), channels (EPulseUIMarkerChannels: Compass, Screen, Map) and distance units (EPulseUIDistanceUnits) are types of PulseFoundationUI. |
FPulseHUDTooltipData | Tooltip. |
FPulseHUDProgressRequest | Progress overlay. |
FPulseHUDHint, FPulseHUDHintPayload | Tutorial hint and the payload of its notification. |
FPulseHUDContextMenuPayload | Where a context menu opens. |
FPulseHUDNotification | Notification (Speaker for subtitles). |
FPulseHUDHandle | Handle of a notification, highlight or progress overlay (IsValid, Invalidate). Markers use FPulseHandle of PulseFoundation. |
FPulseHUDStyle | Default classes of the settings. |
FPulseHUDNotificationQueue | Notification queue without widgets. |
Widget base classes
| Class | Bound widgets (optional unless noted) |
|---|---|
UPulseHUDLayout | CompassSlot, GameplayRoot; AddGameplayWidget(Widget, Placement) puts a widget of another module (e.g. the minimap) into GameplayRoot (at the anchor of the FPulseUIPlacement, or over all of it with bFill; Pulse::HUD::Layout::AddToPanel does the same for another panel) |
UPulseHUDStackContainer / UPulseHUDDynamicStackContainer | — (StackName, StackContainerClass) |
UPulseHUDModal | TitleText, MessageText, ContentSlot, ActionList |
UPulseHUDModalActionButton | ButtonTextBlock |
UPulseHUDModalStyle | ModalContainer (with bAddModalToPanel) |
UPulseHUDModalContainer | first panel, or GetModalContainer |
UPulseHUDCompassBase | CompassBarImage (required), CompassMarkersOverlay (required) |
UPulseHUDCompassMarker | MarkerContainer (required), MarkerIcon, MarkerNameText, MarkerDistanceText |
UPulseHUDNotificationArea | EntryBox (required) |
UPulseHUDNotificationWidget | TitleText, MessageText, IconImage, CountText, SpeakerText |
UPulseHUDWorldMarkerLayer | MarkerCanvas (required) |
UPulseHUDWorldMarker | MarkerIcon, MarkerNameText, MarkerDistanceText, EdgeArrow |
UPulseHUDTooltipLayer | TooltipCanvas (required) |
UPulseHUDTooltipWidget | TitleText, MessageText, IconImage |
UPulseHUDHighlightLayer | HighlightCanvas, HighlightFrame (both required) |
UPulseHUDProgressWidget | TitleText, MessageText, ProgressBar, PercentText, CancelButton |
UPulseHUDContextMenuContainer | first panel (a canvas panel over the screen) |
UI component: UPulseHUDTooltipComponent (Pulse HUD Tooltip) gives any widget a tooltip. Hint storage: IPulseHUDHintStorage, default UPulseHUDHintMemoryStorage.
Helpers
UPulseHUDHelpers: IsValidHUDHandle, HUDHandleToString, GetHUDFromWidget, GetTypedParent, ConvertDistanceUnit, GetDefaultDistanceUnit, SetImageFromSoftObject. C++: Pulse::HUD::GenerateHUDHandle, SetImageResource, GetHUD, GetParentWidgetTyped, LoadSoftClass (soft class load that is safe in designer code), ConvertDistanceUnit / FormatDistance (call Pulse::UI::Markers::ConvertDistance / FormatDistance of PulseFoundation), ResolveMarkerPresentation (widget classes of a marker), Pulse::HUD::ScreenMath (marker and tooltip placement).
Rich text: URichTextBlockInputActionDecorator shows the key of an input action with <input id="/Game/Input/IA_Interact.IA_Interact"/> (optional width, height, stretch). It uses the owning player of the rich text block.