Skip to main content

Component UI API Reference

Documentation for each component in the mod.io UI framework contains the following sections:

  • Implementation Requirements
    This section specifies any requirements that a widget must meet in order to be considered a component by the mod.io UI. The mod.io framework does not impose a specific base class on widgets; the primary requirements for each component will be specified in terms of the interfaces a widget should implement.

  • Default Component Implementations
    This section contains a number of sub-sections providing information that is specific to the default implementation of a given component provided by mod.io. These should be treated as implementation details from the perspective of widgets or components that consume the widget in question.

    • Additional Interfaces
      This is a list of any interfaces that this particular default component implementation uses in addition to the standard implementation requirements for this component. For example, the Icon Button implements all the standard interfaces of the Button (IModioUIClickableWidget, IModioUISelectableWidget etc.), plus the IModioUIImageDisplayWidget interface to display an icon.

    • Properties
      This is a list of editable configuration properties that the default component implementation exposes. These properties are configurable on instances of the component, but runtime changes should be performed through the relevant interface instead.

    • Sub-components
      Some components may have sub-components (for example, the default Button implementation provides a Label sub-component). This section outlines:

      • The getter function that's used to retrieve a reference to the sub-component in question
      • A description of the sub-component, including the type or expected interfaces that it needs to implement and how the sub-component is used in the default component implementation
    • Event Data
      Components will expose interface functions for adding event handlers for various events that the component will emit. This section outlines what those events are and the data that is passed by the default implementation to delegates that are bound to those event handlers.

UI Component Specifications

Button

The button component is a base component in the mod.io Component UI framework. It implements interfaces to support data binding as well as click, selection and hover events.

Implementation Requirements

A UWidget-derived class must implement the following interfaces to meet the requirements of a Button Component:

Required InterfacePurpose
IModioUIClickableWidgetAllows the widget to emit events when clicked
IModioUISelectableWidgetAllows the widget to be configured as selectable
IModioUIHoverableWidgetAllows the widget to emit events when hovered
IModioUIHasTooltipWidgetAllows the widget to have its tooltip externally configured
IModioUIDataSourceWidgetAllows the widget to data-bind to a UObject*

Default Component Implementations

Icon Button

The Icon Button is a default implementation of the button component, which extends Text Button and adds support for an image to be displayed on the button at runtime. The default blueprint implementation implements IModioUIImageDisplayWidget to allow the image to be set at runtime, and forwards those interface messages onto an Image sub-component which actually displays the image as an icon beside the button label.

Additional Interfaces
IModioUIImageDisplayWidgetAllows the widget to receive messages regarding displaying an image
Properties
FTextLabelTextText to display on this button's label. For runtime changes, use IModioUIHasTextWidget::SetText
Sub-components
GetImageWidgetGets a reference to the sub-component responsible for displaying the image. The default Blueprint implementation will forward IModioUIImageDisplayWidget messages to this widget if it is valid.
Event Data

Icon Button emits the following interface events with the specified data:

FModioImageDisplayOnLoadStateChangedvoid(UObject* LoadContext, bool bLoadSuccess)Passes this as LoadContext, bLoadSuccess indicates if loading succeeded
FModioClickableOnClickedvoid(UObject* ClickContext)Passes this as ClickContext
FModioOnFocusPathChangedvoid(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused)Passes this as FocusContext, InFocusEvent as the focus event, bIsFocused as the new focus state
FModioSelectableOnSelectionChangedvoid(UObject* SelectionContext, bool bNewSelectedState)Passes this as SelectionContext, bNewSelectedState is new selection state
FModioHoverableOnHoverStateChangedvoid(UObject* HoverContext, bool bHoveredState)Passes this as HoverContext, bHoveredState is new hover state
Text Button

The Text Button is a default implementation of the Button component which implements IModioUIHasTextWidget to allow an associated FText to be set at runtime. The default blueprint implementation visualizes this FText on a static text widget which functions as the button's label.

Additional Interfaces
IModioUIHasTextWidgetAllows the widget to be sent an FText to display at runtime
Properties
FTextLabelTextText to display on this button's label. For runtime changes, use IModioUIHasTextWidget::SetText
Sub-components
GetLabelWidgetGets a reference to the widget responsible for displaying the button's label. The default implementation will forward IModioUIHasTextWidget messages to this widget if it is valid
Event Data

Text Button emits the following interface events with the specified data:

FModioClickableOnClickedvoid(UObject* ClickContext)Passes this as ClickContext
FModioOnFocusPathChangedvoid(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused)Passes this as FocusContext, InFocusEvent as the focus event, bIsFocused as the new focus state
FModioSelectableOnSelectionChangedvoid(UObject* SelectionContext, bool bNewSelectedState)Passes this as SelectionContext, bNewSelectedState is new selection state
FModioHoverableOnHoverStateChangedvoid(UObject* HoverContext, bool bHoveredState)Passes this as HoverContext, bHoveredState is new hover state

Text

The Text component is a base component in the mod.io Component UI framework for visualizing a piece of text. The requirements for a Text component are very minimal - just the implementation of a single interface to allow for the value of the text to be set or queried at runtime.

Implementation Requirements

A UWidget-derived class must implement the following interfaces to meet the requirements of a Text Component:

Required InterfacePurpose
IModioUIHasTextWidgetAllows the widget to have its associated text externally configured

Default Component Implementations

Text Block

The text block is a default implementation of a Text component that supports displaying a localized piece of text, which can be externally configured.

Additional Interfaces
IModioUIHasTextWidgetAllows the text being displayed to be set or queried at runtime
IModioUIHasConfigurableColorAllows the text color to be configured at runtime
Properties
Sub-components
Event Data

Text Block emits the following interface events with the specified data:


Editable Text

The Editable Text component is a widget that gathers user-specified text input. It optionally can be configured with validation rules to use to check the user input for conformity.

Implementation Requirements

A UWidget-derived class must implement the following interfaces to meet the requirements of a Editable Text Component:

Required InterfacePurpose
IModioUIStringInputWidgetAllows the widget to have its user input retrieved, and the hint text configured
IModioUITextValidatorAllows the widget to be externally configured with validation rules, or to be queried for the results of validation

Image

The Image component is a widget that displays an externally-configurable image.

Implementation Requirements

A UWidget-derived class must implement the following interfaces to meet the requirements of a Image Component:

Required InterfacePurpose
IModioUIImageDisplayWidgetAllows the widget to have its associated image/brush externally configured

Default Component Implementations

Image

The Image widget is a default implementation of the Image component, which uses UImage for the underlying implementation.

Properties
Sub-components
Event Data

Image emits the following interface events with the specified data:


Progress

The Progress component is a widget that visualizes a float value between 0-1 as progress, with 0 representing no progress and 1 representing completion.

Implementation Requirements

A UWidget-derived class must implement the following interfaces to meet the requirements of a Progress Component:

Required InterfacePurpose
IModioUIProgressWidgetAllows the widget to have its associated progress value set and queried

Tag

The Tag component is a widget that visualizes a single tag from a mod.

Implementation Requirements

A UWidget-derived class must implement the following interfaces to meet the requirements of a Tag Component:

Required InterfacePurpose
IModioUIHasTextWidgetAllows the widget to have its associated label configured with the text representation of the tag

Object List

The Object List component is a widget that visualizes a group of objects in some fashion. It allows external registration of a delegate that will be called any time a widget is created to visualize an element in the associated object array.

Implementation Requirements

A UWidget-derived class must implement the following interfaces to meet the requirements of a Object List Component:

Required InterfacePurpose
IModioUIObjectListWidgetAllows the set of objects to visualize to be configured externally and allows for callback to be registered for internal widget creation/destruction

Default Component Implementations

Object Wrap Box

The Object Wrap Box is a default implementation of the Object List component. This implementation derives from UWrapBox and defers to it for visualizing a set of objects. It does this by instantiating a specific IModioUIDataSourceWidget-implementing widget for each object in the set, using that interface to bind the widget to the object in question, and then adding the widget as a child to the wrap box implementation, which handles the positioning and layout of those widgets.

Properties
Sub-components
Event Data

Object Wrap Box emits the following interface events with the specified data:

FModioObjectListOnObjectWidgetCreatedvoid(UWidget* ObjectWidget, UObject* Object)Passes the newly created widget as ObjectWidget, and the UObject bound to that widget as Object

Mod List

The Mod List component is a specialization of Object List that visualizes a group of mods in some fashion. It requires the objects given to the component, to implement IModioModInfoUIDetails.

Implementation Requirements

A UWidget-derived class must implement the following interfaces to meet the requirements of a Mod List Component:

Required InterfacePurpose
IModioUIObjectListWidgetAllows the set of objects to visualize to be configured externally and allows for callback to be registered for internal widget creation/destruction

Object Selector

The Object Selector component is a widget that allows a user to make a selection amongst a set of bound UObjects. It allows other objects to register for notifications when a user selects an object from the list.

Implementation Requirements

A UWidget-derived class must implement the following interfaces to meet the requirements of a Object Selector Component:

Required InterfacePurpose
IModioUIObjectSelectorAllows the set of objects to select from, to be configured externally, and allows for callback to be registered for selection changes.

Default Component Implementations

Object Selector

The Default Object Selector is a default implementation of the Object Selector component. This implementation derives from UListView and defers to it for displaying a set of objects and allowing the user to select one or more of them based on the widget's configuration. It requires the widgets that represent each entry in the list to implement IModioUIDataSourceWidget and IModioUIClickableWidget in addition to the IUserObjectListEntry interface requirement imposed by the underlying List View.

Properties
Sub-components
Event Data

Object Selector emits the following interface events with the specified data:

FModioOnObjectSelectionChangedvoid(UObject* SelectedValue)Passes the bound value for which selection state has changed as SelectedValue
FModioObjectListOnObjectWidgetCreatedvoid(UWidget* ObjectWidget, UObject* Object)Passes the newly created widget as ObjectWidget, and the UObject bound to that widget as Object

Enum Selector

The Enum Selector component is a specialization of the Object Selector widget. Value objects passed to the selector should implement IModioEnumEntryUIDetails so that they can be queried for an associated entry in an enum.

Implementation Requirements

A UWidget-derived class must implement the following interfaces to meet the requirements of a Enum Selector Component:

Required InterfacePurpose
IModioUIObjectSelectorAllows the widget to internally track the selection state of the passed-in enum values, which can be externally queried

Default Component Implementations

Enum Selector

The Enum Selector is a default implementation of the Enum Selector component. This default implementation uses an internal sub-component as a menu.

Properties
Sub-components
GetSelectorMenuWidgetProvides a reference to the internal widget that provides a menu users can select an enum value from. The default implementation will forward IModioUIObjectSelector messages to this widget if it is valid
GetMenuToggleClickableWidgetProvides a reference to the internal widget that will toggle the display of the menu to allow users to make a selection
Event Data

Enum Selector emits the following interface events with the specified data:

FModioOnObjectSelectionChangedvoid(UObject* SelectedValue)Passes this as SelectedValue
FModioOnActivationChangedvoid(UObject* ActivationContext, bool bIsActivated)Passes this as ActivationContext, bIsActivated as the new activation state
FModioOnFocusPathChangedvoid(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused)Passes this as FocusContext, InFocusEvent as the focus event, bIsFocused as the new focus state
Enum Selector Menu

The Enum Selector is a default implementation of the Enum Selector component. This default implementation uses an internal sub-component to display and manage selection of individual enum values.

Properties
Sub-components
GetSelectorWidgetProvides a reference to the internal widget that actually displays the enum values and tracks the user's selection. The default implementation will forward IModioUIObjectSelector messages to this widget if it is valid
Event Data

Enum Selector Menu emits the following interface events with the specified data:

FModioOnObjectSelectionChangedvoid(UObject* SelectedValue)Passes UObject* as SelectedValue
FModioOnActivationChangedvoid(UObject* ActivationContext, bool bIsActivated)Passes this as ActivationContext, bIsActivated as the new activation state
FModioOnFocusPathChangedvoid(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused)Passes this as FocusContext, InFocusEvent as the focus event, bIsFocused as the new focus state

Enum Selector Entry

The Enum Selector Entry component is a specialization of the Object Selector Entry that visualizes an enum value and allows it to be selected.

Implementation Requirements

A UWidget-derived class must implement the following interfaces to meet the requirements of a Enum Selector Entry Component:

Required InterfacePurpose
IUserObjectListEntryRequired to allow Entry components to be used as visualization widgets in standard Unreal list and tile views
IModioUIClickableWidgetAllows the widget to emit events when clicked to allow the enum selector to trigger a selection change
IModioUISelectableWidgetAllows the widget to internally track the selection state of the bound enum value, which can be externally queried
IModioUIDataSourceWidgetAllows the widget to be data-bound to a UObject implementing IModioEnumEntryUIDetails

Default Component Implementations

Enum Selector Entry

the Enum Selector Entry is a default implementation of the Enum Selector Entry component. This default implementation uses a subwidget for a text label for the enum value, a clickable subwidget to allow users to make selections, and a selectable subwidget to visually represent the selection state of the associated enum value in the selector.

Properties
Sub-components
GetSelectableWidgetProvides a reference to the internal widget that will visualize the current selection state of the bound enum value
GetLabelWidgetProvides a reference to the internal widget that is used for displaying the display string for the bound enum value
GetClickableWidgetProvides a reference to the internal widget that will receive click/enter events so that the enclosing selector can change selection based on user input
Event Data

Enum Selector Entry emits the following interface events with the specified data:

FModioClickableOnClickedvoid(UObject* ClickContext)Passes this as ClickContext
FModioSelectableOnSelectionChangedvoid(UObject* SelectionContext, bool bNewSelectedState)Passes this as SelectionContext, bNewSelectedState is new selection state
FModioOnActivationChangedvoid(UObject* ActivationContext, bool bIsActivated)Passes this as ActivationContext, bIsActivated as the new activation state
FModioOnFocusPathChangedvoid(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused)Passes this as FocusContext, InFocusEvent as the focus event, bIsFocused as the new focus state
Enum Selector Entry

An entry that represents a single selectable enum option.

Properties
Sub-components
Event Data

Enum Selector Entry emits the following interface events with the specified data:

FModioClickableOnClickedvoid(UObject* ClickContext)Passes this as ClickContext
FModioSelectableOnSelectionChangedvoid(UObject* SelectionContext, bool bNewSelectedState)Passes this as SelectionContext, bNewSelectedState is new selection state
FModioOnActivationChangedvoid(UObject* ActivationContext, bool bIsActivated)Passes this as ActivationContext, bIsActivated as the new activation state
FModioOnFocusPathChangedvoid(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused)Passes this as FocusContext, InFocusEvent as the focus event, bIsFocused as the new focus state

Preset Filter Selector

The Preset Filter Selector component is a specialization of Object Selector that visualizes a group of objects that implement IModioModFilterUIDetails in some fashion. It allows other widgets to register for notifications when a user selects a preset filter from the list.

Implementation Requirements

A UWidget-derived class must implement the following interfaces to meet the requirements of a Preset Filter Selector Component:

Required InterfacePurpose
IModioUIObjectSelectorAllows the selection state of the preset filters to be queried or set externally

Default Component Implementations

Preset Filter Selector

The Preset Filter Selector is a default implementation of the Preset Filter Selector component. This implementation uses an internal sub-component to display the available presets.

Properties
Sub-components
GetPresetListWidgetGets a reference to the widget responsible for displaying and selecting the set of available presets. The default implementation will forward IModioUIObjectSelector messages to this widget if it is valid
GetFilterPresetsFetches the available filter presets that the selector should present to users
Event Data

Preset Filter Selector emits the following interface events with the specified data:

FModioOnActivationChangedvoid(UObject* ActivationContext, bool bIsActivated)Passes this as ActivationContext, bIsActivated as the new activation state
FModioOnFocusPathChangedvoid(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused)Passes this as FocusContext, InFocusEvent as the focus event, bIsFocused as the new focus state
Preset Filter Selector

A selector for choosing from preset filters.

Properties
Sub-components
Event Data

Preset Filter Selector emits the following interface events with the specified data:

FModioOnActivationChangedvoid(UObject* ActivationContext, bool bIsActivated)Passes this as ActivationContext, bIsActivated as the new activation state
FModioOnFocusPathChangedvoid(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused)Passes this as FocusContext, InFocusEvent as the focus event, bIsFocused as the new focus state

Preset Filter Selector Entry

The Preset Filter Selector Entry component is a specialization of the Object Selector Entry that visualizes a named preconfigured set of filter parameters and allows it to be selected.

Implementation Requirements

A UWidget-derived class must implement the following interfaces to meet the requirements of a Preset Filter Selector Entry Component:

Required InterfacePurpose
IUserObjectListEntryRequired to allow Entry components to be used as visualization widgets in standard Unreal list and tile views
IModioUIClickableWidgetAllows the widget to emit events when clicked to allow the filter selector to trigger a selection change
IModioUISelectableWidgetAllows the widget to internally track the selection state of the bound filter parameters, which can be externally queried
IModioUIDataSourceWidgetAllows the widget to be data-bound to a UObject implementing IModioModFilterUIDetails

Command Menu

The Command Menu component is a widget that visualizes a set of UObjects implementing IModioUICommandObject.

Implementation Requirements

A UWidget-derived class must implement the following interfaces to meet the requirements of a Command Menu Component:

Required InterfacePurpose
IModioUICommandMenuAllows the implementing widget to be externally configured with menu builder delegates, and external triggering of a refresh/rebuild of the set of commands via the menu builders.

Default Component Implementations

Command Menu

The Command Menu is a default implementation of the Command Menu component which uses an internal sub-component implementing IModioUIObjectSelector to display a set of commands to users and allow them to select one. When a command is selected, the Command Menu will query the selected command object to check if the command can be executed and invoke it if so.

Properties
Sub-components
GetSelectorWidgetProvides a reference to the internal widget that actually displays the available commands and and tracks the user's selection. The default implementation will forward IModioUIObjectSelector messages to this widget if it is valid, and assumes that this widget will be responsible for data-binding the command objects to each entry widget, and that those entry widgets will be responsible for inspecting their bound object for any information they want to visualize.
Event Data

Command Menu emits the following interface events with the specified data:

FModioOnActivationChangedvoid(UObject* ActivationContext, bool bIsActivated)Passes this as ActivationContext, bIsActivated as the new activation state
FModioOnFocusPathChangedvoid(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused)Passes this as FocusContext, InFocusEvent as the focus event, bIsFocused as the new focus state

The Popup Command Menu is a default implementation of the Command Menu component which is intended as an abstract base class for a widget that manages an internal sub-component that can be shown and dismissed based on user input. This base class provides an overridable function to construct the internal menu sub-component that will be displayed on request, and handles forwarding IModioUICommandMenu messages to that widget. Derived classes should provide an implementation of ConstructCommandMenuWidget, and their own custom behaviour for showing and dismissing that widget instance.

Properties
Sub-components
GetCommandMenuWidgetProvides a reference to the internal widget that displays the command menu
Event Data

Popup Command Menu emits the following interface events with the specified data:

FModioOnActivationChangedvoid(UObject* ActivationContext, bool bIsActivated)Passes this as ActivationContext, bIsActivated as the new activation state
FModioOnFocusPathChangedvoid(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused)Passes this as FocusContext, InFocusEvent as the focus event, bIsFocused as the new focus state
Command Menu

A menu displaying a list of commands.

Properties
Sub-components
Event Data

Command Menu emits the following interface events with the specified data:

FModioOnActivationChangedvoid(UObject* ActivationContext, bool bIsActivated)Passes this as ActivationContext, bIsActivated as the new activation state
FModioOnFocusPathChangedvoid(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused)Passes this as FocusContext, InFocusEvent as the focus event, bIsFocused as the new focus state
Mod Details More Options Menu

A menu displaying additional options for a mod in the details view, such as reporting, viewing mods by the same author, or viewing dependencies.

Properties
Sub-components
Event Data

Mod Details More Options Menu emits the following interface events with the specified data:

FModioOnActivationChangedvoid(UObject* ActivationContext, bool bIsActivated)Passes this as ActivationContext, bIsActivated as the new activation state
FModioOnFocusPathChangedvoid(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused)Passes this as FocusContext, InFocusEvent as the focus event, bIsFocused as the new focus state

Mod Property Collection Visualizer

The Mod Property Collection Visualizer is a widget that visualizes a set of properties for a FModioModInfo object.

Implementation Requirements

A UWidget-derived class must implement the following interfaces to meet the requirements of a Mod Property Collection Visualizer Component:

Required InterfacePurpose
IModioUIDataSourceWidgetAllows the implementing widget to be externally configured with a UObject that implements IModioModInfoUIDetails, which will be queried by the individual property visualizers this widget manages.

Default Component Implementations

Mod Property Collection Visualizer

A widget that manages the visualization of a collection of mod properties

Properties
Sub-components
GetModPropertyVisualizerWidgets
Event Data

Mod Property Collection Visualizer emits the following interface events with the specified data:

FModioOnActivationChangedvoid(UObject* ActivationContext, bool bIsActivated)Passes this as ActivationContext, bIsActivated as the new activation state
FModioOnFocusPathChangedvoid(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused)Passes this as FocusContext, InFocusEvent as the focus event, bIsFocused as the new focus state
Mod Property Collection Visualizer

Displays a collection of properties for a mod, such as downloads, rating, size, and other metadata.

Properties
Sub-components
Event Data

Mod Property Collection Visualizer emits the following interface events with the specified data:

FModioOnActivationChangedvoid(UObject* ActivationContext, bool bIsActivated)Passes this as ActivationContext, bIsActivated as the new activation state
FModioOnFocusPathChangedvoid(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused)Passes this as FocusContext, InFocusEvent as the focus event, bIsFocused as the new focus state

Mod Tile

The Mod Tile is a specialization of Button that visualizes a FModioModInfo and is suitable for use as an item widget in Mod List and Mod Tile View components.

Implementation Requirements

A UWidget-derived class must implement the following interfaces to meet the requirements of a Mod Tile Component:

