Detailed usage

Main subsystem: ADS Menu Subsystem

ADS Menu Subsystem is created automatically with the Game Instance. It creates and keeps the active menu logic. These Blueprint nodes map directly to their C++ signatures.

Blueprint logic: BP_ADS_MenuSystem

The supplied asset is named BP_ADS_MenuSystem. It is the main Blueprint logic, built on the C++ class ADS_MenuLogicBase. The main subsystem instantiates this class and uses it as the active menu logic.

You can extend or modify its features: this logic was created in Blueprint specifically to let you do so. In that case, it is strongly recommended that you duplicate this asset before making any changes, as a safety measure.

Functions

The functions below form the API for opening and closing UI and menus. Execution pins are intentionally not listed.

Event Dispatchers

Player subsystem: ADS Player Subsystem

ADS Player Subsystem belongs to the local player and detects the last input device, including while the game is paused.

Actor Component: AC_MenuSystemConfig

Add AC_MenuSystemConfig to the local player's character or Player Controller Blueprint. It connects that player to the system input contexts.

Use GetMenuSystem to retrieve logic, ShowUI to show a UI, and the mapping-context functions to switch input contexts.

UI

A UI is a Widget Blueprint used to display information or a non-interactive interface. The plugin provides UI_Parent as its base. Keep this asset intact and always create a child in your project content.

Create a UI

Create a Widget Blueprint child of UI_Parent in your project content.

Functions

Your UI child inherits functions from UI_Parent. Override the following functions when you need logic specific to the UI appearing or disappearing. In the overridden function graph, right-click the entry node and choose Add Call to Parent Function. Calling the parent is strongly recommended to keep the plugin behavior.

Menus

A menu is an interactive Widget Blueprint based on UI_Menu_Parent. This class provides the menu base and manages button groups and hover state. Create menus in your project content; do not modify the supplied asset.

Create a menu

Create a Widget Blueprint child of UI_Menu_Parent in your project content.

Functions

Your menu child inherits functions from UI_Menu_Parent. Override Show and Hide when the menu needs additional opening or closing logic. In the overridden function graph, right-click the entry node and choose Add Call to Parent Function. Calling it is strongly recommended to preserve the menu’s base behavior.

Buttons

A menu’s buttons are based on BTN_Parent. This class provides the common foundation for the system’s buttons. Create child widgets in your project content to extend their appearance and functionality.

Provided classes and structures

Assets suffixed _Demo are examples. They are provided as references and are not plugin classes to modify.

Create a button

1. Create a Widget Blueprint child of BTN_Parent in your project content.
2. Build its appearance in the Designer: text, image, border, animation, or any required widget.
3. Place the button in the Designer of a UI_Menu_Parent child menu.

Parameters exposed by the button

These parameters are exposed to the Widget Blueprint that contains the button. Set them from this container widget, not while creating the button child class.

Functions

Your button child inherits BTN_Parent behavior. When overriding a function supplied by this parent, right-click the function entry node and choose Add Call to Parent Function. Keeping that call is strongly recommended to preserve the parent logic.

Dynamic Icons

Dynamic Icons display the visual corresponding to the last input-device type used for the same action. For example, one prompt can show a keyboard key, Xbox button, PlayStation button, or Switch button.

Provided elements

Configure the icon data

1. Duplicate DT_ControllersIcons into your project content if you need to change or add to the provided icons.
2. In each row, fill in the required variants: KeyboardMouse, XBox, PlayStation, and Switch.
3. For each variant, use a Texture, or enable bUseWidget and provide a Widget.
4. In BP_ADS_MenuSystem, assign this Data Table to DT_DynamicIcons.

Each row name is its icon key. Keep it stable: widgets use it to find their variants.

Use a Dynamic Icon in a UI or menu

1. Add UI_DynamicIcon to the Designer of the relevant UI or menu.
2. In its Details panel, set RowName to the exact name of a DT_DynamicIcons row.
3. Adjust its layout like any other UMG widget.

Once configured, the widget displays the current device variant and updates when the last input-device type changes.

Functions

The following functions are part of the UI_DynamicIcon provided logic. For ordinary use, configuring DT_DynamicIcons and RowName is sufficient; these functions are mainly useful for custom behavior.

Notifications

The notification system displays temporary on-screen messages. BP_ADS_MenuSystem provides the logic, while widgets in the Notification folder provide the rendering.

Provided elements

Configure notifications

1. In BP_ADS_MenuSystem, make sure UI_Notifications references the notification widget to use.
2. Use the provided line widgets as-is, or create child widgets in your project content to adapt their appearance.
3. Set NotificationLinesMax to define the maximum number of lines displayed at once.
4. Set NotificationDuration to define the default display duration.

Functions

Call these functions on the BP_ADS_MenuSystem instance to display a notification. Execution pins are not listed.