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 Interface	Purpose
IModioUIClickableWidget	Allows the widget to emit events when clicked
IModioUISelectableWidget	Allows the widget to be configured as selectable
IModioUIHoverableWidget	Allows the widget to emit events when hovered
IModioUIHasTooltipWidget	Allows the widget to have its tooltip externally configured
IModioUIDataSourceWidget	Allows 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


IModioUIImageDisplayWidget	Allows the widget to receive messages regarding displaying an image

Properties


`FText`	`LabelText`	Text to display on this button's label. For runtime changes, use IModioUIHasTextWidget::SetText

Sub-components


GetImageWidget	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.

Event Data

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


`FModioImageDisplayOnLoadStateChanged`	`void(UObject* LoadContext, bool bLoadSuccess)`	Passes `this` as LoadContext, `bLoadSuccess` indicates if loading succeeded
`FModioClickableOnClicked`	`void(UObject* ClickContext)`	Passes `this` as ClickContext
`FModioOnFocusPathChanged`	`void(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused)`	Passes `this` as FocusContext, `InFocusEvent` as the focus event, `bIsFocused` as the new focus state
`FModioSelectableOnSelectionChanged`	`void(UObject* SelectionContext, bool bNewSelectedState)`	Passes `this` as SelectionContext, `bNewSelectedState` is new selection state
`FModioHoverableOnHoverStateChanged`	`void(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


IModioUIHasTextWidget	Allows the widget to be sent an FText to display at runtime

Properties


`FText`	`LabelText`	Text to display on this button's label. For runtime changes, use IModioUIHasTextWidget::SetText

Sub-components


GetLabelWidget	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

Event Data

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


`FModioClickableOnClicked`	`void(UObject* ClickContext)`	Passes `this` as ClickContext
`FModioOnFocusPathChanged`	`void(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused)`	Passes `this` as FocusContext, `InFocusEvent` as the focus event, `bIsFocused` as the new focus state
`FModioSelectableOnSelectionChanged`	`void(UObject* SelectionContext, bool bNewSelectedState)`	Passes `this` as SelectionContext, `bNewSelectedState` is new selection state
`FModioHoverableOnHoverStateChanged`	`void(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 Interface	Purpose
IModioUIHasTextWidget	Allows 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


IModioUIHasTextWidget	Allows the text being displayed to be set or queried at runtime
IModioUIHasConfigurableColor	Allows 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 Interface	Purpose
IModioUIStringInputWidget	Allows the widget to have its user input retrieved, and the hint text configured
IModioUITextValidator	Allows the widget to be externally configured with validation rules, or to be queried for the results of validation

Multiline Editable Text

The Multiline 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 Multiline Editable Text Component:

Required Interface	Purpose
IModioUIStringInputWidget	Allows the widget to have its user input retrieved, and the hint text configured
IModioUITextValidator	Allows 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 Interface	Purpose
IModioUIImageDisplayWidget	Allows 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 Interface	Purpose
IModioUIProgressWidget	Allows 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 Interface	Purpose
IModioUIHasTextWidget	Allows 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 Interface	Purpose
IModioUIObjectListWidget	Allows 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:


`FModioObjectListOnObjectWidgetCreated`	`void(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 Interface	Purpose
IModioUIObjectListWidget	Allows 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 Interface	Purpose
IModioUIObjectSelector	Allows 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:


`FModioOnObjectSelectionChanged`	`void(UObject* SelectedValue)`	Passes the bound value for which selection state has changed as `SelectedValue`
`FModioObjectListOnObjectWidgetCreated`	`void(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 Interface	Purpose
IModioUIObjectSelector	Allows 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


GetSelectorMenuWidget	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
GetMenuToggleClickableWidget	Provides 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:


`FModioOnObjectSelectionChanged`	`void(UObject* SelectedValue)`	Passes `this` as SelectedValue
`FModioOnActivationChanged`	`void(UObject* ActivationContext, bool bIsActivated)`	Passes `this` as ActivationContext, `bIsActivated` as the new activation state
`FModioOnFocusPathChanged`	`void(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused)`	Passes `this` as FocusContext, `InFocusEvent` as the focus event, `bIsFocused` as the new focus state

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


GetSelectorWidget	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

Event Data

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


`FModioOnObjectSelectionChanged`	`void(UObject* SelectedValue)`	Passes `UObject*` as SelectedValue
`FModioOnActivationChanged`	`void(UObject* ActivationContext, bool bIsActivated)`	Passes `this` as ActivationContext, `bIsActivated` as the new activation state
`FModioOnFocusPathChanged`	`void(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 Interface	Purpose
IUserObjectListEntry	Required to allow Entry components to be used as visualization widgets in standard Unreal list and tile views
IModioUIClickableWidget	Allows the widget to emit events when clicked to allow the enum selector to trigger a selection change
IModioUISelectableWidget	Allows the widget to internally track the selection state of the bound enum value, which can be externally queried
IModioUIDataSourceWidget	Allows 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


GetSelectableWidget	Provides a reference to the internal widget that will visualize the current selection state of the bound enum value
GetLabelWidget	Provides a reference to the internal widget that is used for displaying the display string for the bound enum value
GetClickableWidget	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

Event Data

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


`FModioClickableOnClicked`	`void(UObject* ClickContext)`	Passes `this` as ClickContext
`FModioSelectableOnSelectionChanged`	`void(UObject* SelectionContext, bool bNewSelectedState)`	Passes `this` as SelectionContext, `bNewSelectedState` is new selection state
`FModioOnActivationChanged`	`void(UObject* ActivationContext, bool bIsActivated)`	Passes `this` as ActivationContext, `bIsActivated` as the new activation state
`FModioOnFocusPathChanged`	`void(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:


`FModioClickableOnClicked`	`void(UObject* ClickContext)`	Passes `this` as ClickContext
`FModioSelectableOnSelectionChanged`	`void(UObject* SelectionContext, bool bNewSelectedState)`	Passes `this` as SelectionContext, `bNewSelectedState` is new selection state
`FModioOnActivationChanged`	`void(UObject* ActivationContext, bool bIsActivated)`	Passes `this` as ActivationContext, `bIsActivated` as the new activation state
`FModioOnFocusPathChanged`	`void(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 Interface	Purpose
IModioUIObjectSelector	Allows 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


GetPresetListWidget	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
GetFilterPresets	Fetches 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:


`FModioOnActivationChanged`	`void(UObject* ActivationContext, bool bIsActivated)`	Passes `this` as ActivationContext, `bIsActivated` as the new activation state
`FModioOnFocusPathChanged`	`void(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:


`FModioOnActivationChanged`	`void(UObject* ActivationContext, bool bIsActivated)`	Passes `this` as ActivationContext, `bIsActivated` as the new activation state
`FModioOnFocusPathChanged`	`void(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 Interface	Purpose
IUserObjectListEntry	Required to allow Entry components to be used as visualization widgets in standard Unreal list and tile views
IModioUIClickableWidget	Allows the widget to emit events when clicked to allow the filter selector to trigger a selection change
IModioUISelectableWidget	Allows the widget to display and modify internally track the selection state of the bound filter parameters, which can be externally queried
IModioUIDataSourceWidget	Allows the widget to be data-bound to a UObject implementing IModioModFilterUIDetails

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 Interface	Purpose
IModioUICommandMenu	Allows 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

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

GetSelectorWidget

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.

Event Data

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


`FModioOnActivationChanged`	`void(UObject* ActivationContext, bool bIsActivated)`	Passes `this` as ActivationContext, `bIsActivated` as the new activation state
`FModioOnFocusPathChanged`	`void(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


GetCommandMenuWidget	Provides 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:


`FModioOnActivationChanged`	`void(UObject* ActivationContext, bool bIsActivated)`	Passes `this` as ActivationContext, `bIsActivated` as the new activation state
`FModioOnFocusPathChanged`	`void(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused)`	Passes `this` as FocusContext, `InFocusEvent` as the focus event, `bIsFocused` as the new focus state

A menu displaying a list of commands.

Properties

Sub-components

Event Data

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


`FModioOnActivationChanged`	`void(UObject* ActivationContext, bool bIsActivated)`	Passes `this` as ActivationContext, `bIsActivated` as the new activation state
`FModioOnFocusPathChanged`	`void(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused)`	Passes `this` as FocusContext, `InFocusEvent` as the focus event, `bIsFocused` as the new focus state

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:


`FModioOnActivationChanged`	`void(UObject* ActivationContext, bool bIsActivated)`	Passes `this` as ActivationContext, `bIsActivated` as the new activation state
`FModioOnFocusPathChanged`	`void(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 Interface	Purpose
IModioUIDataSourceWidget	Allows 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:


`FModioOnActivationChanged`	`void(UObject* ActivationContext, bool bIsActivated)`	Passes `this` as ActivationContext, `bIsActivated` as the new activation state
`FModioOnFocusPathChanged`	`void(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:


`FModioOnActivationChanged`	`void(UObject* ActivationContext, bool bIsActivated)`	Passes `this` as ActivationContext, `bIsActivated` as the new activation state
`FModioOnFocusPathChanged`	`void(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 Interface	Purpose
IUserObjectListEntry	Required to allow Mod Tile components to be used as visualization widgets in Mod List View and Mod Tile View components
IModioUIDataSourceWidget	Allows 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:


`FModioClickableOnClicked`	`void(UObject* ClickContext)`	Passes `this` as ClickContext
`FModioSelectableOnSelectionChanged`	`void(UObject* SelectionContext, bool bNewSelectedState)`	Passes `this` as SelectionContext, `bNewSelectedState` is new selection state
`FModioHoverableOnHoverStateChanged`	`void(UObject* HoverContext, bool bHoveredState)`	Passes `this` as HoverContext, `bHoveredState` is new hover state
`FModioOnActivationChanged`	`void(UObject* ActivationContext, bool bIsActivated)`	Passes `this` as ActivationContext, `bIsActivated` as the new activation state
`FModioOnFocusPathChanged`	`void(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:


`FModioClickableOnClicked`	`void(UObject* ClickContext)`	Passes `this` as ClickContext
`FModioSelectableOnSelectionChanged`	`void(UObject* SelectionContext, bool bNewSelectedState)`	Passes `this` as SelectionContext, `bNewSelectedState` is new selection state
`FModioHoverableOnHoverStateChanged`	`void(UObject* HoverContext, bool bHoveredState)`	Passes `this` as HoverContext, `bHoveredState` is new hover state
`FModioOnActivationChanged`	`void(UObject* ActivationContext, bool bIsActivated)`	Passes `this` as ActivationContext, `bIsActivated` as the new activation state
`FModioOnFocusPathChanged`	`void(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 Interface	Purpose
IModioUIDataSourceWidget	Allows 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:


`FModioOnActivationChanged`	`void(UObject* ActivationContext, bool bIsActivated)`	Passes `this` as ActivationContext, `bIsActivated` as the new activation state
`FModioOnFocusPathChanged`	`void(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused)`	Passes `this` as FocusContext, `InFocusEvent` as the focus event, `bIsFocused` as the new focus state

API Reference

bool RequestModCollectionRatingChange(int64 CollectionID, EModioRating NewRating)

Parameters


`Target`	`ModCollectionRatingStateProvider`
`CollectionID`	The raw ID for the mod Collection to request the rating change for
`NewRating`	the new rating for the mod collection

Returns

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

Query Mod Collection Rating

EModioRating QueryModCollectionRating(int64 ModCollectionID)

Parameters


`Target`	`ModCollectionRatingStateProvider`
`ModCollectionID`	the raw ID for the mod Collection to query

Returns

Rating of the mod Collection

ModRatingStateProvider

Inheritance Hierarchy

-> Interface-> Object

Request Mod Rating Change

bool RequestModRatingChange(int64 ID, EModioRating NewRating)

Parameters


`Target`	`ModRatingStateProvider`
`ID`	The raw ID for the mod to request the rating change for
`NewRating`	the 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


`Target`	`ModRatingStateProvider`
`ModID`	the 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


`Target`	`ModioActivatableWidget`
`Handler`	Delegate to remove from activation state change

Deactivate

Deactivates the implementing widget

void Deactivate()

Parameters


`Target`	`ModioActivatableWidget`

Add Activation Changed Handler

Registers a delegate to receive callbacks when the activation state changes

void AddActivationChangedHandler(FModioOnActivationChanged Handler)

Parameters


`Target`	`ModioActivatableWidget`
`Handler`	Delegate to invoke on activation state change

Activate

Activates the implementing widget

void Activate()

Parameters


`Target`	`ModioActivatableWidget`

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


`FModioClickableOnClickedMulticast`	`OnClicked`	Passes `this` as ClickContext
`TObjectPtr<UObject>`	`DataSource`	Cached object to use as the source for data binding Populated by SetDataSource
`bool`	`bFocusOnHover`	Whether the button should focus on hover. This is useful for gamepad navigation
`bool`	`bEnableKeyboardHover`	Bool to control whether keyboard navigation should visually trigger hover behavior
`FModioOnFocusPathChangedMulticast`	`OnModioFocusPathChanged`	Passes `this` as FocusContext, `InFocusEvent` as the focus event, `bIsFocused` as the new focus state
`FModioSelectableOnSelectionChangedMulticast`	`OnSelected`	Passes `this` as SelectionContext, `bNewSelectedState` is new selection state
`FModioHoverableOnHoverStateChangedMulticast`	`OnHoverStateChanged`	Passes `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

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

nd_img_ModioCommandEntry_GetLabelWidget.png

TScriptInterface<IModioUIHasTextWidget> GetLabelWidget() const

Parameters


`Target`	`ModioCommandEntry`

Returns

The label widget

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

nd_img_ModioCommandEntry_GetIconWidget.png

TScriptInterface<IModioUIImageDisplayWidget> GetIconWidget() const

Parameters


`Target`	`ModioCommandEntry`

Returns

The icon widget

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

nd_img_ModioCommandEntry_GetClickableWidget.png

TScriptInterface<IModioUIClickableWidget> GetClickableWidget() const

Parameters


`Target`	`ModioCommandEntry`

Returns

The clickable widget

Variables

ModioCommandMenu

Inheritance Hierarchy

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

nd_img_ModioCommandMenu_GetSelectorWidget.png

TScriptInterface<IModioUIObjectSelector> GetSelectorWidget() const

Parameters


`Target`	`ModioCommandMenu`

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 the image widget that displays the avatar

nd_img_ModioCurrentUserAvatarWidget_GetAvatarImageWidget.png

TScriptInterface<IModioUIImageDisplayWidget> GetAvatarImageWidget() const

Parameters


`Target`	`ModioCurrentUserAvatarWidget`

Returns

The image widget

Variables


`FSlateBrush`	`UnloadedBrush`	The brush to use when the avatar is not loaded
`FSlateBrush`	`ErroredBrush`	The brush to use when the avatar is errored (failed to load)
`FSlateBrush`	`LoadingBrush`	The 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

ModioDefaultCarouselModListView

A default implementation of IModioUIModListViewInterface which displays mods as a carousel. This widget inherits from UModioDefaultModListView.

Inheritance Hierarchy

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

Scroll Row

void ScrollRow(bool bBackwards)

Navigate in Direction

UWidget* NavigateInDirection(EUINavigation InNavigation)

Get Item Count on Screen

float GetItemCountOnScreen() const

Variables


`int32`	`DefaultLoopingListItemOffset`
`float`	`DefaultItemScrollOffset`
`float`	`MinimumLoopingTiles`
`bool`	`bLoopTiles`
`TSubclassOf<UUserWidget>`	`ViewMoreButtonClass`
`float`	`ScrollCheckPadding`
`bool`	`bScrollCheckViewMoreTileVisible`
`bool`	`bResetScrollWhenOffscreen`
`int32`	`OffscreenResetFrameCount`

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


`Target`	`ModioDefaultCheckBox`
`InLabelText`	The label to set

Set Hovered

void SetHovered(bool bHovered)

Parameters


`Target`	`ModioDefaultCheckBox`
`bHovered`	Whether the check box is hovered

Handle on Check State Changed

void HandleOnCheckStateChanged(bool bIsChecked)

Parameters


`Target`	`ModioDefaultCheckBox`
`bIsChecked`	The new state of the check box

Get Label Text Block Text

FText GetLabelTextBlockText() const

Parameters


`Target`	`ModioDefaultCheckBox`

Returns

The label text block text

Get Label

FText GetLabel() const

Parameters


`Target`	`ModioDefaultCheckBox`

Returns

The label

Get Checkbox Content Padding

FMargin GetCheckboxContentPadding() const

Parameters


`Target`	`ModioDefaultCheckBox`

Returns

The content padding

Variables


`FMargin`	`ContentPadding`
`TSubclassOf<UWidget>`	`LabelClass`
`FText`	`LabelText`

ModioDefaultCodeInputTextBox

Inheritance Hierarchy

-> Widget-> Visual-> Object

nd_img_ModioDefaultCodeInputTextBox_GetValidationErrorWidget.png

TScriptInterface<IModioUIHasTextWidget> GetValidationErrorWidget() const

Variables


`FModioDefaultCodeInputTextBoxStyle`	`CodeInputStyle`
`ETextFlowDirection`	`TextFlowDirection`
`EVirtualKeyboardTrigger`	`VirtualKeyboardTrigger`
`EVirtualKeyboardDismissAction`	`VirtualKeyboardDismissAction`
`FModioOnTextCommittedMulticast`	`OnModioTextCommitted`	Passes `this` as Context, `Text` as the new text, `CommitMethod` as the method used to commit the text
`FModioOnTextChangedMulticast`	`OnModioTextChanged`	Passes `this` as Context, `Text` as the new text
`int32`	`NumberOfCharacters`
`FOnCodeSubmitDynamic`	`OnCodeSubmitDynamic`

ModioDefaultEditableTextBox

Inheritance Hierarchy

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

Variables


`FModioOnTextCommittedMulticast`	`OnModioTextCommitted`	Passes `this` as Context, `Text` as the new text, `CommitMethod` as the method used to commit the text
`FModioOnTextChangedMulticast`	`OnModioTextChanged`	Passes `this` as Context, `Text` as the new text
`FModioOnFocusPathChangedMulticast`	`OnModioFocusPathChanged`	Passes `this` as FocusContext, `InFocusEvent` as the focus event, `bIsFocused` as the new focus state

ModioDefaultIconButton

Inheritance Hierarchy

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

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.

nd_img_ModioDefaultIconButton_GetImageWidget.png

TScriptInterface<IModioUIImageDisplayWidget> GetImageWidget() const

Parameters


`Target`	`ModioDefaultIconButton`

Variables


`FModioImageDisplayOnLoadStateChangedMulticast`	`OnLoadStateChanged`	Passes `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

ModioDefaultModCollectionTile

This is a default implementation of the Mod Collection Tile component which is intended to represent a mod collection in Mod List and Mod Collection 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


`Target`	`ModioDefaultModCollectionTile`
`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


`Target`	`ModioDefaultModCollectionTile`

nd_img_ModioDefaultModCollectionTile_GetMoreOptionsMenuWidget.png

TScriptInterface<IModioUICommandMenu> GetMoreOptionsMenuWidget() const

Variables


`FModioClickableOnClickedMulticast`	`OnClicked`	Passes `this` as ClickContext
`bool`	`bSelected`
`FModioSelectableOnSelectionChangedMulticast`	`OnSelected`	Passes `this` as SelectionContext, `bNewSelectedState` is new selection state
`FModioHoverableOnHoverStateChangedMulticast`	`OnHoverStateChanged`	Passes `this` as HoverContext, `bHoveredState` is new hover state
`TObjectPtr<UObject>`	`EditorDataSource`

ModioDefaultModCollectionTileView

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

Inheritance Hierarchy

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

Variables


`bool`	`bSelectFirstTileWhenFocused`
`FModioOnObjectSelectionChangedMulticast`	`OnSelectedValueChanged`	Passes the bound value for which selection state has changed as `SelectedValue`

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


`FModioScrollableOffsetChangedMulticast`	`OnScroll`	Passes `this` as ScrollableContext
`FModioOnObjectSelectionChangedMulticast`	`OnSelectedValueChanged`	Passes 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


`Target`	`ModioDefaultModTile`
`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


`Target`	`ModioDefaultModTile`

nd_img_ModioDefaultModTile_GetMoreOptionsMenuWidget.png

TScriptInterface<IModioUICommandMenu> GetMoreOptionsMenuWidget() const

Variables


`FModioClickableOnClickedMulticast`	`OnClicked`	Passes `this` as ClickContext
`bool`	`bSelected`
`FModioSelectableOnSelectionChangedMulticast`	`OnSelected`	Passes `this` as SelectionContext, `bNewSelectedState` is new selection state
`FModioHoverableOnHoverStateChangedMulticast`	`OnHoverStateChanged`	Passes `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


`bool`	`bSelectFirstTileWhenFocused`
`FModioOnObjectSelectionChangedMulticast`	`OnSelectedValueChanged`	Passes 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


`FModioDialogButtonClickedEventMulticast`	`OnDialogButtonClicked`
`bool`	`bUseGeneratedButtonContent`
`TArray<FModioDialogButtonInfo>`	`DialogButtonData`

ModioDefaultMultiLineEditableTextBox

Inheritance Hierarchy

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

Variables


`bool`	`IsCaretMovedWhenGainFocus`
`bool`	`SelectAllTextWhenFocused`
`bool`	`RevertTextOnEscape`
`bool`	`ClearKeyboardFocusOnCommit`
`bool`	`SelectAllTextOnCommit`
`ETextOverflowPolicy`	`OverflowPolicy`
`FModioOnTextCommittedMulticast`	`OnModioTextCommitted`	Passes `this` as Context, `Text` as the new text, `CommitMethod` as the method used to commit the text
`FModioOnTextChangedMulticast`	`OnModioTextChanged`	Passes `this` as Context, `Text` as the new text

ModioDefaultObjectSelector

Inheritance Hierarchy

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

nd_img_ModioDefaultObjectSelector_GetEntryWidgetFromItem.png

UUserWidget* GetEntryWidgetFromItem(UObject* Item) const

Variables


`TSubclassOf<UWidget>`	`MultipleSelectionListItemClass`
`FModioOnObjectSelectionChangedMulticast`	`OnSelectedValueChanged`	Passes the bound value for which selection state has changed as `SelectedValue`
`FModioObjectListOnObjectWidgetCreatedMulticast`	`OnWidgetCreated`	Passes 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

nd_img_ModioDefaultScrollBox_UpdateNavigationData.png

void UpdateNavigationData(int32 PendingScrollOffset)

Parameters


`Target`	`ModioDefaultScrollBox`
`PendingScrollOffset`	The 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


`Target`	`ModioDefaultScrollBox`
`CurrentOffset`	The current scroll offset

Variables


`bool`	`bScrollByNavigationInput`
`int32`	`NavigationScrollOffsetStep`
`float`	`NavigationScrollOffsetSpeed`
`TObjectPtr<UWidgetNavigation>`	`UserDefinedNavigation`

ModioDefaultTagWidget

Inheritance Hierarchy

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

nd_img_ModioDefaultTagWidget_GetLabelWidget.png

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


`FLinearColorRefOverride`	`TextColorOverride`

ModioDefaultTextButton

Inheritance Hierarchy

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

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

nd_img_ModioDefaultTextButton_GetLabelWidget.png

TScriptInterface<IModioUIHasTextWidget> GetLabelWidget() const

Parameters


`Target`	`ModioDefaultTextButton`

Variables


`FText`	`LabelText`	Text 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


`Target`	`ModioDefaultTokenPackTile`
`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


`Target`	`ModioDefaultTokenPackTile`

Variables


`FModioClickableOnClickedMulticast`	`OnClicked`	Passes `this` as ClickContext
`bool`	`bSelected`
`FModioSelectableOnSelectionChangedMulticast`	`OnSelected`	Passes `this` as SelectionContext, `bNewSelectedState` is new selection state
`FModioHoverableOnHoverStateChangedMulticast`	`OnHoverStateChanged`	Passes `this` as HoverContext, `bHoveredState` is new hover state
`TObjectPtr<UObject>`	`EditorDataSource`

ModioDefaultTokenPackTileView

Inheritance Hierarchy

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

Variables


`FModioOnObjectSelectionChangedMulticast`	`OnSelectedValueChanged`	Passes 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


`Target`	`ModioDialogButtonUIDetails`

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


`uint8`	`UnderlyingEnumValue`	Underlying enum value for this entry
`FText`	`UnderlyingEnumValueDisplayText`	Display 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


`Target`	`ModioEnumEntryUIDetails`
`Enum Value`	the raw enum value the object represents
`Enum Value Display Text`	the 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)

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

nd_img_ModioEnumSelector_GetSelectorMenuWidget.png

TScriptInterface<IModioUIObjectSelector> GetSelectorMenuWidget() const

Parameters


`Target`	`ModioEnumSelector`

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

nd_img_ModioEnumSelector_GetMenuToggleClickableWidget.png

TScriptInterface<IModioUIClickableWidget> GetMenuToggleClickableWidget() const

Parameters


`Target`	`ModioEnumSelector`

Variables


`FModioOnObjectSelectionChangedMulticast`	`OnSelectionChanged`	Passes `this` as SelectedValue

ModioEnumSelectorEntry

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


`Target`	`ModioEnumSelectorEntry`
`bNewSelectedState`	The new selection state

Notify Clicked

Notifies the component that the clickable widget has been clicked

void NotifyClicked()

Parameters


`Target`	`ModioEnumSelectorEntry`

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

nd_img_ModioEnumSelectorEntry_GetSelectableWidget.png

TScriptInterface<IModioUISelectableWidget> GetSelectableWidget() const

Parameters


`Target`	`ModioEnumSelectorEntry`

Returns

The selectable widget

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

nd_img_ModioEnumSelectorEntry_GetLabelWidget.png

TScriptInterface<IModioUIHasTextWidget> GetLabelWidget() const

Parameters


`Target`	`ModioEnumSelectorEntry`

Returns

The label 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

nd_img_ModioEnumSelectorEntry_GetClickableWidget.png

TScriptInterface<IModioUIClickableWidget> GetClickableWidget() const

Parameters


`Target`	`ModioEnumSelectorEntry`

Returns

The clickable widget

Variables


`FModioClickableOnClickedMulticast`	`OnClicked`	Passes `this` as ClickContext
`FModioSelectableOnSelectionChangedMulticast`	`OnSelectionChanged`	Passes `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


`Target`	`ModioEnumSelectorMenu`
`SelectedObject`	The object that was selected

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

nd_img_ModioEnumSelectorMenu_GetSelectorWidget.png

TScriptInterface<IModioUIObjectSelector> GetSelectorWidget() const

Parameters


`Target`	`ModioEnumSelectorMenu`

Returns

The selector widget

Variables


`FModioOnObjectSelectionChangedMulticast`	`OnSelectionChanged`	Passes `UObject*` as SelectedValue

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

nd_img_ModioFilterCounterButton_GetFilterCounterWidget.png

TScriptInterface<IModioUIDataSourceWidget> GetFilterCounterWidget()

Variables

ModioFilterPanel

Inheritance Hierarchy

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

nd_img_ModioFilterPanel_GetTagSelectorWidget.png

TScriptInterface<IModioUIModTagSelector> GetTagSelectorWidget() const

Get Selected Tags

TArray<FString> GetSelectedTags()

nd_img_ModioFilterPanel_GetClearButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetClearButtonWidget() const

nd_img_ModioFilterPanel_GetBackgroundButtonWidget.png

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


`FText`	`FilterName`	Display name for this set of filter parameters.
`FModioFilterParams`	`Underlying`	Underlying 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


`Target`	`ModioFocusableWidget`
`Handler`	Delegate to remove from focus path change

Queries the implementing object for the widget that should receive focus

nd_img_ModioFocusableWidget_GetWidgetToFocus.png

UWidget* GetWidgetToFocus(EUINavigation NavigationType) const

Parameters


`Target`	`ModioFocusableWidget`
`NavigationType`	Navigation 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


`Target`	`ModioFocusableWidget`
`Handler`	Delegate to invoke on focus path change

ModioForceFeedbackRefLibrary

Library of functions for working with force feedback references

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

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


`FModioImageWrapper`	`UnderlyingImage`	Underlying image data
`int32`	`UnderlyingIndex`	Index 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


`Target`	`ModioGalleryImageUIDetails`

Returns

Index associated with the object

Get Image

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

FModioImageWrapper GetImage()

Parameters


`Target`	`ModioGalleryImageUIDetails`

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()

nd_img_ModioImageGallery_GetIncrementSelectionButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetIncrementSelectionButtonWidget() const

Parameters


`Target`	`ModioImageGallery`

Returns

The widget which implements IModioUIClickableWidget

nd_img_ModioImageGallery_GetImageWidget.png

TScriptInterface<IModioUIImageDisplayWidget> GetImageWidget() const

Parameters


`Target`	`ModioImageGallery`

Returns

The image widget which implements IModioUIImageDisplayWidget

nd_img_ModioImageGallery_GetImageSelectorWidget.png

TScriptInterface<IModioUIObjectSelector> GetImageSelectorWidget() const

Parameters


`Target`	`ModioImageGallery`

Returns

The widget which implements IModioUIObjectSelector

nd_img_ModioImageGallery_GetDecrementSelectionButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetDecrementSelectionButtonWidget() const

Parameters


`Target`	`ModioImageGallery`

Returns

The widget which implements IModioUIClickableWidget

Variables


`int64`	`ModIdEditor`
`FModioModInfo`	`BoundModInfo`
`bool`	`bUseLogoOnly`

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)

Initialize Collection Tag Data

void InitializeCollectionTagData(UObject* InTagData)

Increment Preset Filter Selection

void IncrementPresetFilterSelection()

nd_img_ModioModBrowser_GetWalletButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetWalletButtonWidget() const

nd_img_ModioModBrowser_GetViewDescriptionTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetViewDescriptionTextWidget() const

nd_img_ModioModBrowser_GetViewDescriptionImageWidget.png

TScriptInterface<IModioUIImageDisplayWidget> GetViewDescriptionImageWidget() const

nd_img_ModioModBrowser_GetTabRightButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetTabRightButtonWidget() const

nd_img_ModioModBrowser_GetTabLeftButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetTabLeftButtonWidget() const

nd_img_ModioModBrowser_GetSearchTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetSearchTextWidget() const

nd_img_ModioModBrowser_GetSearchEditableTextBoxWidget.png

TScriptInterface<IModioUIStringInputWidget> GetSearchEditableTextBoxWidget() const

nd_img_ModioModBrowser_GetSearchButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetSearchButtonWidget() const

nd_img_ModioModBrowser_GetPresetFilterSelectorWidget.png

TScriptInterface<IModioUIObjectSelector> GetPresetFilterSelectorWidget() const

nd_img_ModioModBrowser_GetModTileViewWidget.png

TScriptInterface<IModioUIModListViewInterface> GetModTileViewWidget() const

nd_img_ModioModBrowser_GetModCollectionTileViewWidget.png

TScriptInterface<IModioUIModCollectionListViewInterface> GetModCollectionTileViewWidget() const

nd_img_ModioModBrowser_GetModCollectionsViewButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetModCollectionsViewButtonWidget() const

nd_img_ModioModBrowser_GetLibraryViewButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetLibraryViewButtonWidget() const

nd_img_ModioModBrowser_GetFilterButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetFilterButtonWidget() const

nd_img_ModioModBrowser_GetCloseBrowserButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetCloseBrowserButtonWidget() const

nd_img_ModioModBrowser_GetClearSearchButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetClearSearchButtonWidget() const

Decrement Preset Filter Selection

void DecrementPresetFilterSelection()

Variables


`EModioModBrowserState`	`CurrentView`
`FString`	`StoredSearchString`
`TObjectPtr<UObject>`	`StoredTagData`
`TObjectPtr<UObject>`	`StoredLibraryTagData`
`TObjectPtr<UObject>`	`StoredCollectionTagData`

ModioModBrowserDialogButtonInfoUI

Wrapper around FModioDialogButtonInfo for data binding to UListView etc

Inheritance Hierarchy

-> Object

ModioModCollectionDetailsDialog

Inheritance Hierarchy

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

Populate Extra Options Commands

void PopulateExtraOptionsCommands(TArray<UObject*> Commands, UObject* Context)

nd_img_ModioModCollectionDetailsDialog_GetTagDisplayWidget.png

TScriptInterface<IModioUIDataSourceWidget> GetTagDisplayWidget() const

nd_img_ModioModCollectionDetailsDialog_GetRateUpButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetRateUpButtonWidget() const

nd_img_ModioModCollectionDetailsDialog_GetRateDownButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetRateDownButtonWidget() const

nd_img_ModioModCollectionDetailsDialog_GetMoreOptionsMenuWidget.png

TScriptInterface<IModioUICommandMenu> GetMoreOptionsMenuWidget() const

nd_img_ModioModCollectionDetailsDialog_GetModCollectionSummaryShortTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetModCollectionSummaryShortTextWidget() const

nd_img_ModioModCollectionDetailsDialog_GetModCollectionStatusWidget.png

TScriptInterface<IModioUIDataSourceWidget> GetModCollectionStatusWidget() const

nd_img_ModioModCollectionDetailsDialog_GetModCollectionPropertiesWidget.png

TScriptInterface<IModioUIDataSourceWidget> GetModCollectionPropertiesWidget() const

nd_img_ModioModCollectionDetailsDialog_GetModCollectionNameTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetModCollectionNameTextWidget() const

nd_img_ModioModCollectionDetailsDialog_GetModCollectionLogoWidget.png

TScriptInterface<IModioUIImageDisplayWidget> GetModCollectionLogoWidget() const

nd_img_ModioModCollectionDetailsDialog_GetModCollectionCuratorDisplayWidget.png

TScriptInterface<IModioUIDataSourceWidget> GetModCollectionCuratorDisplayWidget() const

nd_img_ModioModCollectionDetailsDialog_GetFollowButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetFollowButtonWidget() const

nd_img_ModioModCollectionDetailsDialog_GetExpandDescriptionButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetExpandDescriptionButtonWidget() const

nd_img_ModioModCollectionDetailsDialog_GetCollectionModsListViewWidget.png

TScriptInterface<IModioUIModListViewInterface> GetCollectionModsListViewWidget() const

nd_img_ModioModCollectionDetailsDialog_GetCloseDialogButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetCloseDialogButtonWidget() const

Variables


`FText`	`ExpandLabelText`
`TObjectPtr<UObject>`	`EditorDataSource`
`FModioModCollectionInfo`	`BoundModCollectionInfo`
`bool`	`bHasFullDescription`

-> Interface-> Object

Get Mod Collection ID

FModioModCollectionID GetModCollectionID()

Parameters


`Target`	`ModioModCollectionInfoUIDetails`

Returns

Mod Collection ID for the associated mod collection

Get Full Mod Collection Info

FModioModCollectionInfo GetFullModCollectionInfo()

Parameters


`Target`	`ModioModCollectionInfoUIDetails`

Returns

ModCollectionInfo for the associated mod collection

ModioModCollectionStatusWidget

This is a default implementation of the Mod Collection Status component which is intended to represent a mod collection's follow state for the currently authenticated user.

Inheritance Hierarchy

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

Set Mod Collection Follow State

void SetModCollectionFollowState(EModioModCollectionState NewState)

Get Mod Collection Info

Full information for the mod collection this widget represents, based on its data source

FModioModCollectionInfo GetModCollectionInfo()

Parameters


`Target`	`ModioModCollectionStatusWidget`

Variables


`FOnFollowStateChanged`	`OnCollectionFollowStateChangedEvent`	Broadcasts when the mod collection's follow state is updated
`EModioModCollectionState`	`CurrentCollectionFollowState`

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


`Target`	`ModioModDependencyUIDetails`

Returns

Mod ID for the associated mod

Get Mod Dependency

FModioModDependency GetModDependency()

Parameters


`Target`	`ModioModDependencyUIDetails`

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


`Target`	`ModioModDetailsDialog`

Is Mod Purchased

bool IsModPurchased()

nd_img_ModioModDetailsDialog_GetWalletButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetWalletButtonWidget() const

nd_img_ModioModDetailsDialog_GetTagDisplayWidget.png

TScriptInterface<IModioUIDataSourceWidget> GetTagDisplayWidget() const

TScriptInterface<IModioUIClickableWidget> GetSubscribeButtonWidget() const

nd_img_ModioModDetailsDialog_GetRateUpButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetRateUpButtonWidget() const

nd_img_ModioModDetailsDialog_GetRateDownButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetRateDownButtonWidget() const

nd_img_ModioModDetailsDialog_GetPurchaseButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetPurchaseButtonWidget() const

nd_img_ModioModDetailsDialog_GetMoreOptionsMenuWidget.png

TScriptInterface<IModioUICommandMenu> GetMoreOptionsMenuWidget() const

nd_img_ModioModDetailsDialog_GetModSummaryShortTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetModSummaryShortTextWidget() const

nd_img_ModioModDetailsDialog_GetModStatusWidget.png

TScriptInterface<IModioUIDataSourceWidget> GetModStatusWidget() const

nd_img_ModioModDetailsDialog_GetModPropertiesWidget.png

TScriptInterface<IModioUIDataSourceWidget> GetModPropertiesWidget() const

nd_img_ModioModDetailsDialog_GetModNameTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetModNameTextWidget() const

nd_img_ModioModDetailsDialog_GetModImageGalleryWidget.png

TScriptInterface<IModioUIMediaDownloadCompletedReceiver> GetModImageGalleryWidget() const

nd_img_ModioModDetailsDialog_GetModDependenciesButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetModDependenciesButtonWidget() const

nd_img_ModioModDetailsDialog_GetModAuthorDisplayWidget.png

TScriptInterface<IModioUIDataSourceWidget> GetModAuthorDisplayWidget() const

nd_img_ModioModDetailsDialog_GetExpandDescriptionButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetExpandDescriptionButtonWidget() const

nd_img_ModioModDetailsDialog_GetCloseDialogButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetCloseDialogButtonWidget() const

Variables


`FText`	`ExpandLabelText`
`TObjectPtr<UObject>`	`EditorDataSource`
`FModioModInfo`	`BoundModInfo`
`bool`	`bHasFullDescription`

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


`Target`	`ModioModFilterUIDetails`

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


`Target`	`ModioModFilterUIDetails`
`Name`	The 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


`Target`	`ModioModInfoUIDetails`

Returns

Mod ID for the associated mod

Get Full Mod Info

FModioModInfo GetFullModInfo()

Parameters


`Target`	`ModioModInfoUIDetails`

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


`Target`	`ModioModInstallationStatusWidget`
`ProgressState`	The 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


`FModioModInfo`	`BoundModInfo`	Full information for the mod this widget represents, based on its data source
`FOnModInstallationStatusChanged`	`OnInstallationStatusChanged`	Broadcasts when the mod's installation status is updated
`EModioModInstallationStatus`	`CurrentInstallationStatus`

Get Mod Property Visualizer Widgets

TArray<TScriptInterface<IModioUIDataSourceWidget> > GetModPropertyVisualizerWidgets()

Parameters


`Target`	`ModioModPropCollectionVisualizer`

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 the label widget that displays the rating percentage

nd_img_ModioModRatingDisplay_GetRatingPercentageLabelWidget.png

TScriptInterface<IModioUIHasTextWidget> GetRatingPercentageLabelWidget() const

Parameters


`Target`	`ModioModRatingDisplay`

Returns

The label widget

Get the rating description label widget

nd_img_ModioModRatingDisplay_GetRatingDescriptionLabelWidget.png

TScriptInterface<IModioUIHasTextWidget> GetRatingDescriptionLabelWidget() const

Parameters


`Target`	`ModioModRatingDisplay`

Returns

The label widget

Variables


`TObjectPtr<UObject>`	`EditorDataSource`	The 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

Set Tag Selected State

Sets the selection state for a given array of tags.

void SetTagSelectedState(TArray<FString> InTags, bool bSelectedState)

Parameters


`Target`	`ModioModTagCategoryUIDetails`
`InTags`	The array of tags to set the selection state for
`bSelectedState`	The new selection state for the provided tags

Get Selected Tags

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

TArray<FString> GetSelectedTags()

Parameters


`Target`	`ModioModTagCategoryUIDetails`

Get Raw Category Name

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

FString GetRawCategoryName()

Parameters


`Target`	`ModioModTagCategoryUIDetails`

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


`Target`	`ModioModTagCategoryUIDetails`

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


`Target`	`ModioModTagCategoryUIDetails`

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


`Target`	`ModioModTagCategoryUIDetails`

Returns

True if only visible by admins

Get Category Tags

Gets the bindable tag objects for this category

TArray<TScriptInterface<IModioModTagUIDetails> > GetCategoryTags()

Parameters


`Target`	`ModioModTagCategoryUIDetails`

Get Allow Multiple Selection

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

bool GetAllowMultipleSelection()

Parameters


`Target`	`ModioModTagCategoryUIDetails`

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 the widget that will contain the tags

nd_img_ModioModTagDisplay_GetTagContainerWidget.png

TScriptInterface<IModioUIObjectListWidget> GetTagContainerWidget() const

Parameters


`Target`	`ModioModTagDisplay`

Returns

The widget

Variables


`TObjectPtr<UObject>`	`EditorDataSource`	The 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


`FModioModTagInfo`	`Underlying`	Underlying tag info
`FText`	`LocalizedCategoryName`	Localized tag category string
`TArray<TObjectPtr<UModioModTagUI> >`	`BindableTags`	Transient 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


`FModioModTagOptions`	`Underlying`	Underlying tag options
`TArray<TObjectPtr<UModioModTagInfoUI> >`	`BindableTagCategories`	Transient set of bindable tag categories for use in the UI

ModioModTagOptionsUIDetails

Inheritance Hierarchy

-> Interface-> Object

Set Tag Selected State

Sets the selection state for a given array of tags.

void SetTagSelectedState(TArray<FString> InTags, bool bSelectedState)

Parameters


`Target`	`ModioModTagOptionsUIDetails`
`InTags`	The array of tags to set the selection state for
`bSelectedState`	The new selection state for the provided tags

Get Selected Tags

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

TArray<FString> GetSelectedTags()

Parameters


`Target`	`ModioModTagOptionsUIDetails`

Get Categories

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

TArray<TScriptInterface<IModioModTagCategoryUIDetails> > GetCategories()

Parameters


`Target`	`ModioModTagOptionsUIDetails`

Clear Selected Tags

Clears all selected tags across all categories

void ClearSelectedTags()

Parameters


`Target`	`ModioModTagOptionsUIDetails`

ModioModTagSelector

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

Inheritance Hierarchy

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

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

nd_img_ModioModTagSelector_GetSelectorMenuWidget.png

TScriptInterface<IModioUIModTagSelector> GetSelectorMenuWidget() const

Parameters


`Target`	`ModioModTagSelector`

Returns

The widget that displays the tag categories and values

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

nd_img_ModioModTagSelector_GetMenuToggleClickableWidget.png

TScriptInterface<IModioUIClickableWidget> GetMenuToggleClickableWidget() const

Parameters


`Target`	`ModioModTagSelector`

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


`Target`	`ModioModTagSelectorCategory`

Returns

The label widget

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

nd_img_ModioModTagSelectorCategory_GetCategoryTagListWidget.png

TScriptInterface<IModioUIObjectSelector> GetCategoryTagListWidget() const

Parameters


`Target`	`ModioModTagSelectorCategory`

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


`Target`	`ModioModTagSelectorEntry`

Notify Clicked

Notify listeners that this entry has been clicked

void NotifyClicked()

Parameters


`Target`	`ModioModTagSelectorEntry`

Get the widget that displays the tag text for this entry

nd_img_ModioModTagSelectorEntry_GetTagLabelWidget.png

TScriptInterface<IModioUIHasTextWidget> GetTagLabelWidget() const

Parameters


`Target`	`ModioModTagSelectorEntry`

Returns

The text widget

Get the widget that represents the selection state of this entry

nd_img_ModioModTagSelectorEntry_GetSelectionWidget.png

TScriptInterface<IModioUISelectableWidget> GetSelectionWidget() const

Parameters


`Target`	`ModioModTagSelectorEntry`

Returns

The selection widget

Get the widget that can be clicked to select this entry

nd_img_ModioModTagSelectorEntry_GetClickableWidget.png

TScriptInterface<IModioUIClickableWidget> GetClickableWidget() const

Parameters


`Target`	`ModioModTagSelectorEntry`

Returns

The clickable widget

Variables


`FModioSelectableOnSelectionChangedMulticast`	`OnSelectionStateChanged`	Passes `this` as SelectionContext, `bNewSelectedState` is new selection state
`FModioClickableOnClickedMulticast`	`OnClicked`	Passes `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


`Target`	`ModioModTagSelectorMenu`

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

nd_img_ModioModTagSelectorMenu_GetCategoryContainerWidget.png

TScriptInterface<IModioUIObjectListWidget> GetCategoryContainerWidget() const

Parameters


`Target`	`ModioModTagSelectorMenu`

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


`Target`	`ModioModTagSelectorMenu`

Returns

Array of category tags allowed to be shown

Variables


`FModioOnTagSelectionChangedMulticast`	`OnTagSelectionChanged`

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


`FString`	`Underlying`	Raw tag string used in the mod.io API
`FText`	`LocalizedText`	Localized tag string
`bool`	`bSelectionState`	Transient 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


`Target`	`ModioModTagUIDetails`
`bNewSelectionState`	The 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


`Target`	`ModioModTagUIDetails`

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


`Target`	`ModioModTagUIDetails`

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


`Target`	`ModioModTagUIDetails`

Returns

localized text value for the mod tag

ModioObjectWrapBox

Inheritance Hierarchy

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

Variables


`FModioObjectListOnObjectWidgetCreatedMulticast`	`OnWidgetCreated`	Passes 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

nd_img_ModioOperationTracker_GetRadialProgressWidget.png

TScriptInterface<IModioUIProgressWidget> GetRadialProgressWidget() const

nd_img_ModioOperationTracker_GetQueueLabelTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetQueueLabelTextWidget() const

nd_img_ModioOperationTracker_GetQueueCountTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetQueueCountTextWidget() const

nd_img_ModioOperationTracker_GetQueueCountIconWidget.png

TScriptInterface<IModioUIImageDisplayWidget> GetQueueCountIconWidget() const

nd_img_ModioOperationTracker_GetPercentProgressTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetPercentProgressTextWidget() const

nd_img_ModioOperationTracker_GetOperationTypeIconWidget.png

TScriptInterface<IModioUIImageDisplayWidget> GetOperationTypeIconWidget() const

nd_img_ModioOperationTracker_GetDownloadSpeedTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetDownloadSpeedTextWidget() const

nd_img_ModioOperationTracker_GetDownloadSizeTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetDownloadSizeTextWidget() const

Variables

ModioPlatformSpecificWidget

Inheritance Hierarchy

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

Variables

ModioPopupCommandMenu

Inheritance Hierarchy

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

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

TScriptInterface<IModioUICommandMenu> GetCommandMenuWidget() const

Parameters


`Target`	`ModioPopupCommandMenu`

Returns

The widget that displays the command menu

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


`Target`	`ModioPopupCommandMenu`

Variables

ModioPresetFilterEntryWidget

A widget that represents a filter entry in a filter preset

Inheritance Hierarchy

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

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

nd_img_ModioPresetFilterEntryWidget_GetLabelWidget.png

TScriptInterface<IModioUIHasTextWidget> GetLabelWidget() const

Parameters


`Target`	`ModioPresetFilterEntryWidget`

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

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

nd_img_ModioPresetFilterSelector_GetPresetListWidget.png

TScriptInterface<IModioUIObjectSelector> GetPresetListWidget() const

Parameters


`Target`	`ModioPresetFilterSelector`

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


`Target`	`ModioPresetFilterSelector`

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


`FModioReportParams`	`ReportData`	Data for the report
`TObjectPtr<UObject>`	`ModInfo`	Mod 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


`Target`	`ModioScrollableWidget`
`Offset`	The scroll offset to set

Scroll Visible Area

Scroll the widget by the size of the visible content area

void ScrollVisibleArea(bool bBackward)

Parameters


`Target`	`ModioScrollableWidget`
`bBackward`	If true, scroll up/left; if false, scroll down/right

Scroll to Top

Scroll the widget to the top

void ScrollToTop()

Parameters


`Target`	`ModioScrollableWidget`

Scroll to Bottom

Scroll the widget to the bottom

void ScrollToBottom()

Parameters


`Target`	`ModioScrollableWidget`

Remove Scrollable Offset Changed Handler

Unsubscribes a delegate from receiving state change callbacks

void RemoveScrollableOffsetChangedHandler(FModioScrollableOffsetChanged Handler)

Parameters


`Target`	`ModioScrollableWidget`
`Handler`	The delegate to remove

Get Scroll Offset

Get the current scroll offset of the widget

float GetScrollOffset() const

Parameters


`Target`	`ModioScrollableWidget`

Returns

The current scroll offset

Can Scroll in Direction

Checks if the widget can scroll in the specified direction

bool CanScrollInDirection(bool bBackward) const

Parameters


`Target`	`ModioScrollableWidget`
`bBackward`	If true, check if can scroll up/left; if false check if can scroll down/right

Returns

True if the widget can scroll in the specified direction, false otherwise

Add Scrollable Offset Changed Handler

Registers a delegate that receives a callback when the scroll offset of the widget changes

void AddScrollableOffsetChangedHandler(FModioScrollableOffsetChanged Handler)

Parameters


`Target`	`ModioScrollableWidget`
`Handler`	Delegate to invoke on state change

ModioSearchBar

Inheritance Hierarchy

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

nd_img_ModioSearchBar_GetSearchBoxWidget.png

TScriptInterface<IModioUIStringInputWidget> GetSearchBoxWidget() const

nd_img_ModioSearchBar_GetButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetButtonWidget() const

Variables

ModioSoundCueRefLibrary

Library of functions for working with sound references

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object

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()

nd_img_ModioStorageTracker_GetStorageUsedTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetStorageUsedTextWidget() const

Variables

ModioTagCounterIcon

Inheritance Hierarchy

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

Synchronize Counter

int32 SynchronizeCounter()

nd_img_ModioTagCounterIcon_GetCounterLabelWidget.png

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


`Target`	`ModioToggleableWidget`
`Handler`	Delegate to remove from toggle state change

Open

Toggles the open state of the widget

void Open(bool bForce, bool bFocusMenu)

Parameters


`Target`	`ModioToggleableWidget`
`bForce`	Whether to force the widget to open (e.g. it may take ShouldOpenDueToClick into account when the implementing widget is derived from UMenuAnchor)
`bFocusMenu`	Whether to focus the menu when opening

Is Open

Get the current open/close state of the widget

bool IsOpen() const

Parameters


`Target`	`ModioToggleableWidget`

Returns

True if the widget is open, false otherwise

Close

Toggles the close state of the widget

void Close()

Parameters


`Target`	`ModioToggleableWidget`

Add Toggle State Changed Handler

Registers a delegate to receive callbacks when the toggle state changes

void AddToggleStateChangedHandler(FModioOnToggleStateChanged Handler)

Parameters


`Target`	`ModioToggleableWidget`
`Handler`	Delegate to invoke on toggle state change

ModioTokenPackBrowser

Inheritance Hierarchy

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

nd_img_ModioTokenPackBrowser_GetTokenTileViewWidget.png

TScriptInterface<IModioUITokenPackListInterface> GetTokenTileViewWidget() const

nd_img_ModioTokenPackBrowser_GetTitleTextWidget.png

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

Is Purchasable

Check if the token pack is purchasable

bool IsPurchasable() const

Parameters


`Target`	`ModioTokenPackUIDetails`

Returns

True if the token pack is purchasable, false otherwise

Get Token Pack Display Price

FText GetTokenPackDisplayPrice() const

Parameters


`Target`	`ModioTokenPackUIDetails`

Returns

FText containing display string for the pack's current price

Get Title

Get the title of the token pack

FText GetTitle() const

Parameters


`Target`	`ModioTokenPackUIDetails`

Returns

The title text of the token pack

Get Release Date

Get the release date of the token pack

FDateTime GetReleaseDate() const

Parameters


`Target`	`ModioTokenPackUIDetails`

Returns

The release date of the token pack

Get Regular Price

Get the regular price of the token pack

FText GetRegularPrice() const

Parameters


`Target`	`ModioTokenPackUIDetails`

Returns

The regular price text of the token pack

Get Numeric Price

Get the numeric price of the token pack

int64 GetNumericPrice() const

Parameters


`Target`	`ModioTokenPackUIDetails`

Returns

The numeric price of the token pack

Get Modio Id

FModioTokenPackID GetModioId() const

Parameters


`Target`	`ModioTokenPackUIDetails`

Returns

Token Pack ID for the relevant TokenPack

Get Long Description

Get the long description of the token pack

FText GetLongDescription() const

Parameters


`Target`	`ModioTokenPackUIDetails`

Returns

The long description text of the token pack

Get Fields

Get any dynamic fields associated with the token pack

TMap<FString,FString> GetFields() const

Parameters


`Target`	`ModioTokenPackUIDetails`

Returns

A map of dynamic fields for the token pack

Get Expiration Date

Get the expiration date of the token pack

FDateTime GetExpirationDate() const

Parameters


`Target`	`ModioTokenPackUIDetails`

Returns

The expiration date of the token pack

Get Description

Get the description of the token pack

FText GetDescription() const

Parameters


`Target`	`ModioTokenPackUIDetails`

Returns

The description text of the token pack

Get Currency Code

Get the currency code of the token pack

FString GetCurrencyCode() const

Parameters


`Target`	`ModioTokenPackUIDetails`

Returns

The currency code of the token pack

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


`Target`	`ModioUIBoundActionWidget`
`Input Action Row`	The 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


`Target`	`ModioUIBoundActionWidget`
`InputActionRow`	Delegate to invoke with hold progress

Remove Action Progress Handler

void RemoveActionProgressHandler(FModioBoundActionProgressed Handler)

Parameters


`Target`	`ModioUIBoundActionWidget`
`Handler`	Delegate to unsubscribe

Remove Action Completed Handler

void RemoveActionCompletedHandler(FModioBoundActionCompleted Handler)

Parameters


`Target`	`ModioUIBoundActionWidget`
`Handler`	Delegate to unsubscribe

Clear Bound Action

Clears the bound action for the implementing object

void ClearBoundAction()

Parameters


`Target`	`ModioUIBoundActionWidget`

Add Action Progress Handler

void AddActionProgressHandler(FModioBoundActionProgressed Handler)

Parameters


`Target`	`ModioUIBoundActionWidget`
`Handler`	Delegate to invoke with hold progress

Add Action Completed Handler

void AddActionCompletedHandler(FModioBoundActionCompleted Handler)

Parameters


`Target`	`ModioUIBoundActionWidget`
`Handler`	Delegate 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


`Target`	`ModioUIClickableWidget`
`Handler`	Delegate to unsubscribe

Enable Click

Enables click events being emitted by the implementing object

void EnableClick()

Parameters


`Target`	`ModioUIClickableWidget`

Disable Click

Disables click events being emitted by the implementing object

void DisableClick()

Parameters


`Target`	`ModioUIClickableWidget`

Add Clicked Handler

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

void AddClickedHandler(FModioClickableOnClicked Handler)

Parameters


`Target`	`ModioUIClickableWidget`
`Handler`	Delegate to invoke on a click event

ModioUICollectionFollowStateChangedReceiver

void RemoveCommandListBuilder(FModioCommandListBuilder Builder)

Parameters


`Target`	`ModioUICommandMenu`
`Builder`	Delegate 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


`Target`	`ModioUICommandMenu`

Add Command List Builder

Registers a delegate to be invoked when RebuildCommandList is called

void AddCommandListBuilder(FModioCommandListBuilder Builder)

Parameters


`Target`	`ModioUICommandMenu`
`Builder`	Delegate 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


`Target`	`ModioUICommandObject`
`InDataSource`	The object to use as a context

Get Command Display String

Retrieves the text to display for this command

FText GetCommandDisplayString()

Parameters


`Target`	`ModioUICommandObject`

Returns

Localized display string for this command

Get Command Brush

Retrieves the brush to use as an icon for this command

FSlateBrush GetCommandBrush()

Parameters


`Target`	`ModioUICommandObject`

Returns

The brush to use as an icon

Execute

Performs the command associated with this object

void Execute(UObject* Context)

Parameters


`Target`	`ModioUICommandObject`
`Context`	Additional secondary context object for this command

Can Execute

Indicates if the command can currently be executed

bool CanExecute(UObject* Context)

Parameters


`Target`	`ModioUICommandObject`
`Context`	Additional 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


`Target`	`ModioUICommonButtonWidget`
`Params`	The 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>`	`DataSource`	Cached object to use as the source for data binding. Populated by SetDataSource
`FModioOnActivationChangedMulticast`	`OnModioActivationChanged`	Passes `this` as ActivationContext, `bIsActivated` as the new activation state
`FModioOnFocusPathChangedMulticast`	`OnModioFocusPathChanged`	Passes `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


`Target`	`ModioUIDataSourceWidget`
`InDataSource`	the 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


`Target`	`ModioUIDataSourceWidget`

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

Requests that the modal dialog be displayed

void ShowModal(bool bFocusCancelButton)

Parameters


`Target`	`ModioUIDialog`
`bFocusCancelButton`	Should 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


`Target`	`ModioUIDialog`
`Handler`	Delegate 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


`Target`	`ModioUIDialog`
`Handler`	Delegate 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


`Target`	`ModioUIDialog`
`Handler`	Delegate 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


`Target`	`ModioUIDialog`
`Handler`	Delegate that will no longer receive invocations

Closes the modal dialog, removing it from display

void CloseModal()

Parameters


`Target`	`ModioUIDialog`

Add Dialog Shown Handler

Registers a callback to receive notifications when the dialog is shown

void AddDialogShownHandler(FModioDialogShownEvent Handler)

Parameters


`Target`	`ModioUIDialog`
`Handler`	Delegate 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


`Target`	`ModioUIDialog`
`Handler`	Delegate 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


`Target`	`ModioUIDialog`
`Handler`	Delegate 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


`Target`	`ModioUIDialog`
`Handler`	Delegate to invoke when a button is clicked

ModioUIDialogDisplayEventReceiver

Inheritance Hierarchy

-> Interface-> Object

ModioUIDisplayFilteredModCollectionsCommand

Inheritance Hierarchy

-> Object

Set Filter Params

void SetFilterParams(FModioFilterParams FilterParams)

Set Display String Key

void SetDisplayStringKey(FName InDisplayStringKey)

ModioUIDisplayFilteredModsCommand

Inheritance Hierarchy

-> Object

Set Filter Params

void SetFilterParams(FModioFilterParams FilterParams)

Set Display String Key

void SetDisplayStringKey(FName InDisplayStringKey)

ModioUIHasConfigurableColor

Inheritance Hierarchy

-> Interface-> Object

nd_img_ModioUIHasConfigurableColor_ConfigureWidgetColorDirectly.png

void ConfigureWidgetColorDirectly(FName ColorName, FSlateColor ColorValue)

nd_img_ModioUIHasConfigurableColor_ConfigureWidgetColor.png

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


`Target`	`ModioUIHasLoadStateWidget`
`NewState`	the 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


`Target`	`ModioUIHasLoadStateWidget`
`Handler`	The delegate to unregister

Get Load State

Retrieves the implementing widget's current load state

EModioUILoadState GetLoadState() const

Parameters


`Target`	`ModioUIHasLoadStateWidget`

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


`Target`	`ModioUIHasLoadStateWidget`
`Handler`	Delegate to invoke on a state change event

ModioUIHasTextWidget

Interface indicating the implementing widget has a configurable Text

Inheritance Hierarchy

-> Interface-> Object

Sets the font for the implementing widget, if applicable

nd_img_ModioUIHasTextWidget_SetWidgetTextFont.png

void SetWidgetTextFont(FSlateFontInfo FontInfo)

Parameters


`Target`	`ModioUIHasTextWidget`
`FontInfo`	the font to use

Sets the value of the associated text for the implementing object

nd_img_ModioUIHasTextWidget_SetWidgetText.png

void SetWidgetText(FText DisplayText)

Parameters


`Target`	`ModioUIHasTextWidget`
`DisplayText`	the text to display

Retrieves the font for the implementing widget, if applicable

nd_img_ModioUIHasTextWidget_GetWidgetTextFont.png

FSlateFontInfo GetWidgetTextFont()

Parameters


`Target`	`ModioUIHasTextWidget`

Returns

The font to use

Retrieves the value of the implementing widget's associated text

nd_img_ModioUIHasTextWidget_GetWidgetText.png

FText GetWidgetText()

Parameters


`Target`	`ModioUIHasTextWidget`

Returns

The text value

ModioUIHasTooltipWidget

Interface indicating the implementing widget has a configurable tooltip

Inheritance Hierarchy

-> Interface-> Object

Sets whether a tooltip is enabled on the implementing object

nd_img_ModioUIHasTooltipWidget_SetTooltipEnabledState.png

void SetTooltipEnabledState(bool bNewEnabledState)

Parameters


`Target`	`ModioUIHasTooltipWidget`
`bNewEnabledState`	True if tooltips should be enabled

Configures the values for the associated tooltip for the implementing object

nd_img_ModioUIHasTooltipWidget_ConfigureTooltip.png

void ConfigureTooltip(FText TitleText, FText InfoText, FText TagText)

Parameters


`Target`	`ModioUIHasTooltipWidget`
`TitleText`	The title of the tooltip
`InfoText`	The contents of the tooltip
`TagText`	The 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


`Target`	`ModioUIHoverableWidget`
`Handler`	Delegate to unregister

Enable Hover Events

Enable emitting hover state changed events on the implementing object

void EnableHoverEvents()

Parameters


`Target`	`ModioUIHoverableWidget`

Disable Hover Events

Disable emitting hover state changed events on the implementing object

void DisableHoverEvents()

Parameters


`Target`	`ModioUIHoverableWidget`

Add Hover State Changed Handler

void AddHoverStateChangedHandler(FModioHoverableOnHoverStateChanged Handler)

Parameters


`Target`	`ModioUIHoverableWidget`
`Handler`	Delegate 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


`Target`	`ModioUIImageDisplayWidget`
`DesiredSize`	Desired 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


`Target`	`ModioUIImageDisplayWidget`
`bMatchTextureSize`	True 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


`Target`	`ModioUIImageDisplayWidget`
`NewBrush`	The brush to set

Remove Image Load Event Handler

Unregisters a delegate, preventing it from receiving image loading callbacks

void RemoveImageLoadEventHandler(FModioImageDisplayOnLoadStateChanged Handler)

Parameters


`Target`	`ModioUIImageDisplayWidget`
`Handler`	Delegate to unregister

Begin Load Image from File

Begins loading an image from a file path

void BeginLoadImageFromFile(FModioImageWrapper Image)

Parameters


`Target`	`ModioUIImageDisplayWidget`
`Image`	Image data to load. Can be loaded asynchronously

Add Image Load Event Handler

void AddImageLoadEventHandler(FModioImageDisplayOnLoadStateChanged Handler)

Parameters


`Target`	`ModioUIImageDisplayWidget`
`Handler`	Delegate to invoke on load state change

ModioUIInputModeChangedReceiver

void PlayUISoundFeedback(USoundBase* UIFeedbackSound, UObject* WorldContextObject)

Parameters


`Target`	`ModioUIInteractionFeedback`
`UIFeedbackSound`	The feedback sound to play
`WorldContextObject`	Object used to resolve the world for sound playback (e.g. the calling widget)

Play UIForce Feedback

Plays the force feedback associated with the given interaction key

void PlayUIForceFeedback(UForceFeedbackEffect* UIFeedbackForceEffect, APlayerController* PlayerController)

Parameters


`Target`	`ModioUIInteractionFeedback`
`UIFeedbackForceEffect`	The force feedback effect to play
`PlayerController`	The player to play force feedback on

ModioUIManageModSubscriptionCommand

Inheritance Hierarchy

-> Object

ModioUIMediaDownloadCompletedReceiver

Inheritance Hierarchy

-> Interface-> Object

ModioUIModCollectionInfoReceiver

Inheritance Hierarchy

-> Interface-> Object

ModioUIModCollectionListViewInterface

Interface for any widget that can visualise a list of mod collections

Inheritance Hierarchy

-> Interface-> Object

Set Mod Collection Selection by ID

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

void SetModCollectionSelectionByID(FModioModCollectionID ModCollectionID)

Parameters


`Target`	`ModioUIModCollectionListViewInterface`
`ModCollectionID`	The mod collection ID to select

Set Mod Collection from Mod Collection Info List

Populates the list based on the mod collections contained in the provided ModCollectionInfoList

void SetModCollectionFromModCollectionInfoList(FModioModCollectionInfoList InList, bool bAddToExisting)

Parameters


`Target`	`ModioUIModCollectionListViewInterface`
`InList`	The set of mod collections to populate with
`bAddToExisting`	Should the new set be merged with the existing mod collections or replace them?

Set Mod Collection from Mod Collection Info Array

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

void SetModCollectionFromModCollectionInfoArray(TArray<FModioModCollectionInfo> InArray, bool bAddToExisting)

Parameters


`Target`	`ModioUIModCollectionListViewInterface`
`InArray`	The set of mod collections to populate with
`bAddToExisting`	Should the new set be merged with the existing mod corrections or replace them?

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


`Target`	`ModioUIModEnabledStateProvider`
`ID`	The ID of the mod to change the state of
`bNewEnabledState`	The 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


`Target`	`ModioUIModEnabledStateProvider`
`Handler`	Delegate 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


`Target`	`ModioUIModEnabledStateProvider`
`ModID`	The 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


`Target`	`ModioUIModEnabledStateProvider`
`Handler`	Delegate 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


`Target`	`ModioUIModListViewInterface`
`InList`	The set of mods to populate with
`bAddToExisting`	Should 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


`Target`	`ModioUIModListViewInterface`
`InArray`	The set of mods to populate with
`bAddToExisting`	Should 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


`Target`	`ModioUIModListViewInterface`
`InArray`	The set of mods to populate with
`bAddToExisting`	Should 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


`Target`	`ModioUIModListViewInterface`
`ModID`	The 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 Tag Selected State

Sets the selection state of the given tags

void SetTagSelectedState(TArray<FString> InTags, bool bSelectedState)

Parameters


`Target`	`ModioUIModTagSelector`
`InTags`	Array of tag values to set
`bSelectedState`	Whether the given tags should be selected or unselected

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


`Target`	`ModioUIModTagSelector`
`InOptions`	Tag 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


`Target`	`ModioUIModTagSelector`
`InOptions`	Tag 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


`Target`	`ModioUIModTagSelector`
`Handler`	Delegate that will no longer receive selection changed events

Get Selected Tags

Retrieves the selected tags from the implementing object

TArray<FString> GetSelectedTags()

Parameters


`Target`	`ModioUIModTagSelector`

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


`Target`	`ModioUIModTagSelector`

Get Allow Hidden Tags

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

bool GetAllowHiddenTags()

Parameters


`Target`	`ModioUIModTagSelector`

Clear Selected Tags

Clears the selection state of the selector

void ClearSelectedTags()

Parameters


`Target`	`ModioUIModTagSelector`

Add Tag Selection Changed Handler

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

void AddTagSelectionChangedHandler(FModioOnTagSelectionChanged Handler)

Parameters


`Target`	`ModioUIModTagSelector`
`Handler`	Delegate 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


`Target`	`ModioUIObjectListWidget`
`InObjects`	the objects to use as a data source

Unregisters a delegate from receiving object widget creation callbacks

nd_img_ModioUIObjectListWidget_RemoveObjectWidgetCreatedHandler.png

void RemoveObjectWidgetCreatedHandler(FModioObjectListOnObjectWidgetCreated Handler)

Parameters


`Target`	`ModioUIObjectListWidget`
`Handler`	Delegate to remove

Get Objects

Retrieves the associated data source objects for the implementing widget

TArray<UObject*> GetObjects()

Parameters


`Target`	`ModioUIObjectListWidget`

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


`Target`	`ModioUIObjectListWidget`
`Index`	The index of the object to retrieve

Returns

The object at the specified index

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

nd_img_ModioUIObjectListWidget_GetFirstEntryWidget.png

UWidget* GetFirstEntryWidget()

Parameters


`Target`	`ModioUIObjectListWidget`

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

nd_img_ModioUIObjectListWidget_AddObjectWidgetCreatedHandler.png

void AddObjectWidgetCreatedHandler(FModioObjectListOnObjectWidgetCreated Handler)

Parameters


`Target`	`ModioUIObjectListWidget`
`Handler`	Delegate 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


`Target`	`ModioUIObjectSelector`
`InValues`	Array 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


`Target`	`ModioUIObjectSelector`
`Value`	The value to select
`bEmitSelectionEvent`	True 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


`Target`	`ModioUIObjectSelector`
`Index`	The 0-based index to use when determining the selected object
`bEmitSelectionEvent`	True 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


`Target`	`ModioUIObjectSelector`
`Value`	The value to set the selection state for
`bNewSelectionState`	The new selection state to set
`bEmitSelectionEvent`	True 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


`Target`	`ModioUIObjectSelector`
`Index`	The 0-based index to set the selection state for
`bNewSelectionState`	The new selection state to set
`bEmitSelectionEvent`	True 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


`Target`	`ModioUIObjectSelector`
`bMultiSelectionAllowed`	True if multiple selections are allowed

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

nd_img_ModioUIObjectSelector_SetListEntryWidgetClass.png

void SetListEntryWidgetClass(TSubclassOf<UWidget> InNewEntryClass)

Parameters


`Target`	`ModioUIObjectSelector`
`InNewEntryClass`	The 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


`Target`	`ModioUIObjectSelector`
`Handler`	Delegate that will no longer receive callbacks

Retrieves the widget associated with the specified value

nd_img_ModioUIObjectSelector_GetWidgetForValue.png

UUserWidget* GetWidgetForValue(UObject* Value) const

Parameters


`Target`	`ModioUIObjectSelector`
`Value`	The 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


`Target`	`ModioUIObjectSelector`

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


`Target`	`ModioUIObjectSelector`

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


`Target`	`ModioUIObjectSelector`

Returns

Array of UObjects representing the selected values

Get Num Entries

Gets the number of entries in the implementing widget

int32 GetNumEntries()

Parameters


`Target`	`ModioUIObjectSelector`

Returns

The number of entries in the implementing widget

Get Multi Selection Allowed

Retrieves whether the implementing widget allows multiple selections

bool GetMultiSelectionAllowed()

Parameters


`Target`	`ModioUIObjectSelector`

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


`Target`	`ModioUIObjectSelector`

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


`Target`	`ModioUIObjectSelector`
`Value`	The 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


`Target`	`ModioUIObjectSelector`

Add Selection Changed Handler

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

void AddSelectionChangedHandler(FModioOnObjectSelectionChanged Handler)

Parameters


`Target`	`ModioUIObjectSelector`
`Handler`	Delegate 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


`Target`	`ModioUIProgressWidget`
`NewProgressValue`	The new progress value

Set Marquee

Sets whether the progress widget should be a marquee/throbber

void SetMarquee(bool bNewIsMarquee)

Parameters


`Target`	`ModioUIProgressWidget`
`bNewIsMarquee`	True 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


`Target`	`ModioUIProgressWidget`
`Override`	The 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


`Target`	`ModioUIProgressWidget`
`Handler`	Delegate to remove from the notification list

Get Progress

Retrieves the current progress value of the implementing widget

float GetProgress()

Parameters


`Target`	`ModioUIProgressWidget`

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


`Target`	`ModioUIProgressWidget`

Add Value Changed Handler

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

void AddValueChangedHandler(FModioProgressWidgetValueChanged Handler)

Parameters


`Target`	`ModioUIProgressWidget`
`Handler`	Delegate 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


`Target`	`ModioUISelectableWidget`

Set Toggleable

Enables or disables toggle-ability on the implementing widget

void SetToggleable(bool bNewToggleableState)

Parameters


`Target`	`ModioUISelectableWidget`
`bNewToggleableState`	True 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


`Target`	`ModioUISelectableWidget`
`bNewSelectedState`	The new selection state

Set Selectable

Sets the selectable state of the implementing widget

void SetSelectable(bool bNewSelectableState)

Parameters


`Target`	`ModioUISelectableWidget`
`bNewSelectableState`	Whether 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


`Target`	`ModioUISelectableWidget`
`Handler`	The delegate to remove

Get Toggleable

Retrieves the toggle-able state of the implementing widget

void GetToggleable(bool bIsToggleable)

Parameters


`Target`	`ModioUISelectableWidget`
`Is Toggleable`	True 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


`Target`	`ModioUISelectableWidget`
`Current Selected State`	True if the widget is currently selected

Get Selectable

Retrieves the selectable state of the implementing widget

void GetSelectable(bool bIsSelectable)

Parameters


`Target`	`ModioUISelectableWidget`
`Is Selectable`	True 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


`Target`	`ModioUISelectableWidget`
`Handler`	Delegate to invoke on state change

ModioUISettings

Inheritance Hierarchy

-> Object

Variables


`TSoftObjectPtr<UDataTable>`	`ColorsTable`
`TSoftObjectPtr<UDataTable>`	`SoundsTable`
`TSoftObjectPtr<UDataTable>`	`ForceFeedbackTable`
`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


`Target`	`ModioUIStringInputWidget`
`Input`	The input string to set

Set Hint

Sets the hint text for the implementing widget

void SetHint(FText HintText)

Parameters


`Target`	`ModioUIStringInputWidget`
`HintText`	Text 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


`Target`	`ModioUIStringInputWidget`
`Handler`	Delegate 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


`Target`	`ModioUIStringInputWidget`
`Handler`	Delegate to unsubscribe

Gather Input

Retrieves the user's input from the implementing widget

FString GatherInput()

Parameters


`Target`	`ModioUIStringInputWidget`

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


`Target`	`ModioUIStringInputWidget`
`Handler`	Delegate 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


`Target`	`ModioUIStringInputWidget`
`Handler`	Delegate 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


`Target`	`ModioUISubsystem`

Should Show Platform SKUInformation

Check if the UI should display SKU information when checking out a purchase for a mod

bool ShouldShowPlatformSKUInformation()

Parameters


`Target`	`ModioUISubsystem`

Returns

True if the UI should display SKU information, false otherwise

Set UIInteraction Feedback Provider

Sets the provider object responsible for playing UI feedback (sound and force feedback).

void SetUIInteractionFeedbackProvider(TScriptInterface<IModioUIInteractionFeedback> InUIInteractionFeedbackProvider)

Parameters


`Target`	`ModioUISubsystem`
`InUIInteractionFeedbackProvider`	The object implementing the IModioUIInteractionFeedback interface that will play feedback.

Set Mod Rating State Data Provider

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

void SetModRatingStateDataProvider(TScriptInterface<IModRatingStateProvider> InModRatingStateProvider)

Parameters


`Target`	`ModioUISubsystem`
`InModRatingStateProvider`	The 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


`Target`	`ModioUISubsystem`
`InModEnabledStateDataProvider`	The object implementing the IModioUIModEnabledStateProvider interface that will act as the data provider.

Set Mod Collection Rating State Data Provider

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

void SetModCollectionRatingStateDataProvider(TScriptInterface<IModCollectionRatingStateProvider> InModCollectionRatingStateProvider)

Parameters


`Target`	`ModioUISubsystem`
`InModCollectionRatingStateProvider`	The object implementing the IModCollectionRatingStateProvider interface that will act as the data provider.

Set Cached SKUMappings

Sets the cached set of platform-specific token packs so that UI elements can fetch the localized pricing when fiat monetization is enabled

void SetCachedSKUMappings(TArray<FModioTokenPack> SKUMappings)

Parameters


`Target`	`ModioUISubsystem`
`SKUMappings`

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


`Target`	`ModioUISubsystem`
`Callback`	The 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


`Target`	`ModioUISubsystem`

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


`Target`	`ModioUISubsystem`

Request Unsubscribe from Mod Collection with Handler

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

void RequestUnsubscribeFromModCollectionWithHandler(FModioModCollectionID ID, FOnErrorOnlyDelegate DedicatedCallback)

Parameters


`Target`	`ModioUISubsystem`
`ID`	The ModCollectionId of the Mod Collection to unsubscribe from.
`Dedicated Callback`	The callback to be executed upon a successful unsubscription.

Request Unsubscribe from Mod Collection

Unsubscribes the current user from the given ModCollectionId.

void RequestUnsubscribeFromModCollection(FModioModCollectionID ID)

Parameters


`Target`	`ModioUISubsystem`
`ID`	The ModId of the Mod Collection to unsubscribe from.

Request Unfollow User

Requests to unfollow the given user for the currently authenticated user. Executes callbacks in implementations of IModioUIUserFollowingInfoReceiver.

void RequestUnfollowUser(FModioUserID UserToUnfollow)

Parameters


`Target`	`ModioUISubsystem`
`UserToUnfollow`

Request Unfollow Mod Collection with Handler

Unfollows the given Mod collection ID for the current user, executing the given callback upon completing the unsubscribing.

void RequestUnfollowModCollectionWithHandler(FModioModCollectionID ID, FOnErrorOnlyDelegate DedicatedCallback)

Parameters


`Target`	`ModioUISubsystem`
`ID`	The ModCollectionId of the Mod collection to unfollow.
`Dedicated Callback`	The callback to be executed upon a successful unfollow.

Request Unfollow Mod Collection

Unfollows the given Mod Collection Id for the current user.

void RequestUnfollowModCollection(FModioModCollectionID ID)

Parameters


`Target`	`ModioUISubsystem`
`ID`	The ModCollectionId of the Mod collection to unfollow.

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


`Target`	`ModioUISubsystem`
`ID`	The ModId of the Mod to be subscribed to.
`IncludeDependencies`	Boolean indicating whether Mods that the given Mod depends on should also be subscribed to.
`Callback`	The 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


`Target`	`ModioUISubsystem`
`ID`	The ModId of the Mod to be subscribed to.
`IncludeDependencies`	Boolean indicating whether Mods that the given Mod depends on should also be subscribed to.

Subscribes the current user to the provided ModCollectionID, executing the provided callback upon successfully subscribing.

void RequestSubscribeToModCollectionWithHandler(FModioModCollectionID ID, FOnErrorOnlyDelegate Callback)

Parameters


`Target`	`ModioUISubsystem`
`ID`	The ModCollectionId of the Mod Collection to be subscribed to.
`Callback`	The callback to be executed upon a successful subscription.

Subscribes the current user to the provided ModCollectionID.

void RequestSubscribeToModCollection(FModioModCollectionID ID)

Parameters


`Target`	`ModioUISubsystem`
`ID`	The ModCollectionId of the Mod Collection to be subscribed to.

Request Show Token SKUPurchase UIWith Handler

Attempts to invoke the store with a specific SKU for the current platform.

EModioOpenStoreResult RequestShowTokenSKUPurchaseUIWithHandler(FOnShowTokenPurchaseUIResult Callback, FString SKU)

Parameters


`Target`	`ModioUISubsystem`
`Callback`	A callback that returns a bool indicating whether the user made a purchase in the store
`SKU`	ID of the SKU to purchase, if empty just opens the store normally

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 UIWith Handler

Attempts to invoke the store for the current platform.

EModioOpenStoreResult RequestShowTokenPurchaseUIWithHandler(FOnShowTokenPurchaseUIResult Callback)

Parameters


`Target`	`ModioUISubsystem`
`Callback`	A 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


`Target`	`ModioUISubsystem`

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


`Target`	`ModioUISubsystem`
`DialogType`	The type of dialog to display
`DataSource`	The 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


`Target`	`ModioUISubsystem`
`ID`	The ModId of the Mod to unsubscribe from.
`Dedicated Callback`	The 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


`Target`	`ModioUISubsystem`
`ID`	The 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. Requires that a valid portal implementation has been set via RegisterPortalInterface before calling.

void RequestRefreshEntitlements()

Parameters


`Target`	`ModioUISubsystem`

Request Purchase with Entitlement for Mod IDWith Handler

Purchases a mod for the current player, executing the callback upon completion. Requires that a valid portal implementation has been set via RegisterPortalInterface before calling.

void RequestPurchaseWithEntitlementForModIDWithHandler(FModioModID ID, FOnPurchaseModDelegate Callback)

Parameters


`Target`	`ModioUISubsystem`
`ID`	ID of the mod to purchase between the displayed price and the price in the backend. If there is a mismatch, the purchase will fail.
`Callback`	Callback invoked with purchase information once the purchase is completed.

Request Purchase Token Pack

Requests the purchase of the given Token Pack via the currently active online portal provider. Requires that a valid portal implementation has been set via RegisterPortalInterface before calling.

bool RequestPurchaseTokenPack(FModioTokenPackID TokenPackID, FOnPlatformCheckoutDelegate Callback)

Parameters


`Target`	`ModioUISubsystem`
`TokenPackID`	ID of the pack to purchase
`Callback`	Executed 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


`Target`	`ModioUISubsystem`
`ID`	ID of the mod to purchase
`ExpectedPrice`	The 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.
`Callback`	Callback 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


`Target`	`ModioUISubsystem`
`IDs`	Array 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


`Target`	`ModioUISubsystem`
`ID`	The ModID of the Mod to update
`bNewEnabledState`	The 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


`Target`	`ModioUISubsystem`
`ID`	Mod ID for use in logo retrieval
`LogoSize`	Parameter indicating the size of logo that's required

Request Logo Download for Mod Collection ID

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

void RequestLogoDownloadForModCollectionID(FModioModCollectionID ID, EModioLogoSize LogoSize)

Parameters


`Target`	`ModioUISubsystem`
`ID`	Mod Collection ID for use in logo retrieval
`LogoSize`	Parameter indicating the size of logo that's required

Request List User Following Mod Collections

Requests a list of all followed mod collections Executes callbacks in implementations of IModioUICollectionFollowStateChangedReceiver

void RequestListUserFollowingModCollections()

Parameters


`Target`	`ModioUISubsystem`

Request List User Following

Requests a list of all users the currently authenticated user follows. Executes callbacks in implementations of IModioUIUserFollowingInfoReceiver.

void RequestListUserFollowing()

Parameters


`Target`	`ModioUISubsystem`

Request List Mod Collections

Requests a list of mod collections for the current game. Executes callbacks in implementations of IModioUIModCollectionInfoReceiver.

void RequestListModCollections(FModioFilterParams Filter, FString RequestIdentifier)

Parameters


`Target`	`ModioUISubsystem`
`Filter`	A filter to apply to the results, returning only Mod collections that match it
`RequestIdentifier`	For requesters to tell if a set of results or an error belongs to them

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. Requires that a valid portal implementation has been set via RegisterPortalInterface before calling.

void RequestListAllTokenPacks()

Parameters


`Target`	`ModioUISubsystem`

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


`Target`	`ModioUISubsystem`
`Params`	A filter to apply to the results, returning only Mods that match it
`RequestIdentifier`	For requesters to tell if a set of results or an error belongs to them

Request Get Mod Collection Mods

Requests The list of mods for the given Mod Collection. Executes callbacks in implementations of IModioUIModCollectionInfoReceiver.

void RequestGetModCollectionMods(FModioModCollectionID CollectionID)

Parameters


`Target`	`ModioUISubsystem`
`CollectionID`	The ID of the collection to get all the mods for

Request Gallery Image Download for Mod ID

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

void RequestGalleryImageDownloadForModID(FModioModID ID, int32 Index, EModioGallerySize ImageSize)

Parameters


`Target`	`ModioUISubsystem`
`ID`	The mod you want to retrieve an image for
`Index`	The zero-based index of the image you want to retrieve
`ImageSize`	Size of the image you want to retrieve

Request Follow User

Requests to follow the given user for the currently authenticated user. Executes callbacks in implementations of IModioUIUserFollowingInfoReceiver.

void RequestFollowUser(FModioUserID UserToFollow)

Parameters


`Target`	`ModioUISubsystem`
`UserToFollow`

Request Follow Mod Collection with Handler

Follows the given Mod Collection ID for the current user, executing the provided callback upon successfully subscribing.

void RequestFollowModCollectionWithHandler(FModioModCollectionID ID, FOnFollowModCollectionDelegate Callback)

Parameters


`Target`	`ModioUISubsystem`
`ID`	The ModCollectionId of the Mod to be subscribed to.
`Callback`	The callback to be executed upon a successful follow.

Request Follow Mod Collection

Follows the given ModCollection ID for the current user.

void RequestFollowModCollection(FModioModCollectionID ID)

Parameters


`Target`	`ModioUISubsystem`
`ID`	The ModCollectionId of the Mod Collection to be followed.

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


`Target`	`ModioUISubsystem`
`Code`	The authentication code that has been entered.
`Callback`	The callback to be executed upon completion.

Request Available User Entitlements

Requests the list of the currently logged in user's entitlements and does NOT consume them. The result is returned via the provided callback. Requires that a valid portal implementation has been set via RegisterPortalInterface before calling.

void RequestAvailableUserEntitlements(FOnGetAvailableUserEntitlementsDelegate OnGetUserEntitlements)

Parameters


`Target`	`ModioUISubsystem`
`On Get User Entitlements`	The callback to be executed upon completion of the request

Register Pre Uninstall Handler

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

void RegisterPreUninstallHandler(FOnPreUninstallDelegate Callback)

Parameters


`Target`	`ModioUISubsystem`
`Callback`	The Callback to invoke before uninstall. Receives the FModioModID of the mod being uninstalled, and must return a bool indicating approval.

Register Portal Interface

Registers a portal interface that will be used for certain platform specific functionality

void RegisterPortalInterface(TScriptInterface<IModioPortalInterface> InPortalInterface)

Parameters


`Target`	`ModioUISubsystem`
`InPortalInterface`	The portal interface to register

Query Is User Following Mod Collection with Handler

Checks if the current user is following to the given ModCollectionId, returning the result in a delegate

void QueryIsUserFollowingModCollectionWithHandler(FModioModCollectionID ID, FOnQueryFollowedModCollectionCompleted Handler)

Parameters


`Target`	`ModioUISubsystem`
`ID`	The ModCollectionId of the Mod Collection to check is followed.
`Handler`	The callback to be executed upon a successful check.

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


`Target`	`ModioUISubsystem`
`ID`	The Id of the Mod to query the Enabled status of.

Returns

Whether the Mod is enabled or not.

Query Input Mode State

Gets the current MouseInputMode State

EModioUIInputMode QueryInputModeState()

Parameters


`Target`	`ModioUISubsystem`

Returns

The current MouseInputMode State.

Query Connectivity State

Gets the current Connectivity State

bool QueryConnectivityState()

Parameters


`Target`	`ModioUISubsystem`

Returns

The current connectivity State.

Play UISound Feedback

Plays the UI sound feedback associated with the given event key via the current feedback provider.

void PlayUISoundFeedback(USoundBase* UIFeedbackSound, UObject* WorldContextObject)

Parameters


`Target`	`ModioUISubsystem`
`UIFeedbackSound`	The feedback sound to play

Play UIForce Feedback

Plays the UI force feedback associated with the given event key via the current feedback provider.

void PlayUIForceFeedback(UForceFeedbackEffect* UIFeedbackForceEffect, APlayerController* PlayerController)

Parameters


`Target`	`ModioUISubsystem`
`UIFeedbackForceEffect`	The force feedback effect to play
`PlayerController`	The player to play force feedback on.

Notify Platform Store Browsing

Notifies the portal interface that the user is currently browsing products from the the platform store, which may affect the behavior of certain UI elements.

void NotifyPlatformStoreBrowsing(bool bBrowsing)

Parameters


`Target`	`ModioUISubsystem`
`bBrowsing`	Whether the user is currently browsing products from the platform store.

Notify Input Mode Change

Updates the current MouseInputMode state, and notifies implementations of IModioUIInputModeChangedReceiver only if the state changes.

void NotifyInputModeChange(EModioUIInputMode NewInputModeState)

Parameters


`Target`	`ModioUISubsystem`
`NewInputModeState`

Notify Connectivity Change

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

void NotifyConnectivityChange(bool bNewConnectivityState)

Parameters


`Target`	`ModioUISubsystem`
`bNewConnectivityState`	the new Connectivity state

Is User Following Creator

bool IsUserFollowingCreator(FModioUserID CreatorId)

Is UGCFeature Enabled

Indicates whether a UGC subsystem feature is enabled

bool IsUGCFeatureEnabled(EModioUIFeatureFlags Feature)

Parameters


`Target`	`ModioUISubsystem`
`Feature`	The feature to query

Returns

bool indicating the state of the specified feature

Is Running in VR

Gets the current running in VR state

bool IsRunningInVR()

Parameters


`Target`	`ModioUISubsystem`

Returns

True if HMD is connected and stereo rendering is enabled

Get SKUMapping by SKUMapping Array

FModioTokenPack GetSKUMappingBySKUMappingArray(TArray<FModioModMonetizationSKU> SKUMappings, bool bValid)

Get SKUMapping by Id

Looks up the specified SKU by ID in the subsystem's cache. The cache is populated by game code invoking SetCachedSKUMappings.

FModioTokenPack GetSKUMappingById(FString ID, bool bValid)

Parameters


`Target`	`ModioUISubsystem`
`ID`
`Valid`

Get Portal Interface

Returns the currently registered portal interface

TScriptInterface<IModioPortalInterface> GetPortalInterface() const

Parameters


`Target`	`ModioUISubsystem`

Get Current DPIScale Value

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

float GetCurrentDPIScaleValue()

Parameters


`Target`	`ModioUISubsystem`

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


`Target`	`ModioUISubsystem`

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


`Target`	`ModioUISubsystem`

ModioUISupportsCustomNavigation

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

Inheritance Hierarchy

-> Interface-> Object

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

nd_img_ModioUISupportsCustomNavigation_SetNavigationDelegate.png

void SetNavigationDelegate(uint8 Context, FCustomWidgetNavigationDelegate ContentNavigationDelegate)

Parameters


`Target`	`ModioUISupportsCustomNavigation`
`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


`Target`	`ModioUITextValidator`
`InputText`	the text to validate
`Validation Message Text`	FText containing the localised failure message

Set Validation Error

SChange the validation error with new text

void SetValidationError(FText ErrorText)

Parameters


`Target`	`ModioUITextValidator`
`ErrorText`	The 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


`Target`	`ModioUITextValidator`
`Handler`	Delegate 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


`Target`	`ModioUITextValidator`
`Rules`	Reference 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


`Target`	`ModioUITextValidator`
`Handler`	Delegate to invoke on a text validation event

ModioUIToggleModCollectionFollowedCommand

Inheritance Hierarchy

-> Object

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


`Target`	`ModioUITokenPackListInterface`
`InList`	The set of token packs to populate with
`bAddToExisting`	Should 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


`Target`	`ModioUITokenPackListInterface`
`InArray`	The set of token packs to populate with
`bAddToExisting`	Should 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


`Target`	`ModioUITokenPackListInterface`
`TokenPackID`	The token pack ID to select

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


`Target`	`ModioUserUIDetails`

Returns

User ID for the associated user

Get Full User

Queries the implementing object for the user that the object represents

FModioUser GetFullUser()

Parameters


`Target`	`ModioUserUIDetails`

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

UserFollowingListProvider

Inheritance Hierarchy

-> Interface-> Object

Request User Following List Change

void RequestUserFollowingListChange(FModioUserList NewFollowingList)

Parameters


`Target`	`UserFollowingListProvider`
`NewFollowingList`	The new list of users to replace the current list of followers with.

Request Remove Followed User

void RequestRemoveFollowedUser(FModioUserID NewUnfollowedUser)

Parameters


`Target`	`UserFollowingListProvider`
`NewUnfollowedUser`	the user to remove from the list of currently followed users

Request Add Followed User

void RequestAddFollowedUser(FModioUserID NewFollowedUser)

Parameters


`Target`	`UserFollowingListProvider`
`NewFollowedUser`	the user to add to the list of currently followed users

Query User Following List

void QueryUserFollowingList()

ViewMoreWidgetItem

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


`FLinearColorRef`	`NormalColor`
`FLinearColorRef`	`SelectedColor`
`FLinearColorRef`	`HoveredColor`
`FLinearColorRef`	`TextColor`
`FLinearColorRef`	`SelectedTextColor`
`bool`	`bUseBorder`
`FIntegerOverride`	~~`TextSize_DEPRECATED`~~	Use size member of FontProperties instead
`FSlateFontInfoOverride`	`FontProperties`
`FHAlignOverride`	`TextAlignment`
`FTextTransformOverride`	`TextTransform`
`UObject*`	`HighlightBorderOverrideImage`
`UObject*`	`BackgroundBorderOverrideImage`
`FLinearColorRef`	`NormalBorderColor`
`FLinearColorRef`	`SelectedBorderColor`
`FLinearColorRef`	`HoveredBorderColor`
`FMargin`	`ContentPadding`
`FModioSoundCueRef`	`NavigateSoundFeedback`
`FModioForceFeedbackRef`	`PressForceFeedback`

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


`FOnSelectionChanged`	`OnSelectionChanged`
`TArray<UObject*>`	`Values`

WBP_ModioDefaultCommandMenu

A menu displaying a list of commands.

Inheritance Hierarchy

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

Variables


`FLinearColorRef`	`BackgroundColor`

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


`FOnDialogConfirmed`	`OnDialogConfirmed`
`FOnDialogCanceled`	`OnDialogCanceled`
`EModioUILoadState`	`PurchaseResultsLoadingState`
`FLinearColorRef`	`TokenIconColor`
`double`	`ScrollVelocity`

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


`int32`	`EmailInputSubdialogIndex`
`int32`	`CodeInputSubdialogIndex`
`FOnDialogConfirmed`	`OnDialogConfirmed`
`FOnDialogCancelled`	`OnDialogCancelled`

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


`FLinearColorRef`	`BackgroundColor`

WBP_ModioDefaultIconButton

A button that displays only an icon, without text.

Inheritance Hierarchy

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

Variables


`FLinearColorRef`	`NormalColor`
`FLinearColorRef`	`SelectedColor`
`FLinearColorRef`	`HoveredColor`
`bool`	`bFreezeBorderColorOnSelection`
`FLinearColorRef`	`TextColor`
`FLinearColorRef`	`SelectedTextColor`
`bool`	`bIconVertical`
`bool`	`bSwapIconSide`
`FSlateBrush`	`Icon`
`FHAlignOverride`	`HorizontalAlignmentOverride`
`FSlateFontInfoOverride`	`FontProperties`
`FHAlignOverride`	`TextAlignment`
`FTextTransformOverride`	`TextTransform`
`FLinearColorRef`	`IconColor`
`FLinearColorRef`	`SelectedIconColor`
`bool`	`bDisplayText`
`FLinearColorRef`	`BorderColorToFreeze`
`bool`	`bFreezeBorderColor`
`bool`	`bUseBorder`
`UObject*`	`HighlightBorderOverrideImage`
`UObject*`	`BackgroundBorderOverrideImage`
`FLinearColorRef`	`SelectedBorderColor`
`FMargin`	`ContentPadding`
`FLinearColorRef`	`NormalBorderColor`
`FVector2D`	`OverrideButtonSize`

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


`FText`	`InsufficientTokensHeadingText`
`FText`	`InsufficientTokensDescText`
`FText`	`InsufficientTokensSubInfoText`
`FText`	`InsufficientFundsConfirmText`

WBP_ModioDefaultModCollectionContributerList

Inheritance Hierarchy

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

Variables


`FOnSelectionChanged`	`OnSelectionChanged`

WBP_ModioDefaultModCollectionContributorsDisplayDialog

Inheritance Hierarchy

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

Variables


`FOnDialogConfirmed`	`OnDialogConfirmed`
`FOnDialogCanceled`	`OnDialogCanceled`
`FLinearColorRef`	`TotalBackgroundColor`
`FModioModID`	`CurrentModID`
`double`	`TargetModDependencyListScrollOffset`
`FModioUnsigned64`	`TotalSizeToInstall`

WBP_ModioDefaultModCollectionDescriptionDialog

Inheritance Hierarchy

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

Variables


`int32`	`NavigationScrollOffsetStep`

WBP_ModioDefaultModCollectionDownloadVisualizer

Inheritance Hierarchy

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

Variables


`FText`	`LabelTextValue`
`UObject*`	`EditorDataSource`
`FText`	`DownloadFormatText`
`bool`	`bShowPropertyLabel`
`FLinearColorRef`	`PropertyLabelColor`

WBP_ModioDefaultModCollectionDownloadVisualizer_Horizontal

Inheritance Hierarchy

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

Variables


`FText`	`LabelTextValue`
`UObject*`	`EditorDataSource`
`FText`	`DownloadFormatText`
`FLinearColorRef`	`PropertyLabelColor`
`bool`	`bShowPropertyLabel`

WBP_ModioDefaultModCollectionFollowDialog

Inheritance Hierarchy

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

Variables


`FOnFollowClicked`	`OnFollowClicked`
`FOnDialogCanceled`	`OnDialogCanceled`
`FLinearColorRef`	`TotalBackgroundColor`
`FModioModID`	`CurrentModID`
`double`	`TargetModDependencyListScrollOffset`
`FModioUnsigned64`	`TotalSizeToInstall`

WBP_ModioDefaultModCollectionFollowersVisualizer

Inheritance Hierarchy

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

Variables


`FText`	`LabelTextValue`
`UObject*`	`EditorDataSource`
`FText`	`SubscriberCountFormatText`
`bool`	`bShowPropertyLabel`
`FLinearColorRef`	`PropertyLabelColor`

WBP_ModioDefaultModCollectionModCountVisualizer_Horizontal

Inheritance Hierarchy

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

Variables


`FText`	`FilesizeLabelText`
`UObject*`	`EditorDataSource`
`FLinearColorRef`	`PropertyLabelColor`
`bool`	`bShowPropertyLabel`

WBP_ModioDefaultModCollectionModEntry

Inheritance Hierarchy

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

Variables


`FLinearColorRef`	`BackgroundColor`
`UMaterialInterface*`	`InstalledStatusMaterial`
`FModioModID`	`CurrentModID`
`EModioLogoSize`	`DesiredLogoSize`
`FText`	`InstalledStatusText`
`FLinearColorRef`	`InstalledStatusColor`
`FLinearColorRef`	`NotInstalledStatusColor`

WBP_ModioDefaultModCollectionModList

Inheritance Hierarchy

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

Variables


`FOnSelectionChanged`	`OnSelectionChanged`

WBP_ModioDefaultModCollectionModsVisualizer

Inheritance Hierarchy

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

Variables


`FText`	`LabelTextValue`
`UObject*`	`EditorDataSource`
`FText`	`DownloadFormatText`
`bool`	`bShowPropertyLabel`
`FLinearColorRef`	`PropertyLabelColor`

WBP_ModioDefaultModCollectionPropCollectionVisualizer

Inheritance Hierarchy

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

Variables


`UObject*`	`EditorDataSource`
`FLinearColorRef`	`BackgroundColor`

WBP_ModioDefaultModCollectionPropVisualizer

Inheritance Hierarchy

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

Variables

WBP_ModioDefaultModCollectionRatingVisualizer

Inheritance Hierarchy

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

Variables


`FText`	`FilesizeLabelText`
`UObject*`	`EditorDataSource`
`bool`	`bShowPropertyLabel`
`FLinearColorRef`	`PropertyLabelColor`

WBP_ModioDefaultModCollectionRatingVisualizer_Horizontal

Inheritance Hierarchy

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

Variables


`FText`	`FilesizeLabelText`
`UObject*`	`EditorDataSource`
`bool`	`bShowPropertyLabel`
`FLinearColorRef`	`PositiveRatingColor`
`FLinearColorRef`	`NegativeRatingColor`
`FLinearColorRef`	`NeutralRatingColor`

WBP_ModioDefaultModCollectionReleaseDateVisualizer

Inheritance Hierarchy

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

Variables


`FText`	`LabelTextValue`
`UObject*`	`EditorDataSource`
`bool`	`bShowPropertyLabel`
`FLinearColorRef`	`PropertyLabelColor`

WBP_ModioDefaultModCollectionSizeVisualizer

Inheritance Hierarchy

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

Variables


`FText`	`FilesizeLabelText`
`UObject*`	`EditorDataSource`
`bool`	`bShowPropertyLabel`
`FLinearColorRef`	`PropertyLabelColor`

WBP_ModioDefaultModCollectionSizeVisualizer_Horizontal

Inheritance Hierarchy

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

Variables


`FText`	`FilesizeLabelText`
`UObject*`	`EditorDataSource`
`FLinearColorRef`	`PropertyLabelColor`
`bool`	`bShowPropertyLabel`

WBP_ModioDefaultModCollectionStatusWidget

Inheritance Hierarchy

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

Variables


`bool`	`bDisplayStatusText`
`FLinearColorRef`	`NotFollowedBackgroundColor`
`FLinearColorRef`	`FollowedBackgroundColor`
`FLinearColorRef`	`FollowedIconColor`
`FLinearColorRef`	`IncompleteIconColor`
`FLinearColorRef`	`NotFollowedTextColor`
`FLinearColorRef`	`NotFollowedIconColor`
`FLinearColorRef`	`SubscribedTextColor`
`FLinearColorRef`	`IncompleteTextColor`
`FLinearColorRef`	`SubscribedIconColor`
`FLinearColorRef`	`FollowedTextColor`
`FLinearColorRef`	`IncompleteBackgroundColor`
`FLinearColorRef`	`SubscribedBackgroundColor`
`FText`	`SubscribedText`
`FText`	`IncompleteText`
`FText`	`FollowedText`
`FSlateBrush`	`IncompleteIcon`
`FSlateBrush`	`NotFollowedIcon`
`FSlateBrush`	`SubscribedIcon`
`FSlateBrush`	`FollowedIcon`
`FText`	`NotFollowedText`

WBP_ModioDefaultModCollectionTile

Inheritance Hierarchy

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

Variables


`FLinearColorRef`	`NormalBorderColor`
`FLinearColorRef`	`SelectedBorderColor`
`FLinearColorRef`	`NormalBackgroundColor`
`FLinearColorRef`	`SelectedBackgroundColor`
`FLinearColorRef`	`PremiumBackgroundColor`
`FLinearColorRef`	`NormalTextColor`
`FLinearColorRef`	`SelectedTextColor`
`FLinearColorRef`	`PriceTextColor`
`FText`	`PurchasedLabelText`

WBP_ModioDefaultModCollectionUnfollowDialog

Inheritance Hierarchy

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

Variables


`FOnFollowClicked`	`OnFollowClicked`
`FOnDialogCanceled`	`OnDialogCanceled`
`FLinearColorRef`	`TotalBackgroundColor`
`FModioModID`	`CurrentModID`
`double`	`TargetModDependencyListScrollOffset`
`FModioUnsigned64`	`TotalSizeToInstall`

WBP_ModioDefaultModCollectionUpdatedVisualizer

Inheritance Hierarchy

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

Variables


`FText`	`LabelTextValue`
`UObject*`	`EditorDataSource`
`bool`	`bShowPropertyLabel`
`FLinearColorRef`	`PropertyLabelColor`
`FText`	`ValueFormatText`
`bool`	`bUseTimeElapsed`
`FText`	`Year Format`
`FText`	`Month Format`
`FText`	`Day Format`
`FText`	`Today Format`

WBP_ModioDefaultModContributerEntry

Inheritance Hierarchy

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

Variables


`FLinearColorRef`	`BackgroundColor`

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


`FOnDialogConfirmed`	`OnDialogConfirmed`
`FOnDialogCanceled`	`OnDialogCanceled`
`FLinearColorRef`	`TotalBackgroundColor`
`FModioModID`	`CurrentModID`
`FModioUnsigned64`	`TotalSizeToInstall`
`double`	`ScrollVelocity`

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


`FOnDialogConfirmed`	`OnDialogConfirmed`
`FOnDialogCanceled`	`OnDialogCanceled`
`FLinearColorRef`	`TotalBackgroundColor`
`FModioModID`	`CurrentModID`
`double`	`ScrollVelocity`
`FModioUnsigned64`	`TotalSizeToInstall`

WBP_ModioDefaultModDependencyEntry

An entry displaying a single dependency for a mod.

Inheritance Hierarchy

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

Variables


`FLinearColorRef`	`BackgroundColor`
`UMaterialInterface*`	`InstalledStatusMaterial`
`FModioModID`	`CurrentModID`
`EModioLogoSize`	`DesiredLogoSize`
`FText`	`InstalledStatusText`
`FLinearColorRef`	`InstalledStatusColor`
`FLinearColorRef`	`NotInstalledStatusColor`
`bool`	`bHasFocus`

WBP_ModioDefaultModDependencyList

A list displaying all dependencies for a selected mod.

Inheritance Hierarchy

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

Variables


`FOnSelectionChanged`	`OnSelectionChanged`

WBP_ModioDefaultModDescriptionDialog

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

Inheritance Hierarchy

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

Variables


`int32`	`NavigationScrollOffsetStep`

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


`FOnSelectionChanged`	`OnSelectionChanged`
`FModioSoundCueRef`	`NavigateSoundFeedback`
`FModioForceFeedbackRef`	`PressForceFeedback`

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


`FLinearColorRef`	`BackgroundColor`

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


`FInputActionOverride`	`BoundActionOverride`

WBP_ModioDefaultModDownloadVisualizer

Displays the download count for a mod.

Inheritance Hierarchy

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

Variables


`FText`	`LabelTextValue`
`UObject*`	`EditorDataSource`
`FText`	`DownloadFormatText`
`bool`	`bShowPropertyLabel`
`FLinearColorRef`	`PropertyLabelColor`

WBP_ModioDefaultModDownloadVisualizer_Horizontal

Inheritance Hierarchy

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

Variables


`FText`	`LabelTextValue`
`UObject*`	`EditorDataSource`
`FText`	`DownloadFormatText`
`bool`	`bShowPropertyLabel`
`FLinearColorRef`	`PropertyLabelColor`

WBP_ModioDefaultModEnabledStatusWidget

Displays the current enabled/disabled status of a mod.

Inheritance Hierarchy

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

Variables


`FLinearColorRef`	`BackgroundColor`
`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


`FLinearColorRef`	`BackgroundColor`
`FText`	`DisableModText`
`FText`	`EnableModText`

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


`bool`	`bDisplayStatusText`
`FLinearColorRef`	`DefaultBackgroundColor`
`FLinearColorRef`	`ErrorBackgroundColor`
`FLinearColorRef`	`DefaultTextColor`
`FLinearColorRef`	`DisabledTextColor`
`FLinearColorRef`	`ProcessingTextColor`
`FLinearColorRef`	`DefaultIconColor`
`FLinearColorRef`	`DisabledIconColor`
`FLinearColorRef`	`EnabledIconColor`
`FLinearColorRef`	`ExtractingProgressBarColor`
`FText`	`EnabledStatusText`
`FText`	`DisabledStatusText`
`FText`	`ErrorStatusText`
`FText`	`QueuedStatusText`
`FText`	`DownloadingStatusText`
`FText`	`ExtractingStatusText`
`FText`	`PurchasedStatusText`
`FText`	`InitializingStatusText`
`FText`	`UploadingStatusText`
`FText`	`UploadedStatusText`
`FText`	`SystemInstallStatusText`
`FSlateBrush`	`SystemInstallStatusIcon`
`FSlateBrush`	`EnabledStatusIcon`
`FSlateBrush`	`DisabledStatusIcon`
`FSlateBrush`	`ErrorStatusIcon`
`FSlateBrush`	`QueuedStatusIcon`
`FSlateBrush`	`DownloadingStatusIcon`
`FSlateBrush`	`ExtractingStatusIcon`
`FSlateBrush`	`PurchasedStatusIcon`
`FSlateBrush`	`InitializingStatusIcon`
`FSlateBrush`	`UploadingStatusIcon`
`FSlateBrush`	`UploadedStatusIcon`
`bool`	`bDisplayPurchasedState`

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`
`FLinearColorRef`	`BackgroundColor`

WBP_ModioDefaultModRatingVisualizer

Displays the rating of a mod.

Inheritance Hierarchy

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

Variables


`FText`	`FilesizeLabelText`
`UObject*`	`EditorDataSource`
`bool`	`bShowPropertyLabel`
`FLinearColorRef`	`PropertyLabelColor`

WBP_ModioDefaultModRatingVisualizer_Horizontal

Inheritance Hierarchy

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

Variables


`FText`	`FilesizeLabelText`
`UObject*`	`EditorDataSource`
`bool`	`bShowPropertyLabel`
`FLinearColorRef`	`PropertyLabelColor`

WBP_ModioDefaultModReleaseDateVisualizer

Displays the release date of a mod.

Inheritance Hierarchy

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

Variables


`FText`	`LabelTextValue`
`UObject*`	`EditorDataSource`
`bool`	`bShowPropertyLabel`
`FLinearColorRef`	`PropertyLabelColor`

WBP_ModioDefaultModSizeVisualizer

Displays the file size of a mod.

Inheritance Hierarchy

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

Variables


`FText`	`FilesizeLabelText`
`UObject*`	`EditorDataSource`
`bool`	`bShowPropertyLabel`
`FLinearColorRef`	`PropertyLabelColor`

WBP_ModioDefaultModSizeVisualizer_Horizontal

Inheritance Hierarchy

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

Variables


`FText`	`FilesizeLabelText`
`UObject*`	`EditorDataSource`
`bool`	`bShowPropertyLabel`
`FLinearColorRef`	`PropertyLabelColor`

WBP_ModioDefaultModSubscribersVisualizer

Displays the subscriber count for a mod.

Inheritance Hierarchy

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

Variables


`FText`	`LabelTextValue`
`UObject*`	`EditorDataSource`
`FText`	`SubscriberCountFormatText`
`bool`	`bShowPropertyLabel`
`FLinearColorRef`	`PropertyLabelColor`

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


`FLinearColorRef`	`NormalBorderColor`
`FLinearColorRef`	`SelectedBorderColor`
`FLinearColorRef`	`NormalBackgroundColor`
`FLinearColorRef`	`SelectedBackgroundColor`
`FLinearColorRef`	`PremiumBackgroundColor`
`FLinearColorRef`	`NormalTextColor`
`FLinearColorRef`	`SelectedTextColor`
`FLinearColorRef`	`PriceTextColor`
`UClass*`	`PriceWidget`
`FLinearColorRef`	`PremiumBadgeColor`
`UClass*`	`PremiumBadgeWidget`
`double`	`ModNameTextSize`
`double`	`ModNameSizeBoxHeight`
`FVector2D`	`TileSize`
`EModioLogoSize`	`LogoSizeToDownload`

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`
`FLinearColorRef`	`BackgroundColor`

WBP_ModioDefaultModTile_Featured

Inheritance Hierarchy

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

Variables

WBP_ModioDefaultModTile_FeaturedLarge

Inheritance Hierarchy

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

Variables

WBP_ModioDefaultModUpdatedVisualizer

Displays the last updated date for a mod.

Inheritance Hierarchy

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

Variables


`FText`	`LabelTextValue`
`UObject*`	`EditorDataSource`
`bool`	`bShowPropertyLabel`
`FLinearColorRef`	`PropertyLabelColor`
`FText`	`ValueFormatText`
`bool`	`bUseTimeElapsed`
`FText`	`Year Format`
`FText`	`Month Format`
`FText`	`Day Format`
`FText`	`Today Format`

WBP_ModioDefaultModVersionVisualizer

Displays the current version of a mod.

Inheritance Hierarchy

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

Variables


`FText`	`LabelTextValue`
`UObject*`	`EditorDataSource`
`bool`	`bShowPropertyLabel`
`FLinearColorRef`	`PropertyLabelColor`

WBP_ModioDefaultModalDialogImpl

The base implementation for modal dialogs.

Inheritance Hierarchy

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

Variables


`FLinearColorRef`	`HeaderBackgroundColor`
`FLinearColorRef`	`PrimaryBackgroundColor`
`FLinearColorRef`	`ButtonBackgroundColor`
`FLinearColorRef`	`FooterBackgroundColor`
`FText`	`DefaultHeadingText`
`FText`	`DefaultPrimaryText`
`FFloatOverride`	`MinimumWidth`
`FFloatOverride`	`MinimumHeight`

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


`FSlateBrush`	`CheckboxImage_Unselected`
`FSlateBrush`	`CheckboxImage_Selected`

WBP_ModioDefaultPlatformUsername

Displays the platform username of the user.

Inheritance Hierarchy

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

Variables


`FText`	`PlatformUserNameFormat`

WBP_ModioDefaultPopupCommandMenu

A popup menu displaying commands.

Inheritance Hierarchy

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

Variables


`FOnToggleStateChanged`	`OnToggleStateChanged`
`FDataTableRowHandle`	`TriggeringInputAction`

WBP_ModioDefaultPresetFilterEntryWidget

Represents an entry for a preset filter option.

Inheritance Hierarchy

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

Variables


`FLinearColorRef`	`BackgroundColor`
`FOnClicked`	`OnClicked`

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


`FString`	`TermsURL`
`FString`	`RefundURL`

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`
`double`	`CurrentProgressValue`
`FLinearColor`	`OriginalColor`
`double`	`PreviewProgress`

WBP_ModioDefaultRatingDisplay

Displays the rating of a mod.

Inheritance Hierarchy

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

Variables


`FLinearColorRef`	`PositiveColor`
`FLinearColorRef`	`MixedColor`
`FLinearColorRef`	`NegativeColor`
`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


`FSlateBrush`	`LoadingCog`

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


`FSlateBrush`	`RadioButton_Selected`
`FSlateBrush`	`RadioButton_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


`FLinearColorRef`	`NormalColor`
`FLinearColorRef`	`SelectedColor`
`FLinearColorRef`	`HoveredColor`
`FLinearColorRef`	`TextColor`

WBP_ModioDefaultSpecialButton

A specialized button with unique styling.

Inheritance Hierarchy

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

Variables


`FLinearColorRef`	`NormalColor`
`FLinearColorRef`	`SelectedColor`
`FLinearColorRef`	`HoveredColor`
`FLinearColorRef`	`TextColor`
`FLinearColorRef`	`SelectedTextColor`
`bool`	`bUseBorder`
`FLinearColorRef`	`SelectedBorderColor`
`UObject*`	`HighlightBorderOverrideImage`
`UObject*`	`BackgroundBorderOverrideImage`
`TEnumAsByte<E_SpecialButtonContentDirection>`	`AdditionalContentDirection`

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


`FOnDialogConfirmed`	`OnDialogConfirmed`
`FOnDialogCancelled`	`OnDialogCancelled`

WBP_ModioDefaultTagCategoryContainer

A container for grouping related tags within a category.

Inheritance Hierarchy

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

Variables


`bool`	`bSelectable`
`bool`	`bSelected`
`bool`	`bToggleable`
`FSlateBrush`	`ExpandedIconBrush`
`FSlateBrush`	`ClosedIconBrush`
`FLinearColorRef`	`IconColor`
`FOnNavigationOutsideBounds`	`OnNavigationOutsideBounds`

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


`FOnNavigationOutsideBounds`	`OnNavigationOutsideBounds`

WBP_ModioDefaultTagWidget

A widget representing an individual mod tag.

Inheritance Hierarchy

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

Variables


`FOnTagClicked`	`OnTagClicked`

WBP_ModioDefaultTermsButtonsGroup

A group of buttons related to general terms and conditions.

Inheritance Hierarchy

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

Variables


`FString`	`TermsURL`
`FString`	`PrivacyURL`

WBP_ModioDefaultTokenPackBrowser

Inheritance Hierarchy

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

Variables


`FModioTokenPackID`	`PackToPurchase`

WBP_ModioDefaultTokenPackTile

Inheritance Hierarchy

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

Variables

WBP_ModioDefaultViewMoreButton

Inheritance Hierarchy

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

Variables

WBP_ModioDefaultViewMoreButton_Featured

Inheritance Hierarchy

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

Variables

WBP_ModioDefaultViewMoreButton_FeaturedLarge

Inheritance Hierarchy

-> WBP_ModioDefaultIconButton-> ModioDefaultIconButton-> ModioDefaultTextButton-> ModioButtonWidget-> CommonButtonBase-> 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


`FLinearColorRef`	`NormalColor`
`FLinearColorRef`	`SelectedColor`
`FLinearColorRef`	`HoveredColor`
`FLinearColorRef`	`TextColor`
`FLinearColorRef`	`SelectedTextColor`
`FHAlignOverride`	`HorizontalAlignmentOverride`
`FLinearColorRef`	`NormalBorderColor`

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


`FLinearColorRef`	`FilterPanelBackgroundColor`
`FLinearColorRef`	`FilterPanelHeaderColor`

WBP_ModioGalleryListEntry

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

Inheritance Hierarchy

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

Variables


`FLinearColorRef`	`UnselectedColor`
`FLinearColorRef`	`SelectedColor`

WBP_ModioImageGallery

A gallery displaying a collection of images.

Inheritance Hierarchy

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

Variables


`FSlateBrush`	`LoadingCog`
`bool`	`bTouchInteractionActive`

WBP_ModioLibraryCategorySelector

Inheritance Hierarchy

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

Variables


`bool`	`bSelectable`
`bool`	`bSelected`
`bool`	`bToggleable`
`FSlateBrush`	`ExpandedIconBrush`
`FSlateBrush`	`ClosedIconBrush`
`FLinearColorRef`	`IconColor`
`FOnNavigationOutsideBounds`	`OnNavigationOutsideBounds`

WBP_ModioLibraryFilterPanel

Inheritance Hierarchy

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

Variables


`FLinearColorRef`	`FilterPanelBackgroundColor`
`FLinearColorRef`	`FilterPanelHeaderColor`

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


`FModioFilterParams`	`SearchParams`
`FModioUnsigned64`	`Wallet Balance`
`FLinearColorRef`	`BackgroundColor`
`FSlateBrush`	`LibraryIcon`
`FSlateBrush`	`RecentIcon`
`FSlateBrush`	`TrendingIcon`
`int32`	`SelectedLibraryCategoryIndex`
`FLinearColorRef`	`HeaderSeparatorColor`
`bool`	`bSearchBoxIsExpanded`
`FSlateBrush`	`CollectionsIcon`
`FText`	`ModSearchHintText`
`FText`	`CollectionSearchHintText`
`bool`	`bSearching`
`FText`	`SelectedNamedPreset`
`FModioSoundCueRef`	`NavigateSoundFeedback`
`FModioForceFeedbackRef`	`PressForceFeedback`

WBP_ModioModCollectionDetailsDialog

Inheritance Hierarchy

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

Variables


`FLinearColorRef`	`PremiumBadgeColor`
`FLinearColorRef`	`BackgroundColor`
`EModioRating`	`CurrentCollectionRating`
`EModioRating`	`NewRating`

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


`FLinearColorRef`	`PremiumBadgeColor`
`FLinearColorRef`	`BackgroundColor`
`EModioRating`	`CurrentModRating`
`EModioRating`	`NewRating`
`FModioSoundCueRef`	`NavigateSoundFeedback`
`FModioForceFeedbackRef`	`PressForceFeedback`

WBP_ModioModTilePriceWidget

Inheritance Hierarchy

-> UserWidget-> Widget-> Visual-> Object

Variables


`UObject*`	`DataSource`
`double`	`IconSize`
`double`	`TextSize`

WBP_ModioModTilePriceWidget_Large

Inheritance Hierarchy

-> WBP_ModioModTilePriceWidget-> UserWidget-> Widget-> Visual-> Object

Variables

WBP_ModioOperationTracker

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

Inheritance Hierarchy

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

Variables


`FSlateBrush`	`DownloadingImageBrush`
`FSlateBrush`	`ExtractingImageBrush`
`FSlateBrush`	`QueueCountImageBrush`
`FLinearColorRef`	`DownloadingIconColor`
`FLinearColorRef`	`QueueCountIconColor`
`FLinearColorRef`	`ExtractingIconColor`

WBP_ModioPremiumBadgeWidget

Inheritance Hierarchy

-> UserWidget-> Widget-> Visual-> Object

Variables


`UObject*`	`DataSource`
`double`	`IconSize`
`double`	`TextSize`

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


`FLinearColorRef`	`BackgroundColor`

Structs

ModioDefaultCodeInputTextBoxStyle

Inheritance Hierarchy

-> Text Block Style-> Slate Widget Style

Variables


`FSlateBrush`	`CharacterBorderBrushBase`
`FSlateBrush`	`CharacterBorderBrushFocused`
`FMargin`	`CharacterBorderPadding`
`FSlateBrush`	`FakeCaretBrush`
`TEnumAsByte<EHorizontalAlignment>`	`FakeCaretHorizontalAlignment`
`TEnumAsByte<EVerticalAlignment>`	`FakeCaretVerticalAlignment`
`FMargin`	`CharacterPadding`
`FMargin`	`CharacterSpacing`
`float`	`MinimumCharacterWidth`

ModioCommonButtonParams

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

Variables


`bool`	`bIsSpacer`	Whether this button is a spacer or a common button
`int32`	`Width`	Width and height of the button - only used if a spacer
`int32`	`Height`	Width and height of the button - only used if a spacer
`FTextOverride`	`ButtonRoleDescription`	Description of the role of the button - only used if not a spacer, but a button
`int32`	`MinWidth`	Minimum width of the button - only used if not a spacer, but a button
`int32`	`MinHeight`	Minimum height of the button - only used if not a spacer, but a button
`FClassPathOverride`	`Style`	Style to apply to the button - only used if not a spacer, but a button
`FDataTableRowHandle`	`TriggeringInputAction`	Action to apply for the button click - only used if not a spacer, but a button
`bool`	`bConsumePointerInput`	Whether to consume pointer input when the button is clicked - only used if not a spacer, but a button
`bool`	`bShouldUseFallbackDefaultInputAction`	Whether 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


`bool`	`bOverride`	Whether the value is overridden
`FSoftClassPath`	`Value`	The 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


`bool`	`bOverride`	Whether the value is overridden
`FText`	`Value`	The overridden value

ModioDialogButtonInfo

Data structure representing a dialog button

Variables


`FText`	`ButtonLabel`	Label for the button
`FClassPathOverride`	`StyleOverride`	Style to apply to the button
`FInputActionOverride`	`InputActionOverride`	Action to apply for the button click
`bool`	`bShowTooltip`	Whether to show a tooltip for the button
`FText`	`TooltipTitleText`	Title for the tooltip, if shown
`FText`	`TooltipInfoText`	Info text for the tooltip, if shown
`FText`	`TooltipTagText`	Tag text for the tooltip, if shown
`bool`	`bFocusedByDefault`	Whether 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


`bool`	`bOverride`	Whether the value is overridden
`FDataTableRowHandle`	`Value`	The overridden value

ModioFeaturedCategoryParams

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

Variables


`FText`	`CategoryName`	Name of the category (e.g. "Popular Mods")
`TArray<FString>`	`Tags`	Tags to include in the filter (e.g. "RPG", "Fantasy")
`TArray<FString>`	`ExcludedTags`	Tags to exclude from the filter (e.g. "RPG", "Fantasy")
`EModioSortDirection`	`Direction`	Sort direction for the category
`EModioSortFieldType`	`SortField`	Sort field for the category
`int64`	`Count`	Number of mods to display in the category

ModioUIColorEntry

Struct representing a color entry in a data table

Inheritance Hierarchy

-> Table Row Base

Variables


`FLinearColor`	`Color`	The color to use for the entry

LinearColorRef

Blueprint-compatible truct representing a color reference

Variables


`FName`	`ReferencedColorName`	The name of the color to reference
`FLinearColor`	`FallbackColor`	The color to use if the reference is not found

LinearColorRefOverride

Blueprint-compatible struct representing a color reference override

Variables


`bool`	`bOverride`	Whether the color reference is overridden
`FLinearColorRef`	`Color`	The color to use if the reference is overridden

ModioUIForceFeedbackEntry

Struct representing a force feedback entry in a data table

Inheritance Hierarchy

-> Table Row Base

Variables


`TObjectPtr<UForceFeedbackEffect>`	`ForceFeedback`	The force feedback effect to use for the entry

ModioForceFeedbackRef

Blueprint-compatible struct representing a force feedback reference

Variables


`FName`	`ReferencedForceFeedbackName`	The name of the force feedback effect to reference
`TObjectPtr<UForceFeedbackEffect>`	`FallbackForceFeedback`	The force feedback effect to use if the reference is not found

ModioForceFeedbackRefOverride

Blueprint-compatible struct representing a force feedback reference override

Variables


`bool`	`bOverride`	Whether the force feedback reference is overridden
`FModioForceFeedbackRef`	`ForceFeedback`	The force feedback 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


`bool`	`bOverride`	Whether the value is overridden
`int32`	`Value`	The 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


`bool`	`bOverride`	Whether the value is overridden
`float`	`Value`	The 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


`bool`	`bOverride`	Whether the value is overridden
`TEnumAsByte<EHorizontalAlignment>`	`Value`	The 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


`bool`	`bOverride`	Whether the value is overridden
`FSlateFontInfo`	`Value`	The 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


`bool`	`bOverride`	Whether the value is overridden
`ETextTransformPolicy`	`Value`	The overridden value

ModioRetryCounter

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

Variables


`int32`	`RetriesRemaining`	Number of retries remaining

ModioUISoundEntry

Struct representing a sound entry in a data table

Inheritance Hierarchy

-> Table Row Base

Variables


`TObjectPtr<USoundBase>`	`Sound`	The sound to use for the entry

ModioSoundCueRef

Blueprint-compatible struct representing a sound reference

Variables


`FName`	`ReferencedSoundName`	The name of the sound to reference
`TObjectPtr<USoundBase>`	`FallbackSound`	The sound to use if the reference is not found

ModioSoundCueRefOverride

Blueprint-compatible struct representing a sound reference override

Variables


`bool`	`bOverride`	Whether the sound reference is overridden
`FModioSoundCueRef`	`Sound`	The sound to use if the reference is overridden

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>`	`CommandTexts`	Map of command-specific key names to command-specific localized text
`TMap<FName,FSlateBrush>`	`CommandIconBrushes`	Map 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


`EModioTextValidationRule`	`RuleToUse`	The base rule to use in this instance. One of the many listed in EModioTextValidationRule
`FText`	`ValidationMessage`	Message to display if validation fails
`int32`	`MinimumLength`	SApply the validation rule to at least minimum length
`int32`	`MaximumLength`	SApply the validation rule to a maximum length

Functions

Resolve Color Override As Exec

Resolves a color reference to a color value

nd_img_LinearColorRefLibrary_ResolveOverrideAsExec.png

FLinearColor ResolveOverrideAsExec(FLinearColorRefOverride Target, bool bOverrideSet)

Parameters


`Target`	`FLinearColorRefOverride`

Returns

The resolved color value

Resolve Color Override

Resolves a color reference to a color value

nd_img_LinearColorRefLibrary_ResolveOverride.png

FLinearColor ResolveOverride(FLinearColorRefOverride Target, bool bOverrideSet)

Parameters


`Target`	`FLinearColorRefOverride`
`Override Set`	True 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


`Target`	`FLinearColorRef`
`Resolved`	True 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


`Handler`	The 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


`Handler`	The handler to add

Resolve Force Feedback Override As Exec

Resolves a force feedback reference override to a force feedback effect

nd_img_ModioForceFeedbackRefLibrary_ResolveOverrideAsExec.png

UForceFeedbackEffect* ResolveOverrideAsExec(FModioForceFeedbackRefOverride Target, bool bOverrideSet)

Parameters


`Target`	`FModioForceFeedbackRefOverride`

Returns

The resolved force feedback effect, or null if the override is not set

Resolve Force Feedback Override

Resolves a force feedback reference override to a force feedback effect

nd_img_ModioForceFeedbackRefLibrary_ResolveOverride.png

UForceFeedbackEffect* ResolveOverride(FModioForceFeedbackRefOverride Target, bool bOverrideSet)

Parameters


`Target`	`FModioForceFeedbackRefOverride`
`Override Set`	True if the force feedback reference was overridden, false otherwise

Returns

The resolved force feedback effect, or null if the override is not set

Resolve

Resolves a force feedback reference to a force feedback effect

UForceFeedbackEffect* Resolve(FModioForceFeedbackRef Target, bool bResolved)

Parameters


`Target`	`FModioForceFeedbackRef`
`Resolved`	True if the force feedback reference was resolved, false if the fallback effect was used

Returns

The resolved force feedback effect

Remove Force Feedback Change Handler

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

void RemoveForceFeedbackChangeHandler(FModioForceFeedbackRefChangeHandler Handler)

Parameters


`Handler`	The handler to remove

Get Valid Force Feedback Keys

Gets the list of valid force feedback keys

TArray<FName> GetValidForceFeedbackKeys()

Parameters

Returns

The list of valid force feedback keys

Add Force Feedback Change Handler

Adds a handler to be called when the force feedback table changes

void AddForceFeedbackChangeHandler(FModioForceFeedbackRefChangeHandler Handler)

Parameters


`Handler`	The handler to add

Get Override Value(TextTransform) As Exec

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

nd_img_PropertyOverridesLibrary_ResolveTextTransformOverrideAsExec.png

ETextTransformPolicy ResolveTextTransformOverrideAsExec(FTextTransformOverride Target, bool bOverrideSet)

Parameters


`Target`	`FTextTransformOverride`

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.

nd_img_PropertyOverridesLibrary_ResolveTextTransformOverride.png

ETextTransformPolicy ResolveTextTransformOverride(FTextTransformOverride Target, bool bOverrideSet)

Parameters


`Target`	`FTextTransformOverride`
`Override Set`	Whether 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.

nd_img_PropertyOverridesLibrary_ResolveTextOverrideAsExec.png

FText ResolveTextOverrideAsExec(FTextOverride Target, bool bOverrideSet)

Parameters


`Target`	`FTextOverride`

Returns

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

Get Override Value(Text)

Resolve a text override value.

nd_img_PropertyOverridesLibrary_ResolveTextOverride.png

FText ResolveTextOverride(FTextOverride Target, bool bOverrideSet)

Parameters


`Target`	`FTextOverride`
`Override Set`	Whether 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.

nd_img_PropertyOverridesLibrary_ResolveIntOverrideAsExec.png

int32 ResolveIntOverrideAsExec(FIntegerOverride Target, bool bOverrideSet)

Parameters


`Target`	`FIntegerOverride`

Returns

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

Get Override Value(Integer)

Resolve an integer override value.

nd_img_PropertyOverridesLibrary_ResolveIntOverride.png

int32 ResolveIntOverride(FIntegerOverride Target, bool bOverrideSet)

Parameters


`Target`	`FIntegerOverride`
`Override Set`	Whether 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.

nd_img_PropertyOverridesLibrary_ResolveInputActionOverrideAsExec.png

FDataTableRowHandle ResolveInputActionOverrideAsExec(FInputActionOverride Target, bool bOverrideSet)

Parameters


`Target`	`FInputActionOverride`

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.

nd_img_PropertyOverridesLibrary_ResolveInputActionOverride.png

FDataTableRowHandle ResolveInputActionOverride(FInputActionOverride Target, bool bOverrideSet)

Parameters


`Target`	`FInputActionOverride`
`Override Set`	Whether 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.

nd_img_PropertyOverridesLibrary_ResolveHAlignOverrideAsExec.png

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

Parameters


`Target`	`FHAlignOverride`

Returns

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

Get Override Value(HAlign)

Resolve a horizontal alignment override value.

nd_img_PropertyOverridesLibrary_ResolveHAlignOverride.png

TEnumAsByte<EHorizontalAlignment> ResolveHAlignOverride(FHAlignOverride Target, bool bOverrideSet)

Parameters


`Target`	`FHAlignOverride`
`Override Set`	Whether 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.

nd_img_PropertyOverridesLibrary_ResolveFontInfoOverrideAsExec.png

FSlateFontInfo ResolveFontInfoOverrideAsExec(FSlateFontInfoOverride Target, bool bOverrideSet)

Parameters


`Target`	`FSlateFontInfoOverride`

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.

nd_img_PropertyOverridesLibrary_ResolveFontInfoOverride.png

FSlateFontInfo ResolveFontInfoOverride(FSlateFontInfoOverride Target, bool bOverrideSet)

Parameters


`Target`	`FSlateFontInfoOverride`
`Override Set`	Whether 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.

nd_img_PropertyOverridesLibrary_ResolveFloatOverrideAsExec.png

float ResolveFloatOverrideAsExec(FFloatOverride Target, bool bOverrideSet)

Parameters


`Target`	`FFloatOverride`

Returns

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

Get Override Value(Float)

Resolve a float override value.

nd_img_PropertyOverridesLibrary_ResolveFloatOverride.png

float ResolveFloatOverride(FFloatOverride Target, bool bOverrideSet)

Parameters


`Target`	`FFloatOverride`
`Override Set`	Whether 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.

nd_img_PropertyOverridesLibrary_ResolveClassPathOverrideAsExec_Casted.png

UClass* ResolveClassPathOverrideAsExec_Casted(FClassPathOverride Target, TSubclassOf<UObject> BaseClass, bool bOverrideSet)

Parameters


`Target`	`FClassPathOverride`
`BaseClass`	The 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.

nd_img_PropertyOverridesLibrary_ResolveClassPathOverrideAsExec.png

FSoftClassPath ResolveClassPathOverrideAsExec(FClassPathOverride Target, bool bOverrideSet)

Parameters


`Target`	`FClassPathOverride`

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.

nd_img_PropertyOverridesLibrary_ResolveClassPathOverride_Casted.png

UClass* ResolveClassPathOverride_Casted(FClassPathOverride Target, TSubclassOf<UObject> BaseClass, bool bOverrideSet)

Parameters


`Target`	`FClassPathOverride`
`BaseClass`	The base class to check the loaded class against.
`Override Set`	Whether 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.

nd_img_PropertyOverridesLibrary_ResolveClassPathOverride.png

FSoftClassPath ResolveClassPathOverride(FClassPathOverride Target, bool bOverrideSet)

Parameters


`Target`	`FClassPathOverride`
`Override Set`	Whether 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.

nd_img_PropertyOverridesLibrary_ApplyTextTransformOverride.png

ETextTransformPolicy ApplyTextTransformOverride(FTextTransformOverride Target, ETextTransformPolicy DefaultValue)

Parameters


`Target`	`FTextTransformOverride`
`DefaultValue`	The 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.

nd_img_PropertyOverridesLibrary_ApplyTextOverride.png

FText ApplyTextOverride(FTextOverride Target, FText DefaultValue)

Parameters


`Target`	`FTextOverride`
`DefaultValue`	The default value to use if no override is set.

Returns

The overridden text value or the default value.

Apply Override to Value(Integer)

nd_img_PropertyOverridesLibrary_ApplyIntOverride.png

int32 ApplyIntOverride(FIntegerOverride Target, int32 DefaultValue)

Parameters


`Target`	`FIntegerOverride`
`DefaultValue`	The 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.

nd_img_PropertyOverridesLibrary_ApplyInputActionOverride.png

FDataTableRowHandle ApplyInputActionOverride(FInputActionOverride Target, FDataTableRowHandle DefaultValue)

Parameters


`Target`	`FInputActionOverride`
`DefaultValue`	The 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.

nd_img_PropertyOverridesLibrary_ApplyHAlignOverride.png

TEnumAsByte<EHorizontalAlignment> ApplyHAlignOverride(FHAlignOverride Target, TEnumAsByte<EHorizontalAlignment> DefaultValue)

Parameters


`Target`	`FHAlignOverride`
`DefaultValue`	The 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.

nd_img_PropertyOverridesLibrary_ApplyFontInfoOverride.png

FSlateFontInfo ApplyFontInfoOverride(FSlateFontInfoOverride Target, FSlateFontInfo DefaultValue)

Parameters


`Target`	`FSlateFontInfoOverride`
`DefaultValue`	The 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.

nd_img_PropertyOverridesLibrary_ApplyFloatOverride.png

float ApplyFloatOverride(FFloatOverride Target, float DefaultValue)

Parameters


`Target`	`FFloatOverride`
`DefaultValue`	The 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.

nd_img_PropertyOverridesLibrary_ApplyClassPathOverride_Casted.png

UClass* ApplyClassPathOverride_Casted(FClassPathOverride Target, TSubclassOf<UObject> BaseClass, UClass* DefaultValue)

Parameters


`Target`	`FClassPathOverride`
`BaseClass`	The base class to check the loaded class against.
`DefaultValue`	The 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.

nd_img_PropertyOverridesLibrary_ApplyClassPathOverride.png

FSoftClassPath ApplyClassPathOverride(FClassPathOverride Target, FSoftClassPath DefaultValue)

Parameters


`Target`	`FClassPathOverride`
`DefaultValue`	The 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


`Target`	`FModioRetryCounter`

Returns

True if the operation should be retried

Reset Retry Count

Resets the retry counter

FModioRetryCounter ResetRetryCountPure(FModioRetryCounter Target)

Parameters


`Target`	`FModioRetryCounter`

Returns

The reset retry counter

Reset Retry Count

Resets the retry counter

void ResetRetryCount(FModioRetryCounter Target)

Parameters


`Target`	`FModioRetryCounter`

Can Retry as Exec

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

bool CanRetryAsExec(FModioRetryCounter Target)

Parameters


`Target`	`FModioRetryCounter`

Returns

True if the retry counter has retries remaining

Can Retry

Checks if the retry counter has retries remaining

bool CanRetry(FModioRetryCounter Target)

Parameters


`Target`	`FModioRetryCounter`

Returns

True if the retry counter has retries remaining

Resolve Sound Override As Exec

Resolves a sound reference override to a sound asset

nd_img_ModioSoundCueRefLibrary_ResolveOverrideAsExec.png

USoundBase* ResolveOverrideAsExec(FModioSoundCueRefOverride Target, bool bOverrideSet)

Parameters


`Target`	`FModioSoundCueRefOverride`

Returns

The resolved sound asset, or null if the override is not set

Resolve Sound Override

Resolves a sound reference override to a sound asset

nd_img_ModioSoundCueRefLibrary_ResolveOverride.png

USoundBase* ResolveOverride(FModioSoundCueRefOverride Target, bool bOverrideSet)

Parameters


`Target`	`FModioSoundCueRefOverride`
`Override Set`	True if the sound reference was overridden, false otherwise

Returns

The resolved sound asset, or null if the override is not set

Resolve

Resolves a sound reference to a sound asset

USoundBase* Resolve(FModioSoundCueRef Target, bool bResolved)

Parameters


`Target`	`FModioSoundCueRef`
`Resolved`	True if the sound reference was resolved, false if the fallback sound was used

Returns

The resolved sound asset

Remove Sound Change Handler

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

void RemoveSoundChangeHandler(FModioSoundCueRefChangeHandler Handler)

Parameters


`Handler`	The handler to remove

Get Valid Sound Keys

Gets the list of valid sound keys

TArray<FName> GetValidSoundKeys()

Parameters

Returns

The list of valid sound keys

Add Sound Change Handler

Adds a handler to be called when the sound table changes

void AddSoundChangeHandler(FModioSoundCueRefChangeHandler Handler)

Parameters


`Handler`	The handler to add

Push Value on Stack(bool)

Pushes a new value onto the stack

nd_img_ModioStackedBoolLibrary_PushBoolValue.png

void PushBoolValue(FModioStackedBool Target, bool bNewValue)

Parameters


`Target`	`FModioStackedBool`
`bNewValue`	The value to push onto the stack

Pop Value from Stack(bool)

Pops a value from the stack

nd_img_ModioStackedBoolLibrary_PopBoolValue.png

bool PopBoolValue(FModioStackedBool Target, bool bDidPopSuccessfully)

Parameters


`Target`	`FModioStackedBool`
`Did Pop Successfully`	True if the pop was successful

Returns

The popped value

Peek Value from Stack(bool)

Peeks at the top value of the stack

nd_img_ModioStackedBoolLibrary_PeekBoolValue.png

bool PeekBoolValue(FModioStackedBool Target, bool bDidPeekSuccessfully)

Parameters


`Target`	`FModioStackedBool`
`Did Peek Successfully`	True if the peek was successful

Returns

The peeked value

Get Preset Named Filters

TArray<FModioPresetFilterParams> GetPresetNamedFilters()

Get Preset Filter by Name

FModioPresetFilterParams GetPresetFilterByName(FText PresetFilterName, bool bSuccess)

Get Default Collections Filter

FModioPresetFilterParams GetDefaultCollectionsFilter()

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


`CommandID`	ID for the command to search within
`TextName`	Name of the string to retrieve
`Resolved`	Set 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


`CommandID`	ID for the command to search within
`BrushName`	Name of the brush to retrieve
`Resolved`	Set 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


`CommandID`	ID for the command to retrieve
`Resolved`	Set 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


`Rule`	The text validation rule to apply
`TextToValidate`	The string to apply a rule to
`Validation Message Text`	A 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


`TextToValidate`	String 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


`TextToValidate`	String 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


`TextToValidate`	String 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


`TextToValidate`	String 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


`TextToValidate`	String 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


`TextToValidate`	String 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


`TextToValidate`	String 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


`TextToValidate`	String 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


`TargetObject`	Object that implements IModioUITextValidator and will receive `GetTextValidationRules` and `SetValidationError` interface calls as necessary
`InputText`	The text to validate
`Validation Message Text`	FText that will be initialized by this function to an appropriate error message if validation fails

Returns

True if validation succeeded, false if it failed

nd_img_ModioUICommonFunctionLibrary_ValidateWidget.png

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


`ValueRanges`	The ranges to search through
`Value`	The value to locate
`Out Index`	The 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


`Target`	`UWidget*`

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


`Target`	`UWidget*`

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


`StringKey`	Name of the text to retrieve

Returns

The resolved FText or empty FText if not found

Get Mod Display Price Text

FText GetModDisplayPriceText(FModioModInfo InModInfo)

Get Localized Tag Value

Localizes the specified tag value //

FText GetLocalizedTagValue(FModioModTagLocalizationData InTagLocalizationData)

Parameters


`InTagLocalizationData`	The 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


`InTagInfo`	The 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


`Timespan`	The timespan to format
`YearFormat`	Format text to use if the timespan is > 1 year
`MonthFormat`	Format text to use if the timespan is > 1 month
`DaysFormat`	Format text to use if the timespan is > 1 day
`TodayFormat`	Format 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


`Value`	The raw value to localize
`FormatText`	FText 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 Array from Array

Creates an array of data-bindable UObject wrappers around users coming from an array //

TArray<UModioUserUI*> CreateBindableUserArrayFromArray(TArray<FModioUser> InUserArray)

Parameters


`InUserArray`

Returns

Array of UObjects suitable for use as a DataSource

Create Bindable User

Creates a data-bindable UObject wrapper around an FModioUser //

UModioUserUI* CreateBindableUser(FModioUser InRawUser)

Parameters


`InRawUser`	The user profile to wrap

Returns

A wrapped FModioUserUI pointer suitable for user a a DataSource

Create Bindable Report Type Enum Array

TArray<UModioEnumEntryUI*> CreateBindableReportTypeEnumArray()

Parameters

Returns

Create Bindable Mod Tag Raw Value from String

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

UModioModTagUI* CreateBindableModTagRawValueFromString(FString InTag)

Parameters


`InTag`	The tag to make bindable

Returns

UObject suitable for use as a DataSource

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


`InTag`	The 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


`InRawOptions`	The 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


`InRawTagInfo`	The struct containing tag data to bind to

Returns

UObject wrapper suitable for use as a DataSource

Create Bindable Mod Tag Array from String Array

Creates an array of data-bindable UObject wrappers around and array of strings //

TArray<UModioModTagUI*> CreateBindableModTagArrayFromStringArray(TArray<FString> InTags)

Parameters


`InTags`	The array of tags to make bindable

Returns

Array of UObjects suitable for use as a DataSource as UModioModTagUI

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


`InTags`	The 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


`InTagLocalizationData`	The tag value to make bindable

Returns

UObject suitable for use as a DataSource

Create Bindable Mod Info Array from List

Creates an array of data-bindable UObject wrappers around mod infos coming from a /// FModioModInfoList //

TArray<UModioModInfoUI*> CreateBindableModInfoArrayFromList(FModioModInfoList InModInfoList)

Parameters


`InModInfoList`	The list of mods to make bindable

Returns

Array of UObjects suitable for use as a DataSource

Create Bindable Mod Info

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

UModioModInfoUI* CreateBindableModInfo(FModioModInfo InModInfo)

Parameters


`InModInfo`	The mod info to wrap

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


`InModDependencyList`	The 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


`InModDependencyArray`	The 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


`InModDependency`	The raw string value of the tag

Returns

UObject suitable for use as a DataSource

Create Bindable Mod Collection Array from List

Creates an array of data-bindable UObject wrappers around mod collections coming from a /// FModioModCollectionInfoList //

TArray<UModioModCollectionInfoUI*> CreateBindableModCollectionArrayFromList(FModioModCollectionInfoList InModCollectionList)

Parameters


`InModCollectionList`	The array of mod collections to make bindable

Returns

Array of UObjects suitable for use as a DataSource

Create Bindable Mod Collection

Creates a data-bindable UObject wrapper around an FModioModCollectionInfo //

UModioModCollectionInfoUI* CreateBindableModCollection(FModioModCollectionInfo InRawCollection)

Parameters


`InRawCollection`

Returns

A wrapped FModioModCollectionInfoUI pointer suitable for use as a DataSource

Create Bindable Enum

UModioEnumEntryUI* CreateBindableEnum(uint8 InValue, FText InText)

Parameters


`InValue`
`InText`

Returns

CheckLogoDownloadEventForDataSource (Mod)

Utility method to validate if a logo download event is relevant for the given data source and requested /// size //

nd_img_ModioUICommonFunctionLibrary_CheckLogoDownloadEventForDataSource.png

bool CheckLogoDownloadEventForDataSource(FModioModID EventModID, EModioLogoSize EventLogoSize, UObject* DataSource, EModioLogoSize RequestedSize)

Parameters


`EventModID`	The event's associated mod ID
`EventLogoSize`	The event's associated download size
`DataSource`	The data source containing the relevant mod ID
`RequestedSize`	the size that the widget requested

Returns

CheckLogoDownloadEvent (Mod)

Utility method to validate if a logo download event is relevant for the given mod ID and requested size //

nd_img_ModioUICommonFunctionLibrary_CheckLogoDownloadEvent.png

bool CheckLogoDownloadEvent(FModioModID EventModID, EModioLogoSize EventLogoSize, FModioModID RequestedModID, EModioLogoSize RequestedSize)

Parameters


`EventModID`	The event's associated mod ID
`EventLogoSize`	The event's associated download size
`RequestedModID`	The relevant mod ID for the widget that is making the check
`RequestedSize`	The relevant size for the widget that is making the check

Returns

CheckLogoDownloadEventForDataSource (Mod Collection)

Utility method to validate if a logo download event is relevant for the given data source and requested /// size //

nd_img_ModioUICommonFunctionLibrary_CheckCollectionLogoDownloadEventForDataSource.png

bool CheckCollectionLogoDownloadEventForDataSource(FModioModCollectionID EventModCollectionID, EModioLogoSize EventLogoSize, UObject* DataSource, EModioLogoSize RequestedSize)

Parameters


`EventModCollectionID`	The event's associated mod collection ID
`EventLogoSize`	The event's associated download size
`DataSource`	The data source containing the relevant mod collection ID
`RequestedSize`	the size that the widget requested

Returns

CheckLogoDownloadEvent (Mod Collection)

Utility method to validate if a logo download event is relevant for the given mod collection ID and requested size //

nd_img_ModioUICommonFunctionLibrary_CheckCollectionLogoDownloadEvent.png

bool CheckCollectionLogoDownloadEvent(FModioModCollectionID EventModCollectionID, EModioLogoSize EventLogoSize, FModioModCollectionID RequestedModCollectionID, EModioLogoSize RequestedSize)

Parameters


`EventModCollectionID`	The event's associated mod collection ID
`EventLogoSize`	The event's associated download size
`RequestedModCollectionID`	The relevant mod collection ID for the widget that is making the check
`RequestedSize`	The relevant size for the widget that is making the check

Returns

Async Load Class Array

Utility method to async load an array of soft class pointers //

void AsyncLoadClassArray(TArray<TSoftClassPtr<UObject> > SoftClassPtrs, FModioAsyncLoadClassesComplete OnComplete)

Parameters


`SoftClassPtrs`
`On Complete`	Delegate to execute once loading is complete

As Object Array

Converts an array of Interface references to an array of UObjects //

TArray<UObject*> AsObjectArray(TArray<int32> TargetArray)

Parameters


`TargetArray`	The 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`

EModioModCollectionState


`NotFollowed`	Not followed, subscriptions irrelevant
`IncompleteSubscriptions`	Followed, but not all mods are subscribed
`Followed`	Followed, but none are subscribed
`Subscribed`	Followed and Subscribed to all mods

EModioModInstallationStatus


`NotInstalled`	Not installed by any user on the current system
`Error`	Mod has encountered an error during processing
`Enabled`	Installed and enabled by the current user
`Disabled`	Installed but disabled by the current user
`Purchased`	Purchased by the current user, but not installed by any user on the current system
`SystemInstall`	Installed by another user on the current system. This status takes precedence over Purchased.
`Queued`	Mod is queued for processing
`Initializing`	Beginning a new mod processing state
`Downloading`	Mod is currently downloading
`Extracting`	Mod is currently extracting
`Uploading`	Mod is currently uploading
`Uploaded`	Mod upload has completed
`Compressing`	Mod is currently compressing

EModioUIDialogType

Enum for specific dialog types, can be extended if there are additional dialog types added


`ModDetails`
`ModCollectionDetails`
`ModCollectionContributors`
`ReportMod`
`EnableDisableManagement`
`PurchaseMod`
`StoreUi`
`ConfirmDependencyDownload`	Dialog 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`
`FiatMonetization`
`ModDownvote`
`ModCollections`

EModioUIInputMode


`None`
`Mouse`
`Touch`
`Navigation`

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


`ModGalleryImages`	Downloading gallery images *
`ModCreatorAvatarImage`	Downloading an avatar *
`ModLogo`	Downloading a logo *
`ModCollectionLogo`	Downloading a collection logo
`ModCollectionCuratorAvatarImage`	Downloading a collection curator avatar

EModioUIModCollectionInfoEventType

Enumerator of the information events


`ListAllModCollections`	Event to list all mod collections *
`GetModCollectionInfo`	Event to retrieve the mod collection information *
`GetModCollectionMods`	Event to recieve information on the mods in a collection *

EModioUIModInfoEventType

Enumerator of the information envents


`ListAllMods`	Event to list all mods *
`GetModInfo`	Event to retrieve the mod information *

EModioUITokenPackEventType

Enumerator of the information envents


`ListAllTokenPacks`	Event to list all token packs *
`GetTokenPack`	Event to retrieve the token pack information *

EModioUIUserFollowingEventType

Enumerator of the information envents


`ListUserFollowing`	Event to list user following *
`FollowUser`	Event when a user is followed *
`UnfollowUser`	Event when a user is unfollowed *

EModioTextValidationRule

Enumeration for the possible validation rules ScriptName meta specifier suppresses a duplicate name LogPython warning


`ETVR_ValidateEmailAddress`	Validate as an email *
`ETVR_ValidateAllLetters`	Validate that every character is a letter *
`ETVR_ValidateAllNumeric`	Validate that every character is a number *
`ETVR_ValidateAlphanumeric`	Validate characters as numbers or letters *
`ETVR_ValidateLength`	Validate the length of the stream *
`ETVR_ValidateNotEmpty`	Validate that has some content *
`ETVR_ValidateNoWhitespace`	Validate the lack of spaces *
`ETVR_ValidateNotBlank`	Validate that there is not only whitespace *

EModioModBrowserState


`ModsView`
`CollectionsView`
`LibraryView`

UI Component Specifications
API Reference

UI Component Specifications​

Button​

Implementation Requirements​

Default Component Implementations​

Icon Button​

Additional Interfaces​

Properties​

Sub-components​

Event Data​

Text Button​

Additional Interfaces​

Properties​

Sub-components​

Event Data​

Text​

Implementation Requirements​

Default Component Implementations​

Text Block​

Additional Interfaces​

Properties​

Sub-components​

Event Data​

Editable Text​

Implementation Requirements​

Multiline Editable Text​

Implementation Requirements​

Image​

Implementation Requirements​

Default Component Implementations​

Image​

Properties​

Sub-components​

Event Data​

Progress​

Implementation Requirements​

Tag​

Implementation Requirements​

Object List​

Implementation Requirements​

Default Component Implementations​

Object Wrap Box​

Properties​

Sub-components​

Event Data​

Mod List​

Implementation Requirements​

Object Selector​

Implementation Requirements​

Default Component Implementations​

Object Selector​

Properties​

Sub-components​

Event Data​

Enum Selector​

Implementation Requirements​

Default Component Implementations​

Enum Selector​

Properties​

Sub-components​

Event Data​

Enum Selector Menu​

Properties​

Sub-components​

Event Data​

Enum Selector Entry​

Implementation Requirements​

Default Component Implementations​

Enum Selector Entry​

Properties​

Sub-components​

Event Data​

Enum Selector Entry​

Properties​

Sub-components​

Event Data​

Preset Filter Selector​

Implementation Requirements​

Default Component Implementations​

Preset Filter Selector​

Properties​

UI Component Specifications

Button

Implementation Requirements

Default Component Implementations

Icon Button

Additional Interfaces

Properties

Sub-components

Event Data

Text Button

Additional Interfaces

Properties

Sub-components

Event Data

Text

Implementation Requirements

Default Component Implementations

Text Block

Additional Interfaces

Properties

Sub-components

Event Data

Editable Text

Implementation Requirements

Multiline Editable Text

Implementation Requirements

Image

Implementation Requirements

Default Component Implementations

Image

Properties

Sub-components

Event Data

Progress

Implementation Requirements

Tag

Implementation Requirements

Object List

Implementation Requirements

Default Component Implementations

Object Wrap Box

Properties

Sub-components

Event Data

Mod List

Implementation Requirements

Object Selector

Implementation Requirements

Default Component Implementations

Object Selector

Properties

Sub-components

Event Data

Enum Selector

Implementation Requirements

Default Component Implementations

Enum Selector

Properties

Sub-components

Event Data

Enum Selector Menu

Properties

Sub-components

Event Data

Enum Selector Entry

Implementation Requirements

Default Component Implementations

Enum Selector Entry

Properties

Sub-components

Event Data

Enum Selector Entry

Properties

Sub-components

Event Data

Preset Filter Selector

Implementation Requirements

Default Component Implementations

Preset Filter Selector

Properties