Required InterfacePurpose
IUserObjectListEntryRequired to allow Mod Tile components to be used as visualization widgets in Mod List View and Mod Tile View components
IModioUIDataSourceWidgetAllows the implementing widget to be externally configured with a UObject that implements IModioModInfoUIDetails, which can then be displayed on this tile.

Default Component Implementations

Mod Tile

This is a default implementation of the Mod Tile component which is intended to represent an individual mod in Mod List and Mod Tile View components.

Properties
Sub-components
Event Data

Mod Tile emits the following interface events with the specified data:

FModioClickableOnClickedvoid(UObject* ClickContext)Passes this as ClickContext
FModioSelectableOnSelectionChangedvoid(UObject* SelectionContext, bool bNewSelectedState)Passes this as SelectionContext, bNewSelectedState is new selection state
FModioHoverableOnHoverStateChangedvoid(UObject* HoverContext, bool bHoveredState)Passes this as HoverContext, bHoveredState is new hover state
FModioOnActivationChangedvoid(UObject* ActivationContext, bool bIsActivated)Passes this as ActivationContext, bIsActivated as the new activation state
FModioOnFocusPathChangedvoid(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused)Passes this as FocusContext, InFocusEvent as the focus event, bIsFocused as the new focus state
Mod Tile

Displays a mod tile with key details like title, image, and relevant metadata.

Properties
Sub-components
Event Data

Mod Tile emits the following interface events with the specified data:

FModioClickableOnClickedvoid(UObject* ClickContext)Passes this as ClickContext
FModioSelectableOnSelectionChangedvoid(UObject* SelectionContext, bool bNewSelectedState)Passes this as SelectionContext, bNewSelectedState is new selection state
FModioHoverableOnHoverStateChangedvoid(UObject* HoverContext, bool bHoveredState)Passes this as HoverContext, bHoveredState is new hover state
FModioOnActivationChangedvoid(UObject* ActivationContext, bool bIsActivated)Passes this as ActivationContext, bIsActivated as the new activation state
FModioOnFocusPathChangedvoid(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused)Passes this as FocusContext, InFocusEvent as the focus event, bIsFocused as the new focus state

User Display

The User Display component is a widget that visualizes an FModioUser object.

Implementation Requirements

A UWidget-derived class must implement the following interfaces to meet the requirements of a User Display Component:

Required InterfacePurpose
IModioUIDataSourceWidgetAllows the implementing widget to be externally configured with a UObject that implements IModioUserUIDetails, which will be queried for properties this widget needs to display.

Default Component Implementations

Platform Username

Displays the platform username of the user.

Properties
Sub-components
Event Data

Platform Username emits the following interface events with the specified data:

FModioOnActivationChangedvoid(UObject* ActivationContext, bool bIsActivated)Passes this as ActivationContext, bIsActivated as the new activation state
FModioOnFocusPathChangedvoid(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused)Passes this as FocusContext, InFocusEvent as the focus event, bIsFocused as the new focus state

API Reference

Classes

LinearColorRefLibrary

Library of functions for working with color references

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object


ModRatingStateProvider

Inheritance Hierarchy

-> Interface-> Object

Request Mod Rating Change
bool RequestModRatingChange(int64 ID, EModioRating NewRating)
Parameters
TargetModRatingStateProvider
IDThe raw ID for the mod to request the rating change for
NewRatingthe new rating for the mod
Returns

true if the mod's rating was successfully changed, else false

Query Mod Rating
EModioRating QueryModRating(int64 ModID)
Parameters
TargetModRatingStateProvider
ModIDthe raw ID for the mod to query
Returns

Rating of the mod


ModioActivatableWidget

Interface indicating the implementing widget can be activated or deactivated

Inheritance Hierarchy

-> Interface-> Object

Remove Activation Changed Handler

Unregisters a delegate from receiving callbacks when the activation state changes

void RemoveActivationChangedHandler(FModioOnActivationChanged Handler)
Parameters
TargetModioActivatableWidget
HandlerDelegate to remove from activation state change
Deactivate

Deactivates the implementing widget

void Deactivate()
Parameters
TargetModioActivatableWidget
Add Activation Changed Handler

Registers a delegate to receive callbacks when the activation state changes

void AddActivationChangedHandler(FModioOnActivationChanged Handler)
Parameters
TargetModioActivatableWidget
HandlerDelegate to invoke on activation state change
Activate

Activates the implementing widget

void Activate()
Parameters
TargetModioActivatableWidget

ModioButtonWidget

The button component is a basic building block in the mod.io Component UI framework. It implements interfaces to support data binding as well as click, selection and hover events.

Inheritance Hierarchy

-> CommonButtonBase-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FModioClickableOnClickedMulticastOnClickedPasses this as ClickContext
TObjectPtr<UObject>DataSourceCached object to use as the source for data binding Populated by SetDataSource
boolbFocusOnHoverWhether the button should focus on hover. This is useful for gamepad navigation
boolbEnableKeyboardHoverBool to control whether keyboard navigation should visually trigger hover behavior
FModioOnFocusPathChangedMulticastOnModioFocusPathChangedPasses this as FocusContext, InFocusEvent as the focus event, bIsFocused as the new focus state
FModioSelectableOnSelectionChangedMulticastOnSelectedPasses this as SelectionContext, bNewSelectedState is new selection state
FModioHoverableOnHoverStateChangedMulticastOnHoverStateChangedPasses this as HoverContext, bHoveredState is new hover state

ModioCommandEntry

A UI component that represents a single command entry in a list of commands

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Get Label Widget

The label widget for the command entry (e.g. the text of the command)

TScriptInterface<IModioUIHasTextWidget> GetLabelWidget() const
Parameters
TargetModioCommandEntry
Returns

The label widget

Get Icon Widget

The icon widget for the command entry (e.g. the icon that represents the command)

TScriptInterface<IModioUIImageDisplayWidget> GetIconWidget() const
Parameters
TargetModioCommandEntry
Returns

The icon widget

Get Clickable Widget

The clickable widget for the command entry (e.g. the button that should be clicked to execute the command)

TScriptInterface<IModioUIClickableWidget> GetClickableWidget() const
Parameters
TargetModioCommandEntry
Returns

The clickable widget

Variables

ModioCommandMenu

The Command Menu is a default implementation of the Command Menu component which uses an internal sub-component implementing IModioUIObjectSelector to display a set of commands to users and allow them to select one. When a command is selected, the Command Menu will query the selected command object to check if the command can be executed and invoke it if so.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Get Selector Widget

Provides a reference to the internal widget that actually displays the available commands and and tracks the user's selection. The default implementation will forward IModioUIObjectSelector messages to this widget if it is valid, and assumes that this widget will be responsible for data-binding the command objects to each entry widget, and that those entry widgets will be responsible for inspecting their bound object for any information they want to visualize.

TScriptInterface<IModioUIObjectSelector> GetSelectorWidget() const
Parameters
TargetModioCommandMenu
Returns

The selector widget

Variables

ModioCurrentUserAvatarWidget

Widget that displays the current user's avatar

Inheritance Hierarchy

-> ModioUserDisplay-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Get Avatar Image Widget

Get the image widget that displays the avatar

TScriptInterface<IModioUIImageDisplayWidget> GetAvatarImageWidget() const
Parameters
TargetModioCurrentUserAvatarWidget
Returns

The image widget

Variables
FSlateBrushUnloadedBrushThe brush to use when the avatar is not loaded
FSlateBrushErroredBrushThe brush to use when the avatar is errored (failed to load)
FSlateBrushLoadingBrushThe brush to use when the avatar is loading

ModioDefaultBorder

Default implementation of a border that can be used as a component in mod.io UI

Inheritance Hierarchy

-> Border-> ContentWidget-> PanelWidget-> Widget-> Visual-> Object

Variables

ModioDefaultCheckBox

Default implementation of a check box that can be used as a component in mod.io UI

Inheritance Hierarchy

-> CheckBox-> ContentWidget-> PanelWidget-> Widget-> Visual-> Object

Set Label

Sets the label of the Check Box

void SetLabel(FText InLabelText)
Parameters
TargetModioDefaultCheckBox
InLabelTextThe label to set
Set Hovered
void SetHovered(bool bHovered)
Parameters
TargetModioDefaultCheckBox
bHoveredWhether the check box is hovered
Handle on Check State Changed
void HandleOnCheckStateChanged(bool bIsChecked)
Parameters
TargetModioDefaultCheckBox
bIsCheckedThe new state of the check box
Get Label Text Block Text
FText GetLabelTextBlockText() const
Parameters
TargetModioDefaultCheckBox
Returns

The label text block text

Get Label
FText GetLabel() const
Parameters
TargetModioDefaultCheckBox
Returns

The label

Get Checkbox Content Padding
FMargin GetCheckboxContentPadding() const
Parameters
TargetModioDefaultCheckBox
Returns

The content padding

Variables
FMarginContentPadding
TSubclassOf<UWidget> LabelClass
FTextLabelText

ModioDefaultCodeInputTextBox

Inheritance Hierarchy

-> Widget-> Visual-> Object

Get Validation Error Widget
TScriptInterface<IModioUIHasTextWidget> GetValidationErrorWidget() const
Variables
FModioDefaultCodeInputTextBoxStyleCodeInputStyle
ETextFlowDirectionTextFlowDirection
EVirtualKeyboardTriggerVirtualKeyboardTrigger
EVirtualKeyboardDismissActionVirtualKeyboardDismissAction
FModioOnTextCommittedMulticastOnModioTextCommittedPasses this as Context, Text as the new text, CommitMethod as the method used to commit the text
FModioOnTextChangedMulticastOnModioTextChangedPasses this as Context, Text as the new text
int32NumberOfCharacters
FOnCodeSubmitDynamicOnCodeSubmitDynamic

ModioDefaultEditableTextBox

Inheritance Hierarchy

-> Text Box-> Widget-> Visual-> Object

Variables
FModioOnTextCommittedMulticastOnModioTextCommittedPasses this as Context, Text as the new text, CommitMethod as the method used to commit the text
FModioOnTextChangedMulticastOnModioTextChangedPasses this as Context, Text as the new text
FModioOnFocusPathChangedMulticastOnModioFocusPathChangedPasses this as FocusContext, InFocusEvent as the focus event, bIsFocused as the new focus state

ModioDefaultIconButton

The Icon Button is a default implementation of the button component, which extends Text Button and adds support for an image to be displayed on the button at runtime. The default blueprint implementation implements IModioUIImageDisplayWidget to allow the image to be set at runtime, and forwards those interface messages onto an Image sub-component which actually displays the image as an icon beside the button label.

Inheritance Hierarchy

-> ModioDefaultTextButton-> ModioButtonWidget-> CommonButtonBase-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Get Image Widget

Gets a reference to the sub-component responsible for displaying the image. The default Blueprint implementation will forward IModioUIImageDisplayWidget messages to this widget if it is valid.

TScriptInterface<IModioUIImageDisplayWidget> GetImageWidget() const
Parameters
TargetModioDefaultIconButton
Variables
FModioImageDisplayOnLoadStateChangedMulticastOnLoadStateChangedPasses this as LoadContext, bLoadSuccess indicates if loading succeeded

ModioDefaultImage

The Image widget is a default implementation of the Image component, which uses UImage for the underlying implementation.

Inheritance Hierarchy

-> Image-> Widget-> Visual-> Object

Variables

ModioDefaultModListView

A default implementation of IModioUIModListViewInterface which displays mods as a simple list. This widget inherits from UListView and forwards calls from IModioUIModListViewInterface and IModioUIObjectListWidget to the existing ListView implementation.

Inheritance Hierarchy

-> ListView-> ListViewBase-> Widget-> Visual-> Object

Variables
FModioOnObjectSelectionChangedMulticastOnSelectedValueChangedPasses the bound value for which selection state has changed as SelectedValue

ModioDefaultModTile

This is a default implementation of the Mod Tile component which is intended to represent an individual mod in Mod List and Mod Tile View components.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Populate Extra Options Commands
void PopulateExtraOptionsCommands(TArray<UObject*> Commands, UObject* Context)
Notify Hover State Changed

Notifies the component that the hover state has changed

void NotifyHoverStateChanged(bool bNewHoveredState)
Parameters
TargetModioDefaultModTile
bNewHoveredState
Notify Clicked
void NotifyClicked()
Get Selected State Ex

Handles both getting the selected state from an associated list if there is one, and falls back on the local state variable otherwise

bool GetSelectedStateEx()
Parameters
TargetModioDefaultModTile
Get More Options Menu Widget
TScriptInterface<IModioUICommandMenu> GetMoreOptionsMenuWidget() const
Variables
FModioClickableOnClickedMulticastOnClickedPasses this as ClickContext
boolbSelected
FModioSelectableOnSelectionChangedMulticastOnSelectedPasses this as SelectionContext, bNewSelectedState is new selection state
FModioHoverableOnHoverStateChangedMulticastOnHoverStateChangedPasses this as HoverContext, bHoveredState is new hover state
TObjectPtr<UObject>EditorDataSource

ModioDefaultModTileView

A default implementation of IModioUIModListViewInterface which displays mods as tiles in a grid. This widget inherits from UTileView and forwards calls from IModioUIModListViewInterface and IModioUIObjectListWidget to the existing TileView implementation.

Inheritance Hierarchy

-> TileView-> ListView-> ListViewBase-> Widget-> Visual-> Object

Variables
FModioOnObjectSelectionChangedMulticastOnSelectedValueChangedPasses the bound value for which selection state has changed as SelectedValue

ModioDefaultModalDialogImpl

Internal helper class for making the default component implementations of Dialog. Default Dialog implementations use a Widget Blueprint deriving from this class to provide a consistent layout, the ability to data-drive button configuration, etc. See WBP_ModioDefaultModalDialogImpl for more information.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FModioDialogButtonClickedEventMulticastOnDialogButtonClicked
boolbUseGeneratedButtonContent
TArray<FModioDialogButtonInfo>DialogButtonData

ModioDefaultMultiLineEditableTextBox

Inheritance Hierarchy

-> Text Box (Multi-Line)-> TextLayoutWidget-> Widget-> Visual-> Object

Variables
boolIsCaretMovedWhenGainFocus
boolSelectAllTextWhenFocused
boolRevertTextOnEscape
boolClearKeyboardFocusOnCommit
boolSelectAllTextOnCommit
ETextOverflowPolicyOverflowPolicy
FModioOnTextCommittedMulticastOnModioTextCommittedPasses this as Context, Text as the new text, CommitMethod as the method used to commit the text
FModioOnTextChangedMulticastOnModioTextChangedPasses this as Context, Text as the new text

ModioDefaultObjectSelector

The Default Object Selector is a default implementation of the Object Selector component. This implementation derives from UListView and defers to it for displaying a set of objects and allowing the user to select one or more of them based on the widget's configuration. It requires the widgets that represent each entry in the list to implement IModioUIDataSourceWidget and IModioUIClickableWidget in addition to the IUserObjectListEntry interface requirement imposed by the underlying List View.

Inheritance Hierarchy

-> ListView-> ListViewBase-> Widget-> Visual-> Object

Get Entry Widget from Item
UUserWidget* GetEntryWidgetFromItem(UObject* Item) const
Variables
TSubclassOf<UWidget> MultipleSelectionListItemClass
FModioOnObjectSelectionChangedMulticastOnSelectedValueChangedPasses the bound value for which selection state has changed as SelectedValue
FModioObjectListOnObjectWidgetCreatedMulticastOnWidgetCreatedPasses the newly created widget as ObjectWidget, and the UObject bound to that widget as Object

ModioDefaultProgressBar

The Progress Bar is a default implementation of the Progress component which utilizes UProgressBar for the underlying functionality.

Inheritance Hierarchy

-> ProgressBar-> Widget-> Visual-> Object

Variables

ModioDefaultScrollBox

A widget that allows scrolling of its content. Apart from the default scroll box functionality, this scroll box also supports scrolling by controller/keyboard navigation

Inheritance Hierarchy

-> ScrollBox-> PanelWidget-> Widget-> Visual-> Object

Update Navigation Data
void UpdateNavigationData(int32 PendingScrollOffset)
Parameters
TargetModioDefaultScrollBox
PendingScrollOffsetThe pending scroll offset (may differ from the actual current scroll offset due to ongoing scrolling animation, if any)
On User Scrolled Handle
void OnUserScrolledHandle(float CurrentOffset)
Parameters
TargetModioDefaultScrollBox
CurrentOffsetThe current scroll offset
Variables
boolbScrollByNavigationInput
int32NavigationScrollOffsetStep
floatNavigationScrollOffsetSpeed
TObjectPtr<UWidgetNavigation>UserDefinedNavigation

ModioDefaultTagWidget

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Get Label Widget
TScriptInterface<IModioUIHasTextWidget> GetLabelWidget() const
Variables

ModioDefaultTextBlock

The text block is a default implementation of a Text component that supports displaying a localized piece of text, which can be externally configured.

Inheritance Hierarchy

-> Text-> TextLayoutWidget-> Widget-> Visual-> Object

Variables
FLinearColorRefOverrideTextColorOverride

ModioDefaultTextButton

The Text Button is a default implementation of the Button component which implements IModioUIHasTextWidget to allow an associated FText to be set at runtime. The default blueprint implementation visualizes this FText on a static text widget which functions as the button's label.

Inheritance Hierarchy

-> ModioButtonWidget-> CommonButtonBase-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Get Label Widget

Gets a reference to the widget responsible for displaying the button's label. The default implementation will forward IModioUIHasTextWidget messages to this widget if it is valid

TScriptInterface<IModioUIHasTextWidget> GetLabelWidget() const
Parameters
TargetModioDefaultTextButton
Variables
FTextLabelTextText to display on this button's label. For runtime changes, use IModioUIHasTextWidget::SetText

ModioDefaultTokenPackTile

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Notify Hover State Changed

Notifies the component that the hover state has changed

void NotifyHoverStateChanged(bool bNewHoveredState)
Parameters
TargetModioDefaultTokenPackTile
bNewHoveredState
Notify Clicked
void NotifyClicked()
Get Selected State Ex

Handles both getting the selected state from an associated list if there is one, and falls back on the local state variable otherwise

bool GetSelectedStateEx()
Parameters
TargetModioDefaultTokenPackTile
Variables
FModioClickableOnClickedMulticastOnClickedPasses this as ClickContext
boolbSelected
FModioSelectableOnSelectionChangedMulticastOnSelectedPasses this as SelectionContext, bNewSelectedState is new selection state
FModioHoverableOnHoverStateChangedMulticastOnHoverStateChangedPasses this as HoverContext, bHoveredState is new hover state
TObjectPtr<UObject>EditorDataSource

ModioDefaultTokenPackTileView

Inheritance Hierarchy

-> TileView-> ListView-> ListViewBase-> Widget-> Visual-> Object

Variables
FModioOnObjectSelectionChangedMulticastOnSelectedValueChangedPasses the bound value for which selection state has changed as SelectedValue

ModioDialogButtonUIDetails

Inheritance Hierarchy

-> Interface-> Object

Get Dialog Button Info

Queries the implementing object for the dialog button parameters that the object represents

FModioDialogButtonInfo GetDialogButtonInfo()
Parameters
TargetModioDialogButtonUIDetails
Returns

DialogButtonInfo associated with the object


ModioDropdownAnchor

A widget that anchors a dropdown menu to a button

Inheritance Hierarchy

-> MenuAnchor-> ContentWidget-> PanelWidget-> Widget-> Visual-> Object

Variables

ModioEnumEntryUI

Class wrapping a specific entry from an enum, suitable for use as a data source

Inheritance Hierarchy

-> Object

Variables
uint8UnderlyingEnumValueUnderlying enum value for this entry
FTextUnderlyingEnumValueDisplayTextDisplay text for this entry

ModioEnumEntryUIDetails

Inheritance Hierarchy

-> Interface-> Object

Get Enum Entry Details

Queries the implementing object for it's associated enum value and display text for that value

void GetEnumEntryDetails(uint8 EnumValue, FText EnumValueDisplayText)
Parameters
TargetModioEnumEntryUIDetails
Enum Valuethe raw enum value the object represents
Enum Value Display Textthe display string to show for this object

ModioEnumSelector

The Enum Selector is a default implementation of the Enum Selector component. This default implementation uses an internal sub-component as a menu.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Notify Selection Changed
void NotifySelectionChanged(UObject* SelectedObject)
Get Selector Menu Widget

Provides a reference to the internal widget that provides a menu users can select an enum value from. The default implementation will forward IModioUIObjectSelector messages to this widget if it is valid

TScriptInterface<IModioUIObjectSelector> GetSelectorMenuWidget() const
Parameters
TargetModioEnumSelector
Get Menu Toggle Clickable Widget

Provides a reference to the internal widget that will toggle the display of the menu to allow users to make a selection

TScriptInterface<IModioUIClickableWidget> GetMenuToggleClickableWidget() const
Parameters
TargetModioEnumSelector
Variables
FModioOnObjectSelectionChangedMulticastOnSelectionChangedPasses this as SelectedValue

ModioEnumSelectorEntry

the Enum Selector Entry is a default implementation of the Enum Selector Entry component. This default implementation uses a subwidget for a text label for the enum value, a clickable subwidget to allow users to make selections, and a selectable subwidget to visually represent the selection state of the associated enum value in the selector.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Notify Selection Changed

Notifies the component that the selection state has changed

void NotifySelectionChanged(bool bNewSelectedState)
Parameters
TargetModioEnumSelectorEntry
bNewSelectedStateThe new selection state
Notify Clicked

Notifies the component that the clickable widget has been clicked

void NotifyClicked()
Parameters
TargetModioEnumSelectorEntry
Get Selectable Widget

Provides a reference to the internal widget that will visualize the current selection state of the bound enum value

TScriptInterface<IModioUISelectableWidget> GetSelectableWidget() const
Parameters
TargetModioEnumSelectorEntry
Returns

The selectable widget

Get Label Widget

Provides a reference to the internal widget that is used for displaying the display string for the bound enum value

TScriptInterface<IModioUIHasTextWidget> GetLabelWidget() const
Parameters
TargetModioEnumSelectorEntry
Returns

The label widget

Get Clickable Widget

Provides a reference to the internal widget that will receive click/enter events so that the enclosing selector can change selection based on user input

TScriptInterface<IModioUIClickableWidget> GetClickableWidget() const
Parameters
TargetModioEnumSelectorEntry
Returns

The clickable widget

Variables
FModioClickableOnClickedMulticastOnClickedPasses this as ClickContext
FModioSelectableOnSelectionChangedMulticastOnSelectionChangedPasses this as SelectionContext, bNewSelectedState is new selection state

ModioEnumSelectorMenu

The Enum Selector is a default implementation of the Enum Selector component. This default implementation uses an internal sub-component to display and manage selection of individual enum values.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Notify Selection Changed

Called when the selection changes

void NotifySelectionChanged(UObject* SelectedObject)
Parameters
TargetModioEnumSelectorMenu
SelectedObjectThe object that was selected
Get Selector Widget

Provides a reference to the internal widget that actually displays the enum values and tracks the user's selection. The default implementation will forward IModioUIObjectSelector messages to this widget if it is valid

TScriptInterface<IModioUIObjectSelector> GetSelectorWidget() const
Parameters
TargetModioEnumSelectorMenu
Returns

The selector widget

Variables
FModioOnObjectSelectionChangedMulticastOnSelectionChangedPasses UObject* as SelectedValue

ModioFeatureVisibilityWidget

A widget that manages the visibility of its children based on the enabled state of a mod.io feature

Inheritance Hierarchy

-> ContentWidget-> PanelWidget-> Widget-> Visual-> Object

Variables
EModioUIFeatureFlagsFeatureToCheck

ModioFeaturedCategoryParamsUI

Wrapper around FModioCommonFeaturedCategoryParams for data binding to UListView etc

Inheritance Hierarchy

-> Object


ModioFilterCounterButton

Inheritance Hierarchy

-> ModioDefaultTextButton-> ModioButtonWidget-> CommonButtonBase-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Get Filter Counter Widget
TScriptInterface<IModioUIDataSourceWidget> GetFilterCounterWidget()
Variables

ModioFilterPanel

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Get Tag Selector Widget
TScriptInterface<IModioUIModTagSelector> GetTagSelectorWidget() const
Get Selected Tags
TArray<FString> GetSelectedTags()
Get Clear Button Widget
TScriptInterface<IModioUIClickableWidget> GetClearButtonWidget() const
Get Background Button Widget
TScriptInterface<IModioUIClickableWidget> GetBackgroundButtonWidget() const
Clear Selected Tags
void ClearSelectedTags()
Add Tag Selection Changed Handler
void AddTagSelectionChangedHandler(FModioOnTagSelectionChanged Handler)
Variables

ModioFilterParamsUI

Wrapper around FModioFilterParams when consumer needs UObject-representable data (e.g. for UMG as a list item or data source)

Inheritance Hierarchy

-> Object

Variables
FTextFilterNameDisplay name for this set of filter parameters.
FModioFilterParamsUnderlyingUnderlying filter parameters

ModioFocusableWidget

Interface indicating the implementing widget (or it's children) can receive focus

Inheritance Hierarchy

-> Interface-> Object

Remove Focus Path Changed Handler

Unregisters a delegate from receiving callbacks when the focus path changes

void RemoveFocusPathChangedHandler(FModioOnFocusPathChanged Handler)
Parameters
TargetModioFocusableWidget
HandlerDelegate to remove from focus path change
Get Widget to Focus

Queries the implementing object for the widget that should receive focus

UWidget* GetWidgetToFocus(EUINavigation NavigationType) const
Parameters
TargetModioFocusableWidget
NavigationTypeNavigation type to focus, if applicable
Returns

Widget to focus

Add Focus Path Changed Handler

Registers a delegate to receive callbacks when the focus path changes The delegate is assumed to be invoked both when the implementing widget gains focus and when children of the widget gain focus

void AddFocusPathChangedHandler(FModioOnFocusPathChanged Handler)
Parameters
TargetModioFocusableWidget
HandlerDelegate to invoke on focus path change

ModioGalleryImageUI

Wrapper around FModioImageWrapper when consumer needs UObject-representable data (e.g. for UMG as a list item or data source)

Inheritance Hierarchy

-> Object

Variables
FModioImageWrapperUnderlyingImageUnderlying image data
int32UnderlyingIndexIndex of this image in the gallery

ModioGalleryImageUIDetails

Inheritance Hierarchy

-> Interface-> Object

Get Index

Queries the implementing object for the image index that the object represents

int32 GetIndex()
Parameters
TargetModioGalleryImageUIDetails
Returns

Index associated with the object

Get Image

Queries the implementing object for the image wrapper that the object represents

FModioImageWrapper GetImage()
Parameters
TargetModioGalleryImageUIDetails
Returns

FModioImageWrapper associated with the object


ModioGalleryListEntry

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables

ModioImageGallery

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Refresh
void Refresh()
Get Increment Selection Button Widget
TScriptInterface<IModioUIClickableWidget> GetIncrementSelectionButtonWidget() const
Parameters
TargetModioImageGallery
Returns

The widget which implements IModioUIClickableWidget

Get Image Widget
TScriptInterface<IModioUIImageDisplayWidget> GetImageWidget() const
Parameters
TargetModioImageGallery
Returns

The image widget which implements IModioUIImageDisplayWidget

Get Image Selector Widget
TScriptInterface<IModioUIObjectSelector> GetImageSelectorWidget() const
Parameters
TargetModioImageGallery
Returns

The widget which implements IModioUIObjectSelector

Get Decrement Selection Button Widget
TScriptInterface<IModioUIClickableWidget> GetDecrementSelectionButtonWidget() const
Parameters
TargetModioImageGallery
Returns

The widget which implements IModioUIClickableWidget

Variables
int64ModIdEditor
FModioModInfoBoundModInfo
boolbUseLogoOnly

ModioModBrowser

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Search Subscriptions and Installs with Stored Params
TArray<FModioModInfo> SearchSubscriptionsAndInstallsWithStoredParams() const
Search Purchases with Stored Params
TArray<FModioModInfo> SearchPurchasesWithStoredParams() const
Search Library with Stored Params
TArray<FModioModInfo> SearchLibraryWithStoredParams() const
Initialize Tag Data
void InitializeTagData(UObject* InTagData)
Initialize Library Tag Data
void InitializeLibraryTagData(UObject* InTagData)
Increment Preset Filter Selection
void IncrementPresetFilterSelection()
Get Wallet Button Widget
TScriptInterface<IModioUIClickableWidget> GetWalletButtonWidget() const
Get View Description Text Widget
TScriptInterface<IModioUIHasTextWidget> GetViewDescriptionTextWidget() const
Get View Description Image Widget
TScriptInterface<IModioUIImageDisplayWidget> GetViewDescriptionImageWidget() const
Get Tab Right Button Widget
TScriptInterface<IModioUIClickableWidget> GetTabRightButtonWidget() const
Get Tab Left Button Widget
TScriptInterface<IModioUIClickableWidget> GetTabLeftButtonWidget() const
Get Search Text Widget
TScriptInterface<IModioUIHasTextWidget> GetSearchTextWidget() const
Get Search Editable Text Box Widget
TScriptInterface<IModioUIStringInputWidget> GetSearchEditableTextBoxWidget() const
Get Search Button Widget
TScriptInterface<IModioUIClickableWidget> GetSearchButtonWidget() const
Get Preset Filter Selector Widget
TScriptInterface<IModioUIObjectSelector> GetPresetFilterSelectorWidget() const
Get Mod Tile View Widget
TScriptInterface<IModioUIModListViewInterface> GetModTileViewWidget() const
Get Library View Button Widget
TScriptInterface<IModioUIClickableWidget> GetLibraryViewButtonWidget() const
Get Filter Button Widget
TScriptInterface<IModioUIClickableWidget> GetFilterButtonWidget() const
Get Close Browser Button Widget
TScriptInterface<IModioUIClickableWidget> GetCloseBrowserButtonWidget() const
Get Clear Search Button Widget
TScriptInterface<IModioUIClickableWidget> GetClearSearchButtonWidget() const
Decrement Preset Filter Selection
void DecrementPresetFilterSelection()
Variables
EModioModBrowserStateCurrentView
FStringStoredSearchString
TObjectPtr<UObject>StoredTagData
TObjectPtr<UObject>StoredLibraryTagData

ModioModBrowserDialogButtonInfoUI

Wrapper around FModioDialogButtonInfo for data binding to UListView etc

Inheritance Hierarchy

-> Object


ModioModCollectionEntryUI

Wrapper around FModioModCollectionEntry when consumer needs UObject-representable data (e.g. for UMG as a list item or data source)

Inheritance Hierarchy

-> Object

Variables
FModioModCollectionEntryUnderlyingUnderlying mod collection entry
boolbCachedSubscriptionStatusCached subscription status for this mod. This can be used to avoid unnecessary API calls

ModioModDependencyUI

Wrapper around FModioModDependency when consumer needs UObject-representable data (e.g. for UMG as a list item or data source)

Inheritance Hierarchy

-> Object


ModioModDependencyUIDetails

Inheritance Hierarchy

-> Interface-> Object

Get Mod ID
FModioModID GetModID()
Parameters
TargetModioModDependencyUIDetails
Returns

Mod ID for the associated mod

Get Mod Dependency
FModioModDependency GetModDependency()
Parameters
TargetModioModDependencyUIDetails
Returns

ModioModDependency for the associated mod


ModioModDetailsDialog

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Populate Extra Options Commands
void PopulateExtraOptionsCommands(TArray<UObject*> Commands, UObject* Context)
Is User Subscribed
bool IsUserSubscribed()
Parameters
TargetModioModDetailsDialog
Is Mod Purchased
bool IsModPurchased()
Get Wallet Button Widget
TScriptInterface<IModioUIClickableWidget> GetWalletButtonWidget() const
Get Tag Display Widget
TScriptInterface<IModioUIDataSourceWidget> GetTagDisplayWidget() const
Get Subscribe Button Widget
TScriptInterface<IModioUIClickableWidget> GetSubscribeButtonWidget() const
Get Rate Up Button Widget
TScriptInterface<IModioUIClickableWidget> GetRateUpButtonWidget() const
Get Rate Down Button Widget
TScriptInterface<IModioUIClickableWidget> GetRateDownButtonWidget() const
Get Purchase Button Widget
TScriptInterface<IModioUIClickableWidget> GetPurchaseButtonWidget() const
Get More Options Menu Widget
TScriptInterface<IModioUICommandMenu> GetMoreOptionsMenuWidget() const
Get Mod Summary Short Text Widget
TScriptInterface<IModioUIHasTextWidget> GetModSummaryShortTextWidget() const
Get Mod Status Widget
TScriptInterface<IModioUIDataSourceWidget> GetModStatusWidget() const
Get Mod Properties Widget
TScriptInterface<IModioUIDataSourceWidget> GetModPropertiesWidget() const
Get Mod Name Text Widget
TScriptInterface<IModioUIHasTextWidget> GetModNameTextWidget() const
TScriptInterface<IModioUIMediaDownloadCompletedReceiver> GetModImageGalleryWidget() const
Get Mod Dependencies Button Widget
TScriptInterface<IModioUIClickableWidget> GetModDependenciesButtonWidget() const
Get Mod Author Display Widget
TScriptInterface<IModioUIDataSourceWidget> GetModAuthorDisplayWidget() const
Get Expand Description Button Widget
TScriptInterface<IModioUIClickableWidget> GetExpandDescriptionButtonWidget() const
Get Close Dialog Button Widget
TScriptInterface<IModioUIClickableWidget> GetCloseDialogButtonWidget() const
Variables
FTextExpandLabelText
TObjectPtr<UObject>EditorDataSource
FModioModInfoBoundModInfo
boolbHasFullDescription

ModioModEnabledStatusWidget

A widget that displays the enabled status of a mod

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables

ModioModEnabledToggleWidget

A widget that allows the user to toggle the enabled status of a mod

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables

ModioModFilterUIDetails

Inheritance Hierarchy

-> Interface-> Object

Get Filter Params

Queries the implementing object for the mod filter parameters that the object represents

FModioFilterParams GetFilterParams()
Parameters
TargetModioModFilterUIDetails
Returns

ModFilterParams associated with the object

Get Filter Name

Queries the implementing object for a name that may be associated with the filter

bool GetFilterName(FText Name)
Parameters
TargetModioModFilterUIDetails
NameThe name for the filter if there was one present
Returns

true if the implementing object provides a name for the filter


ModioModInfoUI

Wrapper around FModioModInfo when consumer needs UObject-representable data (e.g. for UMG as a list item or data source)

Inheritance Hierarchy

-> Object


ModioModInfoUIDetails

Inheritance Hierarchy

-> Interface-> Object

Get Mod ID
FModioModID GetModID()
Parameters
TargetModioModInfoUIDetails
Returns

Mod ID for the associated mod

Get Full Mod Info
FModioModInfo GetFullModInfo()
Parameters
TargetModioModInfoUIDetails
Returns

ModInfo for the associated mod


ModioModInstallationStatusWidget

A widget that displays the installation status of a mod

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Query Progress Value for State

Helper function to query the progress of a state-specific operation for the bound mod

float QueryProgressValueForState(EModioModProgressState ProgressState) const
Parameters
TargetModioModInstallationStatusWidget
ProgressStateThe state for which to query progress
Returns

A float between 0 and 1 measuring progress, where 0 represents none and 1 is complete. Returns 0 if the specified state is invalid or not in progress for this mod

Variables
FModioModInfoBoundModInfoFull information for the mod this widget represents, based on its data source
FOnModInstallationStatusChangedOnInstallationStatusChangedBroadcasts when the mod's installation status is updated
EModioModInstallationStatusCurrentInstallationStatus

ModioModManagementEventUI

Wrapper around FModioModManagementEvent when consumer needs UObject-representable data (e.g. for UMG as a list item or data source)

Inheritance Hierarchy

-> Object


ModioModProgressInfoUI

Wrapper around FModioModProgressInfo when consumer needs UObject-representable data (e.g. for UMG as a list item or data source)

Inheritance Hierarchy

-> Object


ModioModPropCollectionVisualizer

A widget that manages the visualization of a collection of mod properties

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Get Mod Property Visualizer Widgets
TArray<TScriptInterface<IModioUIDataSourceWidget> > GetModPropertyVisualizerWidgets()
Parameters
TargetModioModPropCollectionVisualizer
Returns

Array of widgets implementing UModioUIDataSourceWidget that will visualize individual properties

Variables

ModioModRatingDisplay

A widget that displays the rating of a mod

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Get Rating Percentage Label Widget

Get the label widget that displays the rating percentage

TScriptInterface<IModioUIHasTextWidget> GetRatingPercentageLabelWidget() const
Parameters
TargetModioModRatingDisplay
Returns

The label widget

Get Rating Description Label Widget

Get the rating description label widget

TScriptInterface<IModioUIHasTextWidget> GetRatingDescriptionLabelWidget() const
Parameters
TargetModioModRatingDisplay
Returns

The label widget

Variables
TObjectPtr<UObject>EditorDataSourceThe data source to use for editor preview

ModioModSubscriptionStatusWidget

A widget that displays the subscription status of a mod

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables

ModioModTagCategoryUIDetails

Inheritance Hierarchy

-> Interface-> Object

Get Selected Tags

Retrieves an array of strings representing tags which are selected for the associated tag category

TArray<FString> GetSelectedTags()
Parameters
TargetModioModTagCategoryUIDetails
Get Raw Category Name

Queries the implementing object for the raw string name for the tag category that the object represents

FString GetRawCategoryName()
Parameters
TargetModioModTagCategoryUIDetails
Returns

raw string name for the tag category

Get Localized Category Name

Queries the implementing object for the localized name for the tag category that the object represents

FText GetLocalizedCategoryName()
Parameters
TargetModioModTagCategoryUIDetails
Returns

localized name for the tag category

Get Is Category Locked

Queries the implementing object if the associated tag category is flagged as locked

bool GetIsCategoryLocked()
Parameters
TargetModioModTagCategoryUIDetails
Returns

True if only editable by admins

Get Is Category Hidden

Queries the implementing object if the associated tag category is flagged as hidden

bool GetIsCategoryHidden()
Parameters
TargetModioModTagCategoryUIDetails
Returns

True if only visible by admins

Get Category Tags

Gets the bindable tag objects for this category

TArray<TScriptInterface<IModioModTagUIDetails> > GetCategoryTags()
Parameters
TargetModioModTagCategoryUIDetails
Get Allow Multiple Selection

Queries the implementing object for whether the associated tag category allows multiple selection

bool GetAllowMultipleSelection()
Parameters
TargetModioModTagCategoryUIDetails
Returns

True if the category permits multiple values to be selected


ModioModTagDisplay

A widget that displays the tags of a mod (e.g. "Action", "Adventure", "Singleplayer")

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Get Tag Container Widget

Get the widget that will contain the tags

TScriptInterface<IModioUIObjectListWidget> GetTagContainerWidget() const
Parameters
TargetModioModTagDisplay
Returns

The widget

Variables
TObjectPtr<UObject>EditorDataSourceThe data source to use for editor preview

ModioModTagInfoUI

Wrapper around a FModioModTagInfo when consumer needs UObject-representable data (e.g. for UMG as a list item or data source)

Inheritance Hierarchy

-> Object

Variables
FModioModTagInfoUnderlyingUnderlying tag info
FTextLocalizedCategoryNameLocalized tag category string
TArray<TObjectPtr<UModioModTagUI> >BindableTagsTransient set of bindable tag objects for use in the UI

ModioModTagOptionsUI

Wrapper around a FModioModTagOptions because UMG widgets expect UObjects for data sources or list items

Inheritance Hierarchy

-> Object

Variables
FModioModTagOptionsUnderlyingUnderlying tag options
TArray<UModioModTagInfoUI*>BindableTagCategoriesTransient set of bindable tag categories for use in the UI

ModioModTagOptionsUIDetails

Inheritance Hierarchy

-> Interface-> Object

Get Selected Tags

Retrieves an array of strings representing tags which are selected across all categories

TArray<FString> GetSelectedTags()
Parameters
TargetModioModTagOptionsUIDetails
Get Categories

Retrieves an array of objects representing the tag categories this game has configured

TArray<TScriptInterface<IModioModTagCategoryUIDetails> > GetCategories()
Parameters
TargetModioModTagOptionsUIDetails
Clear Selected Tags

Clears all selected tags across all categories

void ClearSelectedTags()
Parameters
TargetModioModTagOptionsUIDetails

ModioModTagSelector

A widget that allows the user to select tags for a mod

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Get Selector Menu Widget

Provides a reference to the internal widget that displays the tag categories and values and tracks the user's selection

TScriptInterface<IModioUIModTagSelector> GetSelectorMenuWidget() const
Parameters
TargetModioModTagSelector
Returns

The widget that displays the tag categories and values

Get Menu Toggle Clickable Widget

Provides a reference to the internal widget that can be clicked to toggle the display of the selector menu

TScriptInterface<IModioUIClickableWidget> GetMenuToggleClickableWidget() const
Parameters
TargetModioModTagSelector
Returns

The widget that can be clicked to toggle the display of the selector menu

Variables

ModioModTagSelectorCategory

A widget that displays a category of tags that can be selected

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Get Tag Category Label

Get the label widget that displays the category name

TScriptInterface<IModioUIHasTextWidget> GetTagCategoryLabel() const
Parameters
TargetModioModTagSelectorCategory
Returns

The label widget

Get Category Tag List Widget

Provides a reference to the internal widget that actually displays the tags for this category

TScriptInterface<IModioUIObjectSelector> GetCategoryTagListWidget() const
Parameters
TargetModioModTagSelectorCategory
Returns

The widget that displays the tags

Variables

ModioModTagSelectorEntry

A widget that represents a tag in a tag selector

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Notify Selection Changed

Notify listeners that the selection state of this entry has changed

void NotifySelectionChanged()
Parameters
TargetModioModTagSelectorEntry
Notify Clicked

Notify listeners that this entry has been clicked

void NotifyClicked()
Parameters
TargetModioModTagSelectorEntry
Get Tag Label Widget

Get the widget that displays the tag text for this entry

TScriptInterface<IModioUIHasTextWidget> GetTagLabelWidget() const
Parameters
TargetModioModTagSelectorEntry
Returns

The text widget

Get Selection Widget

Get the widget that represents the selection state of this entry

TScriptInterface<IModioUISelectableWidget> GetSelectionWidget() const
Parameters
TargetModioModTagSelectorEntry
Returns

The selection widget

Get Clickable Widget

Get the widget that can be clicked to select this entry

TScriptInterface<IModioUIClickableWidget> GetClickableWidget() const
Parameters
TargetModioModTagSelectorEntry
Returns

The clickable widget

Variables
FModioSelectableOnSelectionChangedMulticastOnSelectionStateChangedPasses this as SelectionContext, bNewSelectedState is new selection state
FModioClickableOnClickedMulticastOnClickedPasses this as ClickContext

ModioModTagSelectorMenu

A widget that allows the user to select tags from a list of available tags

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Notify Selection Changed

Notify listeners that the selection state of the tags has changed

void NotifySelectionChanged()
Parameters
TargetModioModTagSelectorMenu
Get Category Container Widget

Provides a reference to the internal widget that actually displays the tag categories

TScriptInterface<IModioUIObjectListWidget> GetCategoryContainerWidget() const
Parameters
TargetModioModTagSelectorMenu
Returns

The widget that displays the tag categories

Get Allowed Tags

Filters through category tags based on their hidden/locked flags to compare with our local preferences if they should be shown

TArray<TScriptInterface<IModioModTagCategoryUIDetails> > GetAllowedTags()
Parameters
TargetModioModTagSelectorMenu
Returns

Array of category tags allowed to be shown

Variables
FModioOnTagSelectionChangedMulticastOnTagSelectionChanged

ModioModTagUI

Wrapper around a Tag Entry (string) when consumer needs UObject-representable data (e.g. for UMG as a list item or data source)

Inheritance Hierarchy

-> Object

Variables
FStringUnderlyingRaw tag string used in the mod.io API
FTextLocalizedTextLocalized tag string
boolbSelectionStateTransient field storing selection state

ModioModTagUIDetails

Inheritance Hierarchy

-> Interface-> Object

Set Selection State

Sets the selection state of the associated tag

void SetSelectionState(bool bNewSelectionState)
Parameters
TargetModioModTagUIDetails
bNewSelectionStateThe new selection state for the tag
Get Selection State

Queries the implementing object for the selection state of the associated tag, if applicable

bool GetSelectionState()
Parameters
TargetModioModTagUIDetails
Returns

The selection state for the tag

Get Raw String Value

Queries the implementing object for the raw string value for the mod tag that the object represents

FString GetRawStringValue()
Parameters
TargetModioModTagUIDetails
Returns

raw string value for the mod tag

Get Localized Text

Queries the implementing object for the localized text for the mod tag that the object represents

FText GetLocalizedText()
Parameters
TargetModioModTagUIDetails
Returns

localized text value for the mod tag


ModioObjectWrapBox

The Object Wrap Box is a default implementation of the Object List component. This implementation derives from UWrapBox and defers to it for visualizing a set of objects. It does this by instantiating a specific IModioUIDataSourceWidget-implementing widget for each object in the set, using that interface to bind the widget to the object in question, and then adding the widget as a child to the wrap box implementation, which handles the positioning and layout of those widgets.

Inheritance Hierarchy

-> WrapBox-> PanelWidget-> Widget-> Visual-> Object

Variables
FModioObjectListOnObjectWidgetCreatedMulticastOnWidgetCreatedPasses the newly created widget as ObjectWidget, and the UObject bound to that widget as Object

ModioOperationTracker

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Get Radial Progress Widget
TScriptInterface<IModioUIProgressWidget> GetRadialProgressWidget() const
Get Queue Label Text Widget
TScriptInterface<IModioUIHasTextWidget> GetQueueLabelTextWidget() const
Get Queue Count Text Widget
TScriptInterface<IModioUIHasTextWidget> GetQueueCountTextWidget() const
Get Queue Count Icon Widget
TScriptInterface<IModioUIImageDisplayWidget> GetQueueCountIconWidget() const
Get Percent Progress Text Widget
TScriptInterface<IModioUIHasTextWidget> GetPercentProgressTextWidget() const
Get Operation Type Icon Widget
TScriptInterface<IModioUIImageDisplayWidget> GetOperationTypeIconWidget() const
Get Download Speed Text Widget
TScriptInterface<IModioUIHasTextWidget> GetDownloadSpeedTextWidget() const
Get Download Size Text Widget
TScriptInterface<IModioUIHasTextWidget> GetDownloadSizeTextWidget() const
Variables

ModioPlatformSpecificWidget

Inheritance Hierarchy

-> ContentWidget-> PanelWidget-> Widget-> Visual-> Object

Variables

ModioPopupCommandMenu

The Popup Command Menu is a default implementation of the Command Menu component which is intended as an abstract base class for a widget that manages an internal sub-component that can be shown and dismissed based on user input. This base class provides an overridable function to construct the internal menu sub-component that will be displayed on request, and handles forwarding IModioUICommandMenu messages to that widget. Derived classes should provide an implementation of ConstructCommandMenuWidget, and their own custom behaviour for showing and dismissing that widget instance.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Get Command Menu Widget

Provides a reference to the internal widget that displays the command menu

TScriptInterface<IModioUICommandMenu> GetCommandMenuWidget() const
Parameters
TargetModioPopupCommandMenu
Returns

The widget that displays the command menu

Construct Command Menu Widget

Implement this function to construct the actual command menu widget that will be displayed and dismissed /// on user input. Implementing classes are responsible for holding onto this internal sub-component so it is not /// garbage collected.

void ConstructCommandMenuWidget()
Parameters
TargetModioPopupCommandMenu
Variables

ModioPresetFilterEntryWidget

A widget that represents a filter entry in a filter preset

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Get Label Widget

Provides a reference to the internal widget that displays the label for this filter entry

TScriptInterface<IModioUIHasTextWidget> GetLabelWidget() const
Parameters
TargetModioPresetFilterEntryWidget
Returns

The widget that displays the label

Variables

ModioPresetFilterSelector

The Preset Filter Selector is a default implementation of the Preset Filter Selector component. This implementation uses an internal sub-component to display the available presets.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Get Preset List Widget

Gets a reference to the widget responsible for displaying and selecting the set of available presets. The default implementation will forward IModioUIObjectSelector messages to this widget if it is valid

TScriptInterface<IModioUIObjectSelector> GetPresetListWidget() const
Parameters
TargetModioPresetFilterSelector
Returns

The widget that displays the presets

Get Filter Presets

Fetches the available filter presets that the selector should present to users

TArray<TScriptInterface<IModioModFilterUIDetails> > GetFilterPresets()
Parameters
TargetModioPresetFilterSelector
Returns

Array of UObjects implementing UModioModFilterUIDetails, one for each preset

Variables

ModioReportInfoUI

UObject wrapper around an FModioReportParams for use as a data source

Inheritance Hierarchy

-> Object

Variables
FModioReportParamsReportDataData for the report
TObjectPtr<UObject>ModInfoMod info for the report

ModioRetryLibrary

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object


ModioScrollableWidget

Interface for widgets that support scrolling functionality

Inheritance Hierarchy

-> Interface-> Object

Set Scroll Offset

Set the scroll offset of the widget

void SetScrollOffset(float Offset)
Parameters
TargetModioScrollableWidget
OffsetThe scroll offset to set
Scroll to Top

Scroll the widget to the top

void ScrollToTop()
Parameters
TargetModioScrollableWidget
Scroll to Bottom

Scroll the widget to the bottom

void ScrollToBottom()
Parameters
TargetModioScrollableWidget
Get Scroll Offset

Get the current scroll offset of the widget

float GetScrollOffset() const
Parameters
TargetModioScrollableWidget
Returns

The current scroll offset


ModioSearchBar

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Get Search Box Widget
TScriptInterface<IModioUIStringInputWidget> GetSearchBoxWidget() const
Get Button Widget
TScriptInterface<IModioUIClickableWidget> GetButtonWidget() const
Variables

ModioStackedBoolLibrary

Library of functions for working with stacked bool values

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object


ModioStorageTracker

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Refresh Data
void RefreshData()
Get Storage Used Text Widget
TScriptInterface<IModioUIHasTextWidget> GetStorageUsedTextWidget() const
Variables

ModioTagCounterIcon

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Synchronize Counter
int32 SynchronizeCounter()
Get Counter Label Widget
TScriptInterface<IModioUIHasTextWidget> GetCounterLabelWidget()
Variables

ModioToggleableWidget

Interface for widgets that can be toggled open or closed

Inheritance Hierarchy

-> Interface-> Object

Remove Toggle State Changed Handler

Unregisters a delegate from receiving callbacks when the toggle state changes

void RemoveToggleStateChangedHandler(FModioOnToggleStateChanged Handler)
Parameters
TargetModioToggleableWidget
HandlerDelegate to remove from toggle state change
Open

Toggles the open state of the widget

void Open(bool bForce, bool bFocusMenu)
Parameters
TargetModioToggleableWidget
bForceWhether to force the widget to open (e.g. it may take ShouldOpenDueToClick into account when the implementing widget is derived from UMenuAnchor)
bFocusMenuWhether to focus the menu when opening
Is Open

Get the current open/close state of the widget

bool IsOpen() const
Parameters
TargetModioToggleableWidget
Returns

True if the widget is open, false otherwise

Close

Toggles the close state of the widget

void Close()
Parameters
TargetModioToggleableWidget
Add Toggle State Changed Handler

Registers a delegate to receive callbacks when the toggle state changes

void AddToggleStateChangedHandler(FModioOnToggleStateChanged Handler)
Parameters
TargetModioToggleableWidget
HandlerDelegate to invoke on toggle state change

ModioTokenPackBrowser

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Get Token Tile View Widget
TScriptInterface<IModioUITokenPackListInterface> GetTokenTileViewWidget() const
Get Title Text Widget
TScriptInterface<IModioUIHasTextWidget> GetTitleTextWidget() const
Variables

ModioTokenPackUI

Wrapper around FModioTokenPack when consumer needs UObject-representable data (e.g. for UMG as a list item or data source)

Inheritance Hierarchy

-> Object


ModioTokenPackUIDetails

Inheritance Hierarchy

-> Interface-> Object

Get Token Pack ID
FModioTokenPackID GetTokenPackID()
Parameters
TargetModioTokenPackUIDetails
Returns

Token Pack ID for the relevant TokenPack

Get Full Token Pack
FModioTokenPack GetFullTokenPack()
Parameters
TargetModioTokenPackUIDetails
Returns

Token Pack struct


ModioUIBoundActionWidget

Interface indicating the implementing widget has a bound action that can be clicked or held

Inheritance Hierarchy

-> ModioUIClickableWidget-> Interface-> Object

Try Get Bound Action

Tries to get the bound action for the implementing object

bool TryGetBoundAction(FDataTableRowHandle InputActionRow) const
Parameters
TargetModioUIBoundActionWidget
Input Action RowThe bound action if it exists
Returns

True if the bound action exists, false otherwise

Set Bound Action

Registers a delegate to receive progress callbacks when the implementing object's bound action is held

void SetBoundAction(FDataTableRowHandle InputActionRow)
Parameters
TargetModioUIBoundActionWidget
InputActionRowDelegate to invoke with hold progress
Remove Action Progress Handler
void RemoveActionProgressHandler(FModioBoundActionProgressed Handler)
Parameters
TargetModioUIBoundActionWidget
HandlerDelegate to unsubscribe
Remove Action Completed Handler
void RemoveActionCompletedHandler(FModioBoundActionCompleted Handler)
Parameters
TargetModioUIBoundActionWidget
HandlerDelegate to unsubscribe
Clear Bound Action

Clears the bound action for the implementing object

void ClearBoundAction()
Parameters
TargetModioUIBoundActionWidget
Add Action Progress Handler
void AddActionProgressHandler(FModioBoundActionProgressed Handler)
Parameters
TargetModioUIBoundActionWidget
HandlerDelegate to invoke with hold progress
Add Action Completed Handler
void AddActionCompletedHandler(FModioBoundActionCompleted Handler)
Parameters
TargetModioUIBoundActionWidget
HandlerDelegate to invoke on a hold completed event

ModioUIClickableWidget

Interface indicating the implementing widget can emit click events that can be enabled/disabled

Inheritance Hierarchy

-> Interface-> Object

Remove Clicked Handler

Unregisters a delegate so it will no longer receive callbacks when the implementing widget is clicked

void RemoveClickedHandler(FModioClickableOnClicked Handler)
Parameters
TargetModioUIClickableWidget
HandlerDelegate to unsubscribe
Enable Click

Enables click events being emitted by the implementing object

void EnableClick()
Parameters
TargetModioUIClickableWidget
Disable Click

Disables click events being emitted by the implementing object

void DisableClick()
Parameters
TargetModioUIClickableWidget
Add Clicked Handler

Registers a delegate to receive callbacks when the implementing object is clicked

void AddClickedHandler(FModioClickableOnClicked Handler)
Parameters
TargetModioUIClickableWidget
HandlerDelegate to invoke on a click event

ModioUICommandLibrary

Library allowing easy access to mod.io UI Command data on a per-command basis

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object


ModioUICommandMenu

Interface indicating the implementing widget is responsible for visualising a list of dynamically generated command objects

Inheritance Hierarchy

-> Interface-> Object

Remove Command List Builder

Unregisters a delegate so it will no longer be invoked when RebuildCommandList is called

void RemoveCommandListBuilder(FModioCommandListBuilder Builder)
Parameters
TargetModioUICommandMenu
BuilderDelegate that will no longer be invoked
Rebuild Command List

Requests the implementing widget invoke all the bound command list builders to regenerate the menu options

void RebuildCommandList()
Parameters
TargetModioUICommandMenu
Add Command List Builder

Registers a delegate to be invoked when RebuildCommandList is called

void AddCommandListBuilder(FModioCommandListBuilder Builder)
Parameters
TargetModioUICommandMenu
BuilderDelegate that will be invoked to allow the command list to be altered

ModioUICommandObject

Inheritance Hierarchy

-> Interface-> Object

Set Data Source

Sets an associated UObject that can be used as a data source/context object for this command

void SetDataSource(UObject* InDataSource)
Parameters
TargetModioUICommandObject
InDataSourceThe object to use as a context
Get Command Display String

Retrieves the text to display for this command

FText GetCommandDisplayString()
Parameters
TargetModioUICommandObject
Returns

Localized display string for this command

Get Command Brush

Retrieves the brush to use as an icon for this command

FSlateBrush GetCommandBrush()
Parameters
TargetModioUICommandObject
Returns

The brush to use as an icon

Execute

Performs the command associated with this object

void Execute(UObject* Context)
Parameters
TargetModioUICommandObject
ContextAdditional secondary context object for this command
Can Execute

Indicates if the command can currently be executed

bool CanExecute(UObject* Context)
Parameters
TargetModioUICommandObject
ContextAdditional secondary context object for this command
Returns

True if the command can be executed


ModioUICommonButtonWidget

Interface indicating the implementing widget can be configured like a CommonButton

Inheritance Hierarchy

-> ModioUIBoundActionWidget-> ModioUIClickableWidget-> Interface-> Object

Configure Common Button

Configures the implementing object as a CommonButton

void ConfigureCommonButton(FModioCommonButtonParams Params)
Parameters
TargetModioUICommonButtonWidget
ParamsThe parameters to configure the button with

ModioUICommonFunctionLibrary

Common utility functions intended for use with the mod.io UI Components

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object


ModioUIComponentBase

Base class for all mod.io UI components that derive from UUserWidget

Inheritance Hierarchy

-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
TObjectPtr<UObject>DataSourceCached object to use as the source for data binding. Populated by SetDataSource
FModioOnActivationChangedMulticastOnModioActivationChangedPasses this as ActivationContext, bIsActivated as the new activation state
FModioOnFocusPathChangedMulticastOnModioFocusPathChangedPasses this as FocusContext, InFocusEvent as the focus event, bIsFocused as the new focus state

ModioUIComponentStatics

Inheritance Hierarchy

-> Object


ModioUIConnectivityChangedReceiver

Inheritance Hierarchy

-> Interface-> Object


ModioUIDataSourceWidget

Interface indicating that the implementing widget can bind to a UObject-derived data source

Inheritance Hierarchy

-> Interface-> Object

Set Data Source

Sets the associated data source/data binding object for the implementing widget

void SetDataSource(UObject* InDataSource)
Parameters
TargetModioUIDataSourceWidget
InDataSourcethe object to use as a data source
Get Data Source

Gets the associated data source/data binding object for the implementing widget

UObject* GetDataSource()
Parameters
TargetModioUIDataSourceWidget
Returns

the object used as a data source


ModioUIDialog

Interface indicating that the implementing widget behaves as a modal dialog that can emit Confirmed/Canceled/Shown events

Inheritance Hierarchy

-> Interface-> Object

Show Modal

Requests that the modal dialog be displayed

void ShowModal(bool bFocusCancelButton)
Parameters
TargetModioUIDialog
bFocusCancelButtonShould the cancel button on the dialog automatically receive focus
Remove Dialog Shown Handler

Unregisters a callback so it no longer receives notifications when the dialog is Shown

void RemoveDialogShownHandler(FModioDialogShownEvent Handler)
Parameters
TargetModioUIDialog
HandlerDelegate that will no longer receive events when the dialog is shown
Remove Dialog Confirmed Handler

Unregisters a callback so it no longer receives notifications when the dialog is confirmed

void RemoveDialogConfirmedHandler(FModioDialogEvent Handler)
Parameters
TargetModioUIDialog
HandlerDelegate that will no longer receive confirmation events
Remove Dialog Canceled Handler

Unregisters a callback so it no longer receives notifications when the dialog is cancelled

void RemoveDialogCanceledHandler(FModioDialogEvent Handler)
Parameters
TargetModioUIDialog
HandlerDelegate that will no longer receive cancellation events
Remove Dialog Button Clicked Handler

Unregisters a callback so it no longer receives notifications when a dialog button is clicked

void RemoveDialogButtonClickedHandler(FModioDialogButtonClickedEvent Handler)
Parameters
TargetModioUIDialog
HandlerDelegate that will no longer receive invocations
Close Modal

Closes the modal dialog, removing it from display

void CloseModal()
Parameters
TargetModioUIDialog
Add Dialog Shown Handler

Registers a callback to receive notifications when the dialog is shown

void AddDialogShownHandler(FModioDialogShownEvent Handler)
Parameters
TargetModioUIDialog
HandlerDelegate to invoke after the dialog is shown
Add Dialog Confirmed Handler

Registers a callback to receive notifications when the dialog is confirmed

void AddDialogConfirmedHandler(FModioDialogEvent Handler)
Parameters
TargetModioUIDialog
HandlerDelegate to invoke on a confirmation event
Add Dialog Canceled Handler

Registers a callback to receive notifications when the dialog is canceled

void AddDialogCanceledHandler(FModioDialogEvent Handler)
Parameters
TargetModioUIDialog
HandlerDelegate to invoke on a cancellation event
Add Dialog Button Clicked Handler

Registers a callback to receive notifications when a dialog button is clicked

void AddDialogButtonClickedHandler(FModioDialogButtonClickedEvent Handler)
Parameters
TargetModioUIDialog
HandlerDelegate to invoke when a button is clicked

ModioUIDialogDisplayEventReceiver

Inheritance Hierarchy

-> Interface-> Object


ModioUIDisplayFilteredModsCommand

Inheritance Hierarchy

-> Object

Set Filter Params
void SetFilterParams(FModioFilterParams FilterParams)
Set Display String Key
void SetDisplayStringKey(FName InDisplayStringKey)

ModioUIEntitlementRefreshEventReceiver

Inheritance Hierarchy

-> Interface-> Object


ModioUIHasConfigurableColor

Inheritance Hierarchy

-> Interface-> Object

Configure Widget Color Directly
void ConfigureWidgetColorDirectly(FName ColorName, FSlateColor ColorValue)
Configure Widget Color
void ConfigureWidgetColor(FName ColorName, FLinearColorRef ColorValue)

ModioUIHasLoadStateWidget

Interface indicating that the implementing widget has a loading state that is either internally or externally managed, and will emit events on loading state transitions

Inheritance Hierarchy

-> Interface-> Object

Set Load State

Requests the implementing widget change its load state to the specified state

void SetLoadState(EModioUILoadState NewState)
Parameters
TargetModioUIHasLoadStateWidget
NewStatethe new state to change to
Remove Load State Changed Handler

Unregisters a delegate so it will no longer receive callbacks when the load state of the implementing widget changes

void RemoveLoadStateChangedHandler(FModioOnLoadStateWidgetStateChanged Handler)
Parameters
TargetModioUIHasLoadStateWidget
HandlerThe delegate to unregister
Get Load State

Retrieves the implementing widget's current load state

EModioUILoadState GetLoadState() const
Parameters
TargetModioUIHasLoadStateWidget
Returns

The current load state for the widget

Add Load State Changed Handler

Registers a delegate to receive callbacks when the load state of the implementing widget changes, either from internal transitions or an external request

void AddLoadStateChangedHandler(FModioOnLoadStateWidgetStateChanged Handler)
Parameters
TargetModioUIHasLoadStateWidget
HandlerDelegate to invoke on a state change event

ModioUIHasTextWidget

Interface indicating the implementing widget has a configurable Text

Inheritance Hierarchy

-> Interface-> Object

Set Widget Text Font

Sets the font for the implementing widget, if applicable

void SetWidgetTextFont(FSlateFontInfo FontInfo)
Parameters
TargetModioUIHasTextWidget
FontInfothe font to use
Set Widget Text

Sets the value of the associated text for the implementing object

void SetWidgetText(FText DisplayText)
Parameters
TargetModioUIHasTextWidget
DisplayTextthe text to display
Get Widget Text Font

Retrieves the font for the implementing widget, if applicable

FSlateFontInfo GetWidgetTextFont()
Parameters
TargetModioUIHasTextWidget
Returns

The font to use

Get Widget Text

Retrieves the value of the implementing widget's associated text

FText GetWidgetText()
Parameters
TargetModioUIHasTextWidget
Returns

The text value


ModioUIHasTooltipWidget

Interface indicating the implementing widget has a configurable tooltip

Inheritance Hierarchy

-> Interface-> Object

Set Tooltip Enabled State

Sets whether a tooltip is enabled on the implementing object

void SetTooltipEnabledState(bool bNewEnabledState)
Parameters
TargetModioUIHasTooltipWidget
bNewEnabledStateTrue if tooltips should be enabled
Configure Tooltip

Configures the values for the associated tooltip for the implementing object

void ConfigureTooltip(FText TitleText, FText InfoText, FText TagText)
Parameters
TargetModioUIHasTooltipWidget
TitleTextThe title of the tooltip
InfoTextThe contents of the tooltip
TagTextThe tagline of the tooltip

ModioUIHoverableWidget

Interface indicating the implementing widget can emit hover state change events

Inheritance Hierarchy

-> Interface-> Object

Remove Hover State Changed Handler

Unregisters a delegate, preventing it from receiving hover state change callbacks

void RemoveHoverStateChangedHandler(FModioHoverableOnHoverStateChanged Handler)
Parameters
TargetModioUIHoverableWidget
HandlerDelegate to unregister
Enable Hover Events

Enable emitting hover state changed events on the implementing object

void EnableHoverEvents()
Parameters
TargetModioUIHoverableWidget
Disable Hover Events

Disable emitting hover state changed events on the implementing object

void DisableHoverEvents()
Parameters
TargetModioUIHoverableWidget
Add Hover State Changed Handler

Register a delegate to receive callbacks when the hover state of the implementing object changes

void AddHoverStateChangedHandler(FModioHoverableOnHoverStateChanged Handler)
Parameters
TargetModioUIHoverableWidget
HandlerDelegate to invoke on hover state change

ModioUIImageDisplayWidget

Interface for widgets that display images

Inheritance Hierarchy

-> Interface-> Object

Set Desired Brush Size

Sets the desired size of the brush

void SetDesiredBrushSize(FVector2D DesiredSize)
Parameters
TargetModioUIImageDisplayWidget
DesiredSizeDesired size of the brush
Set Brush Match Texture Size

Sets whether the brush should match the size of the texture it displays

void SetBrushMatchTextureSize(bool bMatchTextureSize)
Parameters
TargetModioUIImageDisplayWidget
bMatchTextureSizeTrue if the brush should match the texture size, false if it should not
Set Brush Directly

Sets the brush directly

void SetBrushDirectly(FSlateBrush NewBrush)
Parameters
TargetModioUIImageDisplayWidget
NewBrushThe brush to set
Remove Image Load Event Handler

Unregisters a delegate, preventing it from receiving image loading callbacks

void RemoveImageLoadEventHandler(FModioImageDisplayOnLoadStateChanged Handler)
Parameters
TargetModioUIImageDisplayWidget
HandlerDelegate to unregister
Begin Load Image from File

Begins loading an image from a file path

void BeginLoadImageFromFile(FModioImageWrapper Image)
Parameters
TargetModioUIImageDisplayWidget
ImageImage data to load. Can be loaded asynchronously
Add Image Load Event Handler

Register a delegate to receive callbacks when the load state of the implementing object changes

void AddImageLoadEventHandler(FModioImageDisplayOnLoadStateChanged Handler)
Parameters
TargetModioUIImageDisplayWidget
HandlerDelegate to invoke on load state change

ModioUIInputValidationLibrary

Static library of functions to validate text input

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object


ModioUIManageModSubscriptionCommand

Inheritance Hierarchy

-> Object


ModioUIMediaDownloadCompletedReceiver

Inheritance Hierarchy

-> Interface-> Object


ModioUIModEnabledStateChangedReceiver

Inheritance Hierarchy

-> Interface-> Object


ModioUIModEnabledStateProvider

Interface for objects that can provide or store the enabled/disabled state for a mod

Inheritance Hierarchy

-> Interface-> Object

Request Mod Enabled State Change

Requests that the implementing object change the enabled/disabled state of a mod

bool RequestModEnabledStateChange(FModioModID ID, bool bNewEnabledState)
Parameters
TargetModioUIModEnabledStateProvider
IDThe ID of the mod to change the state of
bNewEnabledStateThe new enabled state to set
Returns

True if the request was successful, false if it was not

Remove Mod Enabled State Change Handler
void RemoveModEnabledStateChangeHandler(FModioModEnabledStateChangeHandler Handler)
Parameters
TargetModioUIModEnabledStateProvider
HandlerDelegate to be removed from the notification list
Query Is Mod Enabled

Queries the implementing object for the enabled/disabled state of a mod

bool QueryIsModEnabled(FModioModID ModID)
Parameters
TargetModioUIModEnabledStateProvider
ModIDThe ID of the mod to query
Returns

True if the mod is enabled, false if it is disabled

Add Mod Enabled State Change Handler
void AddModEnabledStateChangeHandler(FModioModEnabledStateChangeHandler Handler)
Parameters
TargetModioUIModEnabledStateProvider
HandlerDelegate to be notified

ModioUIModInfoReceiver

Inheritance Hierarchy

-> Interface-> Object


ModioUIModListViewInterface

Interface for any widget that can visualise a list of mods

Inheritance Hierarchy

-> Interface-> Object

Set Mods from Mod Info List

Populates the list based on the mods contained in the provided ModInfoList

void SetModsFromModInfoList(FModioModInfoList InList, bool bAddToExisting)
Parameters
TargetModioUIModListViewInterface
InListThe set of mods to populate with
bAddToExistingShould the new set be merged with the existing mods or replace them?
Set Mods from Mod Info Array

Populates the list based on the provided raw array of ModInfo objects

void SetModsFromModInfoArray(TArray<FModioModInfo> InArray, bool bAddToExisting)
Parameters
TargetModioUIModListViewInterface
InArrayThe set of mods to populate with
bAddToExistingShould the new set be merged with the existing mods or replace them?
Set Mods from Mod Collection Entry Array

Populates the list based on the provided array of ModCollectionEntry objects

void SetModsFromModCollectionEntryArray(TArray<FModioModCollectionEntry> InArray, bool bAddToExisting)
Parameters
TargetModioUIModListViewInterface
InArrayThe set of mods to populate with
bAddToExistingShould the new set be merged with the existing mods or replace them?
Set Mod Selection by ID

Sets the selected mod in the list based on the passed-in Mod ID

void SetModSelectionByID(FModioModID ModID)
Parameters
TargetModioUIModListViewInterface
ModIDThe mod ID to select

ModioUIModManagementEventReceiver

Inheritance Hierarchy

-> Interface-> Object


ModioUIModTagSelector

Interface class for any widget that displays a set of mod tags for a user to select

Inheritance Hierarchy

-> Interface-> Object

Set Available Tags from Mod Tag Options

Populates the tag selector with the tags specified in the provided tag options struct

void SetAvailableTagsFromModTagOptions(FModioModTagOptions InOptions)
Parameters
TargetModioUIModTagSelector
InOptionsTag data to use to populate the selector
Set Available Tags from Bound Mod Tag Options

Populates the tag selector using the pre-bound tag options

void SetAvailableTagsFromBoundModTagOptions(TScriptInterface<IModioModTagOptionsUIDetails> InOptions)
Parameters
TargetModioUIModTagSelector
InOptionsTag data to use to populate the selector
Remove Tag Selection Changed Handler

Unregisters a delegate so it no longer receives callbacks

void RemoveTagSelectionChangedHandler(FModioOnTagSelectionChanged Handler)
Parameters
TargetModioUIModTagSelector
HandlerDelegate that will no longer receive selection changed events
Get Selected Tags

Retrieves the selected tags from the implementing object

TArray<FString> GetSelectedTags()
Parameters
TargetModioUIModTagSelector
Returns

Array containing the selected tags' raw unlocalized values

Get Allow Locked Tags

Checks if locked tag categories should be shown by the implementing object

bool GetAllowLockedTags()
Parameters
TargetModioUIModTagSelector
Get Allow Hidden Tags

Checks if hidden tag categories should be shown by the implementing object

bool GetAllowHiddenTags()
Parameters
TargetModioUIModTagSelector
Clear Selected Tags

Clears the selection state of the selector

void ClearSelectedTags()
Parameters
TargetModioUIModTagSelector
Add Tag Selection Changed Handler

Registers a delegate to receive callbacks when the set of selected tags changes

void AddTagSelectionChangedHandler(FModioOnTagSelectionChanged Handler)
Parameters
TargetModioUIModTagSelector
HandlerDelegate to invoke on a selection changed event

ModioUIObjectListWidget

Interface indicating that the implementing widget can bind to a list of UObject-derived items

Inheritance Hierarchy

-> Interface-> Object

Set Objects

Sets the associated data source/data binding objects for the implementing widget

void SetObjects(TArray<UObject*> InObjects)
Parameters
TargetModioUIObjectListWidget
InObjectsthe objects to use as a data source
Remove Object Widget Created Handler

Unregisters a delegate from receiving object widget creation callbacks

void RemoveObjectWidgetCreatedHandler(FModioObjectListOnObjectWidgetCreated Handler)
Parameters
TargetModioUIObjectListWidget
HandlerDelegate to remove
Get Objects

Retrieves the associated data source objects for the implementing widget

TArray<UObject*> GetObjects()
Parameters
TargetModioUIObjectListWidget
Returns

Array of UObject-derived objects used as a data source

Get Object At

Retrieves the object at a specific index in the data source

UObject* GetObjectAt(int32 Index) const
Parameters
TargetModioUIObjectListWidget
IndexThe index of the object to retrieve
Returns

The object at the specified index

Get First Entry Widget

Gets the first widget entry in the contained list widget, or nullptr if the list is empty.

UWidget* GetFirstEntryWidget()
Parameters
TargetModioUIObjectListWidget
Add Object Widget Created Handler

Registers a delegate to receive callbacks when a new object widget is created

void AddObjectWidgetCreatedHandler(FModioObjectListOnObjectWidgetCreated Handler)
Parameters
TargetModioUIObjectListWidget
HandlerDelegate to invoke when a new object widget is created

ModioUIObjectSelector

Interface class for any widget that allows a choice between objects

Inheritance Hierarchy

-> Interface-> Object

Set Values

Sets the set of available choices that the user can select between

void SetValues(TArray<UObject*> InValues)
Parameters
TargetModioUIObjectSelector
InValuesArray of UObjects representing choices
Set Single Selection by Value

Sets the current selection for the implementing widget by specifying the associated value

void SetSingleSelectionByValue(UObject* Value, bool bEmitSelectionEvent)
Parameters
TargetModioUIObjectSelector
ValueThe value to select
bEmitSelectionEventTrue if a selection changed event should be emitted
Set Single Selection by Index

Sets the current selection for the implementing widget by index

void SetSingleSelectionByIndex(int32 Index, bool bEmitSelectionEvent)
Parameters
TargetModioUIObjectSelector
IndexThe 0-based index to use when determining the selected object
bEmitSelectionEventTrue if a selection changed event should be emitted
Set Selected State for Value

Sets the selected state for the specified value

void SetSelectedStateForValue(UObject* Value, bool bNewSelectionState, bool bEmitSelectionEvent)
Parameters
TargetModioUIObjectSelector
ValueThe value to set the selection state for
bNewSelectionStateThe new selection state to set
bEmitSelectionEventTrue if a selection changed event should be emitted
Set Selected State for Index

Sets the selected state for the specified index

void SetSelectedStateForIndex(int32 Index, bool bNewSelectionState, bool bEmitSelectionEvent)
Parameters
TargetModioUIObjectSelector
IndexThe 0-based index to set the selection state for
bNewSelectionStateThe new selection state to set
bEmitSelectionEventTrue if a selection changed event should be emitted
Set Multi Selection Allowed

Sets whether the implementing widget should allow multiple selections

void SetMultiSelectionAllowed(bool bMultiSelectionAllowed)
Parameters
TargetModioUIObjectSelector
bMultiSelectionAllowedTrue if multiple selections are allowed
Set List Entry Widget Class

Sets the class to use for list entries in the implementing widget

void SetListEntryWidgetClass(TSubclassOf<UWidget>  InNewEntryClass)
Parameters
TargetModioUIObjectSelector
InNewEntryClassThe class to use for list entries
Remove Selection Changed Handler

Unregisters a delegate so it will not receive callbacks when selection state changes

void RemoveSelectionChangedHandler(FModioOnObjectSelectionChanged Handler)
Parameters
TargetModioUIObjectSelector
HandlerDelegate that will no longer receive callbacks
Get Widget for Value

Retrieves the widget associated with the specified value

UUserWidget* GetWidgetForValue(UObject* Value) const
Parameters
TargetModioUIObjectSelector
ValueThe value to retrieve the widget for
Returns

The widget associated with the specified value

Get Single Selection Index

Gets the current selection for the implementing widget by index

int32 GetSingleSelectionIndex()
Parameters
TargetModioUIObjectSelector
Returns

The 0-based Index of the current selection of the implementing widget

Get Single Selected Value

Retrieves the selection of the implementing widget

UObject* GetSingleSelectedValue()
Parameters
TargetModioUIObjectSelector
Returns

UObject associated with the current selection of the implementing widget

Get Selected Values

Retrieves the selected values from the implementing widget

TArray<UObject*> GetSelectedValues()
Parameters
TargetModioUIObjectSelector
Returns

Array of UObjects representing the selected values

Get Num Entries

Gets the number of entries in the implementing widget

int32 GetNumEntries()
Parameters
TargetModioUIObjectSelector
Returns

The number of entries in the implementing widget

Get Multi Selection Allowed

Retrieves whether the implementing widget allows multiple selections

bool GetMultiSelectionAllowed()
Parameters
TargetModioUIObjectSelector
Returns

True if multiple selections are allowed

Get Last Selection Index

Retrieves the last valid selection index from the implementing widget This index is typically the same as the current selection index. However, if the current selection is invalid (e.g., -1), this function returns the most recent valid selection index.

int32 GetLastSelectionIndex()
Parameters
TargetModioUIObjectSelector
Returns

The 0-based index of the previously selected object

Get Index for Value

Retrieves the index of the specified value

int32 GetIndexForValue(UObject* Value) const
Parameters
TargetModioUIObjectSelector
ValueThe value to retrieve the index for
Returns

The 0-based index of the specified value

Clear Selected Values

Clears the selection state on the implementing widget

void ClearSelectedValues()
Parameters
TargetModioUIObjectSelector
Add Selection Changed Handler

Registers a delegate to receive callbacks when the selection state of the implementing widget changes

void AddSelectionChangedHandler(FModioOnObjectSelectionChanged Handler)
Parameters
TargetModioUIObjectSelector
HandlerDelegate to invoke on selection state change

ModioUIPrioritizeModCommand

Inheritance Hierarchy

-> Object


ModioUIProgressWidget

Interface for widgets that display progress based on a scalar value 0..1

Inheritance Hierarchy

-> Interface-> Object

Set Progress

Directly sets the current progress value of the implementing widget

void SetProgress(float NewProgressValue)
Parameters
TargetModioUIProgressWidget
NewProgressValueThe new progress value
Set Marquee

Sets whether the progress widget should be a marquee/throbber

void SetMarquee(bool bNewIsMarquee)
Parameters
TargetModioUIProgressWidget
bNewIsMarqueeTrue if the progress widget should show indeterminate progress
Set Color Override

Overrides the current color being used to indicate progress on the widget

void SetColorOverride(FLinearColor Override)
Parameters
TargetModioUIProgressWidget
OverrideThe new color to use
Remove Value Changed Handler

Unsubscribes a delegate so it no longer receives callbacks when the implementing widget's progress value changes

void RemoveValueChangedHandler(FModioProgressWidgetValueChanged Handler)
Parameters
TargetModioUIProgressWidget
HandlerDelegate to remove from the notification list
Get Progress

Retrieves the current progress value of the implementing widget

float GetProgress()
Parameters
TargetModioUIProgressWidget
Returns

Progress Value in the range 0..1

Clear Color Override

Resets the color being used to indicate progress to the default implementation-defined value

void ClearColorOverride()
Parameters
TargetModioUIProgressWidget
Add Value Changed Handler

Registers a delegate to receive callbacks when the progress value of the implementing widget changes

void AddValueChangedHandler(FModioProgressWidgetValueChanged Handler)
Parameters
TargetModioUIProgressWidget
HandlerDelegate to receive notifications on value changed events

ModioUIPurchaseModCommand

Inheritance Hierarchy

-> Object


ModioUIReportModCommand

Inheritance Hierarchy

-> Object


ModioUISelectableWidget

Interface for widgets that have a selection state

Inheritance Hierarchy

-> Interface-> Object

Toggle Selected State

Toggles the selected state of the implementing widget

void ToggleSelectedState()
Parameters
TargetModioUISelectableWidget
Set Toggleable

Enables or disables toggle-ability on the implementing widget

void SetToggleable(bool bNewToggleableState)
Parameters
TargetModioUISelectableWidget
bNewToggleableStateTrue to enable the widget's selection state being toggled
Set Selected State

Directly sets the selected state of the implementing widget

void SetSelectedState(bool bNewSelectedState)
Parameters
TargetModioUISelectableWidget
bNewSelectedStateThe new selection state
Set Selectable

Sets the selectable state of the implementing widget

void SetSelectable(bool bNewSelectableState)
Parameters
TargetModioUISelectableWidget
bNewSelectableStateWhether the widget should accept selection or not
Remove Selected State Changed Handler

Unsubscribes a delegate from receiving state change callbacks

void RemoveSelectedStateChangedHandler(FModioSelectableOnSelectionChanged Handler)
Parameters
TargetModioUISelectableWidget
HandlerThe delegate to remove
Get Toggleable

Retrieves the toggle-able state of the implementing widget

void GetToggleable(bool bIsToggleable)
Parameters
TargetModioUISelectableWidget
Is ToggleableTrue if the widget currently can have its selection state toggled
Get Selected State

Retrieves the current selection state of the implementing widget

void GetSelectedState(bool bCurrentSelectedState)
Parameters
TargetModioUISelectableWidget
Current Selected StateTrue if the widget is currently selected
Get Selectable

Retrieves the selectable state of the implementing widget

void GetSelectable(bool bIsSelectable)
Parameters
TargetModioUISelectableWidget
Is SelectableTrue if the implementing widget can be selected
Add Selected State Changed Handler

Registers a delegate that receives a callback when the selected state of the widget changes

void AddSelectedStateChangedHandler(FModioSelectableOnSelectionChanged Handler)
Parameters
TargetModioUISelectableWidget
HandlerDelegate to invoke on state change

ModioUISettings

Inheritance Hierarchy

-> Object

Variables
TSoftObjectPtr<UDataTable>ColorsTable
TSoftObjectPtr<UDataTable>CommandsTable
TSoftObjectPtr<UMaterial>UnderlineMaterial
TSoftObjectPtr<UMaterial>FakeCaretMaterial

ModioUIStringInputWidget

Inheritance Hierarchy

-> Interface-> Object

Set Input

Directly sets/overrides the user input on the implementing widget

void SetInput(FString Input)
Parameters
TargetModioUIStringInputWidget
InputThe input string to set
Set Hint

Sets the hint text for the implementing widget

void SetHint(FText HintText)
Parameters
TargetModioUIStringInputWidget
HintTextText to display
Remove Text Committed Handler

Unregisters a delegate so it will no longer receive callbacks when the user commits text in the implementing widget

void RemoveTextCommittedHandler(FModioOnTextCommitted Handler)
Parameters
TargetModioUIStringInputWidget
HandlerDelegate to unsubscribe
Remove Text Changed Handler

Unregisters a delegate so it will no longer receive callbacks when the text in the implementing widget changes

void RemoveTextChangedHandler(FModioOnTextChanged Handler)
Parameters
TargetModioUIStringInputWidget
HandlerDelegate to unsubscribe
Gather Input

Retrieves the user's input from the implementing widget

FString GatherInput()
Parameters
TargetModioUIStringInputWidget
Returns

The string that the user provided

Add Text Committed Handler

Registers a delegate to receive callbacks when the user commits text in the implementing widget

void AddTextCommittedHandler(FModioOnTextCommitted Handler)
Parameters
TargetModioUIStringInputWidget
HandlerDelegate to invoke on text committed event
Add Text Changed Handler

Registers a delegate to receive callbacks when the text in the implementing widget changes

void AddTextChangedHandler(FModioOnTextChanged Handler)
Parameters
TargetModioUIStringInputWidget
HandlerDelegate to invoke on text changed event

ModioUISubscriptionsChangedReceiver

Inheritance Hierarchy

-> Interface-> Object


ModioUISubsystem

The UI subsystem for mod.io

Inheritance Hierarchy

-> EngineSubsystem-> DynamicSubsystem-> Subsystem-> Object

Unregister Pre Uninstall Handler

Unregisters the currently bound pre-uninstall callback, disabling any veto logic before uninstalls.

void UnregisterPreUninstallHandler()
Parameters
TargetModioUISubsystem
Set Mod Rating State Data Provider

Sets the data provider object for handling Mod Rating actions/tracking.

void SetModRatingStateDataProvider(TScriptInterface<IModRatingStateProvider> InModRatingStateProvider)
Parameters
TargetModioUISubsystem
InModRatingStateProviderThe object implementing the IModRatingStateProvider interface that will act as the data provider.
Set Mod Enabled State Data Provider

Sets the data provider object for handling Mod Enable/Disable actions/tracking.

void SetModEnabledStateDataProvider(TScriptInterface<IModioUIModEnabledStateProvider> InModEnabledStateDataProvider)
Parameters
TargetModioUISubsystem
InModEnabledStateDataProviderThe object implementing the IModioUIModEnabledStateProvider interface that will act as the data provider.
Request Wallet Balance Refresh with Handler

Requests an update of the currently authenticated user's mod.io wallet balance, creating a wallet if one does not already exist. Also executes the given callback upon completion. Executes callbacks in implementations of IModioUIWalletBalanceUpdatedEventReceiver.

void RequestWalletBalanceRefreshWithHandler(FOnGetUserWalletBalanceDelegate Callback)
Parameters
TargetModioUISubsystem
CallbackThe callback to execute upon completion.
Request Wallet Balance Refresh

Requests an update of the currently authenticated user's mod.io wallet balance, creating a wallet if one does not already exist. Executes callbacks in implementations of IModioUIWalletBalanceUpdatedEventReceiver.

void RequestWalletBalanceRefresh()
Parameters
TargetModioUISubsystem
Request User Avatar

Requests download of the currently authenticated user's Avatar. Completion of the request triggers a callback in implementations of IModioUIUserAvatarDownloadCompletedReceiver

void RequestUserAvatar()
Parameters
TargetModioUISubsystem
Request Subscription for Mod IDWith Handler

Subscribes the current user to the provided ModID, optionally subscribing to dependencies, executing the provided callback upon successfully subscribing.

void RequestSubscriptionForModIDWithHandler(FModioModID ID, bool IncludeDependencies, FOnErrorOnlyDelegate Callback)
Parameters
TargetModioUISubsystem
IDThe ModId of the Mod to be subscribed to.
IncludeDependenciesBoolean indicating whether Mods that the given Mod depends on should also be subscribed to.
CallbackThe callback to be executed upon a successful subscription.
Request Subscription for Mod ID

Subscribes the current user to the provided ModID, optionally subscribing to dependencies.

void RequestSubscriptionForModID(FModioModID ID, bool IncludeDependencies)
Parameters
TargetModioUISubsystem
IDThe ModId of the Mod to be subscribed to.
IncludeDependenciesBoolean indicating whether Mods that the given Mod depends on should also be subscribed to.
Request Show Token Purchase UIWith Handler

Attempts to invoke the store for the current platform.

EModioOpenStoreResult RequestShowTokenPurchaseUIWithHandler(FOnShowTokenPurchaseUIResult Callback)
Parameters
TargetModioUISubsystem
CallbackA callback that returns a bool indicating whether the user made a purchase in the store
Returns

Indicates if the native store UI is supported on the current platform, i.e if the store has opened, not if a purchase was made.

Request Show Token Purchase UI

Attempts to invoke the store for the current platform.

EModioOpenStoreResult RequestShowTokenPurchaseUI()
Parameters
TargetModioUISubsystem
Returns

Indicates if the native store UI is supported on the current platform, i.e if the store has opened, not if a purchase was made.

Request Show Dialog

Requests the display of the given Dialog Type, providing the new dialog the given Data Source. Executes only in implementations of IModioDialogDisplayEventReceiver

void RequestShowDialog(EModioUIDialogType DialogType, UObject* DataSource)
Parameters
TargetModioUISubsystem
DialogTypeThe type of dialog to display
DataSourceThe data to hand to the new dialog upon creation
Request Remove Subscription for Mod IDWith Handler

Unsubscribes the current user from the given ModId, executing the given callback upon completing the unsubscribing.

void RequestRemoveSubscriptionForModIDWithHandler(FModioModID ID, FOnErrorOnlyDelegate DedicatedCallback)
Parameters
TargetModioUISubsystem
IDThe ModId of the Mod to unsubscribe from.
Dedicated CallbackThe callback to be executed upon a successful unsubscription.
Request Remove Subscription for Mod ID

Unsubscribes the current user from the given ModId.

void RequestRemoveSubscriptionForModID(FModioModID ID)
Parameters
TargetModioUISubsystem
IDThe ModId of the Mod to unsubscribe from.
Request Refresh Entitlements

Requests a refreshing of the currently logged in user's entitlements (consuming them if possible). This then executes callbacks in implementations of IModioUIWalletBalanceUpdatedEventReceiver.

void RequestRefreshEntitlements()
Parameters
TargetModioUISubsystem
Request Purchase Token Pack

Requests the purchase of the given Token Pack via the currently active online portal provider

bool RequestPurchaseTokenPack(FModioTokenPackID TokenPackID, FOnPlatformCheckoutDelegate Callback)
Parameters
TargetModioUISubsystem
TokenPackIDID of the pack to purchase
CallbackExecuted upon completion of the purchase process, indicating success and any additional information
Returns

Whether - the purchase process was successfully started. Does not indicate status of the purchase itself.

Request Purchase for Mod IDWith Handler

Purchases a mod for the current player, executing the callback upon completion.

void RequestPurchaseForModIDWithHandler(FModioModID ID, FModioUnsigned64 ExpectedPrice, FOnPurchaseModDelegate Callback)
Parameters
TargetModioUISubsystem
IDID of the mod to purchase
ExpectedPriceThe price the user is expected to pay for the mod, this ensures that there is consistency between the displayed price and the price in the backend. If there is a mismatch, the purchase will fail.
CallbackCallback invoked with purchase information once the purchase is completed.
Request Mod Info for Mod IDs

Requests a list of all Mods for the current game that match the given IDs. Executes callbacks in implementations of IModioUIModInfoReceiver

void RequestModInfoForModIDs(TArray<FModioModID> IDs)
Parameters
TargetModioUISubsystem
IDsArray of ModIds to request information on.
Request Mod Enabled State Change

Requests to change the Enabled state of the given Mod to the given State

bool RequestModEnabledStateChange(FModioModID ID, bool bNewEnabledState)
Parameters
TargetModioUISubsystem
IDThe ModID of the Mod to update
bNewEnabledStateThe state to apply to the given Mod.
Request Logo Download for Mod ID

Downloads the logo for the specified ModId. Executes callbacks in implementations of IModioUIMediaDownloadCompletedReceiver

void RequestLogoDownloadForModID(FModioModID ID, EModioLogoSize LogoSize)
Parameters
TargetModioUISubsystem
IDMod ID for use in logo retrieval
LogoSizeParameter indicating the size of logo that's required
Request List All Token Packs

Requests a list of all purchasable Token Packs via the currently active online portal provider The result is received by any class implementing the ModioTokenPackReceiver interface via OnListAllTokenPacksRequestCompleted

void RequestListAllTokenPacks()
Parameters
TargetModioUISubsystem
Request List All Mods

Requests a list of all Mods for the current game. Executes callbacks in implementations of IModioUIModInfoReceiver.

void RequestListAllMods(FModioFilterParams Params, FString RequestIdentifier)
Parameters
TargetModioUISubsystem
ParamsA filter to apply to the results, returning only Mods that match it
RequestIdentifierFor requesters to tell if a set of results or an error belongs to them

Get a gallery image for the specified mod ID. Executes callbacks in implementations of IModioUIMediaDownloadCompletedReceiver

void RequestGalleryImageDownloadForModID(FModioModID ID, int32 Index, EModioGallerySize ImageSize)
Parameters
TargetModioUISubsystem
IDThe mod you want to retrieve an image for
IndexThe zero-based index of the image you want to retrieve
ImageSizeSize of the image you want to retrieve
Request Email Authentication with Handler

Requests the authentication of a provided Authentication Code that has been entered by the user. Calls the callback upon completion.

void RequestEmailAuthenticationWithHandler(FModioEmailAuthCode Code, FOnErrorOnlyDelegate Callback)
Parameters
TargetModioUISubsystem
CodeThe authentication code that has been entered.
CallbackThe callback to be executed upon completion.
Register Pre Uninstall Handler

Registers a callback that will be invoked before mods are uninstalled.

void RegisterPreUninstallHandler(FOnPreUninstallDelegate Callback)
Parameters
TargetModioUISubsystem
CallbackThe Callback to invoke before uninstall. Receives the FModioModID of the mod being uninstalled, and must return a bool indicating approval.
Query Is Mod Enabled

Queries whether the given Mod is enabled. Not to be confused with whether a Mod is Subscribed to.

bool QueryIsModEnabled(FModioModID ID)
Parameters
TargetModioUISubsystem
IDThe Id of the Mod to query the Enabled status of.
Returns

Whether the Mod is enabled or not.

Query Connectivity State

Gets the current Connectivity State

bool QueryConnectivityState()
Parameters
TargetModioUISubsystem
Returns

The current connectivity State.

Notify Connectivity Change

Updates the current Connectivity state, and notifies implementations of IMOdioUIConnectivityChangedReceiver only if the state changes.

void NotifyConnectivityChange(bool bNewConnectivityState)
Parameters
TargetModioUISubsystem
bNewConnectivityStatethe new Connectivity state
Is UGCFeature Enabled

Indicates whether a UGC subsystem feature is enabled

bool IsUGCFeatureEnabled(EModioUIFeatureFlags Feature)
Parameters
TargetModioUISubsystem
FeatureThe feature to query
Returns

bool indicating the state of the specified feature

Get Current DPIScale Value

Gets the current DPI scale value of the UI based on the viewport size.

float GetCurrentDPIScaleValue()
Parameters
TargetModioUISubsystem
Returns

The scale of the UI.

Enable Mod Management

Enables mod management, installing the UI subsystem as the mod management event handler so notifications can be broadcast to UI

FModioErrorCode EnableModManagement()
Parameters
TargetModioUISubsystem
Returns

An error code indicating success or failure of enabling mod management. Note that this is independent of error codes for mod management events. Inspect the Callback for information on each mod management event.

Disable Mod Management

Disables mod management.

void DisableModManagement()
Parameters
TargetModioUISubsystem

ModioUISupportsCustomNavigation

Interface indicating that the implementing widget can query a custom delegate to provide navigation logic

Inheritance Hierarchy

-> Interface-> Object

Set Navigation Delegate

Sets a custom delegate to determine what should be focused during navigation

void SetNavigationDelegate(uint8 Context, FCustomWidgetNavigationDelegate ContentNavigationDelegate)
Parameters
TargetModioUISupportsCustomNavigation
Context
Content Navigation Delegate

ModioUITextValidator

Interface indicating that the implementing widget can be configured with validation rules to check text. The widget can optionally visualize a validation error if one occurs, or requested to show a specific error from and external source.

Inheritance Hierarchy

-> Interface-> Object

Validate Text

Performs validation on the text passed in, storing the validation message of the first rule that failed validation in ValidationMessageText if validation failed

bool ValidateText(FText InputText, FText ValidationMessageText)
Parameters
TargetModioUITextValidator
InputTextthe text to validate
Validation Message TextFText containing the localised failure message
Set Validation Error

SChange the validation error with new text

void SetValidationError(FText ErrorText)
Parameters
TargetModioUITextValidator
ErrorTextThe new string to set on this instance
Remove Text Validation Completed Handler

Unregisters a delegate so it no longer receives callbacks

void RemoveTextValidationCompletedHandler(FModioOnTextValidationCompleted Handler)
Parameters
TargetModioUITextValidator
HandlerDelegate that will no longer receive text validation events
Get Text Validation Rules

SRetrieve the validation rules stored in this instance

void GetTextValidationRules(TArray<FModioTextValidationRule> Rules)
Parameters
TargetModioUITextValidator
RulesReference array where the rules will be stored
Add Text Validation Completed Handler

SRegisters a delegate to receive callbacks when text validation completes

void AddTextValidationCompletedHandler(FModioOnTextValidationCompleted Handler)
Parameters
TargetModioUITextValidator
HandlerDelegate to invoke on a text validation event

ModioUIToggleModEnabledCommand

Inheritance Hierarchy

-> Object


ModioUITokenPackListInterface

Interface for any widget that can visualise a list of token packs

Inheritance Hierarchy

-> Interface-> Object

Set Token Packs from Token Pack List

Populates the list based on the token packs contained in the provided TokenPackList

void SetTokenPacksFromTokenPackList(FModioTokenPackList InList, bool bAddToExisting)
Parameters
TargetModioUITokenPackListInterface
InListThe set of token packs to populate with
bAddToExistingShould the new set be merged with the existing token packs or replace them?
Set Token Packs from Token Pack Array

Populates the list based on the provided raw array of Token Pack objects

void SetTokenPacksFromTokenPackArray(TArray<FModioTokenPack> InArray, bool bAddToExisting)
Parameters
TargetModioUITokenPackListInterface
InArrayThe set of token packs to populate with
bAddToExistingShould the new set be merged with the existing token packs or replace them?
Set Token Pack Selection by ID

Sets the selected token pack in the list based on the passed-in Token Pack ID

void SetTokenPackSelectionByID(FModioTokenPackID TokenPackID)
Parameters
TargetModioUITokenPackListInterface
TokenPackIDThe token pack ID to select

ModioUITokenPackReceiver

Inheritance Hierarchy

-> Interface-> Object


ModioUIUserAvatarDownloadCompletedReceiver

Inheritance Hierarchy

-> Interface-> Object


ModioUIUserChangedReceiver

Inheritance Hierarchy

-> Interface-> Object


ModioUIViewModCommand

Inheritance Hierarchy

-> Object


ModioUIWalletBalanceUpdatedEventReceiver

Inheritance Hierarchy

-> Interface-> Object


ModioUserDisplay

The User Display component is a widget that visualizes an FModioUser object.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
TObjectPtr<UObject>EditorDataSource

ModioUserUI

Wrapper around FModioUser when consumer needs UObject-representable data (e.g. for UMG as a list item or data source)

Inheritance Hierarchy

-> Object


ModioUserUIDetails

Inheritance Hierarchy

-> Interface-> Object

Get User ID

Queries the implementing object for the User ID for the user that the object represents

FModioUserID GetUserID()
Parameters
TargetModioUserUIDetails
Returns

User ID for the associated user

Get Full User

Queries the implementing object for the user that the object represents

FModioUser GetFullUser()
Parameters
TargetModioUserUIDetails
Returns

FModioUser for the associated user


PropertyOverridesLibrary

Library of functions for resolving and applying property overrides in UMG components. These functions are intended to be used in UMG components to allow conditional editing of properties based on an override flag.

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object


WBP_DefaultTagButton

Inheritance Hierarchy

-> ModioDefaultIconButton-> ModioDefaultTextButton-> ModioButtonWidget-> CommonButtonBase-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FLinearColorRefNormalColor
FLinearColorRefSelectedColor
FLinearColorRefHoveredColor

WBP_ModioActionBarButton

Inheritance Hierarchy

-> CommonBoundActionButton-> CommonButtonBase-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables

WBP_ModioActionWidgetButton

A button widget for triggering various actions across the UI.

Inheritance Hierarchy

-> ModioButtonWidget-> CommonButtonBase-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables

WBP_ModioDefaultButton

A standard button used across the UI.

Inheritance Hierarchy

-> ModioDefaultTextButton-> ModioButtonWidget-> CommonButtonBase-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FLinearColorRefNormalColor
FLinearColorRefSelectedColor
FLinearColorRefHoveredColor
FLinearColorRefTextColor
FLinearColorRefSelectedTextColor
boolbUseBorder
FIntegerOverrideTextSize_DEPRECATEDUse size member of FontProperties instead
FSlateFontInfoOverrideFontProperties
FHAlignOverrideTextAlignment
FTextTransformOverrideTextTransform
UObject*HighlightBorderOverrideImage
UObject*BackgroundBorderOverrideImage
FLinearColorRefNormalBorderColor
FLinearColorRefSelectedBorderColor
FLinearColorRefHoveredBorderColor
FMarginContentPadding

WBP_ModioDefaultCommandEntry

Represents a single command entry.

Inheritance Hierarchy

-> ModioCommandEntry-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables

WBP_ModioDefaultCommandList

A list of available commands.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FOnSelectionChangedOnSelectionChanged

WBP_ModioDefaultCommandMenu

A menu displaying a list of commands.

Inheritance Hierarchy

-> ModioCommandMenu-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FLinearColorRefBackgroundColor

WBP_ModioDefaultConfirmPurchaseDialog

The Confirm Purchase Dialog allows users to confirm the purchase of a selected mod.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FOnDialogConfirmedOnDialogConfirmed
FOnDialogCanceledOnDialogCanceled
EModioUILoadStatePurchaseResultsLoadingState
FLinearColorRefTokenIconColor

WBP_ModioDefaultDialogButton

A button used within dialog windows.

Inheritance Hierarchy

-> WBP_ModioDefaultButton-> ModioDefaultTextButton-> ModioButtonWidget-> CommonButtonBase-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables

WBP_ModioDefaultEmailAuthDialog

The Email Authentication Dialog prompts users to enter their email address and the authentication code sent to that address.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
int32EmailInputSubdialogIndex
int32CodeInputSubdialogIndex
FOnDialogConfirmedOnDialogConfirmed
FOnDialogCancelledOnDialogCancelled

WBP_ModioDefaultEnumSelectorEntry

An entry that represents a single selectable enum option.

Inheritance Hierarchy

-> ModioEnumSelectorEntry-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables

WBP_ModioDefaultEnumSelectorMenu

A menu that displays selectable enum options.

Inheritance Hierarchy

-> ModioEnumSelectorMenu-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FLinearColorRefBackgroundColor

WBP_ModioDefaultIconButton

A button that displays only an icon, without text.

Inheritance Hierarchy

-> ModioDefaultIconButton-> ModioDefaultTextButton-> ModioButtonWidget-> CommonButtonBase-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FLinearColorRefNormalColor
FLinearColorRefSelectedColor
FLinearColorRefHoveredColor
boolbFreezeBorderColorOnSelection
FLinearColorRefTextColor
FLinearColorRefSelectedTextColor
boolbSwapIconSide
FSlateBrushIcon
FHAlignOverrideHorizontalAlignmentOverride
FSlateFontInfoOverrideFontProperties
FHAlignOverrideTextAlignment
FTextTransformOverrideTextTransform
FLinearColorRefIconColor
FLinearColorRefSelectedIconColor
boolbDisplayText
FLinearColorRefBorderColorToFreeze
boolbFreezeBorderColor
boolbUseBorder
UObject*HighlightBorderOverrideImage
UObject*BackgroundBorderOverrideImage
FLinearColorRefSelectedBorderColor
FMarginContentPadding
FLinearColorRefNormalBorderColor

WBP_ModioDefaultInsufficientTokensDialog

The Insufficient Tokens Dialog informs users that they do not have enough tokens to proceed.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables

WBP_ModioDefaultModDependenciesConfirmDialog

The Mod Dependencies Confirm Dialog displays the required dependencies for a mod and allows users to confirm their acknowledgment.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FOnDialogConfirmedOnDialogConfirmed
FOnDialogCanceledOnDialogCanceled
FLinearColorRefTotalBackgroundColor
FModioModIDCurrentModID
doubleTargetModDependencyListScrollOffset
FModioUnsigned64TotalSizeToInstall

WBP_ModioDefaultModDependenciesDisplayDialog

The Mod Dependencies Display Dialog shows a list of dependencies required for a selected mod.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FOnDialogConfirmedOnDialogConfirmed
FOnDialogCanceledOnDialogCanceled
FLinearColorRefTotalBackgroundColor
FModioModIDCurrentModID
doubleTargetModDependencyListScrollOffset
FModioUnsigned64TotalSizeToInstall

WBP_ModioDefaultModDependencyEntry

An entry displaying a single dependency for a mod.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FLinearColorRefBackgroundColor
UMaterialInterface*InstalledStatusMaterial
FModioModIDCurrentModID
EModioLogoSizeDesiredLogoSize
FTextInstalledStatusText
FLinearColorRefInstalledStatusColor
FLinearColorRefNotInstalledStatusColor

WBP_ModioDefaultModDependencyList

A list displaying all dependencies for a selected mod.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FOnSelectionChangedOnSelectionChanged

WBP_ModioDefaultModDescriptionDialog

The Mod Description Dialog displays the description of a selected mod.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
int32NavigationScrollOffsetStep

WBP_ModioDefaultModDetailsCommandEntry

An entry representing a single command available in the mod details view.

Inheritance Hierarchy

-> ModioCommandEntry-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables

WBP_ModioDefaultModDetailsCommandList

A list of available commands within the mod details view.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FOnSelectionChangedOnSelectionChanged

WBP_ModioDefaultModDetailsMoreOptionsMenu

A menu displaying additional options for a mod in the details view, such as reporting, viewing mods by the same author, or viewing dependencies.

Inheritance Hierarchy

-> ModioCommandMenu-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FLinearColorRefBackgroundColor

WBP_ModioDefaultModDetailsMoreOptionsPopupMenu

A popup menu with additional options available in the mod details view.

Inheritance Hierarchy

-> ModioPopupCommandMenu-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables

WBP_ModioDefaultModDownloadVisualizer

Displays the download count for a mod.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FTextLabelTextValue
UObject*EditorDataSource
FTextDownloadFormatText
boolbShowPropertyLabel
FLinearColorRefPropertyLabelColor

WBP_ModioDefaultModDownloadVisualizer_Horizontal

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FTextLabelTextValue
UObject*EditorDataSource
FTextDownloadFormatText
boolbShowPropertyLabel
FLinearColorRefPropertyLabelColor

WBP_ModioDefaultModEnabledStatusWidget

Displays the current enabled/disabled status of a mod.

Inheritance Hierarchy

-> ModioModEnabledStatusWidget-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FLinearColorRefBackgroundColor
UMaterialInterface*DisabledImage
UMaterialInterface*EnabledImage

WBP_ModioDefaultModEnabledToggleWidget

A widget to toggle the enabled/disabled status of a mod.

Inheritance Hierarchy

-> ModioModEnabledToggleWidget-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FLinearColorRefBackgroundColor
FTextDisableModText
FTextEnableModText

WBP_ModioDefaultModInstallationProgressBar

Inheritance Hierarchy

-> ModioModInstallationStatusWidget-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables

WBP_ModioDefaultModInstallationStatusWidget

Displays the installation status of a mod.

Inheritance Hierarchy

-> ModioModInstallationStatusWidget-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
boolbDisplayStatusText
FLinearColorRefDefaultBackgroundColor
FLinearColorRefErrorBackgroundColor
FLinearColorRefDefaultTextColor
FLinearColorRefDisabledTextColor
FLinearColorRefProcessingTextColor
FLinearColorRefDefaultIconColor
FLinearColorRefDisabledIconColor
FLinearColorRefEnabledIconColor
FLinearColorRefExtractingProgressBarColor
FTextEnabledStatusText
FTextDisabledStatusText
FTextErrorStatusText
FTextQueuedStatusText
FTextDownloadingStatusText
FTextExtractingStatusText
FTextPurchasedStatusText
FTextInitializingStatusText
FTextUploadingStatusText
FTextUploadedStatusText
FTextSystemInstallStatusText
FSlateBrushSystemInstallStatusIcon
FSlateBrushEnabledStatusIcon
FSlateBrushDisabledStatusIcon
FSlateBrushErrorStatusIcon
FSlateBrushQueuedStatusIcon
FSlateBrushDownloadingStatusIcon
FSlateBrushExtractingStatusIcon
FSlateBrushPurchasedStatusIcon
FSlateBrushInitializingStatusIcon
FSlateBrushUploadingStatusIcon
FSlateBrushUploadedStatusIcon
boolbDisplayPurchasedState

WBP_ModioDefaultModPropCollectionVisualizer

Displays a collection of properties for a mod, such as downloads, rating, size, and other metadata.

Inheritance Hierarchy

-> ModioModPropCollectionVisualizer-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
UObject*EditorDataSource
FLinearColorRefBackgroundColor

WBP_ModioDefaultModRatingVisualizer

Displays the rating of a mod.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FTextFilesizeLabelText
UObject*EditorDataSource
boolbShowPropertyLabel
FLinearColorRefPropertyLabelColor

WBP_ModioDefaultModRatingVisualizer_Horizontal

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FTextFilesizeLabelText
UObject*EditorDataSource
boolbShowPropertyLabel
FLinearColorRefPropertyLabelColor

WBP_ModioDefaultModReleaseDateVisualizer

Displays the release date of a mod.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FTextLabelTextValue
UObject*EditorDataSource
boolbShowPropertyLabel
FLinearColorRefPropertyLabelColor

WBP_ModioDefaultModSizeVisualizer

Displays the file size of a mod.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FTextFilesizeLabelText
UObject*EditorDataSource
boolbShowPropertyLabel
FLinearColorRefPropertyLabelColor

WBP_ModioDefaultModSizeVisualizer_Horizontal

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FTextFilesizeLabelText
UObject*EditorDataSource
boolbShowPropertyLabel
FLinearColorRefPropertyLabelColor

WBP_ModioDefaultModSubscribersVisualizer

Displays the subscriber count for a mod.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FTextLabelTextValue
UObject*EditorDataSource
FTextSubscriberCountFormatText
boolbShowPropertyLabel
FLinearColorRefPropertyLabelColor

WBP_ModioDefaultModSubscriptionStatusWidget

Displays the subscription status of a mod.

Inheritance Hierarchy

-> ModioModSubscriptionStatusWidget-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables

WBP_ModioDefaultModTile

Displays a mod tile with key details like title, image, and relevant metadata.

Inheritance Hierarchy

-> ModioDefaultModTile-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FLinearColorRefNormalBorderColor
FLinearColorRefSelectedBorderColor
FLinearColorRefNormalBackgroundColor
FLinearColorRefSelectedBackgroundColor
FLinearColorRefPremiumBackgroundColor
FLinearColorRefNormalTextColor
FLinearColorRefSelectedTextColor
FLinearColorRefPriceTextColor
FTextPurchasedLabelText

WBP_ModioDefaultModTileModPropCollectionVisualizer

Displays properties associated with a mod tile, such as size, download count, and rating.

Inheritance Hierarchy

-> ModioModPropCollectionVisualizer-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
UObject*EditorDataSource
FLinearColorRefBackgroundColor

WBP_ModioDefaultModUpdatedVisualizer

Displays the last updated date for a mod.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FTextLabelTextValue
UObject*EditorDataSource
boolbShowPropertyLabel
FLinearColorRefPropertyLabelColor
FTextValueFormatText
boolbUseTimeElapsed
FTextYear Format
FTextMonth Format
FTextDay Format
FTextToday Format

WBP_ModioDefaultModVersionVisualizer

Displays the current version of a mod.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FTextLabelTextValue
UObject*EditorDataSource
boolbShowPropertyLabel
FLinearColorRefPropertyLabelColor

WBP_ModioDefaultModalDialogImpl

The base implementation for modal dialogs.

Inheritance Hierarchy

-> ModioDefaultModalDialogImpl-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FLinearColorRefHeaderBackgroundColor
FLinearColorRefPrimaryBackgroundColor
FLinearColorRefButtonBackgroundColor
FLinearColorRefFooterBackgroundColor
FTextDefaultHeadingText
FTextDefaultPrimaryText
FFloatOverrideMinimumWidth
FFloatOverrideMinimumHeight

WBP_ModioDefaultMultiTagSelectorEntry

Represents a selectable tag entry that allows multiple tags to be selected.

Inheritance Hierarchy

-> ModioModTagSelectorEntry-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FSlateBrushCheckboxImage_Unselected
FSlateBrushCheckboxImage_Selected

WBP_ModioDefaultPlatformUsername

Displays the platform username of the user.

Inheritance Hierarchy

-> ModioUserDisplay-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FTextPlatformUserNameFormat

WBP_ModioDefaultPopupCommandMenu

A popup menu displaying commands.

Inheritance Hierarchy

-> ModioPopupCommandMenu-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FOnToggleStateChangedOnToggleStateChanged

WBP_ModioDefaultPresetFilterEntryWidget

Represents an entry for a preset filter option.

Inheritance Hierarchy

-> ModioPresetFilterEntryWidget-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FLinearColorRefBackgroundColor
FOnClickedOnClicked

WBP_ModioDefaultPresetFilterSelectorWidget

A selector for choosing from preset filters.

Inheritance Hierarchy

-> ModioPresetFilterSelector-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables

WBP_ModioDefaultPurchaseTermsButtonsGroup

A group of buttons related to terms and conditions for purchases.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FStringTermsURL
FStringRefundURL

WBP_ModioDefaultRadialProgressWidget

A widget displaying radial progress, used for loading or progress indicators.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
UMaterialInterface*RadialProgressMaterial
UMaterialInstanceDynamic*ProgressMaterialInstance
doubleCurrentProgressValue
FLinearColorOriginalColor
doublePreviewProgress

WBP_ModioDefaultRatingDisplay

Displays the rating of a mod.

Inheritance Hierarchy

-> ModioModRatingDisplay-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FLinearColorRefPositiveColor
FLinearColorRefMixedColor
FLinearColorRefNegativeColor
TArray<FInt32Range>RatingColorRange

WBP_ModioDefaultReportContentDialog

The Report Content Dialog allows users to report inappropriate content related to a mod.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FSlateBrushLoadingCog

WBP_ModioDefaultSingleTagSelectorEntry

Represents a selectable tag entry that allows only one tag to be selected at a time.

Inheritance Hierarchy

-> ModioModTagSelectorEntry-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FSlateBrushRadioButton_Selected
FSlateBrushRadioButton_Unselected

WBP_ModioDefaultSlottedButton

A customizable button that can display different content based on the slot.

Inheritance Hierarchy

-> ModioButtonWidget-> CommonButtonBase-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FLinearColorRefNormalColor
FLinearColorRefSelectedColor
FLinearColorRefHoveredColor
FLinearColorRefTextColor

WBP_ModioDefaultSpecialButton

A specialized button with unique styling.

Inheritance Hierarchy

-> ModioDefaultTextButton-> ModioButtonWidget-> CommonButtonBase-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FLinearColorRefNormalColor
FLinearColorRefSelectedColor
FLinearColorRefHoveredColor
FLinearColorRefTextColor
FLinearColorRefSelectedTextColor
boolbUseBorder
FLinearColorRefSelectedBorderColor
UObject*HighlightBorderOverrideImage
UObject*BackgroundBorderOverrideImage

WBP_ModioDefaultTOSDialog

The Terms of Service Dialog presents the terms and conditions for using the platform.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FOnDialogConfirmedOnDialogConfirmed
FOnDialogCancelledOnDialogCancelled

WBP_ModioDefaultTagCategoryContainer

A container for grouping related tags within a category.

Inheritance Hierarchy

-> ModioModTagSelectorCategory-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
boolbSelectable
boolbSelected
boolbToggleable
FSlateBrushExpandedIconBrush
FSlateBrushClosedIconBrush
FLinearColorRefIconColor
FOnNavigationOutsideBoundsOnNavigationOutsideBounds

WBP_ModioDefaultTagDisplay

Displays a tag associated with a mod.

Inheritance Hierarchy

-> ModioModTagDisplay-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables

WBP_ModioDefaultTagSelectorMenu

A menu displaying available tags for selection.

Inheritance Hierarchy

-> ModioModTagSelectorMenu-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FOnNavigationOutsideBoundsOnNavigationOutsideBounds

WBP_ModioDefaultTagWidget

A widget representing an individual mod tag.

Inheritance Hierarchy

-> ModioDefaultTagWidget-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables

WBP_ModioDefaultTermsButtonsGroup

A group of buttons related to general terms and conditions.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FStringTermsURL
FStringPrivacyURL

WBP_ModioDefaultTokenPackBrowser

Inheritance Hierarchy

-> ModioTokenPackBrowser-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FModioTokenPackIDPackToPurchase

WBP_ModioDefaultTokenPackTile

Inheritance Hierarchy

-> ModioDefaultTokenPackTile-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables

WBP_ModioDefaultWaitDialog

The Wait Dialog indicates to users that a process is ongoing.

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables

WBP_ModioFilterCounterButton

Displays a filter button with a counter indicating the number of currently applied filters.

Inheritance Hierarchy

-> ModioFilterCounterButton-> ModioDefaultTextButton-> ModioButtonWidget-> CommonButtonBase-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FLinearColorRefNormalColor
FLinearColorRefSelectedColor
FLinearColorRefHoveredColor
FLinearColorRefTextColor
FLinearColorRefSelectedTextColor
FHAlignOverrideHorizontalAlignmentOverride
FLinearColorRefNormalBorderColor

WBP_ModioFilterPanel

Displays a panel where users can select filter tags and includes a button to clear all applied filters.

Inheritance Hierarchy

-> ModioFilterPanel-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FLinearColorRefFilterPanelBackgroundColor
FLinearColorRefFilterPanelHeaderColor

WBP_ModioGalleryListEntry

A gallery entry for displaying an individual item in a list.

Inheritance Hierarchy

-> ModioGalleryListEntry-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FLinearColorRefUnselectedColor
FLinearColorRefSelectedColor

WBP_ModioImageGallery

A gallery displaying a collection of images.

Inheritance Hierarchy

-> ModioImageGallery-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FSlateBrushLoadingCog
boolbTouchInteractionActive

WBP_ModioLibraryCategorySelector

Inheritance Hierarchy

-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
boolbSelectable
boolbSelected
boolbToggleable
FSlateBrushExpandedIconBrush
FSlateBrushClosedIconBrush
FLinearColorRefIconColor
FOnNavigationOutsideBoundsOnNavigationOutsideBounds

WBP_ModioLibraryFilterPanel

Inheritance Hierarchy

-> ModioFilterPanel-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FLinearColorRefFilterPanelBackgroundColor
FLinearColorRefFilterPanelHeaderColor

WBP_ModioModBrowser

Main widget that displays available mods and includes features for search, filtering, sorting, toggling between installed mods and all available mods, preset filter selectors, and other mod-related actions.

Inheritance Hierarchy

-> ModioModBrowser-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FModioFilterParamsSearchParams
FModioUnsigned64Wallet Balance
FLinearColorRefBackgroundColor
FSlateBrushLibraryIcon
FSlateBrushRecentIcon
FSlateBrushTrendingIcon
int32SelectedLibraryCategoryIndex
FLinearColorRefHeaderSeparatorColor
boolbSearchBoxIsExpanded

WBP_ModioModDetailsDialog

The Mod Details Dialog displays information about a mod, including the title, author, summary, subscription options, likes/dislikes, tags, images, file size, download count, and other relevant details.

Inheritance Hierarchy

-> ModioModDetailsDialog-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FLinearColorRefPremiumBadgeColor
FLinearColorRefBackgroundColor
EModioRatingCurrentModRating
EModioRatingNewRating

WBP_ModioOperationTracker

Tracks the status and progress of ongoing mod-related operations.

Inheritance Hierarchy

-> ModioOperationTracker-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FSlateBrushDownloadingImageBrush
FSlateBrushExtractingImageBrush
FSlateBrushQueueCountImageBrush
FLinearColorRefDownloadingIconColor
FLinearColorRefQueueCountIconColor
FLinearColorRefExtractingIconColor

WBP_ModioStorageTracker

Tracks storage usage and availability for downloaded mods.

Inheritance Hierarchy

-> ModioStorageTracker-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables

WBP_ModioTagCounterIcon

Icon used within the Filter Counter Button to display the active filter count.

Inheritance Hierarchy

-> ModioTagCounterIcon-> ModioUIComponentBase-> CommonActivatableWidget-> CommonUserWidget-> UserWidget-> Widget-> Visual-> Object

Variables
FLinearColorRefBackgroundColor

Structs

ModioDefaultCodeInputTextBoxStyle

Inheritance Hierarchy

-> Text Block Style-> Slate Widget Style

Variables
FSlateBrushCharacterBorderBrushBase
FSlateBrushCharacterBorderBrushFocused
FMarginCharacterBorderPadding
FSlateBrushFakeCaretBrush
TEnumAsByte<EHorizontalAlignment>FakeCaretHorizontalAlignment
TEnumAsByte<EVerticalAlignment>FakeCaretVerticalAlignment
FMarginCharacterPadding
FMarginCharacterSpacing
floatMinimumCharacterWidth

ModioCommonButtonParams

Struct representing either a spacer or a common button - primarily intended for use in shortcut widgets

Variables
boolbIsSpacerWhether this button is a spacer or a common button
int32WidthWidth and height of the button - only used if a spacer
int32HeightWidth and height of the button - only used if a spacer
FTextOverrideButtonRoleDescriptionDescription of the role of the button - only used if not a spacer, but a button
int32MinWidthMinimum width of the button - only used if not a spacer, but a button
int32MinHeightMinimum height of the button - only used if not a spacer, but a button
FClassPathOverrideStyleStyle to apply to the button - only used if not a spacer, but a button
FDataTableRowHandleTriggeringInputActionAction to apply for the button click - only used if not a spacer, but a button
boolbConsumePointerInputWhether to consume pointer input when the button is clicked - only used if not a spacer, but a button
boolbShouldUseFallbackDefaultInputActionWhether to use the default input action if TriggeringInputAction is not set - only used if not a spacer, but a button

ClassPathOverride

Struct for conveniently handling class path overrides in UMG components. Allows conditional editing of a class path value based on the bOverride flag that is displayed inline as an edit condition toggle. See UPropertyOverridesLibrary for functions to resolve and apply overrides (ResolveClassPathOverride, ApplyClassPathOverride).

Variables
boolbOverrideWhether the value is overridden
FSoftClassPathValueThe overridden value

TextOverride

Struct for conveniently handling text overrides in UMG components. Allows conditional editing of a text value based on the bOverride flag that is displayed inline as an edit condition toggle. See UPropertyOverridesLibrary for functions to resolve and apply overrides (ResolveTextOverride, ApplyTextOverride).

Variables
boolbOverrideWhether the value is overridden
FTextValueThe overridden value

ModioDialogButtonInfo

Data structure representing a dialog button

Variables
FTextButtonLabelLabel for the button
FClassPathOverrideStyleOverrideStyle to apply to the button
FInputActionOverrideInputActionOverrideAction to apply for the button click
boolbShowTooltipWhether to show a tooltip for the button
FTextTooltipTitleTextTitle for the tooltip, if shown
FTextTooltipInfoTextInfo text for the tooltip, if shown
FTextTooltipTagTextTag text for the tooltip, if shown
boolbFocusedByDefaultWhether the button should be focused by default

InputActionOverride

Struct for conveniently handling input action overrides in UMG components. Allows conditional editing of an input action value based on the bOverride flag that is displayed inline as an edit condition toggle. See UPropertyOverridesLibrary for functions to resolve and apply overrides (ResolveInputActionOverride, ApplyInputActionOverride).

Variables
boolbOverrideWhether the value is overridden
FDataTableRowHandleValueThe overridden value

ModioFeaturedCategoryParams

Struct wrapping common query settings to be visualized as a featured search

Variables
FTextCategoryNameName of the category (e.g. "Popular Mods")
TArray<FString>TagsTags to include in the filter (e.g. "RPG", "Fantasy")
TArray<FString>ExcludedTagsTags to exclude from the filter (e.g. "RPG", "Fantasy")
EModioSortDirectionDirectionSort direction for the category
EModioSortFieldTypeSortFieldSort field for the category
int64CountNumber of mods to display in the category

ModioUIColorEntry

Struct representing a color entry in a data table

Inheritance Hierarchy

-> Table Row Base

Variables
FLinearColorColorThe color to use for the entry

LinearColorRef

Blueprint-compatible truct representing a color reference

Variables
FNameReferencedColorNameThe name of the color to reference
FLinearColorFallbackColorThe color to use if the reference is not found

LinearColorRefOverride

Blueprint-compatible struct representing a color reference override

Variables
boolbOverrideWhether the color reference is overridden
FLinearColorRefColorThe color to use if the reference is overridden

IntegerOverride

Struct for conveniently handling integer overrides in UMG components. Allows conditional editing of an integer value based on the bOverride flag that is displayed inline as an edit condition toggle. See UPropertyOverridesLibrary for functions to resolve and apply overrides (ResolveIntOverride, ApplyIntOverride).

Variables
boolbOverrideWhether the value is overridden
int32ValueThe overridden value

FloatOverride

Struct for conveniently handling float overrides in UMG components. Allows conditional editing of a float value based on the bOverride flag that is displayed inline as an edit condition toggle. See UPropertyOverridesLibrary for functions to resolve and apply overrides (ResolveFloatOverride, ApplyFloatOverride).

Variables
boolbOverrideWhether the value is overridden
floatValueThe overridden value

HAlignOverride

Struct for conveniently handling horizontal alignment overrides in UMG components. Allows conditional editing of a horizontal alignment value based on the bOverride flag that is displayed inline as an edit condition toggle. See UPropertyOverridesLibrary for functions to resolve and apply overrides (ResolveHAlignOverride, ApplyHAlignOverride).

Variables
boolbOverrideWhether the value is overridden
TEnumAsByte<EHorizontalAlignment>ValueThe overridden value

SlateFontInfoOverride

Struct for conveniently handling font info overrides in UMG components. Allows conditional editing of a font info value based on the bOverride flag that is displayed inline as an edit condition toggle. See UPropertyOverridesLibrary for functions to resolve and apply overrides (ResolveFontInfoOverride, ApplyFontInfoOverride).

Variables
boolbOverrideWhether the value is overridden
FSlateFontInfoValueThe overridden value

TextTransformOverride

Struct for conveniently handling text transform overrides in UMG components. Allows conditional editing of a text transform value based on the bOverride flag that is displayed inline as an edit condition toggle. See UPropertyOverridesLibrary for functions to resolve and apply overrides (ResolveTextTransformOverride, ApplyTextTransformOverride).

Variables
boolbOverrideWhether the value is overridden
ETextTransformPolicyValueThe overridden value

ModioRetryCounter

A simple retry counter that can be used to limit the number of retries for a given operation

Variables
int32RetriesRemainingNumber of retries remaining

ModioStackedBool

A stack of boolean values


ModioUICommandAssetEntry

Data table struct containing information for a specific mod.io UI Command

Inheritance Hierarchy

-> Table Row Base

Variables
TMap<FName,FText>CommandTextsMap of command-specific key names to command-specific localized text
TMap<FName,FSlateBrush>CommandIconBrushesMap of command-specific key names to command-specific brushes for use as icons

ModioTextValidationRule

Strong type struct with the necessary details to create a text validation rule

Variables
EModioTextValidationRuleRuleToUseThe base rule to use in this instance. One of the many listed in EModioTextValidationRule
FTextValidationMessageMessage to display if validation fails
int32MinimumLengthSApply the validation rule to at least minimum length
int32MaximumLengthSApply the validation rule to a maximum length

Functions

Resolve Color Override As Exec

Resolves a color reference to a color value

FLinearColor ResolveOverrideAsExec(FLinearColorRefOverride Target, bool bOverrideSet)
Parameters
TargetFLinearColorRefOverride
Returns

The resolved color value


Resolve Color Override

Resolves a color reference to a color value

FLinearColor ResolveOverride(FLinearColorRefOverride Target, bool bOverrideSet)
Parameters
TargetFLinearColorRefOverride
Override SetTrue if the color reference was overridden, false if the fallback color was used
Returns

The resolved color value


Resolve

Resolves a color reference to a color value

FLinearColor Resolve(FLinearColorRef Target, bool bResolved)
Parameters
TargetFLinearColorRef
ResolvedTrue if the color reference was resolved, false if the fallback color was used
Returns

The resolved color value


Remove Color Change Handler

Removes a handler from the list of handlers to be called when the color table changes

void RemoveColorChangeHandler(FLinearColorRefColorChangeHandler Handler)
Parameters
HandlerThe handler to remove

Get Valid Color Keys

Gets the list of valid color keys

TArray<FName> GetValidColorKeys()
Parameters
Returns

The list of valid color keys


Add Color Change Handler

Adds a handler to be called when the color table changes

void AddColorChangeHandler(FLinearColorRefColorChangeHandler Handler)
Parameters
HandlerThe handler to add

Get Override Value(TextTransform) As Exec

Resolve a text transform policy override value, with an exec pin for flow control.

ETextTransformPolicy ResolveTextTransformOverrideAsExec(FTextTransformOverride Target, bool bOverrideSet)
Parameters
TargetFTextTransformOverride
Returns

The resolved text transform policy value, or ETextTransformPolicy::ToUpper if no override is set.


Get Override Value(TextTransform)

Resolve a text transform policy override value.

ETextTransformPolicy ResolveTextTransformOverride(FTextTransformOverride Target, bool bOverrideSet)
Parameters
TargetFTextTransformOverride
Override SetWhether the override is set.
Returns

The resolved text transform policy value, or ETextTransformPolicy::ToUpper if no override is set.


Get Override Value(Text) As Exec

Resolve a text override value, with an exec pin for flow control.

FText ResolveTextOverrideAsExec(FTextOverride Target, bool bOverrideSet)
Parameters
TargetFTextOverride
Returns

The resolved text value, or an empty text if no override is set.


Get Override Value(Text)

Resolve a text override value.

FText ResolveTextOverride(FTextOverride Target, bool bOverrideSet)
Parameters
TargetFTextOverride
Override SetWhether the override is set.
Returns

The resolved text value, or an empty text if no override is set.


Get Override Value(Integer) As Exec

Resolve an integer override value, with an exec pin for flow control.

int32 ResolveIntOverrideAsExec(FIntegerOverride Target, bool bOverrideSet)
Parameters
TargetFIntegerOverride
Returns

The resolved integer value, or 0 if no override is set.


Get Override Value(Integer)

Resolve an integer override value.

int32 ResolveIntOverride(FIntegerOverride Target, bool bOverrideSet)
Parameters
TargetFIntegerOverride
Override SetWhether the override is set.
Returns

The resolved integer value, or 0 if no override is set.


Get Override Value(InputAction) As Exec

Resolve an input action override value, with an exec pin for flow control.

FDataTableRowHandle ResolveInputActionOverrideAsExec(FInputActionOverride Target, bool bOverrideSet)
Parameters
TargetFInputActionOverride
Returns

The resolved input action row handle, or an empty handle if no override is set.


Get Override Value(InputAction)

Resolve an input action override value.

FDataTableRowHandle ResolveInputActionOverride(FInputActionOverride Target, bool bOverrideSet)
Parameters
TargetFInputActionOverride
Override SetWhether the override is set.
Returns

The resolved input action row handle, or an empty handle if no override is set.


Get Override Value(HAlign) As Exec

Resolve a horizontal alignment override value, with an exec pin for flow control.

TEnumAsByte<EHorizontalAlignment> ResolveHAlignOverrideAsExec(FHAlignOverride Target, bool bOverrideSet)
Parameters
TargetFHAlignOverride
Returns

The resolved horizontal alignment value, or empty if no override is set.


Get Override Value(HAlign)

Resolve a horizontal alignment override value.

TEnumAsByte<EHorizontalAlignment> ResolveHAlignOverride(FHAlignOverride Target, bool bOverrideSet)
Parameters
TargetFHAlignOverride
Override SetWhether the override is set.
Returns

The resolved horizontal alignment value, or empty if no override is set.


Get Override Value(FSlateFontInfo) As Exec

Resolve a font info override value, with an exec pin for flow control.

FSlateFontInfo ResolveFontInfoOverrideAsExec(FSlateFontInfoOverride Target, bool bOverrideSet)
Parameters
TargetFSlateFontInfoOverride
Returns

The resolved font info value, or an empty font info if no override is set.


Get Override Value(FSlateFontInfo)

Resolve a font info override value.

FSlateFontInfo ResolveFontInfoOverride(FSlateFontInfoOverride Target, bool bOverrideSet)
Parameters
TargetFSlateFontInfoOverride
Override SetWhether the override is set.
Returns

The resolved font info value, or an empty font info if no override is set.


Get Override Value(Float) As Exec

Resolve a float override value, with an exec pin for flow control.

float ResolveFloatOverrideAsExec(FFloatOverride Target, bool bOverrideSet)
Parameters
TargetFFloatOverride
Returns

The resolved float value, or 0.0 if no override is set.


Get Override Value(Float)

Resolve a float override value.

float ResolveFloatOverride(FFloatOverride Target, bool bOverrideSet)
Parameters
TargetFFloatOverride
Override SetWhether the override is set.
Returns

The resolved float value, or 0.0 if no override is set.


Get and Load Override Value(ClassPath) As Exec

Resolve a class path override value, casting it to a specific class, with an exec pin for flow control.

UClass* ResolveClassPathOverrideAsExec_Casted(FClassPathOverride Target, TSubclassOf<UObject>  BaseClass, bool bOverrideSet)
Parameters
TargetFClassPathOverride
BaseClassThe base class to check the loaded class against.
Returns

The loaded class if it matches the BaseClass, otherwise nullptr.


Get Override Value(ClassPath) As Exec

Resolve a class path override value, with an exec pin for flow control.

FSoftClassPath ResolveClassPathOverrideAsExec(FClassPathOverride Target, bool bOverrideSet)
Parameters
TargetFClassPathOverride
Returns

The resolved class path value, or an empty path if no override is set.


Get and Load Override Value(ClassPath)

Resolve a class path override value, casting it to a specific class.

UClass* ResolveClassPathOverride_Casted(FClassPathOverride Target, TSubclassOf<UObject>  BaseClass, bool bOverrideSet)
Parameters
TargetFClassPathOverride
BaseClassThe base class to check the loaded class against.
Override SetWhether the override is set.
Returns

The loaded class if it matches the BaseClass, otherwise nullptr.


Get Override Value(ClassPath)

Resolve a class path override value.

FSoftClassPath ResolveClassPathOverride(FClassPathOverride Target, bool bOverrideSet)
Parameters
TargetFClassPathOverride
Override SetWhether the override is set.
Returns

The resolved class path value, or an empty path if no override is set.


Apply Override to Value(TextTransform)

Apply a text transform policy override value.

ETextTransformPolicy ApplyTextTransformOverride(FTextTransformOverride Target, ETextTransformPolicy DefaultValue)
Parameters
TargetFTextTransformOverride
DefaultValueThe default value to use if no override is set.
Returns

The overridden text transform policy value or the default value.


Apply Override to Value(Text)

Apply a text override value.

FText ApplyTextOverride(FTextOverride Target, FText DefaultValue)
Parameters
TargetFTextOverride
DefaultValueThe default value to use if no override is set.
Returns

The overridden text value or the default value.


Apply Override to Value(Integer)

int32 ApplyIntOverride(FIntegerOverride Target, int32 DefaultValue)
Parameters
TargetFIntegerOverride
DefaultValueThe default value to use if no override is set.
Returns

The overridden integer value or the default value.


Apply Override to Value(InputAction)

Apply an input action override value.

FDataTableRowHandle ApplyInputActionOverride(FInputActionOverride Target, FDataTableRowHandle DefaultValue)
Parameters
TargetFInputActionOverride
DefaultValueThe default value to use if no override is set.
Returns

The overridden input action row handle or the default value.


Apply Override to Value(HAlign)

Apply a horizontal alignment override value.

TEnumAsByte<EHorizontalAlignment> ApplyHAlignOverride(FHAlignOverride Target, TEnumAsByte<EHorizontalAlignment> DefaultValue)
Parameters
TargetFHAlignOverride
DefaultValueThe default value to use if no override is set.
Returns

The overridden horizontal alignment value or the default value.


Apply Override to Value(FSlateFontInfo)

Apply a font info override value.

FSlateFontInfo ApplyFontInfoOverride(FSlateFontInfoOverride Target, FSlateFontInfo DefaultValue)
Parameters
TargetFSlateFontInfoOverride
DefaultValueThe default value to use if no override is set.
Returns

The overridden font info value or the default value.


Apply Override to Value(Float)

Apply a float override value.

float ApplyFloatOverride(FFloatOverride Target, float DefaultValue)
Parameters
TargetFFloatOverride
DefaultValueThe default value to use if no override is set.
Returns

The overridden float value or the default value.


Apply and Load Override to Value(ClassPath)

Apply a class path override value, casting it to a specific class.

UClass* ApplyClassPathOverride_Casted(FClassPathOverride Target, TSubclassOf<UObject>  BaseClass, UClass* DefaultValue)
Parameters
TargetFClassPathOverride
BaseClassThe base class to check the loaded class against.
DefaultValueThe default value to use if no override is set.
Returns

The overridden class if it matches the BaseClass, otherwise the default value.


Apply Override to Value(ClassPath)

Apply a class path override value.

FSoftClassPath ApplyClassPathOverride(FClassPathOverride Target, FSoftClassPath DefaultValue)
Parameters
TargetFClassPathOverride
DefaultValueThe default value to use if no override is set.
Returns

The overridden class path value or the default value.


Retry

Attempts to retry the operation, decrementing the retry counter if successful

bool Retry(FModioRetryCounter Target)
Parameters
TargetFModioRetryCounter
Returns

True if the operation should be retried


Reset Retry Count

Resets the retry counter

FModioRetryCounter ResetRetryCountPure(FModioRetryCounter Target)
Parameters
TargetFModioRetryCounter
Returns

The reset retry counter


Reset Retry Count

Resets the retry counter

void ResetRetryCount(FModioRetryCounter Target)
Parameters
TargetFModioRetryCounter

Can Retry as Exec

Checks if the retry counter has retries remaining, returning an exec enum

bool CanRetryAsExec(FModioRetryCounter Target)
Parameters
TargetFModioRetryCounter
Returns

True if the retry counter has retries remaining


Can Retry

Checks if the retry counter has retries remaining

bool CanRetry(FModioRetryCounter Target)
Parameters
TargetFModioRetryCounter
Returns

True if the retry counter has retries remaining


Push Value on Stack(bool)

Pushes a new value onto the stack

void PushBoolValue(FModioStackedBool Target, bool bNewValue)
Parameters
TargetFModioStackedBool
bNewValueThe value to push onto the stack

Pop Value from Stack(bool)

Pops a value from the stack

bool PopBoolValue(FModioStackedBool Target, bool bDidPopSuccessfully)
Parameters
TargetFModioStackedBool
Did Pop SuccessfullyTrue if the pop was successful
Returns

The popped value


Peek Value from Stack(bool)

Peeks at the top value of the stack

bool PeekBoolValue(FModioStackedBool Target, bool bDidPeekSuccessfully)
Parameters
TargetFModioStackedBool
Did Peek SuccessfullyTrue if the peek was successful
Returns

The peeked value


Get Metadata for Component

FModioUIComponentMetadata GetMetadataForComponent(EModioUIComponentID ComponentType, bool bComponentTypeFound)

Get All Component Metadata

TMap<EModioUIComponentID,FModioUIComponentMetadata> GetAllComponentMetadata()

Get Command Text

Retrieves a specific localized string for the specified command

FText GetCommandText(FString CommandID, FName TextName, bool bResolved)
Parameters
CommandIDID for the command to search within
TextNameName of the string to retrieve
ResolvedSet to true if the string was found in the data table
Returns

The resolved text, or an empty one if bResolved is false


Get Command Brush

Retrieves a specific brush for the specified command

FSlateBrush GetCommandBrush(FString CommandID, FName BrushName, bool bResolved)
Parameters
CommandIDID for the command to search within
BrushNameName of the brush to retrieve
ResolvedSet to true if the brush was found in the data table
Returns

The resolved brush, or an empty one if bResolved is false


Get Command Asset Entry

Retrieves a data table row for the specified command

FModioUICommandAssetEntry GetCommandAssetEntry(FString CommandID, bool bResolved)
Parameters
CommandIDID for the command to retrieve
ResolvedSet to true if the command was found in the data table
Returns

The resolved data table row, or an empty row if bResolved is false


Validate Using Rule

SConvenience function to check a rule against a text and returns a validation text when the rule was not matched

bool ValidateUsingRule(FModioTextValidationRule Rule, FText TextToValidate, FText ValidationMessageText)
Parameters
RuleThe text validation rule to apply
TextToValidateThe string to apply a rule to
Validation Message TextA string that receives a formatted value when rule checks fail
Returns

True when string validation passes, false otherwise


Validate No Whitespace

SConfirm the text provided matches the lack of whitespace rule

bool ValidateNoWhitespace(FText TextToValidate)
Parameters
TextToValidateString to check against the lack of whitespace rule
Returns

True when string validation passes, false otherwise


Validate Not Empty

SConfirm the text provided matches the not-empty rule

bool ValidateNotEmpty(FText TextToValidate)
Parameters
TextToValidateString to check against the not-empty rule
Returns

True when string validation passes, false otherwise


Validate Not Blank

SConfirm the text provided matches the not blank rule

bool ValidateNotBlank(FText TextToValidate)
Parameters
TextToValidateString to check against the not blank rule
Returns

True when string validation passes, false otherwise


Validate Length

SConfirm the text provided matches the length rule

bool ValidateLength(FText TextToValidate, int32 DesiredMaximumLength, int32 DesiredMinimumLength)
Parameters
TextToValidateString to check against the length rule
DesiredMaximumLength
DesiredMinimumLength
Returns

True when string validation passes, false otherwise


Validate Email Address

SConfirm the text provided matches an email address

bool ValidateEmailAddress(FText TextToValidate)
Parameters
TextToValidateString to check against email pattern
Returns

True when string contains a valid email, false otherwise


Validate Alphanumeric

SConfirm the text provided matches the alphanumeric rule

bool ValidateAlphanumeric(FText TextToValidate)
Parameters
TextToValidateString to check against the alphanumeric rule
Returns

True when string validation passes, false otherwise


Validate All Numeric

SConfirm the text provided matches an all numeric rule

bool ValidateAllNumeric(FText TextToValidate)
Parameters
TextToValidateString to check against all numeric rule
Returns

True when string validation passes, false otherwise


Validate All Letters

SConfirm the text provided matches an all letters rule

bool ValidateAllLetters(FText TextToValidate)
Parameters
TextToValidateString to check against all letters rule
Returns

True when string validation passes, false otherwise


Default Validate Text

Helper function that contains the default implementation of ValidateText for widgets implementing IModioUITextValidator. This implmentation is called by default for native classes that implement IModioUITextValidator, but requires an explicit call for classes that implement that interface via Blueprint only

bool DefaultValidateText(TScriptInterface<IModioUITextValidator> TargetObject, FText InputText, FText ValidationMessageText)
Parameters
TargetObjectObject that implements IModioUITextValidator and will receive GetTextValidationRules and SetValidationError interface calls as necessary
InputTextThe text to validate
Validation Message TextFText that will be initialized by this function to an appropriate error message if validation fails
Returns

True if validation succeeded, false if it failed


Validate Widget

UWidget* ValidateWidget(TScriptInterface<IInterface> TargetWidget)

Map Value Into Range Index

Searches the specified value ranges and returns the index of the first range which contains the provided /// value //

bool MapValueIntoRangeIndex(TArray<FInt32Range> ValueRanges, int32 Value, int32 OutIndex)
Parameters
ValueRangesThe ranges to search through
ValueThe value to locate
Out IndexThe index of the first range that contains Value
Returns

True if the value was located


Is Design Time as Exec

Returns true if the widget is currently being viewed in the UMG editor //

bool IsDesignTimeAsExec(UWidget* Target)
Parameters
TargetUWidget*
Returns

True if Target has design-time flags set


Is Design Time

Returns true if the widget is currently being viewed in the UMG editor //

bool IsDesignTime(UWidget* Target)
Parameters
TargetUWidget*
Returns

True if Target has design-time flags set


Get Modio Text

Utility method to dynamically resolve an FText from the primary mod.io string table //

FText GetModioText(FName StringKey)
Parameters
StringKeyName of the text to retrieve
Returns

The resolved FText or empty FText if not found


Get Localized Tag Value

Localizes the specified tag value //

FText GetLocalizedTagValue(FModioModTagLocalizationData InTagLocalizationData)
Parameters
InTagLocalizationDataThe tag localization data from which to localize the tag value
Returns

The localized tag value


Get Localized Tag Category

Localizes the specified tag category //

FText GetLocalizedTagCategory(FModioModTagInfo InTagInfo)
Parameters
InTagInfoThe tag info from which to localize the category
Returns

The localized category name


Format Timespan

Formats the provided timespan to text based on the specified resolution and specified format texts. This /// function passes positional values to the format text in the following order: Years, Months, Days, Hours, /// Minutes. //

FText FormatTimespan(FTimespan Timespan, FText YearFormat, FText MonthFormat, FText DaysFormat, FText TodayFormat)
Parameters
TimespanThe timespan to format
YearFormatFormat text to use if the timespan is > 1 year
MonthFormatFormat text to use if the timespan is > 1 month
DaysFormatFormat text to use if the timespan is > 1 day
TodayFormatFormat text to use if the time is today
Returns

The formatted text


Format Number with SIUnit

Localizes the specified value using the supplied formatting options and format string. Will calculate the /// appropriate SI unit and pass a character indicating that unit to the format call. //

FText FormatNumberWithSIUnit(int64 Value, FText FormatText)
Parameters
ValueThe raw value to localize
FormatTextFText specifying the formatted output pattern. This will be passed the value as placeholder 0 and the units as placeholder 1
Returns

The formatted text


Create Bindable User

//

UModioUserUI* CreateBindableUser(FModioUser InRawUser)
Parameters
InRawUser
Returns

Create Bindable Report Type Enum Array

//

TArray<UModioEnumEntryUI*> CreateBindableReportTypeEnumArray()
Parameters
Returns

Create Bindable Mod Tag Raw Value

Creates a data-bindable UObject wrapper around a mod tag sourced from a FModioModInfo //

UModioModTagUI* CreateBindableModTagRawValue(FModioModTag InTag)
Parameters
InTagThe tag to make bindable
Returns

UObject suitable for use as a DataSource


Create Bindable Mod Tag Options

Creates a data-bindable UObject wrapper around a FModioModTagOptions struct, including child UObjects /// that are data-bindable wrappers for individual tag categories and tags //

UModioModTagOptionsUI* CreateBindableModTagOptions(FModioModTagOptions InRawOptions)
Parameters
InRawOptionsThe struct containing tag data to bind to
Returns

UObject wrapper suitable for use as a DataSource


Create Bindable Mod Tag Info

Creates a data-bindable UObject wrapper around a FModioModTagInfo struct (aka a tag category), including /// child UObjects that are data-bindable wrappers for individual tags //

UModioModTagInfoUI* CreateBindableModTagInfo(FModioModTagInfo InRawTagInfo)
Parameters
InRawTagInfoThe struct containing tag data to bind to
Returns

UObject wrapper suitable for use as a DataSource


Create Bindable Mod Tag Array

Creates an array of data-bindable UObject wrappers around mod tags coming from a FModioModInfo, ie for /// display on the mod details //

TArray<UModioModTagUI*> CreateBindableModTagArray(TArray<FModioModTag> InTags)
Parameters
InTagsThe array of tags to make bindable
Returns

Array of UObjects suitable for use as a DataSource


Create Bindable Mod Tag

Creates a data-bindable UObject wrapper around an individual mod tag value //

UModioModTagUI* CreateBindableModTag(FModioModTagLocalizationData InTagLocalizationData)
Parameters
InTagLocalizationDataThe tag value to make bindable
Returns

UObject suitable for use as a DataSource


Create Bindable Mod Dependency Array from List

Creates an array of data-bindable UObject wrappers around mod dependencies coming from a FModioModDependencyList //

TArray<UModioModDependencyUI*> CreateBindableModDependencyArrayFromList(FModioModDependencyList InModDependencyList)
Parameters
InModDependencyListThe array of tags to make bindable
Returns

Array of UObjects suitable for use as a DataSource


Create Bindable Mod Dependency Array from Array

Creates an array of data-bindable UObject wrappers around mod dependencies coming from an array //

TArray<UModioModDependencyUI*> CreateBindableModDependencyArrayFromArray(TArray<FModioModDependency> InModDependencyArray)
Parameters
InModDependencyArrayThe array of tags to make bindable
Returns

Array of UObjects suitable for use as a DataSource


Create Bindable Mod Dependency

Creates a data-bindable UObject wrapper around an individual mod dependency value //

UModioModDependencyUI* CreateBindableModDependency(FModioModDependency InModDependency)
Parameters
InModDependencyThe raw string value of the tag
Returns

UObject suitable for use as a DataSource


Create Bindable Enum

//

UModioEnumEntryUI* CreateBindableEnum(uint8 InValue, FText InText)
Parameters
InValue
InText
Returns

Check Logo Download Event for Data Source

Utility method to validate if a logo download event is relevant for the given data source and requested /// size //

bool CheckLogoDownloadEventForDataSource(FModioModID EventModID, EModioLogoSize EventLogoSize, UObject* DataSource, EModioLogoSize RequestedSize)
Parameters
EventModIDThe event's associated mod ID
EventLogoSizeThe event's associated download size
DataSourceThe data source containing the relevant mod ID
RequestedSizethe size that the widget requested
Returns

Check Logo Download Event

Utility method to validate if a logo download event is relevant for the given mod ID and requested size //

bool CheckLogoDownloadEvent(FModioModID EventModID, EModioLogoSize EventLogoSize, FModioModID RequestedModID, EModioLogoSize RequestedSize)
Parameters
EventModIDThe event's associated mod ID
EventLogoSizeThe event's associated download size
RequestedModIDThe relevant mod ID for the widget that is making the check
RequestedSizeThe relevant size for the widget that is making the check
Returns

As Object Array

Converts an array of Interface references to an array of UObjects //

TArray<UObject*> AsObjectArray(TArray<int32> TargetArray)
Parameters
TargetArrayThe array containing Interface references
Returns

Array of UObject


Apply Text Property Overrides Helper

void ApplyTextPropertyOverridesHelper(FSlateFontInfoOverride FontPropertiesOverride, FHAlignOverride TextJustificationOverride, FTextTransformOverride TextTransformOverride, UObject* Target)

Do Filter Params Include User Id

bool DoFilterParamsIncludeUserId(FModioFilterParams Params)

Enums

EModioUILoadState

NotLoaded
Loading
Loaded
Errored

EModioModInstallationStatus

NotInstalledNot installed by any user on the current system
ErrorMod has encountered an error during processing
EnabledInstalled and enabled by the current user
DisabledInstalled but disabled by the current user
PurchasedPurchased by the current user, but not installed by any user on the current system
SystemInstallInstalled by another user on the current system. This status takes precedence over Purchased.
QueuedMod is queued for processing
InitializingBeginning a new mod processing state
DownloadingMod is currently downloading
ExtractingMod is currently extracting
UploadingMod is currently uploading
UploadedMod upload has completed
CompressingMod is currently compressing

EModioUIDialogType

Enum for specific dialog types, can be extended if there are additional dialog types added

ModDetails
ReportMod
EnableDisableManagement
PurchaseMod
StoreUi
ConfirmDependencyDownloadDialog to inform users that the mod they want to download has dependencies, which will be downloaded automatically along with the selected mod

EModioUIFeatureFlags

ModEnableDisable
Monetization
ModDownvote

EModioUIComponentID

Button
StaticText
EditableText
MultilineEditableText
CodeInputText
EnumSelector
PresetFilterSelector
ModTile
ModalDialog
Image
ProgressWidget
CheckBox
ModList
TagDisplay
ObjectList
EnumSelectorEntry
CommandMenu
FilterSelectorEntry
ModPropertyCollection
UserDisplay
ObjectSelector

EModioUIMediaDownloadEventType

Enumerator with different events when an image is downloaded

ModGalleryImagesDownloading gallery images *
ModCreatorAvatarImageDownloading an avatar *
ModLogoDownloading a logo *

EModioUIModInfoEventType

Enumerator of the information envents

ListAllModsEvent to list all mods *
GetModInfoEvent to retrieve the mod information *

EModioUITokenPackEventType

Enumerator of the information envents

ListAllTokenPacksEvent to list all token packs *
GetTokenPackEvent to retrieve the token pack information *

EModioTextValidationRule

Enumeration for the possible validation rules ScriptName meta specifier suppresses a duplicate name LogPython warning

ETVR_ValidateEmailAddressValidate as an email *
ETVR_ValidateAllLettersValidate that every character is a letter *
ETVR_ValidateAllNumericValidate that every character is a number *
ETVR_ValidateAlphanumericValidate characters as numbers or letters *
ETVR_ValidateLengthValidate the length of the stream *
ETVR_ValidateNotEmptyValidate that has some content *
ETVR_ValidateNoWhitespaceValidate the lack of spaces *
ETVR_ValidateNotBlankValidate that there is not only whitespace *

EModioModBrowserState

ModsView
LibraryView