Skip to main content

Component UI API Reference

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

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

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

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

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

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

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

UI Component Specifications

Button

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

Implementation Requirements

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

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

Default Component Implementations

Icon Button

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

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

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

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

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

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

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

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

Text

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

Implementation Requirements

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

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

Default Component Implementations

Text Block

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

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

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


Editable Text

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

Implementation Requirements

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

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

Image

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

Implementation Requirements

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

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

Default Component Implementations

Image

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

Properties
Sub-components
Event Data

Image emits the following interface events with the specified data:


Progress

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

Implementation Requirements

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

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

Tag

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

Implementation Requirements

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

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

Object List

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

Implementation Requirements

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

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

Default Component Implementations

Object Wrap Box

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

Properties
Sub-components
Event Data

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

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

Mod List

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

Implementation Requirements

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

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

Object Selector

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

Implementation Requirements

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

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

Default Component Implementations

Object Selector

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

Properties
Sub-components
Event Data

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

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

Enum Selector

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

Implementation Requirements

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

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

Default Component Implementations

Enum Selector

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

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

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

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

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

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

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

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

Enum Selector Entry

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

Implementation Requirements

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

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

Default Component Implementations

Enum Selector Entry

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

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

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

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

An entry that represents a single selectable enum option.

Properties
Sub-components
Event Data

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

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

Preset Filter Selector

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

Implementation Requirements

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

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

Default Component Implementations

Preset Filter Selector

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

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

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

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

A selector for choosing from preset filters.

Properties
Sub-components
Event Data

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

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

Preset Filter Selector Entry

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

Implementation Requirements

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

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

Command Menu

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

Implementation Requirements

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

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

Default Component Implementations

Command Menu

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

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

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

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

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

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

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

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

A menu displaying a list of commands.

Properties
Sub-components
Event Data

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

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

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

Properties
Sub-components
Event Data

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

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

Mod Property Collection Visualizer

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

Implementation Requirements

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

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

Default Component Implementations

Mod Property Collection Visualizer

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

Properties
Sub-components
GetModPropertyVisualizerWidgets
Event Data

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

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

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

Properties
Sub-components
Event Data

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

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

Mod Tile

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

Implementation Requirements

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

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

Default Component Implementations

Mod Tile

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

Properties
Sub-components
Event Data

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

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

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

Properties
Sub-components
Event Data

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

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

User Display

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

Implementation Requirements

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

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

Default Component Implementations

Platform Username

Displays the platform username of the user.

Properties
Sub-components
Event Data

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

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

API Reference

Classes

LinearColorRefLibrary

Library of functions for working with color references

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object


ModRatingStateProvider

Inheritance Hierarchy

-> Interface-> Object

Request Mod Rating Change

nd_img_ModRatingStateProvider_RequestModRatingChange.png

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

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

Query Mod Rating

nd_img_ModRatingStateProvider_QueryModRating.png

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

Rating of the mod


ModioActivatableWidget

Interface indicating the implementing widget can be activated or deactivated

Inheritance Hierarchy

-> Interface-> Object

Remove Activation Changed Handler

Unregisters a delegate from receiving callbacks when the activation state changes

nd_img_ModioActivatableWidget_RemoveActivationChangedHandler.png

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

Deactivates the implementing widget

nd_img_ModioActivatableWidget_Deactivate.png

void Deactivate()
Parameters
TargetModioActivatableWidget
Add Activation Changed Handler

Registers a delegate to receive callbacks when the activation state changes

nd_img_ModioActivatableWidget_AddActivationChangedHandler.png

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

Activates the implementing widget

nd_img_ModioActivatableWidget_Activate.png

void Activate()
Parameters
TargetModioActivatableWidget

ModioButtonWidget

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

Inheritance Hierarchy

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

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

ModioCommandEntry

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

Inheritance Hierarchy

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

Get Label Widget

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

nd_img_ModioCommandEntry_GetLabelWidget.png

TScriptInterface<IModioUIHasTextWidget> GetLabelWidget() const
Parameters
TargetModioCommandEntry
Returns

The label widget

Get Icon Widget

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

nd_img_ModioCommandEntry_GetIconWidget.png

TScriptInterface<IModioUIImageDisplayWidget> GetIconWidget() const
Parameters
TargetModioCommandEntry
Returns

The icon widget

Get Clickable Widget

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

nd_img_ModioCommandEntry_GetClickableWidget.png

TScriptInterface<IModioUIClickableWidget> GetClickableWidget() const
Parameters
TargetModioCommandEntry
Returns

The clickable widget

Variables

ModioCommandMenu

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

Inheritance Hierarchy

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

Get Selector Widget

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

nd_img_ModioCommandMenu_GetSelectorWidget.png

TScriptInterface<IModioUIObjectSelector> GetSelectorWidget() const
Parameters
TargetModioCommandMenu
Returns

The selector widget

Variables

ModioCurrentUserAvatarWidget

Widget that displays the current user's avatar

Inheritance Hierarchy

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

Get Avatar Image Widget

Get the image widget that displays the avatar

nd_img_ModioCurrentUserAvatarWidget_GetAvatarImageWidget.png

TScriptInterface<IModioUIImageDisplayWidget> GetAvatarImageWidget() const
Parameters
TargetModioCurrentUserAvatarWidget
Returns

The image widget

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

ModioDefaultBorder

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

Inheritance Hierarchy

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

Variables

ModioDefaultCheckBox

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

Inheritance Hierarchy

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

Set Label

Sets the label of the Check Box

nd_img_ModioDefaultCheckBox_SetLabel.png

void SetLabel(FText InLabelText)
Parameters
TargetModioDefaultCheckBox
InLabelTextThe label to set
Set Hovered

nd_img_ModioDefaultCheckBox_SetHovered.png

void SetHovered(bool bHovered)
Parameters
TargetModioDefaultCheckBox
bHoveredWhether the check box is hovered
Handle on Check State Changed

nd_img_ModioDefaultCheckBox_HandleOnCheckStateChanged.png

void HandleOnCheckStateChanged(bool bIsChecked)
Parameters
TargetModioDefaultCheckBox
bIsCheckedThe new state of the check box
Get Label Text Block Text

nd_img_ModioDefaultCheckBox_GetLabelTextBlockText.png

FText GetLabelTextBlockText() const
Parameters
TargetModioDefaultCheckBox
Returns

The label text block text

Get Label

nd_img_ModioDefaultCheckBox_GetLabel.png

FText GetLabel() const
Parameters
TargetModioDefaultCheckBox
Returns

The label

Get Checkbox Content Padding

nd_img_ModioDefaultCheckBox_GetCheckboxContentPadding.png

FMargin GetCheckboxContentPadding() const
Parameters
TargetModioDefaultCheckBox
Returns

The content padding

Variables
FMarginContentPadding
TSubclassOf<UWidget> LabelClass
FTextLabelText

ModioDefaultCodeInputTextBox

Inheritance Hierarchy

-> Widget-> Visual-> Object

Get Validation Error Widget

nd_img_ModioDefaultCodeInputTextBox_GetValidationErrorWidget.png

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

ModioDefaultEditableTextBox

Inheritance Hierarchy

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

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

ModioDefaultIconButton

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

Inheritance Hierarchy

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

Get Image Widget

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

nd_img_ModioDefaultIconButton_GetImageWidget.png

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

ModioDefaultImage

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

Inheritance Hierarchy

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

Variables

ModioDefaultModListView

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

Inheritance Hierarchy

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

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

ModioDefaultModTile

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

Inheritance Hierarchy

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

Populate Extra Options Commands

nd_img_ModioDefaultModTile_PopulateExtraOptionsCommands.png

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

Notifies the component that the hover state has changed

nd_img_ModioDefaultModTile_NotifyHoverStateChanged.png

void NotifyHoverStateChanged(bool bNewHoveredState)
Parameters
TargetModioDefaultModTile
bNewHoveredState
Notify Clicked

nd_img_ModioDefaultModTile_NotifyClicked.png

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

nd_img_ModioDefaultModTile_GetSelectedStateEx.png

bool GetSelectedStateEx()
Parameters
TargetModioDefaultModTile
Get More Options Menu Widget

nd_img_ModioDefaultModTile_GetMoreOptionsMenuWidget.png

TScriptInterface<IModioUICommandMenu> GetMoreOptionsMenuWidget() const
Variables
FModioClickableOnClickedMulticastOnClickedPasses this as ClickContext
boolbSelected
FModioSelectableOnSelectionChangedMulticastOnSelectedPasses this as SelectionContext, bNewSelectedState is new selection state
FModioHoverableOnHoverStateChangedMulticastOnHoverStateChangedPasses this as HoverContext, bHoveredState is new hover state
TObjectPtr<UObject>EditorDataSource

ModioDefaultModTileView

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

Inheritance Hierarchy

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

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

ModioDefaultModalDialogImpl

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

Inheritance Hierarchy

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

Variables
FModioDialogButtonClickedEventMulticastOnDialogButtonClicked
boolbUseGeneratedButtonContent
TArray<FModioDialogButtonInfo>DialogButtonData

ModioDefaultMultiLineEditableTextBox

Inheritance Hierarchy

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

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

ModioDefaultObjectSelector

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

Inheritance Hierarchy

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

Get Entry Widget from Item

nd_img_ModioDefaultObjectSelector_GetEntryWidgetFromItem.png

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

ModioDefaultProgressBar

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

Inheritance Hierarchy

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

Variables

ModioDefaultScrollBox

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

Inheritance Hierarchy

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

Update Navigation Data

nd_img_ModioDefaultScrollBox_UpdateNavigationData.png

void UpdateNavigationData(int32 PendingScrollOffset)
Parameters
TargetModioDefaultScrollBox
PendingScrollOffsetThe pending scroll offset (may differ from the actual current scroll offset due to ongoing scrolling animation, if any)
On User Scrolled Handle

nd_img_ModioDefaultScrollBox_OnUserScrolledHandle.png

void OnUserScrolledHandle(float CurrentOffset)
Parameters
TargetModioDefaultScrollBox
CurrentOffsetThe current scroll offset
Variables
boolbScrollByNavigationInput
int32NavigationScrollOffsetStep
floatNavigationScrollOffsetSpeed
TObjectPtr<UWidgetNavigation>UserDefinedNavigation

ModioDefaultTagWidget

Inheritance Hierarchy

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

Get Label Widget

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
FLinearColorRefOverrideTextColorOverride

ModioDefaultTextButton

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

Inheritance Hierarchy

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

Get Label Widget

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

nd_img_ModioDefaultTextButton_GetLabelWidget.png

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

ModioDefaultTokenPackTile

Inheritance Hierarchy

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

Notify Hover State Changed

Notifies the component that the hover state has changed

nd_img_ModioDefaultTokenPackTile_NotifyHoverStateChanged.png

void NotifyHoverStateChanged(bool bNewHoveredState)
Parameters
TargetModioDefaultTokenPackTile
bNewHoveredState
Notify Clicked

nd_img_ModioDefaultTokenPackTile_NotifyClicked.png

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

nd_img_ModioDefaultTokenPackTile_GetSelectedStateEx.png

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

ModioDefaultTokenPackTileView

Inheritance Hierarchy

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

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

ModioDialogButtonUIDetails

Inheritance Hierarchy

-> Interface-> Object

Get Dialog Button Info

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

nd_img_ModioDialogButtonUIDetails_GetDialogButtonInfo.png

FModioDialogButtonInfo GetDialogButtonInfo()
Parameters
TargetModioDialogButtonUIDetails
Returns

DialogButtonInfo associated with the object


ModioDropdownAnchor

A widget that anchors a dropdown menu to a button

Inheritance Hierarchy

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

Variables

ModioEnumEntryUI

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

Inheritance Hierarchy

-> Object

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

ModioEnumEntryUIDetails

Inheritance Hierarchy

-> Interface-> Object

Get Enum Entry Details

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

nd_img_ModioEnumEntryUIDetails_GetEnumEntryDetails.png

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

ModioEnumSelector

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

Inheritance Hierarchy

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

Notify Selection Changed

nd_img_ModioEnumSelector_NotifySelectionChanged.png

void NotifySelectionChanged(UObject* SelectedObject)
Get Selector Menu Widget

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

nd_img_ModioEnumSelector_GetSelectorMenuWidget.png

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

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

nd_img_ModioEnumSelector_GetMenuToggleClickableWidget.png

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

ModioEnumSelectorEntry

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

Inheritance Hierarchy

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

Notify Selection Changed

Notifies the component that the selection state has changed

nd_img_ModioEnumSelectorEntry_NotifySelectionChanged.png

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

Notifies the component that the clickable widget has been clicked

nd_img_ModioEnumSelectorEntry_NotifyClicked.png

void NotifyClicked()
Parameters
TargetModioEnumSelectorEntry
Get Selectable Widget

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

nd_img_ModioEnumSelectorEntry_GetSelectableWidget.png

TScriptInterface<IModioUISelectableWidget> GetSelectableWidget() const
Parameters
TargetModioEnumSelectorEntry
Returns

The selectable widget

Get Label Widget

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

nd_img_ModioEnumSelectorEntry_GetLabelWidget.png

TScriptInterface<IModioUIHasTextWidget> GetLabelWidget() const
Parameters
TargetModioEnumSelectorEntry
Returns

The label widget

Get Clickable Widget

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

nd_img_ModioEnumSelectorEntry_GetClickableWidget.png

TScriptInterface<IModioUIClickableWidget> GetClickableWidget() const
Parameters
TargetModioEnumSelectorEntry
Returns

The clickable widget

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

ModioEnumSelectorMenu

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

Inheritance Hierarchy

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

Notify Selection Changed

Called when the selection changes

nd_img_ModioEnumSelectorMenu_NotifySelectionChanged.png

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

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

nd_img_ModioEnumSelectorMenu_GetSelectorWidget.png

TScriptInterface<IModioUIObjectSelector> GetSelectorWidget() const
Parameters
TargetModioEnumSelectorMenu
Returns

The selector widget

Variables
FModioOnObjectSelectionChangedMulticastOnSelectionChangedPasses UObject* as SelectedValue

ModioFeatureVisibilityWidget

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

Inheritance Hierarchy

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

Variables
EModioUIFeatureFlagsFeatureToCheck

ModioFeaturedCategoryParamsUI

Wrapper around FModioCommonFeaturedCategoryParams for data binding to UListView etc

Inheritance Hierarchy

-> Object


ModioFilterCounterButton

Inheritance Hierarchy

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

Get Filter Counter Widget

nd_img_ModioFilterCounterButton_GetFilterCounterWidget.png

TScriptInterface<IModioUIDataSourceWidget> GetFilterCounterWidget()
Variables

ModioFilterPanel

Inheritance Hierarchy

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

Get Tag Selector Widget

nd_img_ModioFilterPanel_GetTagSelectorWidget.png

TScriptInterface<IModioUIModTagSelector> GetTagSelectorWidget() const
Get Selected Tags

nd_img_ModioFilterPanel_GetSelectedTags.png

TArray<FString> GetSelectedTags()
Get Clear Button Widget

nd_img_ModioFilterPanel_GetClearButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetClearButtonWidget() const
Get Background Button Widget

nd_img_ModioFilterPanel_GetBackgroundButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetBackgroundButtonWidget() const
Clear Selected Tags

nd_img_ModioFilterPanel_ClearSelectedTags.png

void ClearSelectedTags()
Add Tag Selection Changed Handler

nd_img_ModioFilterPanel_AddTagSelectionChangedHandler.png

void AddTagSelectionChangedHandler(FModioOnTagSelectionChanged Handler)
Variables

ModioFilterParamsUI

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

Inheritance Hierarchy

-> Object

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

ModioFocusableWidget

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

Inheritance Hierarchy

-> Interface-> Object

Remove Focus Path Changed Handler

Unregisters a delegate from receiving callbacks when the focus path changes

nd_img_ModioFocusableWidget_RemoveFocusPathChangedHandler.png

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

Queries the implementing object for the widget that should receive focus

nd_img_ModioFocusableWidget_GetWidgetToFocus.png

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

Widget to focus

Add Focus Path Changed Handler

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

nd_img_ModioFocusableWidget_AddFocusPathChangedHandler.png

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

ModioGalleryImageUI

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

Inheritance Hierarchy

-> Object

Variables
FModioImageWrapperUnderlyingImageUnderlying image data
int32UnderlyingIndexIndex of this image in the gallery

ModioGalleryImageUIDetails

Inheritance Hierarchy

-> Interface-> Object

Get Index

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

nd_img_ModioGalleryImageUIDetails_GetIndex.png

int32 GetIndex()
Parameters
TargetModioGalleryImageUIDetails
Returns

Index associated with the object

Get Image

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

nd_img_ModioGalleryImageUIDetails_GetImage.png

FModioImageWrapper GetImage()
Parameters
TargetModioGalleryImageUIDetails
Returns

FModioImageWrapper associated with the object


ModioGalleryListEntry

Inheritance Hierarchy

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

Variables

ModioImageGallery

Inheritance Hierarchy

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

Refresh

nd_img_ModioImageGallery_Refresh.png

void Refresh()
Get Increment Selection Button Widget

nd_img_ModioImageGallery_GetIncrementSelectionButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetIncrementSelectionButtonWidget() const
Parameters
TargetModioImageGallery
Returns

The widget which implements IModioUIClickableWidget

Get Image Widget

nd_img_ModioImageGallery_GetImageWidget.png

TScriptInterface<IModioUIImageDisplayWidget> GetImageWidget() const
Parameters
TargetModioImageGallery
Returns

The image widget which implements IModioUIImageDisplayWidget

Get Image Selector Widget

nd_img_ModioImageGallery_GetImageSelectorWidget.png

TScriptInterface<IModioUIObjectSelector> GetImageSelectorWidget() const
Parameters
TargetModioImageGallery
Returns

The widget which implements IModioUIObjectSelector

Get Decrement Selection Button Widget

nd_img_ModioImageGallery_GetDecrementSelectionButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetDecrementSelectionButtonWidget() const
Parameters
TargetModioImageGallery
Returns

The widget which implements IModioUIClickableWidget

Variables
int64ModIdEditor
FModioModInfoBoundModInfo
boolbUseLogoOnly

ModioModBrowser

Inheritance Hierarchy

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

Search Subscriptions and Installs with Stored Params

nd_img_ModioModBrowser_SearchSubscriptionsAndInstallsWithStoredParams.png

TArray<FModioModInfo> SearchSubscriptionsAndInstallsWithStoredParams() const
Search Purchases with Stored Params

nd_img_ModioModBrowser_SearchPurchasesWithStoredParams.png

TArray<FModioModInfo> SearchPurchasesWithStoredParams() const
Search Library with Stored Params

nd_img_ModioModBrowser_SearchLibraryWithStoredParams.png

TArray<FModioModInfo> SearchLibraryWithStoredParams() const
Initialize Tag Data

nd_img_ModioModBrowser_InitializeTagData.png

void InitializeTagData(UObject* InTagData)
Initialize Library Tag Data

nd_img_ModioModBrowser_InitializeLibraryTagData.png

void InitializeLibraryTagData(UObject* InTagData)
Increment Preset Filter Selection

nd_img_ModioModBrowser_IncrementPresetFilterSelection.png

void IncrementPresetFilterSelection()
Get Wallet Button Widget

nd_img_ModioModBrowser_GetWalletButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetWalletButtonWidget() const
Get View Description Text Widget

nd_img_ModioModBrowser_GetViewDescriptionTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetViewDescriptionTextWidget() const
Get View Description Image Widget

nd_img_ModioModBrowser_GetViewDescriptionImageWidget.png

TScriptInterface<IModioUIImageDisplayWidget> GetViewDescriptionImageWidget() const
Get Tab Right Button Widget

nd_img_ModioModBrowser_GetTabRightButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetTabRightButtonWidget() const
Get Tab Left Button Widget

nd_img_ModioModBrowser_GetTabLeftButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetTabLeftButtonWidget() const
Get Search Text Widget

nd_img_ModioModBrowser_GetSearchTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetSearchTextWidget() const
Get Search Editable Text Box Widget

nd_img_ModioModBrowser_GetSearchEditableTextBoxWidget.png

TScriptInterface<IModioUIStringInputWidget> GetSearchEditableTextBoxWidget() const
Get Search Button Widget

nd_img_ModioModBrowser_GetSearchButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetSearchButtonWidget() const
Get Preset Filter Selector Widget

nd_img_ModioModBrowser_GetPresetFilterSelectorWidget.png

TScriptInterface<IModioUIObjectSelector> GetPresetFilterSelectorWidget() const
Get Mod Tile View Widget

nd_img_ModioModBrowser_GetModTileViewWidget.png

TScriptInterface<IModioUIModListViewInterface> GetModTileViewWidget() const
Get Library View Button Widget

nd_img_ModioModBrowser_GetLibraryViewButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetLibraryViewButtonWidget() const
Get Filter Button Widget

nd_img_ModioModBrowser_GetFilterButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetFilterButtonWidget() const
Get Close Browser Button Widget

nd_img_ModioModBrowser_GetCloseBrowserButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetCloseBrowserButtonWidget() const
Get Clear Search Button Widget

nd_img_ModioModBrowser_GetClearSearchButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetClearSearchButtonWidget() const
Decrement Preset Filter Selection

nd_img_ModioModBrowser_DecrementPresetFilterSelection.png

void DecrementPresetFilterSelection()
Variables
EModioModBrowserStateCurrentView
FStringStoredSearchString
TObjectPtr<UObject>StoredTagData
TObjectPtr<UObject>StoredLibraryTagData

ModioModBrowserDialogButtonInfoUI

Wrapper around FModioDialogButtonInfo for data binding to UListView etc

Inheritance Hierarchy

-> Object


ModioModCollectionEntryUI

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

Inheritance Hierarchy

-> Object

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

ModioModDependencyUI

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

Inheritance Hierarchy

-> Object


ModioModDependencyUIDetails

Inheritance Hierarchy

-> Interface-> Object

Get Mod ID

nd_img_ModioModDependencyUIDetails_GetModID.png

FModioModID GetModID()
Parameters
TargetModioModDependencyUIDetails
Returns

Mod ID for the associated mod

Get Mod Dependency

nd_img_ModioModDependencyUIDetails_GetModDependency.png

FModioModDependency GetModDependency()
Parameters
TargetModioModDependencyUIDetails
Returns

ModioModDependency for the associated mod


ModioModDetailsDialog

Inheritance Hierarchy

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

Populate Extra Options Commands

nd_img_ModioModDetailsDialog_PopulateExtraOptionsCommands.png

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

nd_img_ModioModDetailsDialog_IsUserSubscribed.png

bool IsUserSubscribed()
Parameters
TargetModioModDetailsDialog
Is Mod Purchased

nd_img_ModioModDetailsDialog_IsModPurchased.png

bool IsModPurchased()
Get Wallet Button Widget

nd_img_ModioModDetailsDialog_GetWalletButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetWalletButtonWidget() const
Get Tag Display Widget

nd_img_ModioModDetailsDialog_GetTagDisplayWidget.png

TScriptInterface<IModioUIDataSourceWidget> GetTagDisplayWidget() const
Get Subscribe Button Widget

nd_img_ModioModDetailsDialog_GetSubscribeButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetSubscribeButtonWidget() const
Get Rate Up Button Widget

nd_img_ModioModDetailsDialog_GetRateUpButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetRateUpButtonWidget() const
Get Rate Down Button Widget

nd_img_ModioModDetailsDialog_GetRateDownButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetRateDownButtonWidget() const
Get Purchase Button Widget

nd_img_ModioModDetailsDialog_GetPurchaseButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetPurchaseButtonWidget() const
Get More Options Menu Widget

nd_img_ModioModDetailsDialog_GetMoreOptionsMenuWidget.png

TScriptInterface<IModioUICommandMenu> GetMoreOptionsMenuWidget() const
Get Mod Summary Short Text Widget

nd_img_ModioModDetailsDialog_GetModSummaryShortTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetModSummaryShortTextWidget() const
Get Mod Status Widget

nd_img_ModioModDetailsDialog_GetModStatusWidget.png

TScriptInterface<IModioUIDataSourceWidget> GetModStatusWidget() const
Get Mod Properties Widget

nd_img_ModioModDetailsDialog_GetModPropertiesWidget.png

TScriptInterface<IModioUIDataSourceWidget> GetModPropertiesWidget() const
Get Mod Name Text Widget

nd_img_ModioModDetailsDialog_GetModNameTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetModNameTextWidget() const

nd_img_ModioModDetailsDialog_GetModImageGalleryWidget.png

TScriptInterface<IModioUIMediaDownloadCompletedReceiver> GetModImageGalleryWidget() const
Get Mod Dependencies Button Widget

nd_img_ModioModDetailsDialog_GetModDependenciesButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetModDependenciesButtonWidget() const
Get Mod Author Display Widget

nd_img_ModioModDetailsDialog_GetModAuthorDisplayWidget.png

TScriptInterface<IModioUIDataSourceWidget> GetModAuthorDisplayWidget() const
Get Expand Description Button Widget

nd_img_ModioModDetailsDialog_GetExpandDescriptionButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetExpandDescriptionButtonWidget() const
Get Close Dialog Button Widget

nd_img_ModioModDetailsDialog_GetCloseDialogButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetCloseDialogButtonWidget() const
Variables
FTextExpandLabelText
TObjectPtr<UObject>EditorDataSource
FModioModInfoBoundModInfo
boolbHasFullDescription

ModioModEnabledStatusWidget

A widget that displays the enabled status of a mod

Inheritance Hierarchy

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

Variables

ModioModEnabledToggleWidget

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

Inheritance Hierarchy

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

Variables

ModioModFilterUIDetails

Inheritance Hierarchy

-> Interface-> Object

Get Filter Params

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

nd_img_ModioModFilterUIDetails_GetFilterParams.png

FModioFilterParams GetFilterParams()
Parameters
TargetModioModFilterUIDetails
Returns

ModFilterParams associated with the object

Get Filter Name

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

nd_img_ModioModFilterUIDetails_GetFilterName.png

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

true if the implementing object provides a name for the filter


ModioModInfoUI

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

Inheritance Hierarchy

-> Object


ModioModInfoUIDetails

Inheritance Hierarchy

-> Interface-> Object

Get Mod ID

nd_img_ModioModInfoUIDetails_GetModID.png

FModioModID GetModID()
Parameters
TargetModioModInfoUIDetails
Returns

Mod ID for the associated mod

Get Full Mod Info

nd_img_ModioModInfoUIDetails_GetFullModInfo.png

FModioModInfo GetFullModInfo()
Parameters
TargetModioModInfoUIDetails
Returns

ModInfo for the associated mod


ModioModInstallationStatusWidget

A widget that displays the installation status of a mod

Inheritance Hierarchy

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

Query Progress Value for State

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

nd_img_ModioModInstallationStatusWidget_QueryProgressValueForState.png

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

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

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

ModioModManagementEventUI

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

Inheritance Hierarchy

-> Object


ModioModProgressInfoUI

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

Inheritance Hierarchy

-> Object


ModioModPropCollectionVisualizer

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

Inheritance Hierarchy

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

Get Mod Property Visualizer Widgets

nd_img_ModioModPropCollectionVisualizer_GetModPropertyVisualizerWidgets.png

TArray<TScriptInterface<IModioUIDataSourceWidget> > GetModPropertyVisualizerWidgets()
Parameters
TargetModioModPropCollectionVisualizer
Returns

Array of widgets implementing UModioUIDataSourceWidget that will visualize individual properties

Variables

ModioModRatingDisplay

A widget that displays the rating of a mod

Inheritance Hierarchy

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

Get Rating Percentage Label Widget

Get the label widget that displays the rating percentage

nd_img_ModioModRatingDisplay_GetRatingPercentageLabelWidget.png

TScriptInterface<IModioUIHasTextWidget> GetRatingPercentageLabelWidget() const
Parameters
TargetModioModRatingDisplay
Returns

The label widget

Get Rating Description Label Widget

Get the rating description label widget

nd_img_ModioModRatingDisplay_GetRatingDescriptionLabelWidget.png

TScriptInterface<IModioUIHasTextWidget> GetRatingDescriptionLabelWidget() const
Parameters
TargetModioModRatingDisplay
Returns

The label widget

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

ModioModSubscriptionStatusWidget

A widget that displays the subscription status of a mod

Inheritance Hierarchy

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

Variables

ModioModTagCategoryUIDetails

Inheritance Hierarchy

-> Interface-> Object

Get Selected Tags

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

nd_img_ModioModTagCategoryUIDetails_GetSelectedTags.png

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

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

nd_img_ModioModTagCategoryUIDetails_GetRawCategoryName.png

FString GetRawCategoryName()
Parameters
TargetModioModTagCategoryUIDetails
Returns

raw string name for the tag category

Get Localized Category Name

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

nd_img_ModioModTagCategoryUIDetails_GetLocalizedCategoryName.png

FText GetLocalizedCategoryName()
Parameters
TargetModioModTagCategoryUIDetails
Returns

localized name for the tag category

Get Is Category Locked

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

nd_img_ModioModTagCategoryUIDetails_GetIsCategoryLocked.png

bool GetIsCategoryLocked()
Parameters
TargetModioModTagCategoryUIDetails
Returns

True if only editable by admins

Get Is Category Hidden

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

nd_img_ModioModTagCategoryUIDetails_GetIsCategoryHidden.png

bool GetIsCategoryHidden()
Parameters
TargetModioModTagCategoryUIDetails
Returns

True if only visible by admins

Get Category Tags

Gets the bindable tag objects for this category

nd_img_ModioModTagCategoryUIDetails_GetCategoryTags.png

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

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

nd_img_ModioModTagCategoryUIDetails_GetAllowMultipleSelection.png

bool GetAllowMultipleSelection()
Parameters
TargetModioModTagCategoryUIDetails
Returns

True if the category permits multiple values to be selected


ModioModTagDisplay

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

Inheritance Hierarchy

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

Get Tag Container Widget

Get the widget that will contain the tags

nd_img_ModioModTagDisplay_GetTagContainerWidget.png

TScriptInterface<IModioUIObjectListWidget> GetTagContainerWidget() const
Parameters
TargetModioModTagDisplay
Returns

The widget

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

ModioModTagInfoUI

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

Inheritance Hierarchy

-> Object

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

ModioModTagOptionsUI

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

Inheritance Hierarchy

-> Object

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

ModioModTagOptionsUIDetails

Inheritance Hierarchy

-> Interface-> Object

Get Selected Tags

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

nd_img_ModioModTagOptionsUIDetails_GetSelectedTags.png

TArray<FString> GetSelectedTags()
Parameters
TargetModioModTagOptionsUIDetails
Get Categories

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

nd_img_ModioModTagOptionsUIDetails_GetCategories.png

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

Clears all selected tags across all categories

nd_img_ModioModTagOptionsUIDetails_ClearSelectedTags.png

void ClearSelectedTags()
Parameters
TargetModioModTagOptionsUIDetails

ModioModTagSelector

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

Inheritance Hierarchy

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

Get Selector Menu Widget

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

nd_img_ModioModTagSelector_GetSelectorMenuWidget.png

TScriptInterface<IModioUIModTagSelector> GetSelectorMenuWidget() const
Parameters
TargetModioModTagSelector
Returns

The widget that displays the tag categories and values

Get Menu Toggle Clickable Widget

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

nd_img_ModioModTagSelector_GetMenuToggleClickableWidget.png

TScriptInterface<IModioUIClickableWidget> GetMenuToggleClickableWidget() const
Parameters
TargetModioModTagSelector
Returns

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

Variables

ModioModTagSelectorCategory

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

Inheritance Hierarchy

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

Get Tag Category Label

Get the label widget that displays the category name

nd_img_ModioModTagSelectorCategory_GetTagCategoryLabel.png

TScriptInterface<IModioUIHasTextWidget> GetTagCategoryLabel() const
Parameters
TargetModioModTagSelectorCategory
Returns

The label widget

Get Category Tag List Widget

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

nd_img_ModioModTagSelectorCategory_GetCategoryTagListWidget.png

TScriptInterface<IModioUIObjectSelector> GetCategoryTagListWidget() const
Parameters
TargetModioModTagSelectorCategory
Returns

The widget that displays the tags

Variables

ModioModTagSelectorEntry

A widget that represents a tag in a tag selector

Inheritance Hierarchy

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

Notify Selection Changed

Notify listeners that the selection state of this entry has changed

nd_img_ModioModTagSelectorEntry_NotifySelectionChanged.png

void NotifySelectionChanged()
Parameters
TargetModioModTagSelectorEntry
Notify Clicked

Notify listeners that this entry has been clicked

nd_img_ModioModTagSelectorEntry_NotifyClicked.png

void NotifyClicked()
Parameters
TargetModioModTagSelectorEntry
Get Tag Label Widget

Get the widget that displays the tag text for this entry

nd_img_ModioModTagSelectorEntry_GetTagLabelWidget.png

TScriptInterface<IModioUIHasTextWidget> GetTagLabelWidget() const
Parameters
TargetModioModTagSelectorEntry
Returns

The text widget

Get Selection Widget

Get the widget that represents the selection state of this entry

nd_img_ModioModTagSelectorEntry_GetSelectionWidget.png

TScriptInterface<IModioUISelectableWidget> GetSelectionWidget() const
Parameters
TargetModioModTagSelectorEntry
Returns

The selection widget

Get Clickable Widget

Get the widget that can be clicked to select this entry

nd_img_ModioModTagSelectorEntry_GetClickableWidget.png

TScriptInterface<IModioUIClickableWidget> GetClickableWidget() const
Parameters
TargetModioModTagSelectorEntry
Returns

The clickable widget

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

ModioModTagSelectorMenu

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

Inheritance Hierarchy

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

Notify Selection Changed

Notify listeners that the selection state of the tags has changed

nd_img_ModioModTagSelectorMenu_NotifySelectionChanged.png

void NotifySelectionChanged()
Parameters
TargetModioModTagSelectorMenu
Get Category Container Widget

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

nd_img_ModioModTagSelectorMenu_GetCategoryContainerWidget.png

TScriptInterface<IModioUIObjectListWidget> GetCategoryContainerWidget() const
Parameters
TargetModioModTagSelectorMenu
Returns

The widget that displays the tag categories

Get Allowed Tags

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

nd_img_ModioModTagSelectorMenu_GetAllowedTags.png

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

Array of category tags allowed to be shown

Variables
FModioOnTagSelectionChangedMulticastOnTagSelectionChanged

ModioModTagUI

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

Inheritance Hierarchy

-> Object

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

ModioModTagUIDetails

Inheritance Hierarchy

-> Interface-> Object

Set Selection State

Sets the selection state of the associated tag

nd_img_ModioModTagUIDetails_SetSelectionState.png

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

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

nd_img_ModioModTagUIDetails_GetSelectionState.png

bool GetSelectionState()
Parameters
TargetModioModTagUIDetails
Returns

The selection state for the tag

Get Raw String Value

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

nd_img_ModioModTagUIDetails_GetRawStringValue.png

FString GetRawStringValue()
Parameters
TargetModioModTagUIDetails
Returns

raw string value for the mod tag

Get Localized Text

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

nd_img_ModioModTagUIDetails_GetLocalizedText.png

FText GetLocalizedText()
Parameters
TargetModioModTagUIDetails
Returns

localized text value for the mod tag


ModioObjectWrapBox

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

Inheritance Hierarchy

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

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

ModioOperationTracker

Inheritance Hierarchy

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

Get Radial Progress Widget

nd_img_ModioOperationTracker_GetRadialProgressWidget.png

TScriptInterface<IModioUIProgressWidget> GetRadialProgressWidget() const
Get Queue Label Text Widget

nd_img_ModioOperationTracker_GetQueueLabelTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetQueueLabelTextWidget() const
Get Queue Count Text Widget

nd_img_ModioOperationTracker_GetQueueCountTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetQueueCountTextWidget() const
Get Queue Count Icon Widget

nd_img_ModioOperationTracker_GetQueueCountIconWidget.png

TScriptInterface<IModioUIImageDisplayWidget> GetQueueCountIconWidget() const
Get Percent Progress Text Widget

nd_img_ModioOperationTracker_GetPercentProgressTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetPercentProgressTextWidget() const
Get Operation Type Icon Widget

nd_img_ModioOperationTracker_GetOperationTypeIconWidget.png

TScriptInterface<IModioUIImageDisplayWidget> GetOperationTypeIconWidget() const
Get Download Speed Text Widget

nd_img_ModioOperationTracker_GetDownloadSpeedTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetDownloadSpeedTextWidget() const
Get Download Size Text Widget

nd_img_ModioOperationTracker_GetDownloadSizeTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetDownloadSizeTextWidget() const
Variables

ModioPlatformSpecificWidget

Inheritance Hierarchy

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

Variables

ModioPopupCommandMenu

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

Inheritance Hierarchy

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

Get Command Menu Widget

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

nd_img_ModioPopupCommandMenu_GetCommandMenuWidget.png

TScriptInterface<IModioUICommandMenu> GetCommandMenuWidget() const
Parameters
TargetModioPopupCommandMenu
Returns

The widget that displays the command menu

Construct Command Menu Widget

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

nd_img_ModioPopupCommandMenu_ConstructCommandMenuWidget.png

void ConstructCommandMenuWidget()
Parameters
TargetModioPopupCommandMenu
Variables

ModioPresetFilterEntryWidget

A widget that represents a filter entry in a filter preset

Inheritance Hierarchy

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

Get Label Widget

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

nd_img_ModioPresetFilterEntryWidget_GetLabelWidget.png

TScriptInterface<IModioUIHasTextWidget> GetLabelWidget() const
Parameters
TargetModioPresetFilterEntryWidget
Returns

The widget that displays the label

Variables

ModioPresetFilterSelector

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

Inheritance Hierarchy

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

Get Preset List Widget

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

nd_img_ModioPresetFilterSelector_GetPresetListWidget.png

TScriptInterface<IModioUIObjectSelector> GetPresetListWidget() const
Parameters
TargetModioPresetFilterSelector
Returns

The widget that displays the presets

Get Filter Presets

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

nd_img_ModioPresetFilterSelector_GetFilterPresets.png

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

Array of UObjects implementing UModioModFilterUIDetails, one for each preset

Variables

ModioReportInfoUI

UObject wrapper around an FModioReportParams for use as a data source

Inheritance Hierarchy

-> Object

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

ModioRetryLibrary

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object


ModioScrollableWidget

Interface for widgets that support scrolling functionality

Inheritance Hierarchy

-> Interface-> Object

Set Scroll Offset

Set the scroll offset of the widget

nd_img_ModioScrollableWidget_SetScrollOffset.png

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

Scroll the widget to the top

nd_img_ModioScrollableWidget_ScrollToTop.png

void ScrollToTop()
Parameters
TargetModioScrollableWidget
Scroll to Bottom

Scroll the widget to the bottom

nd_img_ModioScrollableWidget_ScrollToBottom.png

void ScrollToBottom()
Parameters
TargetModioScrollableWidget
Get Scroll Offset

Get the current scroll offset of the widget

nd_img_ModioScrollableWidget_GetScrollOffset.png

float GetScrollOffset() const
Parameters
TargetModioScrollableWidget
Returns

The current scroll offset


ModioSearchBar

Inheritance Hierarchy

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

Get Search Box Widget

nd_img_ModioSearchBar_GetSearchBoxWidget.png

TScriptInterface<IModioUIStringInputWidget> GetSearchBoxWidget() const
Get Button Widget

nd_img_ModioSearchBar_GetButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetButtonWidget() const
Variables

ModioStackedBoolLibrary

Library of functions for working with stacked bool values

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object


ModioStorageTracker

Inheritance Hierarchy

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

Refresh Data

nd_img_ModioStorageTracker_RefreshData.png

void RefreshData()
Get Storage Used Text Widget

nd_img_ModioStorageTracker_GetStorageUsedTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetStorageUsedTextWidget() const
Variables

ModioTagCounterIcon

Inheritance Hierarchy

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

Synchronize Counter

nd_img_ModioTagCounterIcon_SynchronizeCounter.png

int32 SynchronizeCounter()
Get Counter Label Widget

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

nd_img_ModioToggleableWidget_RemoveToggleStateChangedHandler.png

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

Toggles the open state of the widget

nd_img_ModioToggleableWidget_Open.png

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

Get the current open/close state of the widget

nd_img_ModioToggleableWidget_IsOpen.png

bool IsOpen() const
Parameters
TargetModioToggleableWidget
Returns

True if the widget is open, false otherwise

Close

Toggles the close state of the widget

nd_img_ModioToggleableWidget_Close.png

void Close()
Parameters
TargetModioToggleableWidget
Add Toggle State Changed Handler

Registers a delegate to receive callbacks when the toggle state changes

nd_img_ModioToggleableWidget_AddToggleStateChangedHandler.png

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

ModioTokenPackBrowser

Inheritance Hierarchy

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

Get Token Tile View Widget

nd_img_ModioTokenPackBrowser_GetTokenTileViewWidget.png

TScriptInterface<IModioUITokenPackListInterface> GetTokenTileViewWidget() const
Get Title Text Widget

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

Get Token Pack ID

nd_img_ModioTokenPackUIDetails_GetTokenPackID.png

FModioTokenPackID GetTokenPackID()
Parameters
TargetModioTokenPackUIDetails
Returns

Token Pack ID for the relevant TokenPack

Get Full Token Pack

nd_img_ModioTokenPackUIDetails_GetFullTokenPack.png

FModioTokenPack GetFullTokenPack()
Parameters
TargetModioTokenPackUIDetails
Returns

Token Pack struct


ModioUIBoundActionWidget

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

Inheritance Hierarchy

-> ModioUIClickableWidget-> Interface-> Object

Try Get Bound Action

Tries to get the bound action for the implementing object

nd_img_ModioUIBoundActionWidget_TryGetBoundAction.png

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

True if the bound action exists, false otherwise

Set Bound Action

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

nd_img_ModioUIBoundActionWidget_SetBoundAction.png

void SetBoundAction(FDataTableRowHandle InputActionRow)
Parameters
TargetModioUIBoundActionWidget
InputActionRowDelegate to invoke with hold progress
Remove Action Progress Handler

nd_img_ModioUIBoundActionWidget_RemoveActionProgressHandler.png

void RemoveActionProgressHandler(FModioBoundActionProgressed Handler)
Parameters
TargetModioUIBoundActionWidget
HandlerDelegate to unsubscribe
Remove Action Completed Handler

nd_img_ModioUIBoundActionWidget_RemoveActionCompletedHandler.png

void RemoveActionCompletedHandler(FModioBoundActionCompleted Handler)
Parameters
TargetModioUIBoundActionWidget
HandlerDelegate to unsubscribe
Clear Bound Action

Clears the bound action for the implementing object

nd_img_ModioUIBoundActionWidget_ClearBoundAction.png

void ClearBoundAction()
Parameters
TargetModioUIBoundActionWidget
Add Action Progress Handler

nd_img_ModioUIBoundActionWidget_AddActionProgressHandler.png

void AddActionProgressHandler(FModioBoundActionProgressed Handler)
Parameters
TargetModioUIBoundActionWidget
HandlerDelegate to invoke with hold progress
Add Action Completed Handler

nd_img_ModioUIBoundActionWidget_AddActionCompletedHandler.png

void AddActionCompletedHandler(FModioBoundActionCompleted Handler)
Parameters
TargetModioUIBoundActionWidget
HandlerDelegate to invoke on a hold completed event

ModioUIClickableWidget

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

Inheritance Hierarchy

-> Interface-> Object

Remove Clicked Handler

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

nd_img_ModioUIClickableWidget_RemoveClickedHandler.png

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

Enables click events being emitted by the implementing object

nd_img_ModioUIClickableWidget_EnableClick.png

void EnableClick()
Parameters
TargetModioUIClickableWidget
Disable Click

Disables click events being emitted by the implementing object

nd_img_ModioUIClickableWidget_DisableClick.png

void DisableClick()
Parameters
TargetModioUIClickableWidget
Add Clicked Handler

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

nd_img_ModioUIClickableWidget_AddClickedHandler.png

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

ModioUICommandLibrary

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

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object


ModioUICommandMenu

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

Inheritance Hierarchy

-> Interface-> Object

Remove Command List Builder

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

nd_img_ModioUICommandMenu_RemoveCommandListBuilder.png

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

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

nd_img_ModioUICommandMenu_RebuildCommandList.png

void RebuildCommandList()
Parameters
TargetModioUICommandMenu
Add Command List Builder

Registers a delegate to be invoked when RebuildCommandList is called

nd_img_ModioUICommandMenu_AddCommandListBuilder.png

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

ModioUICommandObject

Inheritance Hierarchy

-> Interface-> Object

Set Data Source

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

nd_img_ModioUICommandObject_SetDataSource.png

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

Retrieves the text to display for this command

nd_img_ModioUICommandObject_GetCommandDisplayString.png

FText GetCommandDisplayString()
Parameters
TargetModioUICommandObject
Returns

Localized display string for this command

Get Command Brush

Retrieves the brush to use as an icon for this command

nd_img_ModioUICommandObject_GetCommandBrush.png

FSlateBrush GetCommandBrush()
Parameters
TargetModioUICommandObject
Returns

The brush to use as an icon

Execute

Performs the command associated with this object

nd_img_ModioUICommandObject_Execute.png

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

Indicates if the command can currently be executed

nd_img_ModioUICommandObject_CanExecute.png

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

True if the command can be executed


ModioUICommonButtonWidget

Interface indicating the implementing widget can be configured like a CommonButton

Inheritance Hierarchy

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

Configure Common Button

Configures the implementing object as a CommonButton

nd_img_ModioUICommonButtonWidget_ConfigureCommonButton.png

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

ModioUICommonFunctionLibrary

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

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object


ModioUIComponentBase

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

Inheritance Hierarchy

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

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

ModioUIComponentStatics

Inheritance Hierarchy

-> Object


ModioUIConnectivityChangedReceiver

Inheritance Hierarchy

-> Interface-> Object


ModioUIDataSourceWidget

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

Inheritance Hierarchy

-> Interface-> Object

Set Data Source

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

nd_img_ModioUIDataSourceWidget_SetDataSource.png

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

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

nd_img_ModioUIDataSourceWidget_GetDataSource.png

UObject* GetDataSource()
Parameters
TargetModioUIDataSourceWidget
Returns

the object used as a data source


ModioUIDialog

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

Inheritance Hierarchy

-> Interface-> Object

Show Modal

Requests that the modal dialog be displayed

nd_img_ModioUIDialog_ShowModal.png

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

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

nd_img_ModioUIDialog_RemoveDialogShownHandler.png

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

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

nd_img_ModioUIDialog_RemoveDialogConfirmedHandler.png

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

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

nd_img_ModioUIDialog_RemoveDialogCanceledHandler.png

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

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

nd_img_ModioUIDialog_RemoveDialogButtonClickedHandler.png

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

Closes the modal dialog, removing it from display

nd_img_ModioUIDialog_CloseModal.png

void CloseModal()
Parameters
TargetModioUIDialog
Add Dialog Shown Handler

Registers a callback to receive notifications when the dialog is shown

nd_img_ModioUIDialog_AddDialogShownHandler.png

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

Registers a callback to receive notifications when the dialog is confirmed

nd_img_ModioUIDialog_AddDialogConfirmedHandler.png

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

Registers a callback to receive notifications when the dialog is canceled

nd_img_ModioUIDialog_AddDialogCanceledHandler.png

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

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

nd_img_ModioUIDialog_AddDialogButtonClickedHandler.png

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

ModioUIDialogDisplayEventReceiver

Inheritance Hierarchy

-> Interface-> Object


ModioUIDisplayFilteredModsCommand

Inheritance Hierarchy

-> Object

Set Filter Params

nd_img_ModioUIDisplayFilteredModsCommand_SetFilterParams.png

void SetFilterParams(FModioFilterParams FilterParams)
Set Display String Key

nd_img_ModioUIDisplayFilteredModsCommand_SetDisplayStringKey.png

void SetDisplayStringKey(FName InDisplayStringKey)

ModioUIEntitlementRefreshEventReceiver

Inheritance Hierarchy

-> Interface-> Object


ModioUIHasConfigurableColor

Inheritance Hierarchy

-> Interface-> Object

Configure Widget Color Directly

nd_img_ModioUIHasConfigurableColor_ConfigureWidgetColorDirectly.png

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

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

nd_img_ModioUIHasLoadStateWidget_SetLoadState.png

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

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

nd_img_ModioUIHasLoadStateWidget_RemoveLoadStateChangedHandler.png

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

Retrieves the implementing widget's current load state

nd_img_ModioUIHasLoadStateWidget_GetLoadState.png

EModioUILoadState GetLoadState() const
Parameters
TargetModioUIHasLoadStateWidget
Returns

The current load state for the widget

Add Load State Changed Handler

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

nd_img_ModioUIHasLoadStateWidget_AddLoadStateChangedHandler.png

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

ModioUIHasTextWidget

Interface indicating the implementing widget has a configurable Text

Inheritance Hierarchy

-> Interface-> Object

Set Widget Text Font

Sets the font for the implementing widget, if applicable

nd_img_ModioUIHasTextWidget_SetWidgetTextFont.png

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

Sets the value of the associated text for the implementing object

nd_img_ModioUIHasTextWidget_SetWidgetText.png

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

Retrieves the font for the implementing widget, if applicable

nd_img_ModioUIHasTextWidget_GetWidgetTextFont.png

FSlateFontInfo GetWidgetTextFont()
Parameters
TargetModioUIHasTextWidget
Returns

The font to use

Get Widget Text

Retrieves the value of the implementing widget's associated text

nd_img_ModioUIHasTextWidget_GetWidgetText.png

FText GetWidgetText()
Parameters
TargetModioUIHasTextWidget
Returns

The text value


ModioUIHasTooltipWidget

Interface indicating the implementing widget has a configurable tooltip

Inheritance Hierarchy

-> Interface-> Object

Set Tooltip Enabled State

Sets whether a tooltip is enabled on the implementing object

nd_img_ModioUIHasTooltipWidget_SetTooltipEnabledState.png

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

Configures the values for the associated tooltip for the implementing object

nd_img_ModioUIHasTooltipWidget_ConfigureTooltip.png

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

ModioUIHoverableWidget

Interface indicating the implementing widget can emit hover state change events

Inheritance Hierarchy

-> Interface-> Object

Remove Hover State Changed Handler

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

nd_img_ModioUIHoverableWidget_RemoveHoverStateChangedHandler.png

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

Enable emitting hover state changed events on the implementing object

nd_img_ModioUIHoverableWidget_EnableHoverEvents.png

void EnableHoverEvents()
Parameters
TargetModioUIHoverableWidget
Disable Hover Events

Disable emitting hover state changed events on the implementing object

nd_img_ModioUIHoverableWidget_DisableHoverEvents.png

void DisableHoverEvents()
Parameters
TargetModioUIHoverableWidget
Add Hover State Changed Handler

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

nd_img_ModioUIHoverableWidget_AddHoverStateChangedHandler.png

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

ModioUIImageDisplayWidget

Interface for widgets that display images

Inheritance Hierarchy

-> Interface-> Object

Set Desired Brush Size

Sets the desired size of the brush

nd_img_ModioUIImageDisplayWidget_SetDesiredBrushSize.png

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

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

nd_img_ModioUIImageDisplayWidget_SetBrushMatchTextureSize.png

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

Sets the brush directly

nd_img_ModioUIImageDisplayWidget_SetBrushDirectly.png

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

Unregisters a delegate, preventing it from receiving image loading callbacks

nd_img_ModioUIImageDisplayWidget_RemoveImageLoadEventHandler.png

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

Begins loading an image from a file path

nd_img_ModioUIImageDisplayWidget_BeginLoadImageFromFile.png

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

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

nd_img_ModioUIImageDisplayWidget_AddImageLoadEventHandler.png

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

ModioUIInputValidationLibrary

Static library of functions to validate text input

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object


ModioUIManageModSubscriptionCommand

Inheritance Hierarchy

-> Object


ModioUIMediaDownloadCompletedReceiver

Inheritance Hierarchy

-> Interface-> Object


ModioUIModEnabledStateChangedReceiver

Inheritance Hierarchy

-> Interface-> Object


ModioUIModEnabledStateProvider

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

Inheritance Hierarchy

-> Interface-> Object

Request Mod Enabled State Change

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

nd_img_ModioUIModEnabledStateProvider_RequestModEnabledStateChange.png

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

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

Remove Mod Enabled State Change Handler

nd_img_ModioUIModEnabledStateProvider_RemoveModEnabledStateChangeHandler.png

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

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

nd_img_ModioUIModEnabledStateProvider_QueryIsModEnabled.png

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

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

Add Mod Enabled State Change Handler

nd_img_ModioUIModEnabledStateProvider_AddModEnabledStateChangeHandler.png

void AddModEnabledStateChangeHandler(FModioModEnabledStateChangeHandler Handler)
Parameters
TargetModioUIModEnabledStateProvider
HandlerDelegate to be notified

ModioUIModInfoReceiver

Inheritance Hierarchy

-> Interface-> Object


ModioUIModListViewInterface

Interface for any widget that can visualise a list of mods

Inheritance Hierarchy

-> Interface-> Object

Set Mods from Mod Info List

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

nd_img_ModioUIModListViewInterface_SetModsFromModInfoList.png

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

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

nd_img_ModioUIModListViewInterface_SetModsFromModInfoArray.png

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

Populates the list based on the provided array of ModCollectionEntry objects

nd_img_ModioUIModListViewInterface_SetModsFromModCollectionEntryArray.png

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

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

nd_img_ModioUIModListViewInterface_SetModSelectionByID.png

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

ModioUIModManagementEventReceiver

Inheritance Hierarchy

-> Interface-> Object


ModioUIModTagSelector

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

Inheritance Hierarchy

-> Interface-> Object

Set Available Tags from Mod Tag Options

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

nd_img_ModioUIModTagSelector_SetAvailableTagsFromModTagOptions.png

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

Populates the tag selector using the pre-bound tag options

nd_img_ModioUIModTagSelector_SetAvailableTagsFromBoundModTagOptions.png

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

Unregisters a delegate so it no longer receives callbacks

nd_img_ModioUIModTagSelector_RemoveTagSelectionChangedHandler.png

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

Retrieves the selected tags from the implementing object

nd_img_ModioUIModTagSelector_GetSelectedTags.png

TArray<FString> GetSelectedTags()
Parameters
TargetModioUIModTagSelector
Returns

Array containing the selected tags' raw unlocalized values

Get Allow Locked Tags

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

nd_img_ModioUIModTagSelector_GetAllowLockedTags.png

bool GetAllowLockedTags()
Parameters
TargetModioUIModTagSelector
Get Allow Hidden Tags

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

nd_img_ModioUIModTagSelector_GetAllowHiddenTags.png

bool GetAllowHiddenTags()
Parameters
TargetModioUIModTagSelector
Clear Selected Tags

Clears the selection state of the selector

nd_img_ModioUIModTagSelector_ClearSelectedTags.png

void ClearSelectedTags()
Parameters
TargetModioUIModTagSelector
Add Tag Selection Changed Handler

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

nd_img_ModioUIModTagSelector_AddTagSelectionChangedHandler.png

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

ModioUIObjectListWidget

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

Inheritance Hierarchy

-> Interface-> Object

Set Objects

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

nd_img_ModioUIObjectListWidget_SetObjects.png

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

Unregisters a delegate from receiving object widget creation callbacks

nd_img_ModioUIObjectListWidget_RemoveObjectWidgetCreatedHandler.png

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

Retrieves the associated data source objects for the implementing widget

nd_img_ModioUIObjectListWidget_GetObjects.png

TArray<UObject*> GetObjects()
Parameters
TargetModioUIObjectListWidget
Returns

Array of UObject-derived objects used as a data source

Get Object At

Retrieves the object at a specific index in the data source

nd_img_ModioUIObjectListWidget_GetObjectAt.png

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

The object at the specified index

Get First Entry Widget

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

nd_img_ModioUIObjectListWidget_GetFirstEntryWidget.png

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

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

nd_img_ModioUIObjectListWidget_AddObjectWidgetCreatedHandler.png

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

ModioUIObjectSelector

Interface class for any widget that allows a choice between objects

Inheritance Hierarchy

-> Interface-> Object

Set Values

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

nd_img_ModioUIObjectSelector_SetValues.png

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

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

nd_img_ModioUIObjectSelector_SetSingleSelectionByValue.png

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

Sets the current selection for the implementing widget by index

nd_img_ModioUIObjectSelector_SetSingleSelectionByIndex.png

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

Sets the selected state for the specified value

nd_img_ModioUIObjectSelector_SetSelectedStateForValue.png

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

Sets the selected state for the specified index

nd_img_ModioUIObjectSelector_SetSelectedStateForIndex.png

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

Sets whether the implementing widget should allow multiple selections

nd_img_ModioUIObjectSelector_SetMultiSelectionAllowed.png

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

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

nd_img_ModioUIObjectSelector_SetListEntryWidgetClass.png

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

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

nd_img_ModioUIObjectSelector_RemoveSelectionChangedHandler.png

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

Retrieves the widget associated with the specified value

nd_img_ModioUIObjectSelector_GetWidgetForValue.png

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

The widget associated with the specified value

Get Single Selection Index

Gets the current selection for the implementing widget by index

nd_img_ModioUIObjectSelector_GetSingleSelectionIndex.png

int32 GetSingleSelectionIndex()
Parameters
TargetModioUIObjectSelector
Returns

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

Get Single Selected Value

Retrieves the selection of the implementing widget

nd_img_ModioUIObjectSelector_GetSingleSelectedValue.png

UObject* GetSingleSelectedValue()
Parameters
TargetModioUIObjectSelector
Returns

UObject associated with the current selection of the implementing widget

Get Selected Values

Retrieves the selected values from the implementing widget

nd_img_ModioUIObjectSelector_GetSelectedValues.png

TArray<UObject*> GetSelectedValues()
Parameters
TargetModioUIObjectSelector
Returns

Array of UObjects representing the selected values

Get Num Entries

Gets the number of entries in the implementing widget

nd_img_ModioUIObjectSelector_GetNumEntries.png

int32 GetNumEntries()
Parameters
TargetModioUIObjectSelector
Returns

The number of entries in the implementing widget

Get Multi Selection Allowed

Retrieves whether the implementing widget allows multiple selections

nd_img_ModioUIObjectSelector_GetMultiSelectionAllowed.png

bool GetMultiSelectionAllowed()
Parameters
TargetModioUIObjectSelector
Returns

True if multiple selections are allowed

Get Last Selection Index

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

nd_img_ModioUIObjectSelector_GetLastSelectionIndex.png

int32 GetLastSelectionIndex()
Parameters
TargetModioUIObjectSelector
Returns

The 0-based index of the previously selected object

Get Index for Value

Retrieves the index of the specified value

nd_img_ModioUIObjectSelector_GetIndexForValue.png

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

The 0-based index of the specified value

Clear Selected Values

Clears the selection state on the implementing widget

nd_img_ModioUIObjectSelector_ClearSelectedValues.png

void ClearSelectedValues()
Parameters
TargetModioUIObjectSelector
Add Selection Changed Handler

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

nd_img_ModioUIObjectSelector_AddSelectionChangedHandler.png

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

ModioUIPrioritizeModCommand

Inheritance Hierarchy

-> Object


ModioUIProgressWidget

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

Inheritance Hierarchy

-> Interface-> Object

Set Progress

Directly sets the current progress value of the implementing widget

nd_img_ModioUIProgressWidget_SetProgress.png

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

Sets whether the progress widget should be a marquee/throbber

nd_img_ModioUIProgressWidget_SetMarquee.png

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

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

nd_img_ModioUIProgressWidget_SetColorOverride.png

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

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

nd_img_ModioUIProgressWidget_RemoveValueChangedHandler.png

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

Retrieves the current progress value of the implementing widget

nd_img_ModioUIProgressWidget_GetProgress.png

float GetProgress()
Parameters
TargetModioUIProgressWidget
Returns

Progress Value in the range 0..1

Clear Color Override

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

nd_img_ModioUIProgressWidget_ClearColorOverride.png

void ClearColorOverride()
Parameters
TargetModioUIProgressWidget
Add Value Changed Handler

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

nd_img_ModioUIProgressWidget_AddValueChangedHandler.png

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

ModioUIPurchaseModCommand

Inheritance Hierarchy

-> Object


ModioUIReportModCommand

Inheritance Hierarchy

-> Object


ModioUISelectableWidget

Interface for widgets that have a selection state

Inheritance Hierarchy

-> Interface-> Object

Toggle Selected State

Toggles the selected state of the implementing widget

nd_img_ModioUISelectableWidget_ToggleSelectedState.png

void ToggleSelectedState()
Parameters
TargetModioUISelectableWidget
Set Toggleable

Enables or disables toggle-ability on the implementing widget

nd_img_ModioUISelectableWidget_SetToggleable.png

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

Directly sets the selected state of the implementing widget

nd_img_ModioUISelectableWidget_SetSelectedState.png

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

Sets the selectable state of the implementing widget

nd_img_ModioUISelectableWidget_SetSelectable.png

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

Unsubscribes a delegate from receiving state change callbacks

nd_img_ModioUISelectableWidget_RemoveSelectedStateChangedHandler.png

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

Retrieves the toggle-able state of the implementing widget

nd_img_ModioUISelectableWidget_GetToggleable.png

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

Retrieves the current selection state of the implementing widget

nd_img_ModioUISelectableWidget_GetSelectedState.png

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

Retrieves the selectable state of the implementing widget

nd_img_ModioUISelectableWidget_GetSelectable.png

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

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

nd_img_ModioUISelectableWidget_AddSelectedStateChangedHandler.png

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

ModioUISettings

Inheritance Hierarchy

-> Object

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

ModioUIStringInputWidget

Inheritance Hierarchy

-> Interface-> Object

Set Input

Directly sets/overrides the user input on the implementing widget

nd_img_ModioUIStringInputWidget_SetInput.png

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

Sets the hint text for the implementing widget

nd_img_ModioUIStringInputWidget_SetHint.png

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

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

nd_img_ModioUIStringInputWidget_RemoveTextCommittedHandler.png

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

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

nd_img_ModioUIStringInputWidget_RemoveTextChangedHandler.png

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

Retrieves the user's input from the implementing widget

nd_img_ModioUIStringInputWidget_GatherInput.png

FString GatherInput()
Parameters
TargetModioUIStringInputWidget
Returns

The string that the user provided

Add Text Committed Handler

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

nd_img_ModioUIStringInputWidget_AddTextCommittedHandler.png

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

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

nd_img_ModioUIStringInputWidget_AddTextChangedHandler.png

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

ModioUISubscriptionsChangedReceiver

Inheritance Hierarchy

-> Interface-> Object


ModioUISubsystem

The UI subsystem for mod.io

Inheritance Hierarchy

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

Set Mod Rating State Data Provider

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

nd_img_ModioUISubsystem_SetModRatingStateDataProvider.png

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

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

nd_img_ModioUISubsystem_SetModEnabledStateDataProvider.png

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

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

nd_img_ModioUISubsystem_RequestWalletBalanceRefreshWithHandler.png

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

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

nd_img_ModioUISubsystem_RequestWalletBalanceRefresh.png

void RequestWalletBalanceRefresh()
Parameters
TargetModioUISubsystem
Request User Avatar

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

nd_img_ModioUISubsystem_RequestUserAvatar.png

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

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

nd_img_ModioUISubsystem_RequestSubscriptionForModIDWithHandler.png

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

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

nd_img_ModioUISubsystem_RequestSubscriptionForModID.png

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

Attempts to invoke the store for the current platform.

nd_img_ModioUISubsystem_RequestShowTokenPurchaseUIWithHandler.png

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

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

Request Show Token Purchase UI

Attempts to invoke the store for the current platform.

nd_img_ModioUISubsystem_RequestShowTokenPurchaseUI.png

EModioOpenStoreResult RequestShowTokenPurchaseUI()
Parameters
TargetModioUISubsystem
Returns

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

Request Show Dialog

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

nd_img_ModioUISubsystem_RequestShowDialog.png

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

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

nd_img_ModioUISubsystem_RequestRemoveSubscriptionForModIDWithHandler.png

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

Unsubscribes the current user from the given ModId.

nd_img_ModioUISubsystem_RequestRemoveSubscriptionForModID.png

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

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

nd_img_ModioUISubsystem_RequestRefreshEntitlements.png

void RequestRefreshEntitlements()
Parameters
TargetModioUISubsystem
Request Purchase Token Pack

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

nd_img_ModioUISubsystem_RequestPurchaseTokenPack.png

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

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

Request Purchase for Mod IDWith Handler

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

nd_img_ModioUISubsystem_RequestPurchaseForModIDWithHandler.png

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

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

nd_img_ModioUISubsystem_RequestModInfoForModIDs.png

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

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

nd_img_ModioUISubsystem_RequestModEnabledStateChange.png

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

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

nd_img_ModioUISubsystem_RequestLogoDownloadForModID.png

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

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

nd_img_ModioUISubsystem_RequestListAllTokenPacks.png

void RequestListAllTokenPacks()
Parameters
TargetModioUISubsystem
Request List All Mods

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

nd_img_ModioUISubsystem_RequestListAllMods.png

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

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

nd_img_ModioUISubsystem_RequestGalleryImageDownloadForModID.png

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

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

nd_img_ModioUISubsystem_RequestEmailAuthenticationWithHandler.png

void RequestEmailAuthenticationWithHandler(FModioEmailAuthCode Code, FOnErrorOnlyDelegate Callback)
Parameters
TargetModioUISubsystem
CodeThe authentication code that has been entered.
CallbackThe callback to be executed upon completion.
Query Is Mod Enabled

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

nd_img_ModioUISubsystem_QueryIsModEnabled.png

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

Whether the Mod is enabled or not.

Query Connectivity State

Gets the current Connectivity State

nd_img_ModioUISubsystem_QueryConnectivityState.png

bool QueryConnectivityState()
Parameters
TargetModioUISubsystem
Returns

The current connectivity State.

Notify Connectivity Change

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

nd_img_ModioUISubsystem_NotifyConnectivityChange.png

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

Indicates whether a UGC subsystem feature is enabled

nd_img_ModioUISubsystem_IsUGCFeatureEnabled.png

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

bool indicating the state of the specified feature

Get Current DPIScale Value

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

nd_img_ModioUISubsystem_GetCurrentDPIScaleValue.png

float GetCurrentDPIScaleValue()
Parameters
TargetModioUISubsystem
Returns

The scale of the UI.

Enable Mod Management

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

nd_img_ModioUISubsystem_EnableModManagement.png

FModioErrorCode EnableModManagement()
Parameters
TargetModioUISubsystem
Returns

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

Disable Mod Management

Disables mod management.

nd_img_ModioUISubsystem_DisableModManagement.png

void DisableModManagement()
Parameters
TargetModioUISubsystem

ModioUISupportsCustomNavigation

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

Inheritance Hierarchy

-> Interface-> Object

Set Navigation Delegate

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

nd_img_ModioUISupportsCustomNavigation_SetNavigationDelegate.png

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

ModioUITextValidator

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

Inheritance Hierarchy

-> Interface-> Object

Validate Text

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

nd_img_ModioUITextValidator_ValidateText.png

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

SChange the validation error with new text

nd_img_ModioUITextValidator_SetValidationError.png

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

Unregisters a delegate so it no longer receives callbacks

nd_img_ModioUITextValidator_RemoveTextValidationCompletedHandler.png

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

SRetrieve the validation rules stored in this instance

nd_img_ModioUITextValidator_GetTextValidationRules.png

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

SRegisters a delegate to receive callbacks when text validation completes

nd_img_ModioUITextValidator_AddTextValidationCompletedHandler.png

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

ModioUIToggleModEnabledCommand

Inheritance Hierarchy

-> Object


ModioUITokenPackListInterface

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

Inheritance Hierarchy

-> Interface-> Object

Set Token Packs from Token Pack List

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

nd_img_ModioUITokenPackListInterface_SetTokenPacksFromTokenPackList.png

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

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

nd_img_ModioUITokenPackListInterface_SetTokenPacksFromTokenPackArray.png

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

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

nd_img_ModioUITokenPackListInterface_SetTokenPackSelectionByID.png

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

ModioUITokenPackReceiver

Inheritance Hierarchy

-> Interface-> Object


ModioUIUserAvatarDownloadCompletedReceiver

Inheritance Hierarchy

-> Interface-> Object


ModioUIUserChangedReceiver

Inheritance Hierarchy

-> Interface-> Object


ModioUIViewModCommand

Inheritance Hierarchy

-> Object


ModioUIWalletBalanceUpdatedEventReceiver

Inheritance Hierarchy

-> Interface-> Object


ModioUserDisplay

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

Inheritance Hierarchy

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

Variables
TObjectPtr<UObject>EditorDataSource

ModioUserUI

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

Inheritance Hierarchy

-> Object


ModioUserUIDetails

Inheritance Hierarchy

-> Interface-> Object

Get User ID

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

nd_img_ModioUserUIDetails_GetUserID.png

FModioUserID GetUserID()
Parameters
TargetModioUserUIDetails
Returns

User ID for the associated user

Get Full User

Queries the implementing object for the user that the object represents

nd_img_ModioUserUIDetails_GetFullUser.png

FModioUser GetFullUser()
Parameters
TargetModioUserUIDetails
Returns

FModioUser for the associated user


PropertyOverridesLibrary

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

Inheritance Hierarchy

-> BlueprintFunctionLibrary-> Object


WBP_DefaultTagButton

Inheritance Hierarchy

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

On Hovered

nd_img_WBP_DefaultTagButton_OnHovered.png

void OnHovered()
On Unhovered

nd_img_WBP_DefaultTagButton_OnUnhovered.png

void OnUnhovered()
Set Background Color

nd_img_WBP_DefaultTagButton_SetBackgroundColor.png

void SetBackgroundColor(FLinearColorRef NewColor)
Set Hovered Visual State

nd_img_WBP_DefaultTagButton_SetHoveredVisualState.png

void SetHoveredVisualState()
Set Normal Visual State

nd_img_WBP_DefaultTagButton_SetNormalVisualState.png

void SetNormalVisualState()
Set Selected Visual State

nd_img_WBP_DefaultTagButton_SetSelectedVisualState.png

void SetSelectedVisualState()
On Selection State Changed

nd_img_WBP_DefaultTagButton_OnSelectionStateChanged.png

void OnSelectionStateChanged(bool bNewSelectionState, FSlateBrush UnselectedBrush, FSlateBrush SelectedBrush)
Get Background Widget

nd_img_WBP_DefaultTagButton_GetBackgroundWidget.png

void GetBackgroundWidget(TScriptInterface<IModioUIHasConfigurableColor> Background) const
Variables
FLinearColorRefNormalColor
FLinearColorRefSelectedColor
FLinearColorRefHoveredColor

WBP_ModioActionBarButton

Inheritance Hierarchy

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

Variables

WBP_ModioActionWidgetButton

A button widget for triggering various actions across the UI.

Inheritance Hierarchy

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

Variables

WBP_ModioDefaultButton

A standard button used across the UI.

Inheritance Hierarchy

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

On Hovered

nd_img_WBP_ModioDefaultButton_OnHovered.png

void OnHovered()
On Unhovered

nd_img_WBP_ModioDefaultButton_OnUnhovered.png

void OnUnhovered()
Set Text Color

nd_img_WBP_ModioDefaultButton_SetTextColor.png

void SetTextColor(FLinearColorRef Target)
Set Hovered Visual State

nd_img_WBP_ModioDefaultButton_SetHoveredVisualState.png

void SetHoveredVisualState()
Set Normal Visual State

nd_img_WBP_ModioDefaultButton_SetNormalVisualState.png

void SetNormalVisualState()
Set Selected Visual State

nd_img_WBP_ModioDefaultButton_SetSelectedVisualState.png

void SetSelectedVisualState()
On Selection State Changed

nd_img_WBP_ModioDefaultButton_OnSelectionStateChanged.png

void OnSelectionStateChanged(bool bNewSelectionState)
Set Border

nd_img_WBP_ModioDefaultButton_SetBorder.png

void SetBorder(UBorder* AsBorder)
Set Text Size

nd_img_WBP_ModioDefaultButton_SetTextSize.png

void SetTextSize(FSlateFontInfo FontCopy)
Set Text Overrides

nd_img_WBP_ModioDefaultButton_SetTextOverrides.png

void SetTextOverrides()
Get Highlight Border Widget

nd_img_WBP_ModioDefaultButton_GetHighlightBorderWidget.png

void GetHighlightBorderWidget(TScriptInterface<IModioUIHasConfigurableColor> Border) const
Get Background Border Widget

nd_img_WBP_ModioDefaultButton_GetBackgroundBorderWidget.png

void GetBackgroundBorderWidget(TScriptInterface<IModioUIHasConfigurableColor> Border) const
Set Hover Border Color

nd_img_WBP_ModioDefaultButton_SetHoverBorderColor.png

void SetHoverBorderColor(FLinearColorRef NewColor)
Set Background Color

nd_img_WBP_ModioDefaultButton_SetBackgroundColor.png

void SetBackgroundColor(FLinearColorRef NewColor)
Set Border Brushes

nd_img_WBP_ModioDefaultButton_SetBorderBrushes.png

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

WBP_ModioDefaultCommandEntry

Represents a single command entry.

Inheritance Hierarchy

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

Item Selection Changed Handler

nd_img_WBP_ModioDefaultCommandEntry_ItemSelectionChangedHandler.png

void ItemSelectionChangedHandler(bool bIsSelected)
Variables

WBP_ModioDefaultCommandList

A list of available commands.

Inheritance Hierarchy

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

Set Values

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

nd_img_WBP_ModioDefaultCommandList_SetValues.png

void SetValues(TArray<UObject*> InValues)
Parameters
TargetWBP_ModioDefaultCommandList_C
InValuesArray of UObjects representing choices
Add Selection Changed Handler

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

nd_img_WBP_ModioDefaultCommandList_AddSelectionChangedHandler.png

void AddSelectionChangedHandler(FModioOnObjectSelectionChanged Handler)
Parameters
TargetWBP_ModioDefaultCommandList_C
HandlerDelegate to invoke on selection state change
Remove Selection Changed Handler

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

nd_img_WBP_ModioDefaultCommandList_RemoveSelectionChangedHandler.png

void RemoveSelectionChangedHandler(FModioOnObjectSelectionChanged Handler)
Parameters
TargetWBP_ModioDefaultCommandList_C
HandlerDelegate that will no longer receive callbacks
Set Selected State for Index

Sets the selected state for the specified index

nd_img_WBP_ModioDefaultCommandList_SetSelectedStateForIndex.png

void SetSelectedStateForIndex(int32 Index, bool bNewSelectionState, bool bEmitSelectionEvent)
Parameters
TargetWBP_ModioDefaultCommandList_C
IndexThe 0-based index to set the selection state for
bNewSelectionStateThe new selection state to set
bEmitSelectionEventTrue if a selection changed event should be emitted
On Entry Clicked

nd_img_WBP_ModioDefaultCommandList_OnEntryClicked.png

void OnEntryClicked(UObject* ClickContext)
Get Command List Widget

nd_img_WBP_ModioDefaultCommandList_GetCommandListWidget.png

TScriptInterface<IModioUIObjectSelector> GetCommandListWidget() const
On Set Values

nd_img_WBP_ModioDefaultCommandList_OnSetValues.png

void OnSetValues(TArray<UObject*> InValues, int32 SelectionIndex)
Get Command List Widget Object List

nd_img_WBP_ModioDefaultCommandList_GetCommandListWidget_ObjectList.png

TScriptInterface<IModioUIObjectListWidget> GetCommandListWidget_ObjectList() const
On Entry Generated

nd_img_WBP_ModioDefaultCommandList_OnEntryGenerated.png

void OnEntryGenerated(UWidget* ObjectWidget, UObject* Object)
On Set Selected State for Index

nd_img_WBP_ModioDefaultCommandList_OnSetSelectedStateForIndex.png

void OnSetSelectedStateForIndex(int32 Index, bool NewSelectionState, bool EmitSelectionEvent)
Get Single Selected Value

Retrieves the selection of the implementing widget

nd_img_WBP_ModioDefaultCommandList_GetSingleSelectedValue.png

UObject* GetSingleSelectedValue()
Parameters
TargetWBP_ModioDefaultCommandList_C
Returns

UObject associated with the current selection of the implementing widget

Get Selected Values

Retrieves the selected values from the implementing widget

nd_img_WBP_ModioDefaultCommandList_GetSelectedValues.png

TArray<UObject*> GetSelectedValues()
Parameters
TargetWBP_ModioDefaultCommandList_C
Returns

Array of UObjects representing the selected values

Get Multi Selection Allowed

Retrieves whether the implementing widget allows multiple selections

nd_img_WBP_ModioDefaultCommandList_GetMultiSelectionAllowed.png

bool GetMultiSelectionAllowed()
Parameters
TargetWBP_ModioDefaultCommandList_C
Returns

True if multiple selections are allowed

Get Single Selection Index

Gets the current selection for the implementing widget by index

nd_img_WBP_ModioDefaultCommandList_GetSingleSelectionIndex.png

int32 GetSingleSelectionIndex()
Parameters
TargetWBP_ModioDefaultCommandList_C
Returns

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

Get Num Entries

Gets the number of entries in the implementing widget

nd_img_WBP_ModioDefaultCommandList_GetNumEntries.png

int32 GetNumEntries()
Parameters
TargetWBP_ModioDefaultCommandList_C
Returns

The number of entries in the implementing widget

Get Index for Value

Retrieves the index of the specified value

nd_img_WBP_ModioDefaultCommandList_GetIndexForValue.png

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

The 0-based index of the specified value

Get Widget for Value

Retrieves the widget associated with the specified value

nd_img_WBP_ModioDefaultCommandList_GetWidgetForValue.png

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

The widget associated with the specified value

Set Single Selection by Value

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

nd_img_WBP_ModioDefaultCommandList_SetSingleSelectionByValue.png

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

Sets the current selection for the implementing widget by index

nd_img_WBP_ModioDefaultCommandList_SetSingleSelectionByIndex.png

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

Sets the selected state for the specified value

nd_img_WBP_ModioDefaultCommandList_SetSelectedStateForValue.png

void SetSelectedStateForValue(UObject* Value, bool bNewSelectionState, bool bEmitSelectionEvent)
Parameters
TargetWBP_ModioDefaultCommandList_C
ValueThe value to set the selection state for
bNewSelectionStateThe new selection state to set
bEmitSelectionEventTrue if a selection changed event should be emitted
Set Multi Selection Allowed

Sets whether the implementing widget should allow multiple selections

nd_img_WBP_ModioDefaultCommandList_SetMultiSelectionAllowed.png

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

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

nd_img_WBP_ModioDefaultCommandList_SetListEntryWidgetClass.png

void SetListEntryWidgetClass(TSubclassOf<UWidget>  InNewEntryClass)
Parameters
TargetWBP_ModioDefaultCommandList_C
InNewEntryClassThe class to use for list entries
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.

nd_img_WBP_ModioDefaultCommandList_GetLastSelectionIndex.png

int32 GetLastSelectionIndex()
Parameters
TargetWBP_ModioDefaultCommandList_C
Returns

The 0-based index of the previously selected object

Clear Selected Values

Clears the selection state on the implementing widget

nd_img_WBP_ModioDefaultCommandList_ClearSelectedValues.png

void ClearSelectedValues()
Parameters
TargetWBP_ModioDefaultCommandList_C
Variables
FOnSelectionChangedOnSelectionChanged

WBP_ModioDefaultCommandMenu

A menu displaying a list of commands.

Inheritance Hierarchy

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

Get Background Widget

nd_img_WBP_ModioDefaultCommandMenu_GetBackgroundWidget.png

void GetBackgroundWidget(TScriptInterface<IModioUIHasConfigurableColor> BackgroundWidget) const
Variables
FLinearColorRefBackgroundColor

WBP_ModioDefaultConfirmPurchaseDialog

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

Inheritance Hierarchy

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

Set Load State

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

nd_img_WBP_ModioDefaultConfirmPurchaseDialog_SetLoadState.png

void SetLoadState(EModioUILoadState NewState)
Parameters
TargetWBP_ModioDefaultConfirmPurchaseDialog_C
NewStatethe new state to change to
On Set Data Source

nd_img_WBP_ModioDefaultConfirmPurchaseDialog_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource, FString RawModName, FModioModID CurrentModID, FModioUnsigned64 CurrentModPrice)
Logo Download Completed Handler

nd_img_WBP_ModioDefaultConfirmPurchaseDialog_LogoDownloadCompletedHandler.png

void LogoDownloadCompletedHandler(FModioModID ModID, FModioErrorCode ErrorCode, FModioOptionalImage Image, EModioLogoSize Size)
On Dialog Button Clicked

nd_img_WBP_ModioDefaultConfirmPurchaseDialog_OnDialogButtonClicked.png

void OnDialogButtonClicked(int32 ButtonIndex)
Confirm Dialog Handler

nd_img_WBP_ModioDefaultConfirmPurchaseDialog_ConfirmDialogHandler.png

void ConfirmDialogHandler()
Cancel Dialog Handler

nd_img_WBP_ModioDefaultConfirmPurchaseDialog_CancelDialogHandler.png

void CancelDialogHandler()
On Request Purchase Mod Complete

nd_img_WBP_ModioDefaultConfirmPurchaseDialog_OnRequestPurchaseModComplete.png

void OnRequestPurchaseModComplete(FModioErrorCode ErrorCode, FModioOptionalTransactionRecord Transaction)
Get Confirm Purchase Dialog Impl Widget

nd_img_WBP_ModioDefaultConfirmPurchaseDialog_GetConfirmPurchaseDialogImplWidget.png

TScriptInterface<IModioUIDialog> GetConfirmPurchaseDialogImplWidget() const
Get Mod Name Widget

nd_img_WBP_ModioDefaultConfirmPurchaseDialog_GetModNameWidget.png

TScriptInterface<IModioUIHasTextWidget> GetModNameWidget() const
Get Mod Price Widget

nd_img_WBP_ModioDefaultConfirmPurchaseDialog_GetModPriceWidget.png

TScriptInterface<IModioUIHasTextWidget> GetModPriceWidget() const
Get Mod Logo Widget

nd_img_WBP_ModioDefaultConfirmPurchaseDialog_GetModLogoWidget.png

TScriptInterface<IModioUIImageDisplayWidget> GetModLogoWidget() const
On Load State Changed

nd_img_WBP_ModioDefaultConfirmPurchaseDialog_OnLoadStateChanged.png

void OnLoadStateChanged(EModioUILoadState NewState)
Get Wait Dialog Stack Widget

nd_img_WBP_ModioDefaultConfirmPurchaseDialog_GetWaitDialogStackWidget.png

void GetWaitDialogStackWidget(UCommonActivatableWidgetStack* WidgetStack) const
Get Wallet Button Widget

nd_img_WBP_ModioDefaultConfirmPurchaseDialog_GetWalletButtonWidget.png

void GetWalletButtonWidget(TScriptInterface<IModioUIClickableWidget> Button) const
On Wallet Button Clicked

![nd_img_WBP_ModioDefaultConfirmPurchaseDialog_On Wallet Button Clicked.png](img/refdocs/nd_img_WBP_ModioDefaultConfirmPurchaseDialog_On Wallet Button Clicked.png)

void On Wallet Button Clicked(UObject* ClickContext)
Open Store Result Handler

![nd_img_WBP_ModioDefaultConfirmPurchaseDialog_Open Store Result Handler.png](img/refdocs/nd_img_WBP_ModioDefaultConfirmPurchaseDialog_Open Store Result Handler.png)

void Open Store Result Handler(bool bResult, FString Message)
Wallet Balance Updated Handler

nd_img_WBP_ModioDefaultConfirmPurchaseDialog_WalletBalanceUpdatedHandler.png

void WalletBalanceUpdatedHandler(FModioUnsigned64 WalletBalance)
Get Token Icon Widget

nd_img_WBP_ModioDefaultConfirmPurchaseDialog_GetTokenIconWidget.png

TScriptInterface<IModioUIHasConfigurableColor> GetTokenIconWidget() const
Get Load State

Retrieves the implementing widget's current load state

nd_img_WBP_ModioDefaultConfirmPurchaseDialog_GetLoadState.png

EModioUILoadState GetLoadState() const
Parameters
TargetWBP_ModioDefaultConfirmPurchaseDialog_C
Returns

The current load state for the widget

Remove Load State Changed Handler

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

nd_img_WBP_ModioDefaultConfirmPurchaseDialog_RemoveLoadStateChangedHandler.png

void RemoveLoadStateChangedHandler(FModioOnLoadStateWidgetStateChanged Handler)
Parameters
TargetWBP_ModioDefaultConfirmPurchaseDialog_C
HandlerThe delegate to unregister
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

nd_img_WBP_ModioDefaultConfirmPurchaseDialog_AddLoadStateChangedHandler.png

void AddLoadStateChangedHandler(FModioOnLoadStateWidgetStateChanged Handler)
Parameters
TargetWBP_ModioDefaultConfirmPurchaseDialog_C
HandlerDelegate to invoke on a state change event
Variables
FOnDialogConfirmedOnDialogConfirmed
FOnDialogCanceledOnDialogCanceled
EModioUILoadStatePurchaseResultsLoadingState
FLinearColorRefTokenIconColor

WBP_ModioDefaultDialogButton

A button used within dialog windows.

Inheritance Hierarchy

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

On Set Data Source

nd_img_WBP_ModioDefaultDialogButton_OnSetDataSource.png

void OnSetDataSource(UObject* NewDataSource)
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

Add Dialog Confirmed Handler

Registers a callback to receive notifications when the dialog is confirmed

nd_img_WBP_ModioDefaultEmailAuthDialog_AddDialogConfirmedHandler.png

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

Registers a callback to receive notifications when the dialog is canceled

nd_img_WBP_ModioDefaultEmailAuthDialog_AddDialogCanceledHandler.png

void AddDialogCanceledHandler(FModioDialogEvent Handler)
Parameters
TargetWBP_ModioDefaultEmailAuthDialog_C
HandlerDelegate to invoke on a cancellation event
Transition to Email Subdialog

nd_img_WBP_ModioDefaultEmailAuthDialog_TransitionToEmailSubdialog.png

void TransitionToEmailSubdialog()
Transition to Code Subdialog

nd_img_WBP_ModioDefaultEmailAuthDialog_TransitionToCodeSubdialog.png

void TransitionToCodeSubdialog()
Bind Button Clicked Handlers

nd_img_WBP_ModioDefaultEmailAuthDialog_BindButtonClickedHandlers.png

void BindButtonClickedHandlers()
On Send Code Clicked

nd_img_WBP_ModioDefaultEmailAuthDialog_OnSendCodeClicked.png

void OnSendCodeClicked(UObject* ClickContext)
On Change Email Clicked

nd_img_WBP_ModioDefaultEmailAuthDialog_OnChangeEmailClicked.png

void OnChangeEmailClicked(UObject* ClickContext)
On Submit Code Clicked

nd_img_WBP_ModioDefaultEmailAuthDialog_OnSubmitCodeClicked.png

void OnSubmitCodeClicked(UObject* ClickContext)
On Email Code Requested

nd_img_WBP_ModioDefaultEmailAuthDialog_OnEmailCodeRequested.png

void OnEmailCodeRequested(FModioErrorCode ErrorCode)
On Enter Code Directly Clicked

nd_img_WBP_ModioDefaultEmailAuthDialog_OnEnterCodeDirectlyClicked.png

void OnEnterCodeDirectlyClicked(UObject* ClickContext)
On Cancel Button Clicked

nd_img_WBP_ModioDefaultEmailAuthDialog_OnCancelButtonClicked.png

void OnCancelButtonClicked(UObject* ClickContext)

nd_img_WBP_ModioDefaultEmailAuthDialog_DoNavigateToFooter.png

UWidget* DoNavigateToFooter(EUINavigation Navigation)

nd_img_WBP_ModioDefaultEmailAuthDialog_DoNavigationFromFooterToPrimary.png

UWidget* DoNavigationFromFooterToPrimary(EUINavigation Navigation)
Get Email Input Widget

nd_img_WBP_ModioDefaultEmailAuthDialog_GetEmailInputWidget.png

TScriptInterface<IModioUIStringInputWidget> GetEmailInputWidget() const
Get Code Input Widget

nd_img_WBP_ModioDefaultEmailAuthDialog_GetCodeInputWidget.png

TScriptInterface<IModioUIStringInputWidget> GetCodeInputWidget() const
Get Send Code Button Widget

nd_img_WBP_ModioDefaultEmailAuthDialog_GetSendCodeButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetSendCodeButtonWidget() const
Get Change Email Button Widget

nd_img_WBP_ModioDefaultEmailAuthDialog_GetChangeEmailButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetChangeEmailButtonWidget() const
Get Submit Code Button Widget

nd_img_WBP_ModioDefaultEmailAuthDialog_GetSubmitCodeButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetSubmitCodeButtonWidget() const
Get Enter Code Button Widget

nd_img_WBP_ModioDefaultEmailAuthDialog_GetEnterCodeButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetEnterCodeButtonWidget() const
Get Cancel Email Button Widget

nd_img_WBP_ModioDefaultEmailAuthDialog_GetCancelEmailButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetCancelEmailButtonWidget() const
Get Cancel Code Button Widget

nd_img_WBP_ModioDefaultEmailAuthDialog_GetCancelCodeButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetCancelCodeButtonWidget() const
Get Sub Dialog Switcher Widget

nd_img_WBP_ModioDefaultEmailAuthDialog_GetSubDialogSwitcherWidget.png

void GetSubDialogSwitcherWidget(UWidgetSwitcher* Switcher) const
Get Terms Button Group Widget

nd_img_WBP_ModioDefaultEmailAuthDialog_GetTermsButtonGroupWidget.png

void GetTermsButtonGroupWidget(TScriptInterface<IModioUIDataSourceWidget> NewParam) const
On Email Authentication Complete

nd_img_WBP_ModioDefaultEmailAuthDialog_OnEmailAuthenticationComplete.png

void OnEmailAuthenticationComplete(FModioErrorCode ErrorCode)
Get Email Input Error Text Widget

nd_img_WBP_ModioDefaultEmailAuthDialog_GetEmailInputErrorTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetEmailInputErrorTextWidget() const
Get Code Input Error Text Widget

nd_img_WBP_ModioDefaultEmailAuthDialog_GetCodeInputErrorTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetCodeInputErrorTextWidget() const
Get Invisible Focus Button Email Input Widget

nd_img_WBP_ModioDefaultEmailAuthDialog_GetInvisibleFocusButtonEmailInputWidget.png

UWidget* GetInvisibleFocusButtonEmailInputWidget() const
Get Invisible Focus Button Code Input Widget

nd_img_WBP_ModioDefaultEmailAuthDialog_GetInvisibleFocusButtonCodeInputWidget.png

UWidget* GetInvisibleFocusButtonCodeInputWidget() const
Show Modal

Requests that the modal dialog be displayed

nd_img_WBP_ModioDefaultEmailAuthDialog_ShowModal.png

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

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

nd_img_WBP_ModioDefaultEmailAuthDialog_RemoveDialogShownHandler.png

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

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

nd_img_WBP_ModioDefaultEmailAuthDialog_RemoveDialogConfirmedHandler.png

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

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

nd_img_WBP_ModioDefaultEmailAuthDialog_RemoveDialogCanceledHandler.png

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

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

nd_img_WBP_ModioDefaultEmailAuthDialog_RemoveDialogButtonClickedHandler.png

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

Closes the modal dialog, removing it from display

nd_img_WBP_ModioDefaultEmailAuthDialog_CloseModal.png

void CloseModal()
Parameters
TargetWBP_ModioDefaultEmailAuthDialog_C
Add Dialog Shown Handler

Registers a callback to receive notifications when the dialog is shown

nd_img_WBP_ModioDefaultEmailAuthDialog_AddDialogShownHandler.png

void AddDialogShownHandler(FModioDialogShownEvent Handler)
Parameters
TargetWBP_ModioDefaultEmailAuthDialog_C
HandlerDelegate to invoke after the dialog is shown
Add Dialog Button Clicked Handler

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

nd_img_WBP_ModioDefaultEmailAuthDialog_AddDialogButtonClickedHandler.png

void AddDialogButtonClickedHandler(FModioDialogButtonClickedEvent Handler)
Parameters
TargetWBP_ModioDefaultEmailAuthDialog_C
HandlerDelegate to invoke when a button is clicked
Variables
int32EmailInputSubdialogIndex
int32CodeInputSubdialogIndex
FOnDialogConfirmedOnDialogConfirmed
FOnDialogCancelledOnDialogCancelled

WBP_ModioDefaultEnumSelectorEntry

An entry that represents a single selectable enum option.

Inheritance Hierarchy

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

Variables

WBP_ModioDefaultEnumSelectorMenu

A menu that displays selectable enum options.

Inheritance Hierarchy

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

Get Background Widget

nd_img_WBP_ModioDefaultEnumSelectorMenu_GetBackgroundWidget.png

void GetBackgroundWidget(TScriptInterface<IModioUIHasConfigurableColor> BackgroundWidget) const
Variables
FLinearColorRefBackgroundColor

WBP_ModioDefaultIconButton

A button that displays only an icon, without text.

Inheritance Hierarchy

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

On Hovered

nd_img_WBP_ModioDefaultIconButton_OnHovered.png

void OnHovered()
On Unhovered

nd_img_WBP_ModioDefaultIconButton_OnUnhovered.png

void OnUnhovered()
Set Text Color

nd_img_WBP_ModioDefaultIconButton_SetTextColor.png

void SetTextColor(FLinearColorRef Target)
Set Hovered Visual State

nd_img_WBP_ModioDefaultIconButton_SetHoveredVisualState.png

void SetHoveredVisualState()
Set Normal Visual State

nd_img_WBP_ModioDefaultIconButton_SetNormalVisualState.png

void SetNormalVisualState()
Set Selected Visual State

nd_img_WBP_ModioDefaultIconButton_SetSelectedVisualState.png

void SetSelectedVisualState()
On Selection State Changed

nd_img_WBP_ModioDefaultIconButton_OnSelectionStateChanged.png

void OnSelectionStateChanged(bool bNewSelectionState)
Set Icon Side

nd_img_WBP_ModioDefaultIconButton_SetIconSide.png

void SetIconSide()
Apply Content Alignment Override

nd_img_WBP_ModioDefaultIconButton_ApplyContentAlignmentOverride.png

void ApplyContentAlignmentOverride()
Set Icon Color

nd_img_WBP_ModioDefaultIconButton_SetIconColor.png

void SetIconColor(FLinearColorRef Target, FSlateBrush DynamicIconBrush)
Get Highlight Border Widget

nd_img_WBP_ModioDefaultIconButton_GetHighlightBorderWidget.png

void GetHighlightBorderWidget(TScriptInterface<IModioUIHasConfigurableColor> Border) const
Get Background Border Widget

nd_img_WBP_ModioDefaultIconButton_GetBackgroundBorderWidget.png

void GetBackgroundBorderWidget(TScriptInterface<IModioUIHasConfigurableColor> Border) const
Set Background Color

nd_img_WBP_ModioDefaultIconButton_SetBackgroundColor.png

void SetBackgroundColor(FLinearColorRef NewColor)
Set Hover Border Color

nd_img_WBP_ModioDefaultIconButton_SetHoverBorderColor.png

void SetHoverBorderColor(FLinearColorRef NewColor)
Freeze Border Color

nd_img_WBP_ModioDefaultIconButton_FreezeBorderColor.png

void FreezeBorderColor(bool bFreeze, FLinearColorRef ColorToFreeze)
Set Border

nd_img_WBP_ModioDefaultIconButton_SetBorder.png

void SetBorder(UBorder* AsBorder)
Set Border Brushes

nd_img_WBP_ModioDefaultIconButton_SetBorderBrushes.png

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

WBP_ModioDefaultInsufficientTokensDialog

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

Inheritance Hierarchy

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

On Set Data Source

nd_img_WBP_ModioDefaultInsufficientTokensDialog_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource, FString RawModName, FModioModID CurrentModID, FModioUnsigned64 CurrentModPrice)
Logo Download Completed Handler

nd_img_WBP_ModioDefaultInsufficientTokensDialog_LogoDownloadCompletedHandler.png

void LogoDownloadCompletedHandler(FModioModID ModID, FModioErrorCode ErrorCode, FModioOptionalImage Image, EModioLogoSize Size)
Get Insufficient Dialog Impl Widget

nd_img_WBP_ModioDefaultInsufficientTokensDialog_GetInsufficientDialogImplWidget.png

void GetInsufficientDialogImplWidget(TScriptInterface<IModioUIDialog> DialogImplWidget) const
Get Mod Logo Image Widget

nd_img_WBP_ModioDefaultInsufficientTokensDialog_GetModLogoImageWidget.png

void GetModLogoImageWidget(TScriptInterface<IModioUIImageDisplayWidget> LogoWidget) const
Get Mod Name Label Widget

nd_img_WBP_ModioDefaultInsufficientTokensDialog_GetModNameLabelWidget.png

void GetModNameLabelWidget(TScriptInterface<IModioUIHasTextWidget> ModNameWidget) const
Get Mod Price Label Widget

nd_img_WBP_ModioDefaultInsufficientTokensDialog_GetModPriceLabelWidget.png

void GetModPriceLabelWidget(TScriptInterface<IModioUIHasTextWidget> ModPriceWidget) const
Get Wallet Button Widget

nd_img_WBP_ModioDefaultInsufficientTokensDialog_GetWalletButtonWidget.png

void GetWalletButtonWidget(TScriptInterface<IModioUIClickableWidget> StoreButton) const
On Open Store Button Clicked

nd_img_WBP_ModioDefaultInsufficientTokensDialog_OnOpenStoreButtonClicked.png

void OnOpenStoreButtonClicked(UObject* ClickContext)
Open Store Result Handler

nd_img_WBP_ModioDefaultInsufficientTokensDialog_OpenStoreResultHandler.png

void OpenStoreResultHandler(bool bResult, FString Message)
Open Store

nd_img_WBP_ModioDefaultInsufficientTokensDialog_OpenStore.png

void OpenStore()
Get Token Pack Button Widget

nd_img_WBP_ModioDefaultInsufficientTokensDialog_GetTokenPackButtonWidget.png

void GetTokenPackButtonWidget(TScriptInterface<IModioUIClickableWidget> Button) const
Get Cancel Button Widget

nd_img_WBP_ModioDefaultInsufficientTokensDialog_GetCancelButtonWidget.png

void GetCancelButtonWidget(TScriptInterface<IModioUIClickableWidget> Button)
On Cancel Button Clicked

nd_img_WBP_ModioDefaultInsufficientTokensDialog_OnCancelButtonClicked.png

void OnCancelButtonClicked(UObject* ClickContext)
Wallet Balance Updated Handler

nd_img_WBP_ModioDefaultInsufficientTokensDialog_WalletBalanceUpdatedHandler.png

void WalletBalanceUpdatedHandler(FModioUnsigned64 Balance)
Show Modal

Requests that the modal dialog be displayed

nd_img_WBP_ModioDefaultInsufficientTokensDialog_ShowModal.png

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

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

nd_img_WBP_ModioDefaultInsufficientTokensDialog_RemoveDialogShownHandler.png

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

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

nd_img_WBP_ModioDefaultInsufficientTokensDialog_RemoveDialogConfirmedHandler.png

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

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

nd_img_WBP_ModioDefaultInsufficientTokensDialog_RemoveDialogCanceledHandler.png

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

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

nd_img_WBP_ModioDefaultInsufficientTokensDialog_RemoveDialogButtonClickedHandler.png

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

Closes the modal dialog, removing it from display

nd_img_WBP_ModioDefaultInsufficientTokensDialog_CloseModal.png

void CloseModal()
Parameters
TargetWBP_ModioDefaultInsufficientTokensDialog_C
Add Dialog Shown Handler

Registers a callback to receive notifications when the dialog is shown

nd_img_WBP_ModioDefaultInsufficientTokensDialog_AddDialogShownHandler.png

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

Registers a callback to receive notifications when the dialog is confirmed

nd_img_WBP_ModioDefaultInsufficientTokensDialog_AddDialogConfirmedHandler.png

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

Registers a callback to receive notifications when the dialog is canceled

nd_img_WBP_ModioDefaultInsufficientTokensDialog_AddDialogCanceledHandler.png

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

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

nd_img_WBP_ModioDefaultInsufficientTokensDialog_AddDialogButtonClickedHandler.png

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

WBP_ModioDefaultModDependenciesConfirmDialog

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

Inheritance Hierarchy

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

Add Dialog Confirmed Handler

Registers a callback to receive notifications when the dialog is confirmed

nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_AddDialogConfirmedHandler.png

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

Registers a callback to receive notifications when the dialog is canceled

nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_AddDialogCanceledHandler.png

void AddDialogCanceledHandler(FModioDialogEvent Handler)
Parameters
TargetWBP_ModioDefaultModDependenciesConfirmDialog_C
HandlerDelegate to invoke on a cancellation event
Remove Dialog Confirmed Handler

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

nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_RemoveDialogConfirmedHandler.png

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

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

nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_RemoveDialogCanceledHandler.png

void RemoveDialogCanceledHandler(FModioDialogEvent Handler)
Parameters
TargetWBP_ModioDefaultModDependenciesConfirmDialog_C
HandlerDelegate that will no longer receive cancellation events
On Set Data Source

nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource, FString RawModName, int32 CurrentModPrice, FString CurrentModName, FModioUnsigned64 CurrentModSizeOnDisk)
On Dialog Button Clicked

nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_OnDialogButtonClicked.png

void OnDialogButtonClicked(int32 ButtonIndex)
On Mod Dependencies Fetched

nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_OnModDependenciesFetched.png

void OnModDependenciesFetched(FModioErrorCode ErrorCode, FModioOptionalModDependencyList Dependencies, TArray<FModioModID> DependencyIDs, FModioModDependencyList DependencyList)
Get Dependency Mod List Widget

nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_GetDependencyModListWidget.png

TScriptInterface<IModioUIObjectSelector> GetDependencyModListWidget() const
Get Dependencies Dialog Widget

nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_GetDependenciesDialogWidget.png

TScriptInterface<IModioUIDialog> GetDependenciesDialogWidget() const
Get Mod Name Widget

nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_GetModNameWidget.png

TScriptInterface<IModioUIHasTextWidget> GetModNameWidget() const
Get Mod Size Widget

nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_GetModSizeWidget.png

TScriptInterface<IModioUIHasTextWidget> GetModSizeWidget()
On Confirm Subscription

![nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_On Confirm Subscription.png](img/refdocs/nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_On Confirm Subscription.png)

void On Confirm Subscription()
On Fetch External Updates Complete

![nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_On Fetch External Updates Complete.png](img/refdocs/nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_On Fetch External Updates Complete.png)

void On Fetch External Updates Complete(FModioErrorCode ErrorCode)
Do Navigation to Dialog

nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_DoNavigationToDialog.png

UWidget* DoNavigationToDialog(EUINavigation Navigation)
Get Total Background Border

nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_GetTotalBackgroundBorder.png

void GetTotalBackgroundBorder(TScriptInterface<IModioUIHasConfigurableColor> NewParam) const
Get Total Mod Size Text Widget

nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_GetTotalModSizeTextWidget.png

void GetTotalModSizeTextWidget(TScriptInterface<IModioUIHasTextWidget> TextWidget) const
On Mod Logo Fetched

nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_OnModLogoFetched.png

void OnModLogoFetched(FModioErrorCode ErrorCode, FModioOptionalImage Path)
Get Mod Logo Widget

nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_GetModLogoWidget.png

TScriptInterface<IModioUIImageDisplayWidget> GetModLogoWidget() const
Show Modal

Requests that the modal dialog be displayed

nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_ShowModal.png

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

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

nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_RemoveDialogShownHandler.png

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

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

nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_RemoveDialogButtonClickedHandler.png

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

Closes the modal dialog, removing it from display

nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_CloseModal.png

void CloseModal()
Parameters
TargetWBP_ModioDefaultModDependenciesConfirmDialog_C
Add Dialog Shown Handler

Registers a callback to receive notifications when the dialog is shown

nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_AddDialogShownHandler.png

void AddDialogShownHandler(FModioDialogShownEvent Handler)
Parameters
TargetWBP_ModioDefaultModDependenciesConfirmDialog_C
HandlerDelegate to invoke after the dialog is shown
Add Dialog Button Clicked Handler

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

nd_img_WBP_ModioDefaultModDependenciesConfirmDialog_AddDialogButtonClickedHandler.png

void AddDialogButtonClickedHandler(FModioDialogButtonClickedEvent Handler)
Parameters
TargetWBP_ModioDefaultModDependenciesConfirmDialog_C
HandlerDelegate to invoke when a button is clicked
Variables
FOnDialogConfirmedOnDialogConfirmed
FOnDialogCanceledOnDialogCanceled
FLinearColorRefTotalBackgroundColor
FModioModIDCurrentModID
doubleTargetModDependencyListScrollOffset
FModioUnsigned64TotalSizeToInstall

WBP_ModioDefaultModDependenciesDisplayDialog

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

Inheritance Hierarchy

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

Add Dialog Confirmed Handler

Registers a callback to receive notifications when the dialog is confirmed

nd_img_WBP_ModioDefaultModDependenciesDisplayDialog_AddDialogConfirmedHandler.png

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

Registers a callback to receive notifications when the dialog is canceled

nd_img_WBP_ModioDefaultModDependenciesDisplayDialog_AddDialogCanceledHandler.png

void AddDialogCanceledHandler(FModioDialogEvent Handler)
Parameters
TargetWBP_ModioDefaultModDependenciesDisplayDialog_C
HandlerDelegate to invoke on a cancellation event
Remove Dialog Confirmed Handler

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

nd_img_WBP_ModioDefaultModDependenciesDisplayDialog_RemoveDialogConfirmedHandler.png

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

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

nd_img_WBP_ModioDefaultModDependenciesDisplayDialog_RemoveDialogCanceledHandler.png

void RemoveDialogCanceledHandler(FModioDialogEvent Handler)
Parameters
TargetWBP_ModioDefaultModDependenciesDisplayDialog_C
HandlerDelegate that will no longer receive cancellation events
On Set Data Source

nd_img_WBP_ModioDefaultModDependenciesDisplayDialog_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource, FString RawModName, FString CurrentModName, int32 CurrentModPrice, FModioUnsigned64 CurrentModSizeOnDisk)
On Dialog Button Clicked

nd_img_WBP_ModioDefaultModDependenciesDisplayDialog_OnDialogButtonClicked.png

void OnDialogButtonClicked(int32 ButtonIndex)
On Mod Dependencies Fetched

nd_img_WBP_ModioDefaultModDependenciesDisplayDialog_OnModDependenciesFetched.png

void OnModDependenciesFetched(FModioErrorCode ErrorCode, FModioOptionalModDependencyList Dependencies, FModioModDependencyList DependencyList)
Get Dependency Mod List Widget

nd_img_WBP_ModioDefaultModDependenciesDisplayDialog_GetDependencyModListWidget.png

TScriptInterface<IModioUIObjectSelector> GetDependencyModListWidget() const
Get Mod Name Widget

nd_img_WBP_ModioDefaultModDependenciesDisplayDialog_GetModNameWidget.png

TScriptInterface<IModioUIHasTextWidget> GetModNameWidget() const
Get Dependencies Dialog Widget

nd_img_WBP_ModioDefaultModDependenciesDisplayDialog_GetDependenciesDialogWidget.png

TScriptInterface<IModioUIDialog> GetDependenciesDialogWidget() const
Get Mod Size Widget

nd_img_WBP_ModioDefaultModDependenciesDisplayDialog_GetModSizeWidget.png

TScriptInterface<IModioUIHasTextWidget> GetModSizeWidget()
Get Total Background Border

nd_img_WBP_ModioDefaultModDependenciesDisplayDialog_GetTotalBackgroundBorder.png

void GetTotalBackgroundBorder(TScriptInterface<IModioUIHasConfigurableColor> Border) const
Get Total Mod Size Text Block Widget

nd_img_WBP_ModioDefaultModDependenciesDisplayDialog_GetTotalModSizeTextBlockWidget.png

void GetTotalModSizeTextBlockWidget(TScriptInterface<IModioUIHasTextWidget> NewParam) const
Get Close Dialog Widget

nd_img_WBP_ModioDefaultModDependenciesDisplayDialog_GetCloseDialogWidget.png

TScriptInterface<IModioUIClickableWidget> GetCloseDialogWidget() const
Close Mod Dependencies Dialog

nd_img_WBP_ModioDefaultModDependenciesDisplayDialog_CloseModDependenciesDialog.png

void CloseModDependenciesDialog(UObject* ClickContext)
Get Mod Logo Widget

nd_img_WBP_ModioDefaultModDependenciesDisplayDialog_GetModLogoWidget.png

TScriptInterface<IModioUIImageDisplayWidget> GetModLogoWidget() const
On Mod Logo Fetched

![nd_img_WBP_ModioDefaultModDependenciesDisplayDialog_On Mod Logo Fetched.png](img/refdocs/nd_img_WBP_ModioDefaultModDependenciesDisplayDialog_On Mod Logo Fetched.png)

void On Mod Logo Fetched(FModioErrorCode ErrorCode, FModioOptionalImage Path)
Show Modal

Requests that the modal dialog be displayed

nd_img_WBP_ModioDefaultModDependenciesDisplayDialog_ShowModal.png

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

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

nd_img_WBP_ModioDefaultModDependenciesDisplayDialog_RemoveDialogShownHandler.png

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

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

nd_img_WBP_ModioDefaultModDependenciesDisplayDialog_RemoveDialogButtonClickedHandler.png

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

Closes the modal dialog, removing it from display

nd_img_WBP_ModioDefaultModDependenciesDisplayDialog_CloseModal.png

void CloseModal()
Parameters
TargetWBP_ModioDefaultModDependenciesDisplayDialog_C
Add Dialog Shown Handler

Registers a callback to receive notifications when the dialog is shown

nd_img_WBP_ModioDefaultModDependenciesDisplayDialog_AddDialogShownHandler.png

void AddDialogShownHandler(FModioDialogShownEvent Handler)
Parameters
TargetWBP_ModioDefaultModDependenciesDisplayDialog_C
HandlerDelegate to invoke after the dialog is shown
Add Dialog Button Clicked Handler

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

nd_img_WBP_ModioDefaultModDependenciesDisplayDialog_AddDialogButtonClickedHandler.png

void AddDialogButtonClickedHandler(FModioDialogButtonClickedEvent Handler)
Parameters
TargetWBP_ModioDefaultModDependenciesDisplayDialog_C
HandlerDelegate to invoke when a button is clicked
Variables
FOnDialogConfirmedOnDialogConfirmed
FOnDialogCanceledOnDialogCanceled
FLinearColorRefTotalBackgroundColor
FModioModIDCurrentModID
doubleTargetModDependencyListScrollOffset
FModioUnsigned64TotalSizeToInstall

WBP_ModioDefaultModDependencyEntry

An entry displaying a single dependency for a mod.

Inheritance Hierarchy

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

On Set Data Source

nd_img_WBP_ModioDefaultModDependencyEntry_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource, FModioModID CurrentModID_OLD, FString CurrentModName, FModioUnsigned64 CurrentModSizeOnDisk)
Mod Logo Download Completed Handler

nd_img_WBP_ModioDefaultModDependencyEntry_ModLogoDownloadCompletedHandler.png

void ModLogoDownloadCompletedHandler(FModioModID ModID, FModioErrorCode ErrorCode, FModioOptionalImage Image, EModioLogoSize LogoSize)
Get Mod Name Widget

nd_img_WBP_ModioDefaultModDependencyEntry_GetModNameWidget.png

TScriptInterface<IModioUIHasTextWidget> GetModNameWidget() const
Get Mod Size Widget

nd_img_WBP_ModioDefaultModDependencyEntry_GetModSizeWidget.png

TScriptInterface<IModioUIHasTextWidget> GetModSizeWidget() const
Get Mod Status Image Widget

nd_img_WBP_ModioDefaultModDependencyEntry_GetModStatusImageWidget.png

TScriptInterface<IModioUIImageDisplayWidget> GetModStatusImageWidget() const
Get Background Widget

nd_img_WBP_ModioDefaultModDependencyEntry_GetBackgroundWidget.png

void GetBackgroundWidget(TScriptInterface<IModioUIHasConfigurableColor> Background)
Get Mod Logo Thumbnail Widget

nd_img_WBP_ModioDefaultModDependencyEntry_GetModLogoThumbnailWidget.png

void GetModLogoThumbnailWidget(TScriptInterface<IModioUIImageDisplayWidget> Image) const
Set Installed Visual State

nd_img_WBP_ModioDefaultModDependencyEntry_SetInstalledVisualState.png

void SetInstalledVisualState()
Set Not Installed Visual State

nd_img_WBP_ModioDefaultModDependencyEntry_SetNotInstalledVisualState.png

void SetNotInstalledVisualState(FModioUnsigned64 ModFileSize)
Get Toggleable

Retrieves the toggle-able state of the implementing widget

nd_img_WBP_ModioDefaultModDependencyEntry_GetToggleable.png

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

Retrieves the current selection state of the implementing widget

nd_img_WBP_ModioDefaultModDependencyEntry_GetSelectedState.png

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

Retrieves the selectable state of the implementing widget

nd_img_WBP_ModioDefaultModDependencyEntry_GetSelectable.png

void GetSelectable(bool bIsSelectable)
Parameters
TargetWBP_ModioDefaultModDependencyEntry_C
Is SelectableTrue if the implementing widget can be selected
Toggle Selected State

Toggles the selected state of the implementing widget

nd_img_WBP_ModioDefaultModDependencyEntry_ToggleSelectedState.png

void ToggleSelectedState()
Parameters
TargetWBP_ModioDefaultModDependencyEntry_C
Set Toggleable

Enables or disables toggle-ability on the implementing widget

nd_img_WBP_ModioDefaultModDependencyEntry_SetToggleable.png

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

Directly sets the selected state of the implementing widget

nd_img_WBP_ModioDefaultModDependencyEntry_SetSelectedState.png

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

Sets the selectable state of the implementing widget

nd_img_WBP_ModioDefaultModDependencyEntry_SetSelectable.png

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

Unsubscribes a delegate from receiving state change callbacks

nd_img_WBP_ModioDefaultModDependencyEntry_RemoveSelectedStateChangedHandler.png

void RemoveSelectedStateChangedHandler(FModioSelectableOnSelectionChanged Handler)
Parameters
TargetWBP_ModioDefaultModDependencyEntry_C
HandlerThe delegate to remove
Add Selected State Changed Handler

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

nd_img_WBP_ModioDefaultModDependencyEntry_AddSelectedStateChangedHandler.png

void AddSelectedStateChangedHandler(FModioSelectableOnSelectionChanged Handler)
Parameters
TargetWBP_ModioDefaultModDependencyEntry_C
HandlerDelegate to invoke on state change
Remove Clicked Handler

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

nd_img_WBP_ModioDefaultModDependencyEntry_RemoveClickedHandler.png

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

Enables click events being emitted by the implementing object

nd_img_WBP_ModioDefaultModDependencyEntry_EnableClick.png

void EnableClick()
Parameters
TargetWBP_ModioDefaultModDependencyEntry_C
Disable Click

Disables click events being emitted by the implementing object

nd_img_WBP_ModioDefaultModDependencyEntry_DisableClick.png

void DisableClick()
Parameters
TargetWBP_ModioDefaultModDependencyEntry_C
Add Clicked Handler

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

nd_img_WBP_ModioDefaultModDependencyEntry_AddClickedHandler.png

void AddClickedHandler(FModioClickableOnClicked Handler)
Parameters
TargetWBP_ModioDefaultModDependencyEntry_C
HandlerDelegate to invoke on a click event
Variables
FLinearColorRefBackgroundColor
UMaterialInterface*InstalledStatusMaterial
FModioModIDCurrentModID
EModioLogoSizeDesiredLogoSize
FTextInstalledStatusText
FLinearColorRefInstalledStatusColor
FLinearColorRefNotInstalledStatusColor

WBP_ModioDefaultModDependencyList

A list displaying all dependencies for a selected mod.

Inheritance Hierarchy

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

Set Values

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

nd_img_WBP_ModioDefaultModDependencyList_SetValues.png

void SetValues(TArray<UObject*> InValues)
Parameters
TargetWBP_ModioDefaultModDependencyList_C
InValuesArray of UObjects representing choices
Add Selection Changed Handler

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

nd_img_WBP_ModioDefaultModDependencyList_AddSelectionChangedHandler.png

void AddSelectionChangedHandler(FModioOnObjectSelectionChanged Handler)
Parameters
TargetWBP_ModioDefaultModDependencyList_C
HandlerDelegate to invoke on selection state change
Remove Selection Changed Handler

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

nd_img_WBP_ModioDefaultModDependencyList_RemoveSelectionChangedHandler.png

void RemoveSelectionChangedHandler(FModioOnObjectSelectionChanged Handler)
Parameters
TargetWBP_ModioDefaultModDependencyList_C
HandlerDelegate that will no longer receive callbacks
On Entry Clicked

nd_img_WBP_ModioDefaultModDependencyList_OnEntryClicked.png

void OnEntryClicked(UObject* ClickContext)
Get Dependency List Widget Selector

![nd_img_WBP_ModioDefaultModDependencyList_Get Dependency List Widget_Selector.png](img/refdocs/nd_img_WBP_ModioDefaultModDependencyList_Get Dependency List Widget_Selector.png)

TScriptInterface<IModioUIObjectSelector> Get Dependency List Widget_Selector() const
Get Dependency List Widget Object List

![nd_img_WBP_ModioDefaultModDependencyList_Get Dependency List Widget_ObjectList.png](img/refdocs/nd_img_WBP_ModioDefaultModDependencyList_Get Dependency List Widget_ObjectList.png)

TScriptInterface<IModioUIObjectListWidget> Get Dependency List Widget_ObjectList() const
On Entry Generated

nd_img_WBP_ModioDefaultModDependencyList_OnEntryGenerated.png

void OnEntryGenerated(UWidget* ObjectWidget, UObject* Object)
Get Single Selected Value

Retrieves the selection of the implementing widget

nd_img_WBP_ModioDefaultModDependencyList_GetSingleSelectedValue.png

UObject* GetSingleSelectedValue()
Parameters
TargetWBP_ModioDefaultModDependencyList_C
Returns

UObject associated with the current selection of the implementing widget

Get Selected Values

Retrieves the selected values from the implementing widget

nd_img_WBP_ModioDefaultModDependencyList_GetSelectedValues.png

TArray<UObject*> GetSelectedValues()
Parameters
TargetWBP_ModioDefaultModDependencyList_C
Returns

Array of UObjects representing the selected values

Get Multi Selection Allowed

Retrieves whether the implementing widget allows multiple selections

nd_img_WBP_ModioDefaultModDependencyList_GetMultiSelectionAllowed.png

bool GetMultiSelectionAllowed()
Parameters
TargetWBP_ModioDefaultModDependencyList_C
Returns

True if multiple selections are allowed

Get Single Selection Index

Gets the current selection for the implementing widget by index

nd_img_WBP_ModioDefaultModDependencyList_GetSingleSelectionIndex.png

int32 GetSingleSelectionIndex()
Parameters
TargetWBP_ModioDefaultModDependencyList_C
Returns

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

Get Num Entries

Gets the number of entries in the implementing widget

nd_img_WBP_ModioDefaultModDependencyList_GetNumEntries.png

int32 GetNumEntries()
Parameters
TargetWBP_ModioDefaultModDependencyList_C
Returns

The number of entries in the implementing widget

Get Index for Value

Retrieves the index of the specified value

nd_img_WBP_ModioDefaultModDependencyList_GetIndexForValue.png

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

The 0-based index of the specified value

Get Widget for Value

Retrieves the widget associated with the specified value

nd_img_WBP_ModioDefaultModDependencyList_GetWidgetForValue.png

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

The widget associated with the specified value

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.

nd_img_WBP_ModioDefaultModDependencyList_GetLastSelectionIndex.png

int32 GetLastSelectionIndex()
Parameters
TargetWBP_ModioDefaultModDependencyList_C
Returns

The 0-based index of the previously selected object

Set Single Selection by Value

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

nd_img_WBP_ModioDefaultModDependencyList_SetSingleSelectionByValue.png

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

Sets the current selection for the implementing widget by index

nd_img_WBP_ModioDefaultModDependencyList_SetSingleSelectionByIndex.png

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

Sets the selected state for the specified value

nd_img_WBP_ModioDefaultModDependencyList_SetSelectedStateForValue.png

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

Sets the selected state for the specified index

nd_img_WBP_ModioDefaultModDependencyList_SetSelectedStateForIndex.png

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

Sets whether the implementing widget should allow multiple selections

nd_img_WBP_ModioDefaultModDependencyList_SetMultiSelectionAllowed.png

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

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

nd_img_WBP_ModioDefaultModDependencyList_SetListEntryWidgetClass.png

void SetListEntryWidgetClass(TSubclassOf<UWidget>  InNewEntryClass)
Parameters
TargetWBP_ModioDefaultModDependencyList_C
InNewEntryClassThe class to use for list entries
Clear Selected Values

Clears the selection state on the implementing widget

nd_img_WBP_ModioDefaultModDependencyList_ClearSelectedValues.png

void ClearSelectedValues()
Parameters
TargetWBP_ModioDefaultModDependencyList_C
Variables
FOnSelectionChangedOnSelectionChanged

WBP_ModioDefaultModDescriptionDialog

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

Inheritance Hierarchy

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

On Set Data Source

nd_img_WBP_ModioDefaultModDescriptionDialog_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource)
Do Scroll Up

nd_img_WBP_ModioDefaultModDescriptionDialog_DoScrollUp.png

UWidget* DoScrollUp(EUINavigation Navigation)
Do Scroll Down

nd_img_WBP_ModioDefaultModDescriptionDialog_DoScrollDown.png

UWidget* DoScrollDown(EUINavigation Navigation)
Get Mod Description Text Widget

nd_img_WBP_ModioDefaultModDescriptionDialog_GetModDescriptionTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetModDescriptionTextWidget() const
Get Close Dialog Button Widget

nd_img_WBP_ModioDefaultModDescriptionDialog_GetCloseDialogButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetCloseDialogButtonWidget() const
Close Mod Description Dialog

nd_img_WBP_ModioDefaultModDescriptionDialog_CloseModDescriptionDialog.png

void CloseModDescriptionDialog(UObject* ClickContext)
Get Scroll Navigation Button Widget

nd_img_WBP_ModioDefaultModDescriptionDialog_GetScrollNavigationButtonWidget.png

void GetScrollNavigationButtonWidget(TScriptInterface<IModioUIClickableWidget> NavButton) const
Get Description Scroll Box Widget

nd_img_WBP_ModioDefaultModDescriptionDialog_GetDescriptionScrollBoxWidget.png

void GetDescriptionScrollBoxWidget(UModioDefaultScrollBox* ScrollBox) const
Variables
int32NavigationScrollOffsetStep

WBP_ModioDefaultModDetailsCommandEntry

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

Inheritance Hierarchy

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

Item Selection Changed Handler

nd_img_WBP_ModioDefaultModDetailsCommandEntry_ItemSelectionChangedHandler.png

void ItemSelectionChangedHandler(bool bIsSelected)
Variables

WBP_ModioDefaultModDetailsCommandList

A list of available commands within the mod details view.

Inheritance Hierarchy

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

Set Values

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

nd_img_WBP_ModioDefaultModDetailsCommandList_SetValues.png

void SetValues(TArray<UObject*> InValues)
Parameters
TargetWBP_ModioDefaultModDetailsCommandList_C
InValuesArray of UObjects representing choices
Add Selection Changed Handler

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

nd_img_WBP_ModioDefaultModDetailsCommandList_AddSelectionChangedHandler.png

void AddSelectionChangedHandler(FModioOnObjectSelectionChanged Handler)
Parameters
TargetWBP_ModioDefaultModDetailsCommandList_C
HandlerDelegate to invoke on selection state change
Remove Selection Changed Handler

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

nd_img_WBP_ModioDefaultModDetailsCommandList_RemoveSelectionChangedHandler.png

void RemoveSelectionChangedHandler(FModioOnObjectSelectionChanged Handler)
Parameters
TargetWBP_ModioDefaultModDetailsCommandList_C
HandlerDelegate that will no longer receive callbacks
Set Selected State for Index

Sets the selected state for the specified index

nd_img_WBP_ModioDefaultModDetailsCommandList_SetSelectedStateForIndex.png

void SetSelectedStateForIndex(int32 Index, bool bNewSelectionState, bool bEmitSelectionEvent)
Parameters
TargetWBP_ModioDefaultModDetailsCommandList_C
IndexThe 0-based index to set the selection state for
bNewSelectionStateThe new selection state to set
bEmitSelectionEventTrue if a selection changed event should be emitted
On Entry Clicked

nd_img_WBP_ModioDefaultModDetailsCommandList_OnEntryClicked.png

void OnEntryClicked(UObject* ClickContext)
Get Command List Widget Selector

nd_img_WBP_ModioDefaultModDetailsCommandList_GetCommandListWidget_Selector.png

TScriptInterface<IModioUIObjectSelector> GetCommandListWidget_Selector() const
Get Command List Widget Object List

nd_img_WBP_ModioDefaultModDetailsCommandList_GetCommandListWidget_ObjectList.png

TScriptInterface<IModioUIObjectListWidget> GetCommandListWidget_ObjectList() const
On Entry Generated

nd_img_WBP_ModioDefaultModDetailsCommandList_OnEntryGenerated.png

void OnEntryGenerated(UWidget* ObjectWidget, UObject* Object)
Get Single Selected Value

Retrieves the selection of the implementing widget

nd_img_WBP_ModioDefaultModDetailsCommandList_GetSingleSelectedValue.png

UObject* GetSingleSelectedValue()
Parameters
TargetWBP_ModioDefaultModDetailsCommandList_C
Returns

UObject associated with the current selection of the implementing widget

Get Selected Values

Retrieves the selected values from the implementing widget

nd_img_WBP_ModioDefaultModDetailsCommandList_GetSelectedValues.png

TArray<UObject*> GetSelectedValues()
Parameters
TargetWBP_ModioDefaultModDetailsCommandList_C
Returns

Array of UObjects representing the selected values

Get Multi Selection Allowed

Retrieves whether the implementing widget allows multiple selections

nd_img_WBP_ModioDefaultModDetailsCommandList_GetMultiSelectionAllowed.png

bool GetMultiSelectionAllowed()
Parameters
TargetWBP_ModioDefaultModDetailsCommandList_C
Returns

True if multiple selections are allowed

Get Single Selection Index

Gets the current selection for the implementing widget by index

nd_img_WBP_ModioDefaultModDetailsCommandList_GetSingleSelectionIndex.png

int32 GetSingleSelectionIndex()
Parameters
TargetWBP_ModioDefaultModDetailsCommandList_C
Returns

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

Get Num Entries

Gets the number of entries in the implementing widget

nd_img_WBP_ModioDefaultModDetailsCommandList_GetNumEntries.png

int32 GetNumEntries()
Parameters
TargetWBP_ModioDefaultModDetailsCommandList_C
Returns

The number of entries in the implementing widget

Get Index for Value

Retrieves the index of the specified value

nd_img_WBP_ModioDefaultModDetailsCommandList_GetIndexForValue.png

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

The 0-based index of the specified value

Get Widget for Value

Retrieves the widget associated with the specified value

nd_img_WBP_ModioDefaultModDetailsCommandList_GetWidgetForValue.png

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

The widget associated with the specified value

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.

nd_img_WBP_ModioDefaultModDetailsCommandList_GetLastSelectionIndex.png

int32 GetLastSelectionIndex()
Parameters
TargetWBP_ModioDefaultModDetailsCommandList_C
Returns

The 0-based index of the previously selected object

Set Single Selection by Value

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

nd_img_WBP_ModioDefaultModDetailsCommandList_SetSingleSelectionByValue.png

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

Sets the current selection for the implementing widget by index

nd_img_WBP_ModioDefaultModDetailsCommandList_SetSingleSelectionByIndex.png

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

Sets the selected state for the specified value

nd_img_WBP_ModioDefaultModDetailsCommandList_SetSelectedStateForValue.png

void SetSelectedStateForValue(UObject* Value, bool bNewSelectionState, bool bEmitSelectionEvent)
Parameters
TargetWBP_ModioDefaultModDetailsCommandList_C
ValueThe value to set the selection state for
bNewSelectionStateThe new selection state to set
bEmitSelectionEventTrue if a selection changed event should be emitted
Set Multi Selection Allowed

Sets whether the implementing widget should allow multiple selections

nd_img_WBP_ModioDefaultModDetailsCommandList_SetMultiSelectionAllowed.png

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

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

nd_img_WBP_ModioDefaultModDetailsCommandList_SetListEntryWidgetClass.png

void SetListEntryWidgetClass(TSubclassOf<UWidget>  InNewEntryClass)
Parameters
TargetWBP_ModioDefaultModDetailsCommandList_C
InNewEntryClassThe class to use for list entries
Clear Selected Values

Clears the selection state on the implementing widget

nd_img_WBP_ModioDefaultModDetailsCommandList_ClearSelectedValues.png

void ClearSelectedValues()
Parameters
TargetWBP_ModioDefaultModDetailsCommandList_C
Variables
FOnSelectionChangedOnSelectionChanged

WBP_ModioDefaultModDetailsMoreOptionsMenu

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

Inheritance Hierarchy

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

Get Background Widget

nd_img_WBP_ModioDefaultModDetailsMoreOptionsMenu_GetBackgroundWidget.png

void GetBackgroundWidget(TScriptInterface<IModioUIHasConfigurableColor> Background) const
Variables
FLinearColorRefBackgroundColor

WBP_ModioDefaultModDetailsMoreOptionsPopupMenu

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

Inheritance Hierarchy

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

On Get Menu Content

nd_img_WBP_ModioDefaultModDetailsMoreOptionsPopupMenu_OnGetMenuContent.png

UWidget* OnGetMenuContent(UModioCommandMenu* NewCommandMenuWidget)
On Menu Button Clicked

nd_img_WBP_ModioDefaultModDetailsMoreOptionsPopupMenu_OnMenuButtonClicked.png

void OnMenuButtonClicked(UObject* ClickContext)
Get Menu Button Widget

nd_img_WBP_ModioDefaultModDetailsMoreOptionsPopupMenu_GetMenuButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetMenuButtonWidget() const
Get Dropdown Anchor Widget

nd_img_WBP_ModioDefaultModDetailsMoreOptionsPopupMenu_GetDropdownAnchorWidget.png

TScriptInterface<IModioToggleableWidget> GetDropdownAnchorWidget() const
Get Back Button Widget

nd_img_WBP_ModioDefaultModDetailsMoreOptionsPopupMenu_GetBackButtonWidget.png

TScriptInterface<IModioUIBoundActionWidget> GetBackButtonWidget() const
Get Dropdown Anchor

nd_img_WBP_ModioDefaultModDetailsMoreOptionsPopupMenu_GetDropdownAnchor.png

TScriptInterface<IModioToggleableWidget> GetDropdownAnchor() const
On Dropdown Anchor Toggle State Changed

nd_img_WBP_ModioDefaultModDetailsMoreOptionsPopupMenu_OnDropdownAnchorToggleStateChanged.png

void OnDropdownAnchorToggleStateChanged(UObject* Context, bool bIsOpen)
Do Navigation to Dropdown Menu

nd_img_WBP_ModioDefaultModDetailsMoreOptionsPopupMenu_DoNavigationToDropdownMenu.png

UWidget* DoNavigationToDropdownMenu(EUINavigation Navigation)
Variables

WBP_ModioDefaultModDownloadVisualizer

Displays the download count for a mod.

Inheritance Hierarchy

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

Initialize Editor Preview

nd_img_WBP_ModioDefaultModDownloadVisualizer_InitializeEditorPreview.png

void InitializeEditorPreview(bool bIsDesignTime)
On Set Data Source

nd_img_WBP_ModioDefaultModDownloadVisualizer_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource)
Get Value Text Widget

nd_img_WBP_ModioDefaultModDownloadVisualizer_GetValueTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetValueTextWidget() const
Get Label Text Widget

nd_img_WBP_ModioDefaultModDownloadVisualizer_GetLabelTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetLabelTextWidget() const
Variables
FTextLabelTextValue
UObject*EditorDataSource
FTextDownloadFormatText
boolbShowPropertyLabel
FLinearColorRefPropertyLabelColor

WBP_ModioDefaultModDownloadVisualizer_Horizontal

Inheritance Hierarchy

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

Initialize Editor Preview

nd_img_WBP_ModioDefaultModDownloadVisualizer_Horizontal_InitializeEditorPreview.png

void InitializeEditorPreview(bool bIsDesignTime)
On Set Data Source

nd_img_WBP_ModioDefaultModDownloadVisualizer_Horizontal_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource)
Get Value Text Widget

nd_img_WBP_ModioDefaultModDownloadVisualizer_Horizontal_GetValueTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetValueTextWidget() const
Get Label Text Widget

nd_img_WBP_ModioDefaultModDownloadVisualizer_Horizontal_GetLabelTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetLabelTextWidget() const
Variables
FTextLabelTextValue
UObject*EditorDataSource
FTextDownloadFormatText
boolbShowPropertyLabel
FLinearColorRefPropertyLabelColor

WBP_ModioDefaultModEnabledStatusWidget

Displays the current enabled/disabled status of a mod.

Inheritance Hierarchy

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

Mod Enabled State Changed Handler

nd_img_WBP_ModioDefaultModEnabledStatusWidget_ModEnabledStateChangedHandler.png

void ModEnabledStateChangedHandler(FModioModID ModID, bool bNewState)
Apply Status Image

nd_img_WBP_ModioDefaultModEnabledStatusWidget_ApplyStatusImage.png

void ApplyStatusImage(UMaterialInterface* Material)
Get Status Image

nd_img_WBP_ModioDefaultModEnabledStatusWidget_GetStatusImage.png

TScriptInterface<IModioUIImageDisplayWidget> GetStatusImage() const
Get Background Widget

nd_img_WBP_ModioDefaultModEnabledStatusWidget_GetBackgroundWidget.png

TScriptInterface<IModioUIHasConfigurableColor> GetBackgroundWidget() const
Variables
FLinearColorRefBackgroundColor
UMaterialInterface*DisabledImage
UMaterialInterface*EnabledImage

WBP_ModioDefaultModEnabledToggleWidget

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

Inheritance Hierarchy

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

Mod Enabled State Changed Handler

nd_img_WBP_ModioDefaultModEnabledToggleWidget_ModEnabledStateChangedHandler.png

void ModEnabledStateChangedHandler(FModioModID ModID, bool bNewEnabledState)
Get Enable Disable Action Label Widget

nd_img_WBP_ModioDefaultModEnabledToggleWidget_GetEnableDisableActionLabelWidget.png

TScriptInterface<IModioUIHasTextWidget> GetEnableDisableActionLabelWidget() const
Get Mod Enabled Status Widget

nd_img_WBP_ModioDefaultModEnabledToggleWidget_GetModEnabledStatusWidget.png

TScriptInterface<IModioUIDataSourceWidget> GetModEnabledStatusWidget() const
On Set Data Source

nd_img_WBP_ModioDefaultModEnabledToggleWidget_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource)
On Inner Button Clicked

nd_img_WBP_ModioDefaultModEnabledToggleWidget_OnInnerButtonClicked.png

void OnInnerButtonClicked(FModioModID AssociatedModID)
Get Background Widget

nd_img_WBP_ModioDefaultModEnabledToggleWidget_GetBackgroundWidget.png

TScriptInterface<IModioUIHasConfigurableColor> GetBackgroundWidget() const
Variables
FLinearColorRefBackgroundColor
FTextDisableModText
FTextEnableModText

WBP_ModioDefaultModInstallationProgressBar

Inheritance Hierarchy

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

On Installation Status Change

nd_img_WBP_ModioDefaultModInstallationProgressBar_OnInstallationStatusChange.png

void OnInstallationStatusChange(EModioModInstallationStatus NewStatus)
Update Status Bar Value

nd_img_WBP_ModioDefaultModInstallationProgressBar_UpdateStatusBarValue.png

void UpdateStatusBarValue(EModioModInstallationStatus Status)
Get Progress Widget

nd_img_WBP_ModioDefaultModInstallationProgressBar_GetProgressWidget.png

TScriptInterface<IModioUIProgressWidget> GetProgressWidget() const
Update Visibility

nd_img_WBP_ModioDefaultModInstallationProgressBar_UpdateVisibility.png

void UpdateVisibility(EModioModInstallationStatus Status)
Variables

WBP_ModioDefaultModInstallationStatusWidget

Displays the installation status of a mod.

Inheritance Hierarchy

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

Apply Text Visibility Override

nd_img_WBP_ModioDefaultModInstallationStatusWidget_ApplyTextVisibilityOverride.png

void ApplyTextVisibilityOverride()
Get Status Text Widget

nd_img_WBP_ModioDefaultModInstallationStatusWidget_GetStatusTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetStatusTextWidget() const
Get Progress Widget

nd_img_WBP_ModioDefaultModInstallationStatusWidget_GetProgressWidget.png

TScriptInterface<IModioUIProgressWidget> GetProgressWidget() const
Get Status Icon Widget

nd_img_WBP_ModioDefaultModInstallationStatusWidget_GetStatusIconWidget.png

TScriptInterface<IModioUIImageDisplayWidget> GetStatusIconWidget() const
Get Background Border Widget

nd_img_WBP_ModioDefaultModInstallationStatusWidget_GetBackgroundBorderWidget.png

void GetBackgroundBorderWidget(TScriptInterface<IModioUIHasConfigurableColor> BackgroundBorder) const
Set Extracting Progress Bar Color

nd_img_WBP_ModioDefaultModInstallationStatusWidget_SetExtractingProgressBarColor.png

void SetExtractingProgressBarColor()
Set Default Progress Bar Color

nd_img_WBP_ModioDefaultModInstallationStatusWidget_SetDefaultProgressBarColor.png

void SetDefaultProgressBarColor()
Installation Status Changed

nd_img_WBP_ModioDefaultModInstallationStatusWidget_InstallationStatusChanged.png

void InstallationStatusChanged(EModioModInstallationStatus NewStatus)
Update Visibility

nd_img_WBP_ModioDefaultModInstallationStatusWidget_UpdateVisibility.png

void UpdateVisibility(EModioModInstallationStatus NewStatus)
Update Sub Widget Colors

nd_img_WBP_ModioDefaultModInstallationStatusWidget_UpdateSubWidgetColors.png

void UpdateSubWidgetColors(EModioModInstallationStatus NewStatus)
Update Label Text

nd_img_WBP_ModioDefaultModInstallationStatusWidget_UpdateLabelText.png

void UpdateLabelText(EModioModInstallationStatus NewState)
Update Icon

nd_img_WBP_ModioDefaultModInstallationStatusWidget_UpdateIcon.png

void UpdateIcon(EModioModInstallationStatus NewState)
Apply Status Visibility Override

nd_img_WBP_ModioDefaultModInstallationStatusWidget_ApplyStatusVisibilityOverride.png

void ApplyStatusVisibilityOverride(EModioModInstallationStatus NewStatus)
Update Progress Bar Value

nd_img_WBP_ModioDefaultModInstallationStatusWidget_UpdateProgressBarValue.png

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

WBP_ModioDefaultModPropCollectionVisualizer

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

Inheritance Hierarchy

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

On Set Data Source

nd_img_WBP_ModioDefaultModPropCollectionVisualizer_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource)
Initialize Editor Preview

nd_img_WBP_ModioDefaultModPropCollectionVisualizer_InitializeEditorPreview.png

void InitializeEditorPreview(bool bIsDesignTime)
Get Background Widget

nd_img_WBP_ModioDefaultModPropCollectionVisualizer_GetBackgroundWidget.png

void GetBackgroundWidget(TScriptInterface<IModioUIHasConfigurableColor> Background) const
Variables
UObject*EditorDataSource
FLinearColorRefBackgroundColor

WBP_ModioDefaultModRatingVisualizer

Displays the rating of a mod.

Inheritance Hierarchy

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

Initialize Editor Preview

nd_img_WBP_ModioDefaultModRatingVisualizer_InitializeEditorPreview.png

void InitializeEditorPreview(bool bIsDesignTime)
On Set Data Source

nd_img_WBP_ModioDefaultModRatingVisualizer_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource)
Get Value Text Widget

nd_img_WBP_ModioDefaultModRatingVisualizer_GetValueTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetValueTextWidget() const
Get Label Text Widget

nd_img_WBP_ModioDefaultModRatingVisualizer_GetLabelTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetLabelTextWidget() const
Variables
FTextFilesizeLabelText
UObject*EditorDataSource
boolbShowPropertyLabel
FLinearColorRefPropertyLabelColor

WBP_ModioDefaultModRatingVisualizer_Horizontal

Inheritance Hierarchy

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

Initialize Editor Preview

nd_img_WBP_ModioDefaultModRatingVisualizer_Horizontal_InitializeEditorPreview.png

void InitializeEditorPreview(bool bIsDesignTime)
On Set Data Source

nd_img_WBP_ModioDefaultModRatingVisualizer_Horizontal_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource)
Get Value Text Widget

nd_img_WBP_ModioDefaultModRatingVisualizer_Horizontal_GetValueTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetValueTextWidget() const
Get Label Text Widget

nd_img_WBP_ModioDefaultModRatingVisualizer_Horizontal_GetLabelTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetLabelTextWidget() const
Variables
FTextFilesizeLabelText
UObject*EditorDataSource
boolbShowPropertyLabel
FLinearColorRefPropertyLabelColor

WBP_ModioDefaultModReleaseDateVisualizer

Displays the release date of a mod.

Inheritance Hierarchy

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

Initialize Editor Preview

nd_img_WBP_ModioDefaultModReleaseDateVisualizer_InitializeEditorPreview.png

void InitializeEditorPreview(bool bIsDesignTime)
On Set Data Source

nd_img_WBP_ModioDefaultModReleaseDateVisualizer_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource)
Get Value Text Widget

nd_img_WBP_ModioDefaultModReleaseDateVisualizer_GetValueTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetValueTextWidget() const
Get Label Text Widget

nd_img_WBP_ModioDefaultModReleaseDateVisualizer_GetLabelTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetLabelTextWidget() const
Variables
FTextLabelTextValue
UObject*EditorDataSource
boolbShowPropertyLabel
FLinearColorRefPropertyLabelColor

WBP_ModioDefaultModSizeVisualizer

Displays the file size of a mod.

Inheritance Hierarchy

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

Initialize Editor Preview

nd_img_WBP_ModioDefaultModSizeVisualizer_InitializeEditorPreview.png

void InitializeEditorPreview(bool bIsDesignTime)
On Set Data Source

nd_img_WBP_ModioDefaultModSizeVisualizer_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource)
Get Label Text Widget

nd_img_WBP_ModioDefaultModSizeVisualizer_GetLabelTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetLabelTextWidget() const
Variables
FTextFilesizeLabelText
UObject*EditorDataSource
boolbShowPropertyLabel
FLinearColorRefPropertyLabelColor

WBP_ModioDefaultModSizeVisualizer_Horizontal

Inheritance Hierarchy

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

Initialize Editor Preview

nd_img_WBP_ModioDefaultModSizeVisualizer_Horizontal_InitializeEditorPreview.png

void InitializeEditorPreview(bool bIsDesignTime)
On Set Data Source

nd_img_WBP_ModioDefaultModSizeVisualizer_Horizontal_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource)
Get Label Text Widget

nd_img_WBP_ModioDefaultModSizeVisualizer_Horizontal_GetLabelTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetLabelTextWidget() const
Variables
FTextFilesizeLabelText
UObject*EditorDataSource
boolbShowPropertyLabel
FLinearColorRefPropertyLabelColor

WBP_ModioDefaultModSubscribersVisualizer

Displays the subscriber count for a mod.

Inheritance Hierarchy

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

Initialize Editor Preview

nd_img_WBP_ModioDefaultModSubscribersVisualizer_InitializeEditorPreview.png

void InitializeEditorPreview(bool bIsDesignTime)
On Set Data Source

nd_img_WBP_ModioDefaultModSubscribersVisualizer_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource)
Get Value Text Widget

nd_img_WBP_ModioDefaultModSubscribersVisualizer_GetValueTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetValueTextWidget() const
Get Label Text Widget

nd_img_WBP_ModioDefaultModSubscribersVisualizer_GetLabelTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetLabelTextWidget() const
Variables
FTextLabelTextValue
UObject*EditorDataSource
FTextSubscriberCountFormatText
boolbShowPropertyLabel
FLinearColorRefPropertyLabelColor

WBP_ModioDefaultModSubscriptionStatusWidget

Displays the subscription status of a mod.

Inheritance Hierarchy

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

On Set Data Source

nd_img_WBP_ModioDefaultModSubscriptionStatusWidget_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource, FModioModID RelevantModID)
Mod Subscriptions Changed Handler

nd_img_WBP_ModioDefaultModSubscriptionStatusWidget_ModSubscriptionsChangedHandler.png

void ModSubscriptionsChangedHandler(FModioModID ModID, bool bNewSubscriptionState, FModioModID RelevantModID)
Get Subscription Status Icon Widget

nd_img_WBP_ModioDefaultModSubscriptionStatusWidget_GetSubscriptionStatusIconWidget.png

TScriptInterface<IModioUIImageDisplayWidget> GetSubscriptionStatusIconWidget() const
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

Set Border Color

nd_img_WBP_ModioDefaultModTile_SetBorderColor.png

void SetBorderColor(FLinearColorRef Color)
Set Background Color

nd_img_WBP_ModioDefaultModTile_SetBackgroundColor.png

void SetBackgroundColor(FLinearColorRef Color)
Set Normal Visual State

nd_img_WBP_ModioDefaultModTile_SetNormalVisualState.png

void SetNormalVisualState()
Set Selected Visual State

nd_img_WBP_ModioDefaultModTile_SetSelectedVisualState.png

void SetSelectedVisualState()
Mod Logo Download Completed Handler

![nd_img_WBP_ModioDefaultModTile_Mod Logo Download Completed Handler.png](img/refdocs/nd_img_WBP_ModioDefaultModTile_Mod Logo Download Completed Handler.png)

void Mod Logo Download Completed Handler(FModioModID ModID, FModioErrorCode ErrorCode, FModioOptionalImage Image, EModioLogoSize LogoSize)
Logo Download Error Handler

nd_img_WBP_ModioDefaultModTile_LogoDownloadErrorHandler.png

void LogoDownloadErrorHandler()
On Overlay Button Clicked

nd_img_WBP_ModioDefaultModTile_OnOverlayButtonClicked.png

void OnOverlayButtonClicked(UObject* ClickContext)
On Mod Logo Texture Loaded

nd_img_WBP_ModioDefaultModTile_OnModLogoTextureLoaded.png

void OnModLogoTextureLoaded(UTexture2DDynamic* Texture, FSlateBrush LogoThumbBrush)
On Set Data Source

nd_img_WBP_ModioDefaultModTile_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource)
Update Mod Logo Thumbnail

nd_img_WBP_ModioDefaultModTile_UpdateModLogoThumbnail.png

void UpdateModLogoThumbnail()
Update Mod Name Label

nd_img_WBP_ModioDefaultModTile_UpdateModNameLabel.png

void UpdateModNameLabel()
Get Mod Prop Visualizer Widget

nd_img_WBP_ModioDefaultModTile_GetModPropVisualizerWidget.png

void GetModPropVisualizerWidget(TScriptInterface<IModioUIDataSourceWidget> ModPropVisualizer)
Get Mod Installation Status Widget

nd_img_WBP_ModioDefaultModTile_GetModInstallationStatusWidget.png

void GetModInstallationStatusWidget(TScriptInterface<IModioUIDataSourceWidget> StatusWidget)
Update Premium Details

nd_img_WBP_ModioDefaultModTile_UpdatePremiumDetails.png

void UpdatePremiumDetails(FModioUnsigned64 ModPrice, FModioModID ModID)
Set Text Color

nd_img_WBP_ModioDefaultModTile_SetTextColor.png

void SetTextColor(TScriptInterface<IModioUIHasTextWidget> Target, FLinearColorRef Color)
Get Outer Border Widget

nd_img_WBP_ModioDefaultModTile_GetOuterBorderWidget.png

void GetOuterBorderWidget(TScriptInterface<IModioUIHasConfigurableColor> BorderWidget)
Get Background Widget

nd_img_WBP_ModioDefaultModTile_GetBackgroundWidget.png

void GetBackgroundWidget(TScriptInterface<IModioUIHasConfigurableColor> BorderWidget)
Get Mod Name Label

nd_img_WBP_ModioDefaultModTile_GetModNameLabel.png

void GetModNameLabel(TScriptInterface<IModioUIHasTextWidget> LabelWidget)
Get Premium Badge Background Widget

nd_img_WBP_ModioDefaultModTile_GetPremiumBadgeBackgroundWidget.png

void GetPremiumBadgeBackgroundWidget(TScriptInterface<IModioUIHasConfigurableColor> BorderWidget)
Get Mod Price Label

nd_img_WBP_ModioDefaultModTile_GetModPriceLabel.png

void GetModPriceLabel(TScriptInterface<IModioUIHasTextWidget> LabelWidget)
Get Mod Logo Image

nd_img_WBP_ModioDefaultModTile_GetModLogoImage.png

void GetModLogoImage(TScriptInterface<IModioUIImageDisplayWidget> LabelWidget)
Mod Management Event Handler

nd_img_WBP_ModioDefaultModTile_ModManagementEventHandler.png

void ModManagementEventHandler(FModioModManagementEvent Event)
Get Mod Overlay Button

nd_img_WBP_ModioDefaultModTile_GetModOverlayButton.png

void GetModOverlayButton(TScriptInterface<IModioUIClickableWidget> ClickableWidget) const
Rebuild Command List if Needed

nd_img_WBP_ModioDefaultModTile_RebuildCommandListIfNeeded.png

void RebuildCommandListIfNeeded(FModioModID InModID, FModioModID ForModID)
On Subscriptions Changed Handler

nd_img_WBP_ModioDefaultModTile_OnSubscriptionsChangedHandler.png

void OnSubscriptionsChangedHandler(FModioModID InModID)
Register Event Receivers

nd_img_WBP_ModioDefaultModTile_RegisterEventReceivers.png

void RegisterEventReceivers()
Configure Colors

![nd_img_WBP_ModioDefaultModTile_Configure Colors.png](img/refdocs/nd_img_WBP_ModioDefaultModTile_Configure Colors.png)

void Configure Colors()
Deregister Event Receivers

![nd_img_WBP_ModioDefaultModTile_Deregister Event Receivers.png](img/refdocs/nd_img_WBP_ModioDefaultModTile_Deregister Event Receivers.png)

void Deregister Event Receivers()
Register Click Handlers

nd_img_WBP_ModioDefaultModTile_RegisterClickHandlers.png

void RegisterClickHandlers()
Set Mod Options Menu Visibility

nd_img_WBP_ModioDefaultModTile_SetModOptionsMenuVisibility.png

void SetModOptionsMenuVisibility(bool bShow)
Update Premium Details if Needed

nd_img_WBP_ModioDefaultModTile_UpdatePremiumDetailsIfNeeded.png

void UpdatePremiumDetailsIfNeeded(FModioModID InModID, FModioUnsigned64 ModPrice, FModioModID ModID)
On Menu Toggle State Changed

nd_img_WBP_ModioDefaultModTile_OnMenuToggleStateChanged.png

void OnMenuToggleStateChanged(UObject* Context, bool bIsOpen)
Get Mod Download Progress Widget

nd_img_WBP_ModioDefaultModTile_GetModDownloadProgressWidget.png

void GetModDownloadProgressWidget(TScriptInterface<IModioUIDataSourceWidget> Widget)
Variables
FLinearColorRefNormalBorderColor
FLinearColorRefSelectedBorderColor
FLinearColorRefNormalBackgroundColor
FLinearColorRefSelectedBackgroundColor
FLinearColorRefPremiumBackgroundColor
FLinearColorRefNormalTextColor
FLinearColorRefSelectedTextColor
FLinearColorRefPriceTextColor
FTextPurchasedLabelText

WBP_ModioDefaultModTileModPropCollectionVisualizer

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

Inheritance Hierarchy

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

On Set Data Source

nd_img_WBP_ModioDefaultModTileModPropCollectionVisualizer_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource)
Initialize Editor Preview

nd_img_WBP_ModioDefaultModTileModPropCollectionVisualizer_InitializeEditorPreview.png

void InitializeEditorPreview(bool bIsDesignTime)
Get Background Widget

nd_img_WBP_ModioDefaultModTileModPropCollectionVisualizer_GetBackgroundWidget.png

void GetBackgroundWidget(TScriptInterface<IModioUIHasConfigurableColor> Background)
Variables
UObject*EditorDataSource
FLinearColorRefBackgroundColor

WBP_ModioDefaultModUpdatedVisualizer

Displays the last updated date for a mod.

Inheritance Hierarchy

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

Initialize Editor Preview

nd_img_WBP_ModioDefaultModUpdatedVisualizer_InitializeEditorPreview.png

void InitializeEditorPreview(bool bIsDesignTime)
On Set Data Source

nd_img_WBP_ModioDefaultModUpdatedVisualizer_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource, FDateTime DateUpdated, FTimespan TimeSinceDateUpdated)
Get Value Text Widget

nd_img_WBP_ModioDefaultModUpdatedVisualizer_GetValueTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetValueTextWidget() const
Get Label Text Widget

nd_img_WBP_ModioDefaultModUpdatedVisualizer_GetLabelTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetLabelTextWidget() const
Variables
FTextLabelTextValue
UObject*EditorDataSource
boolbShowPropertyLabel
FLinearColorRefPropertyLabelColor
FTextValueFormatText
boolbUseTimeElapsed
FTextYear Format
FTextMonth Format
FTextDay Format
FTextToday Format

WBP_ModioDefaultModVersionVisualizer

Displays the current version of a mod.

Inheritance Hierarchy

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

Initialize Editor Preview

nd_img_WBP_ModioDefaultModVersionVisualizer_InitializeEditorPreview.png

void InitializeEditorPreview(bool bIsDesignTime)
On Set Data Source

nd_img_WBP_ModioDefaultModVersionVisualizer_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource, FString ModVersionString)
Get Value Text Widget

nd_img_WBP_ModioDefaultModVersionVisualizer_GetValueTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetValueTextWidget() const
Get Label Text Widget

nd_img_WBP_ModioDefaultModVersionVisualizer_GetLabelTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetLabelTextWidget() const
Variables
FTextLabelTextValue
UObject*EditorDataSource
boolbShowPropertyLabel
FLinearColorRefPropertyLabelColor

WBP_ModioDefaultModalDialogImpl

The base implementation for modal dialogs.

Inheritance Hierarchy

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

Apply Colors

nd_img_WBP_ModioDefaultModalDialogImpl_ApplyColors.png

void ApplyColors()
Apply Default Text

nd_img_WBP_ModioDefaultModalDialogImpl_ApplyDefaultText.png

void ApplyDefaultText()
Get Heading Text Widget

nd_img_WBP_ModioDefaultModalDialogImpl_GetHeadingTextWidget.png

void GetHeadingTextWidget(TScriptInterface<IModioUIHasTextWidget> HeadingTextWidget)
Get Primary Text Widget

nd_img_WBP_ModioDefaultModalDialogImpl_GetPrimaryTextWidget.png

void GetPrimaryTextWidget(TScriptInterface<IModioUIHasTextWidget> HeadingTextWidget)
Apply Button Configuration

nd_img_WBP_ModioDefaultModalDialogImpl_ApplyButtonConfiguration.png

void ApplyButtonConfiguration(TArray<UModioModBrowserDialogButtonInfoUI*> BoundButtonInfos)
On Generated Dialog Button Clicked

nd_img_WBP_ModioDefaultModalDialogImpl_OnGeneratedDialogButtonClicked.png

void OnGeneratedDialogButtonClicked(UObject* ClickContext)
Apply Size Overrides

nd_img_WBP_ModioDefaultModalDialogImpl_ApplySizeOverrides.png

void ApplySizeOverrides()
Configure Generated Dialog Button

nd_img_WBP_ModioDefaultModalDialogImpl_ConfigureGeneratedDialogButton.png

void ConfigureGeneratedDialogButton(UWidget* GeneratedButton)
Get Header Background

nd_img_WBP_ModioDefaultModalDialogImpl_GetHeaderBackground.png

void GetHeaderBackground(TScriptInterface<IModioUIHasConfigurableColor> Background)

nd_img_WBP_ModioDefaultModalDialogImpl_GetFooterBackground.png

void GetFooterBackground(TScriptInterface<IModioUIHasConfigurableColor> Background)
Get Primary Background

nd_img_WBP_ModioDefaultModalDialogImpl_GetPrimaryBackground.png

void GetPrimaryBackground(TScriptInterface<IModioUIHasConfigurableColor> Background)
Get Button Background

nd_img_WBP_ModioDefaultModalDialogImpl_GetButtonBackground.png

void GetButtonBackground(TScriptInterface<IModioUIHasConfigurableColor> Background)
Get Button Container

nd_img_WBP_ModioDefaultModalDialogImpl_GetButtonContainer.png

TScriptInterface<IModioUIObjectSelector> GetButtonContainer() const
Hide Default Widgets

nd_img_WBP_ModioDefaultModalDialogImpl_HideDefaultWidgets.png

void HideDefaultWidgets()
On Entry Generated

nd_img_WBP_ModioDefaultModalDialogImpl_OnEntryGenerated.png

void OnEntryGenerated(UWidget* ObjectWidget, UObject* Object)
Variables
FLinearColorRefHeaderBackgroundColor
FLinearColorRefPrimaryBackgroundColor
FLinearColorRefButtonBackgroundColor
FLinearColorRefFooterBackgroundColor
FTextDefaultHeadingText
FTextDefaultPrimaryText
FFloatOverrideMinimumWidth
FFloatOverrideMinimumHeight

WBP_ModioDefaultMultiTagSelectorEntry

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

Inheritance Hierarchy

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

Update Selected Visual State

nd_img_WBP_ModioDefaultMultiTagSelectorEntry_UpdateSelectedVisualState.png

void UpdateSelectedVisualState(bool Index)
On Set Data Source

nd_img_WBP_ModioDefaultMultiTagSelectorEntry_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource)
Get Checkbox Image Widget

nd_img_WBP_ModioDefaultMultiTagSelectorEntry_GetCheckboxImageWidget.png

void GetCheckboxImageWidget(TScriptInterface<IModioUIImageDisplayWidget> CheckboxImage) const
Item Selection Changed Handler

nd_img_WBP_ModioDefaultMultiTagSelectorEntry_ItemSelectionChangedHandler.png

void ItemSelectionChangedHandler(bool bIsSelected)
Variables
FSlateBrushCheckboxImage_Unselected
FSlateBrushCheckboxImage_Selected

WBP_ModioDefaultPlatformUsername

Displays the platform username of the user.

Inheritance Hierarchy

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

Get Modio User Name Text Widget

nd_img_WBP_ModioDefaultPlatformUsername_GetModioUserNameTextWidget.png

void GetModioUserNameTextWidget(TScriptInterface<IModioUIHasTextWidget> Widget)
On Set Data Source

nd_img_WBP_ModioDefaultPlatformUsername_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource, FString PlatformUserNameString)
Get Platform User Name Text Widget

nd_img_WBP_ModioDefaultPlatformUsername_GetPlatformUserNameTextWidget.png

void GetPlatformUserNameTextWidget(TScriptInterface<IModioUIHasTextWidget> Widget)
Variables
FTextPlatformUserNameFormat

WBP_ModioDefaultPopupCommandMenu

A popup menu displaying commands.

Inheritance Hierarchy

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

Add Toggle State Changed Handler

Registers a delegate to receive callbacks when the toggle state changes

nd_img_WBP_ModioDefaultPopupCommandMenu_AddToggleStateChangedHandler.png

void AddToggleStateChangedHandler(FModioOnToggleStateChanged Handler)
Parameters
TargetWBP_ModioDefaultPopupCommandMenu_C
HandlerDelegate to invoke on toggle state change
Remove Toggle State Changed Handler

Unregisters a delegate from receiving callbacks when the toggle state changes

nd_img_WBP_ModioDefaultPopupCommandMenu_RemoveToggleStateChangedHandler.png

void RemoveToggleStateChangedHandler(FModioOnToggleStateChanged Handler)
Parameters
TargetWBP_ModioDefaultPopupCommandMenu_C
HandlerDelegate to remove from toggle state change
Close

Toggles the close state of the widget

nd_img_WBP_ModioDefaultPopupCommandMenu_Close.png

void Close()
Parameters
TargetWBP_ModioDefaultPopupCommandMenu_C
Open

Toggles the open state of the widget

nd_img_WBP_ModioDefaultPopupCommandMenu_Open.png

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

nd_img_WBP_ModioDefaultPopupCommandMenu_OnGetMenuContent.png

UWidget* OnGetMenuContent(UModioCommandMenu* NewCommandMenuWidget)
On Menu Button Clicked

nd_img_WBP_ModioDefaultPopupCommandMenu_OnMenuButtonClicked.png

void OnMenuButtonClicked(UObject* ClickContext)
Get Menu Button

nd_img_WBP_ModioDefaultPopupCommandMenu_GetMenuButton.png

TScriptInterface<IModioUIClickableWidget> GetMenuButton() const
Get Back Button Widget

nd_img_WBP_ModioDefaultPopupCommandMenu_GetBackButtonWidget.png

TScriptInterface<IModioUIBoundActionWidget> GetBackButtonWidget() const
Get Dropdown Anchor Widget

nd_img_WBP_ModioDefaultPopupCommandMenu_GetDropdownAnchorWidget.png

TScriptInterface<IModioToggleableWidget> GetDropdownAnchorWidget() const
On Back Button Clicked

nd_img_WBP_ModioDefaultPopupCommandMenu_OnBackButtonClicked.png

void OnBackButtonClicked(UObject* ClickContext)
On Dropdown Anchor Toggle State Changed

nd_img_WBP_ModioDefaultPopupCommandMenu_OnDropdownAnchorToggleStateChanged.png

void OnDropdownAnchorToggleStateChanged(UObject* Context, bool bIsOpen)
Is Open

Get the current open/close state of the widget

nd_img_WBP_ModioDefaultPopupCommandMenu_IsOpen.png

bool IsOpen() const
Parameters
TargetWBP_ModioDefaultPopupCommandMenu_C
Returns

True if the widget is open, false otherwise

Variables
FOnToggleStateChangedOnToggleStateChanged

WBP_ModioDefaultPresetFilterEntryWidget

Represents an entry for a preset filter option.

Inheritance Hierarchy

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

Notify Clicked

nd_img_WBP_ModioDefaultPresetFilterEntryWidget_NotifyClicked.png

void NotifyClicked()
On Internal Button Clicked

nd_img_WBP_ModioDefaultPresetFilterEntryWidget_OnInternalButtonClicked.png

void OnInternalButtonClicked(UObject* ClickContext)
Variables
FLinearColorRefBackgroundColor
FOnClickedOnClicked

WBP_ModioDefaultPresetFilterSelectorWidget

A selector for choosing from preset filters.

Inheritance Hierarchy

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

Variables

WBP_ModioDefaultPurchaseTermsButtonsGroup

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

Inheritance Hierarchy

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

Get Terms Button Widget

nd_img_WBP_ModioDefaultPurchaseTermsButtonsGroup_GetTermsButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetTermsButtonWidget() const
Get Refund Button Widget

nd_img_WBP_ModioDefaultPurchaseTermsButtonsGroup_GetRefundButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetRefundButtonWidget() const
On Terms Button Clicked

nd_img_WBP_ModioDefaultPurchaseTermsButtonsGroup_OnTermsButtonClicked.png

void OnTermsButtonClicked(UObject* ClickContext)
On Refund Button Clicked

nd_img_WBP_ModioDefaultPurchaseTermsButtonsGroup_OnRefundButtonClicked.png

void OnRefundButtonClicked(UObject* ClickContext)
Add Button Event Handlers

nd_img_WBP_ModioDefaultPurchaseTermsButtonsGroup_AddButtonEventHandlers.png

void AddButtonEventHandlers()
Terms Retrieved Completed Handler

nd_img_WBP_ModioDefaultPurchaseTermsButtonsGroup_TermsRetrievedCompletedHandler.png

void TermsRetrievedCompletedHandler(FModioErrorCode ErrorCode, FModioOptionalTerms Terms)
Get Terms Button Text Widget

nd_img_WBP_ModioDefaultPurchaseTermsButtonsGroup_GetTermsButtonTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetTermsButtonTextWidget() const
Get Refund Button Text Widget

nd_img_WBP_ModioDefaultPurchaseTermsButtonsGroup_GetRefundButtonTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetRefundButtonTextWidget() const
Variables
FStringTermsURL
FStringRefundURL

WBP_ModioDefaultRadialProgressWidget

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

Inheritance Hierarchy

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

Set Progress

Directly sets the current progress value of the implementing widget

nd_img_WBP_ModioDefaultRadialProgressWidget_SetProgress.png

void SetProgress(float NewProgressValue)
Parameters
TargetWBP_ModioDefaultRadialProgressWidget_C
NewProgressValueThe new progress value
Set Color Override

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

nd_img_WBP_ModioDefaultRadialProgressWidget_SetColorOverride.png

void SetColorOverride(FLinearColor Override)
Parameters
TargetWBP_ModioDefaultRadialProgressWidget_C
OverrideThe new color to use
Clear Color Override

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

nd_img_WBP_ModioDefaultRadialProgressWidget_ClearColorOverride.png

void ClearColorOverride()
Parameters
TargetWBP_ModioDefaultRadialProgressWidget_C
Apply Material Instance

nd_img_WBP_ModioDefaultRadialProgressWidget_ApplyMaterialInstance.png

void ApplyMaterialInstance()
Get Progress Image Widget

nd_img_WBP_ModioDefaultRadialProgressWidget_GetProgressImageWidget.png

TScriptInterface<IModioUIImageDisplayWidget> GetProgressImageWidget() const
On Set Progress

nd_img_WBP_ModioDefaultRadialProgressWidget_OnSetProgress.png

void OnSetProgress(double NewProgressValue)
On Set Color Override

nd_img_WBP_ModioDefaultRadialProgressWidget_OnSetColorOverride.png

void OnSetColorOverride(FLinearColor NewColor)
Apply Preview Progress

nd_img_WBP_ModioDefaultRadialProgressWidget_ApplyPreviewProgress.png

void ApplyPreviewProgress()
Get Progress

Retrieves the current progress value of the implementing widget

nd_img_WBP_ModioDefaultRadialProgressWidget_GetProgress.png

float GetProgress()
Parameters
TargetWBP_ModioDefaultRadialProgressWidget_C
Returns

Progress Value in the range 0..1

Set Marquee

Sets whether the progress widget should be a marquee/throbber

nd_img_WBP_ModioDefaultRadialProgressWidget_SetMarquee.png

void SetMarquee(bool bNewIsMarquee)
Parameters
TargetWBP_ModioDefaultRadialProgressWidget_C
bNewIsMarqueeTrue if the progress widget should show indeterminate progress
Remove Value Changed Handler

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

nd_img_WBP_ModioDefaultRadialProgressWidget_RemoveValueChangedHandler.png

void RemoveValueChangedHandler(FModioProgressWidgetValueChanged Handler)
Parameters
TargetWBP_ModioDefaultRadialProgressWidget_C
HandlerDelegate to remove from the notification list
Add Value Changed Handler

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

nd_img_WBP_ModioDefaultRadialProgressWidget_AddValueChangedHandler.png

void AddValueChangedHandler(FModioProgressWidgetValueChanged Handler)
Parameters
TargetWBP_ModioDefaultRadialProgressWidget_C
HandlerDelegate to receive notifications on value changed events
Variables
UMaterialInterface*RadialProgressMaterial
UMaterialInstanceDynamic*ProgressMaterialInstance
doubleCurrentProgressValue
FLinearColorOriginalColor
doublePreviewProgress

WBP_ModioDefaultRatingDisplay

Displays the rating of a mod.

Inheritance Hierarchy

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

On Set Data Source

nd_img_WBP_ModioDefaultRatingDisplay_OnSetDataSource.png

void OnSetDataSource(UObject* DataSource, int64 RatingPercentagepositive)
Set Background Colors

nd_img_WBP_ModioDefaultRatingDisplay_SetBackgroundColors.png

void SetBackgroundColors(FLinearColorRef BackgroundColor, FLinearColor ResolvedColor)
Get Percentage Border Widget

nd_img_WBP_ModioDefaultRatingDisplay_GetPercentageBorderWidget.png

void GetPercentageBorderWidget(TScriptInterface<IModioUIHasConfigurableColor> Border) const
Get Description Border Widget

nd_img_WBP_ModioDefaultRatingDisplay_GetDescriptionBorderWidget.png

void GetDescriptionBorderWidget(TScriptInterface<IModioUIHasConfigurableColor> Border) const
Variables
FLinearColorRefPositiveColor
FLinearColorRefMixedColor
FLinearColorRefNegativeColor
TArray<FInt32Range>RatingColorRange

WBP_ModioDefaultReportContentDialog

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

Inheritance Hierarchy

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

On Set Data Source

nd_img_WBP_ModioDefaultReportContentDialog_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource, FModioModID DataSourceModID, FString ModName, FString ModVersion)
Logo Download Completed Handler

nd_img_WBP_ModioDefaultReportContentDialog_LogoDownloadCompletedHandler.png

void LogoDownloadCompletedHandler(FModioModID ModID, FModioErrorCode ErrorCode, FModioOptionalImage ImageOptional, EModioLogoSize LogoSize)
Display Loading Cog

nd_img_WBP_ModioDefaultReportContentDialog_DisplayLoadingCog.png

void DisplayLoadingCog()
On Submit Clicked

nd_img_WBP_ModioDefaultReportContentDialog_OnSubmitClicked.png

void OnSubmitClicked(UObject* ClickContext, FModioModID ModID, uint8 ReportType, FString ReportDescription, FString ReporterContact)
Return to Reason Select

nd_img_WBP_ModioDefaultReportContentDialog_ReturnToReasonSelect.png

void ReturnToReasonSelect()
Initialize Report Content Dialog

nd_img_WBP_ModioDefaultReportContentDialog_InitializeReportContentDialog.png

void InitializeReportContentDialog()
Cancel Report Dialog

nd_img_WBP_ModioDefaultReportContentDialog_CancelReportDialog.png

void CancelReportDialog(UObject* ClickContext)
On Back Button Clicked

nd_img_WBP_ModioDefaultReportContentDialog_OnBackButtonClicked.png

void OnBackButtonClicked(UObject* ClickContext)
Get Report Reason Selector Widget

nd_img_WBP_ModioDefaultReportContentDialog_GetReportReasonSelectorWidget.png

TScriptInterface<IModioUIObjectSelector> GetReportReasonSelectorWidget() const
Get Mod Name Label Widget

nd_img_WBP_ModioDefaultReportContentDialog_GetModNameLabelWidget.png

TScriptInterface<IModioUIHasTextWidget> GetModNameLabelWidget() const
Get Mod Logo Image

nd_img_WBP_ModioDefaultReportContentDialog_GetModLogoImage.png

void GetModLogoImage(TScriptInterface<IModioUIImageDisplayWidget> LabelWidget) const
Get Back Button Widget

nd_img_WBP_ModioDefaultReportContentDialog_GetBackButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetBackButtonWidget() const
Get Cancel Button Widget

nd_img_WBP_ModioDefaultReportContentDialog_GetCancelButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetCancelButtonWidget() const
Get Submit Button Widget

nd_img_WBP_ModioDefaultReportContentDialog_GetSubmitButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetSubmitButtonWidget() const
Get Report Details Editable Text Box Widget

nd_img_WBP_ModioDefaultReportContentDialog_GetReportDetailsEditableTextBoxWidget.png

void GetReportDetailsEditableTextBoxWidget(TScriptInterface<IModioUIStringInputWidget> ReportDetailsEditableTextBox) const
Get Email Address Editable Text Box Widget

nd_img_WBP_ModioDefaultReportContentDialog_GetEmailAddressEditableTextBoxWidget.png

void GetEmailAddressEditableTextBoxWidget(TScriptInterface<IModioUIStringInputWidget> EmailAddressEditableTextBox) const
On Report Details Text Changed

nd_img_WBP_ModioDefaultReportContentDialog_OnReportDetailsTextChanged.png

void OnReportDetailsTextChanged(UObject* Context, FText Text)
On Report Reason Selection Changed

nd_img_WBP_ModioDefaultReportContentDialog_OnReportReasonSelectionChanged.png

void OnReportReasonSelectionChanged(UObject* SelectedValue)
Report Submission Complete Handler

nd_img_WBP_ModioDefaultReportContentDialog_ReportSubmissionCompleteHandler.png

void ReportSubmissionCompleteHandler(FModioErrorCode ErrorCode)
Get Version Number Text Block

nd_img_WBP_ModioDefaultReportContentDialog_GetVersionNumberTextBlock.png

void GetVersionNumberTextBlock(TScriptInterface<IModioUIHasTextWidget> VersionNumber) const
Get Dialog Switcher Widget

nd_img_WBP_ModioDefaultReportContentDialog_GetDialogSwitcherWidget.png

void GetDialogSwitcherWidget(UWidgetSwitcher* NewParam) const
Set Version Info Visibility

nd_img_WBP_ModioDefaultReportContentDialog_SetVersionInfoVisibility.png

void SetVersionInfoVisibility(ESlateVisibility NewVisibility)
Get Version Label Text Block Widget

nd_img_WBP_ModioDefaultReportContentDialog_GetVersionLabelTextBlockWidget.png

void GetVersionLabelTextBlockWidget(TScriptInterface<IModioUIHasTextWidget> TextWidget) const
Transition to Details View

nd_img_WBP_ModioDefaultReportContentDialog_TransitionToDetailsView.png

void TransitionToDetailsView()
On Email Entry Text Changed

nd_img_WBP_ModioDefaultReportContentDialog_OnEmailEntryTextChanged.png

void OnEmailEntryTextChanged(UObject* Context, FText Text, bool NewSubmitButtonEnabledState)
Validate Report Content

nd_img_WBP_ModioDefaultReportContentDialog_ValidateReportContent.png

bool ValidateReportContent(bool bEmailValid)
Update Submit Button Enabled State

nd_img_WBP_ModioDefaultReportContentDialog_UpdateSubmitButtonEnabledState.png

void UpdateSubmitButtonEnabledState(bool NewSubmitButtonEnabledState)
Get Error Text Widget

nd_img_WBP_ModioDefaultReportContentDialog_GetErrorTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetErrorTextWidget() const
Get Invisible Focus Button Widget

nd_img_WBP_ModioDefaultReportContentDialog_GetInvisibleFocusButtonWidget.png

UWidget* GetInvisibleFocusButtonWidget() const
Variables
FSlateBrushLoadingCog

WBP_ModioDefaultSingleTagSelectorEntry

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

Inheritance Hierarchy

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

Update Selected Visual State

nd_img_WBP_ModioDefaultSingleTagSelectorEntry_UpdateSelectedVisualState.png

void UpdateSelectedVisualState(bool Index)
On Set Data Source

nd_img_WBP_ModioDefaultSingleTagSelectorEntry_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource)
Get Radio Button Image Widget

nd_img_WBP_ModioDefaultSingleTagSelectorEntry_GetRadioButtonImageWidget.png

void GetRadioButtonImageWidget(TScriptInterface<IModioUIImageDisplayWidget> RadioButtonImage) const
Item Selection Changed Handler

nd_img_WBP_ModioDefaultSingleTagSelectorEntry_ItemSelectionChangedHandler.png

void ItemSelectionChangedHandler(bool bIsSelected)
Variables
FSlateBrushRadioButton_Selected
FSlateBrushRadioButton_Unselected

WBP_ModioDefaultSlottedButton

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

Inheritance Hierarchy

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

On Hovered

nd_img_WBP_ModioDefaultSlottedButton_OnHovered.png

void OnHovered()
On Unhovered

nd_img_WBP_ModioDefaultSlottedButton_OnUnhovered.png

void OnUnhovered()
Set Hovered Visual State

nd_img_WBP_ModioDefaultSlottedButton_SetHoveredVisualState.png

void SetHoveredVisualState()
Set Normal Visual State

nd_img_WBP_ModioDefaultSlottedButton_SetNormalVisualState.png

void SetNormalVisualState()
Set Selected Visual State

nd_img_WBP_ModioDefaultSlottedButton_SetSelectedVisualState.png

void SetSelectedVisualState()
On Selection State Changed

nd_img_WBP_ModioDefaultSlottedButton_OnSelectionStateChanged.png

void OnSelectionStateChanged(bool bNewSelectionState)
Get Background Border Widget

nd_img_WBP_ModioDefaultSlottedButton_GetBackgroundBorderWidget.png

void GetBackgroundBorderWidget(TScriptInterface<IModioUIHasConfigurableColor> NewParam) const
Variables
FLinearColorRefNormalColor
FLinearColorRefSelectedColor
FLinearColorRefHoveredColor
FLinearColorRefTextColor

WBP_ModioDefaultSpecialButton

A specialized button with unique styling.

Inheritance Hierarchy

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

On Hovered

nd_img_WBP_ModioDefaultSpecialButton_OnHovered.png

void OnHovered()
On Unhovered

nd_img_WBP_ModioDefaultSpecialButton_OnUnhovered.png

void OnUnhovered()
Set Background Color

nd_img_WBP_ModioDefaultSpecialButton_SetBackgroundColor.png

void SetBackgroundColor(FLinearColorRef NewColor)
Set Hover Border Color

nd_img_WBP_ModioDefaultSpecialButton_SetHoverBorderColor.png

void SetHoverBorderColor(FLinearColorRef NewColor)
Set Text Color

nd_img_WBP_ModioDefaultSpecialButton_SetTextColor.png

void SetTextColor(FLinearColorRef Target)
Set Hovered Visual State

nd_img_WBP_ModioDefaultSpecialButton_SetHoveredVisualState.png

void SetHoveredVisualState()
Set Normal Visual State

nd_img_WBP_ModioDefaultSpecialButton_SetNormalVisualState.png

void SetNormalVisualState()
Set Selected Visual State

nd_img_WBP_ModioDefaultSpecialButton_SetSelectedVisualState.png

void SetSelectedVisualState()
On Selection State Changed

nd_img_WBP_ModioDefaultSpecialButton_OnSelectionStateChanged.png

void OnSelectionStateChanged(bool bNewSelectionState)
Get Background Border Widget

nd_img_WBP_ModioDefaultSpecialButton_GetBackgroundBorderWidget.png

void GetBackgroundBorderWidget(TScriptInterface<IModioUIHasConfigurableColor> Border) const
Get Highlight Border Widget

nd_img_WBP_ModioDefaultSpecialButton_GetHighlightBorderWidget.png

void GetHighlightBorderWidget(TScriptInterface<IModioUIHasConfigurableColor> Border) const
Set Border Brushes

nd_img_WBP_ModioDefaultSpecialButton_SetBorderBrushes.png

void SetBorderBrushes()
Variables
FLinearColorRefNormalColor
FLinearColorRefSelectedColor
FLinearColorRefHoveredColor
FLinearColorRefTextColor
FLinearColorRefSelectedTextColor
boolbUseBorder
FLinearColorRefSelectedBorderColor
UObject*HighlightBorderOverrideImage
UObject*BackgroundBorderOverrideImage

WBP_ModioDefaultTOSDialog

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

Inheritance Hierarchy

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

Add Dialog Confirmed Handler

Registers a callback to receive notifications when the dialog is confirmed

nd_img_WBP_ModioDefaultTOSDialog_AddDialogConfirmedHandler.png

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

Registers a callback to receive notifications when the dialog is canceled

nd_img_WBP_ModioDefaultTOSDialog_AddDialogCanceledHandler.png

void AddDialogCanceledHandler(FModioDialogEvent Handler)
Parameters
TargetWBP_ModioDefaultTOSDialog_C
HandlerDelegate to invoke on a cancellation event
Remove Dialog Confirmed Handler

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

nd_img_WBP_ModioDefaultTOSDialog_RemoveDialogConfirmedHandler.png

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

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

nd_img_WBP_ModioDefaultTOSDialog_RemoveDialogCanceledHandler.png

void RemoveDialogCanceledHandler(FModioDialogEvent Handler)
Parameters
TargetWBP_ModioDefaultTOSDialog_C
HandlerDelegate that will no longer receive cancellation events
Terms Retrieved Completed Handler

nd_img_WBP_ModioDefaultTOSDialog_TermsRetrievedCompletedHandler.png

void TermsRetrievedCompletedHandler(FModioErrorCode ErrorCode, FModioOptionalTerms Terms)
Get Terms Text Widget

nd_img_WBP_ModioDefaultTOSDialog_GetTermsTextWidget.png

void GetTermsTextWidget(TScriptInterface<IModioUIHasTextWidget> TermsTextWidget) const
On Dialog Button Clicked

nd_img_WBP_ModioDefaultTOSDialog_OnDialogButtonClicked.png

void OnDialogButtonClicked(int32 ButtonIndex)
Get TOSDialog Widget

nd_img_WBP_ModioDefaultTOSDialog_GetTOSDialogWidget.png

TScriptInterface<IModioUIDialog> GetTOSDialogWidget() const
Get Agree Dialog Button Widget

nd_img_WBP_ModioDefaultTOSDialog_GetAgreeDialogButtonWidget.png

void GetAgreeDialogButtonWidget(TScriptInterface<IModioUIHasTextWidget> Button) const
Get Disagree Dialog Button Widget

nd_img_WBP_ModioDefaultTOSDialog_GetDisagreeDialogButtonWidget.png

void GetDisagreeDialogButtonWidget(TScriptInterface<IModioUIHasTextWidget> Button) const
On Agree Button Clicked

nd_img_WBP_ModioDefaultTOSDialog_OnAgreeButtonClicked.png

void OnAgreeButtonClicked(UObject* ClickContext)
On Disagree Button Clicked

nd_img_WBP_ModioDefaultTOSDialog_OnDisagreeButtonClicked.png

void OnDisagreeButtonClicked(UObject* ClickContext)
Do Custom Navigation

nd_img_WBP_ModioDefaultTOSDialog_DoCustomNavigation.png

UWidget* DoCustomNavigation(EUINavigation Navigation)
Get Loading Switcher Widget

nd_img_WBP_ModioDefaultTOSDialog_GetLoadingSwitcherWidget.png

UWidgetSwitcher* GetLoadingSwitcherWidget() const
Set Loading Screen Visibility

nd_img_WBP_ModioDefaultTOSDialog_SetLoadingScreenVisibility.png

void SetLoadingScreenVisibility(bool bIsVisible)
Show Modal

Requests that the modal dialog be displayed

nd_img_WBP_ModioDefaultTOSDialog_ShowModal.png

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

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

nd_img_WBP_ModioDefaultTOSDialog_RemoveDialogShownHandler.png

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

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

nd_img_WBP_ModioDefaultTOSDialog_RemoveDialogButtonClickedHandler.png

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

Closes the modal dialog, removing it from display

nd_img_WBP_ModioDefaultTOSDialog_CloseModal.png

void CloseModal()
Parameters
TargetWBP_ModioDefaultTOSDialog_C
Add Dialog Shown Handler

Registers a callback to receive notifications when the dialog is shown

nd_img_WBP_ModioDefaultTOSDialog_AddDialogShownHandler.png

void AddDialogShownHandler(FModioDialogShownEvent Handler)
Parameters
TargetWBP_ModioDefaultTOSDialog_C
HandlerDelegate to invoke after the dialog is shown
Add Dialog Button Clicked Handler

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

nd_img_WBP_ModioDefaultTOSDialog_AddDialogButtonClickedHandler.png

void AddDialogButtonClickedHandler(FModioDialogButtonClickedEvent Handler)
Parameters
TargetWBP_ModioDefaultTOSDialog_C
HandlerDelegate to invoke when a button is clicked
Variables
FOnDialogConfirmedOnDialogConfirmed
FOnDialogCancelledOnDialogCancelled

WBP_ModioDefaultTagCategoryContainer

A container for grouping related tags within a category.

Inheritance Hierarchy

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

Get Category Button Widget

nd_img_WBP_ModioDefaultTagCategoryContainer_GetCategoryButtonWidget.png

void GetCategoryButtonWidget(TScriptInterface<IModioUIClickableWidget> ClickableWidget) const
Get Category Icon Widget

nd_img_WBP_ModioDefaultTagCategoryContainer_GetCategoryIconWidget.png

void GetCategoryIconWidget(TScriptInterface<IModioUIImageDisplayWidget> ClickableWidget)
Set Icon Colors

nd_img_WBP_ModioDefaultTagCategoryContainer_SetIconColors.png

void SetIconColors()
Set Visual State

nd_img_WBP_ModioDefaultTagCategoryContainer_SetVisualState.png

void SetVisualState(bool bCollapsed)
Do Navigation Outside Bounds Down

nd_img_WBP_ModioDefaultTagCategoryContainer_DoNavigationOutsideBoundsDown.png

UWidget* DoNavigationOutsideBoundsDown(EUINavigation Navigation)
Do Navigation Outside Bounds Up

nd_img_WBP_ModioDefaultTagCategoryContainer_DoNavigationOutsideBoundsUp.png

UWidget* DoNavigationOutsideBoundsUp(EUINavigation Navigation)
Process Navigation from Outside

nd_img_WBP_ModioDefaultTagCategoryContainer_ProcessNavigationFromOutside.png

void ProcessNavigationFromOutside(bool bFromDown, UWidget* TagListView_AsWidget)
Do Navigation from Tag Category Button Down

nd_img_WBP_ModioDefaultTagCategoryContainer_DoNavigationFromTagCategoryButtonDown.png

UWidget* DoNavigationFromTagCategoryButtonDown(EUINavigation Navigation, UWidget* TagList_AsWidget)
On Category Button Clicked

nd_img_WBP_ModioDefaultTagCategoryContainer_OnCategoryButtonClicked.png

void OnCategoryButtonClicked(UObject* ClickContext)
Get Widget to Focus Selected Item

nd_img_WBP_ModioDefaultTagCategoryContainer_GetWidgetToFocus_SelectedItem.png

UWidget* GetWidgetToFocus_SelectedItem() const
Get Widget to Focus Last Item

nd_img_WBP_ModioDefaultTagCategoryContainer_GetWidgetToFocus_LastItem.png

UWidget* GetWidgetToFocus_LastItem() const
Do Navigation to Tag Category Button

nd_img_WBP_ModioDefaultTagCategoryContainer_DoNavigationToTagCategoryButton.png

UWidget* DoNavigationToTagCategoryButton(EUINavigation Navigation)
Remove Clicked Handler

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

nd_img_WBP_ModioDefaultTagCategoryContainer_RemoveClickedHandler.png

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

Enables click events being emitted by the implementing object

nd_img_WBP_ModioDefaultTagCategoryContainer_EnableClick.png

void EnableClick()
Parameters
TargetWBP_ModioDefaultTagCategoryContainer_C
Disable Click

Disables click events being emitted by the implementing object

nd_img_WBP_ModioDefaultTagCategoryContainer_DisableClick.png

void DisableClick()
Parameters
TargetWBP_ModioDefaultTagCategoryContainer_C
Add Clicked Handler

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

nd_img_WBP_ModioDefaultTagCategoryContainer_AddClickedHandler.png

void AddClickedHandler(FModioClickableOnClicked Handler)
Parameters
TargetWBP_ModioDefaultTagCategoryContainer_C
HandlerDelegate to invoke on a click event
Get Toggleable

Retrieves the toggle-able state of the implementing widget

nd_img_WBP_ModioDefaultTagCategoryContainer_GetToggleable.png

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

Retrieves the current selection state of the implementing widget

nd_img_WBP_ModioDefaultTagCategoryContainer_GetSelectedState.png

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

Retrieves the selectable state of the implementing widget

nd_img_WBP_ModioDefaultTagCategoryContainer_GetSelectable.png

void GetSelectable(bool bIsSelectable)
Parameters
TargetWBP_ModioDefaultTagCategoryContainer_C
Is SelectableTrue if the implementing widget can be selected
Toggle Selected State

Toggles the selected state of the implementing widget

nd_img_WBP_ModioDefaultTagCategoryContainer_ToggleSelectedState.png

void ToggleSelectedState()
Parameters
TargetWBP_ModioDefaultTagCategoryContainer_C
Set Toggleable

Enables or disables toggle-ability on the implementing widget

nd_img_WBP_ModioDefaultTagCategoryContainer_SetToggleable.png

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

Directly sets the selected state of the implementing widget

nd_img_WBP_ModioDefaultTagCategoryContainer_SetSelectedState.png

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

Sets the selectable state of the implementing widget

nd_img_WBP_ModioDefaultTagCategoryContainer_SetSelectable.png

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

Unsubscribes a delegate from receiving state change callbacks

nd_img_WBP_ModioDefaultTagCategoryContainer_RemoveSelectedStateChangedHandler.png

void RemoveSelectedStateChangedHandler(FModioSelectableOnSelectionChanged Handler)
Parameters
TargetWBP_ModioDefaultTagCategoryContainer_C
HandlerThe delegate to remove
Add Selected State Changed Handler

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

nd_img_WBP_ModioDefaultTagCategoryContainer_AddSelectedStateChangedHandler.png

void AddSelectedStateChangedHandler(FModioSelectableOnSelectionChanged Handler)
Parameters
TargetWBP_ModioDefaultTagCategoryContainer_C
HandlerDelegate to invoke on state change
Variables
boolbSelectable
boolbSelected
boolbToggleable
FSlateBrushExpandedIconBrush
FSlateBrushClosedIconBrush
FLinearColorRefIconColor
FOnNavigationOutsideBoundsOnNavigationOutsideBounds

WBP_ModioDefaultTagDisplay

Displays a tag associated with a mod.

Inheritance Hierarchy

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

Variables

WBP_ModioDefaultTagSelectorMenu

A menu displaying available tags for selection.

Inheritance Hierarchy

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

Get Category Container Widget Object Selector

nd_img_WBP_ModioDefaultTagSelectorMenu_GetCategoryContainerWidget_ObjectSelector.png

void GetCategoryContainerWidget_ObjectSelector(TScriptInterface<IModioUIObjectSelector> TagCategoryContainer) const
Get Widget to Focus from Bottom

nd_img_WBP_ModioDefaultTagSelectorMenu_GetWidgetToFocus_FromBottom.png

UWidget* GetWidgetToFocus_FromBottom() const
On Object Widget Created

nd_img_WBP_ModioDefaultTagSelectorMenu_OnObjectWidgetCreated.png

void OnObjectWidgetCreated(UWidget* ObjectWidget, UObject* Object)
Handle Navigation Outside Bounds

nd_img_WBP_ModioDefaultTagSelectorMenu_HandleNavigationOutsideBounds.png

void HandleNavigationOutsideBounds(bool bDown, UObject* ListItem, int32 NumEntries, int32 SelectionIndex)
Variables
FOnNavigationOutsideBoundsOnNavigationOutsideBounds

WBP_ModioDefaultTagWidget

A widget representing an individual mod tag.

Inheritance Hierarchy

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

Get Tag Button

nd_img_WBP_ModioDefaultTagWidget_GetTagButton.png

void GetTagButton(TScriptInterface<IModioUIClickableWidget> Button)
On Tag Button Clicked Handler

nd_img_WBP_ModioDefaultTagWidget_OnTagButtonClickedHandler.png

void OnTagButtonClickedHandler(UObject* ClickContext)
Variables

WBP_ModioDefaultTermsButtonsGroup

A group of buttons related to general terms and conditions.

Inheritance Hierarchy

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

Get Terms Button Widget

nd_img_WBP_ModioDefaultTermsButtonsGroup_GetTermsButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetTermsButtonWidget() const
Get Privacy Button Widget

nd_img_WBP_ModioDefaultTermsButtonsGroup_GetPrivacyButtonWidget.png

TScriptInterface<IModioUIClickableWidget> GetPrivacyButtonWidget() const
On Terms Button Clicked

nd_img_WBP_ModioDefaultTermsButtonsGroup_OnTermsButtonClicked.png

void OnTermsButtonClicked(UObject* ClickContext)
On Privacy Button Clicked

nd_img_WBP_ModioDefaultTermsButtonsGroup_OnPrivacyButtonClicked.png

void OnPrivacyButtonClicked(UObject* ClickContext)
Add Button Event Handlers

nd_img_WBP_ModioDefaultTermsButtonsGroup_AddButtonEventHandlers.png

void AddButtonEventHandlers()
Terms Retrieved Completed Handler

nd_img_WBP_ModioDefaultTermsButtonsGroup_TermsRetrievedCompletedHandler.png

void TermsRetrievedCompletedHandler(FModioErrorCode ErrorCode, FModioOptionalTerms Terms)
Get Terms Button Text Widget

nd_img_WBP_ModioDefaultTermsButtonsGroup_GetTermsButtonTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetTermsButtonTextWidget() const
Get Privacy Button Text Widget

nd_img_WBP_ModioDefaultTermsButtonsGroup_GetPrivacyButtonTextWidget.png

TScriptInterface<IModioUIHasTextWidget> GetPrivacyButtonTextWidget() const
Variables
FStringTermsURL
FStringPrivacyURL

WBP_ModioDefaultTokenPackBrowser

Inheritance Hierarchy

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

Select First List Item

nd_img_WBP_ModioDefaultTokenPackBrowser_SelectFirstListItem.png

void SelectFirstListItem()
Get Token Pack Tile Widget

nd_img_WBP_ModioDefaultTokenPackBrowser_GetTokenPackTileWidget.png

void GetTokenPackTileWidget(TScriptInterface<IModioUITokenPackListInterface> Widget)
Get Close Button

nd_img_WBP_ModioDefaultTokenPackBrowser_GetCloseButton.png

void GetCloseButton(TScriptInterface<IModioUIClickableWidget> Widget)
Get Token Pack Tile Object List Widget

nd_img_WBP_ModioDefaultTokenPackBrowser_GetTokenPackTileObjectListWidget.png

void GetTokenPackTileObjectListWidget(TScriptInterface<IModioUIObjectListWidget> Widget) const
Get Confirm Purchase Button

nd_img_WBP_ModioDefaultTokenPackBrowser_GetConfirmPurchaseButton.png

void GetConfirmPurchaseButton(TScriptInterface<IModioUIClickableWidget> Widget)
Get Cancel Confirm Purchase Button

nd_img_WBP_ModioDefaultTokenPackBrowser_GetCancelConfirmPurchaseButton.png

void GetCancelConfirmPurchaseButton(TScriptInterface<IModioUIClickableWidget> Widget)
Get Token Pack Description Text

nd_img_WBP_ModioDefaultTokenPackBrowser_GetTokenPackDescriptionText.png

void GetTokenPackDescriptionText(TScriptInterface<IModioUIHasTextWidget> widget)
Initialize Token Packs

nd_img_WBP_ModioDefaultTokenPackBrowser_InitializeTokenPacks.png

void InitializeTokenPacks()
Show Token Pack List

nd_img_WBP_ModioDefaultTokenPackBrowser_ShowTokenPackList.png

void ShowTokenPackList()
Show Token Pack Purchase Confirmation

nd_img_WBP_ModioDefaultTokenPackBrowser_ShowTokenPackPurchaseConfirmation.png

void ShowTokenPackPurchaseConfirmation()
Update Confirmation Token Data

nd_img_WBP_ModioDefaultTokenPackBrowser_UpdateConfirmationTokenData.png

void UpdateConfirmationTokenData(FModioTokenPack TokenPackData)
Do Custom Navigation from Close Button

nd_img_WBP_ModioDefaultTokenPackBrowser_DoCustomNavigationFromCloseButton.png

UWidget* DoCustomNavigationFromCloseButton(EUINavigation Navigation)
On Cancel Purchase Confirmation Handler

nd_img_WBP_ModioDefaultTokenPackBrowser_OnCancelPurchaseConfirmationHandler.png

void OnCancelPurchaseConfirmationHandler(UObject* ClickContext)
On Confirm Purchase Handler

nd_img_WBP_ModioDefaultTokenPackBrowser_OnConfirmPurchaseHandler.png

void OnConfirmPurchaseHandler(UObject* ClickContext)
On Purchase Token Pack Response

nd_img_WBP_ModioDefaultTokenPackBrowser_OnPurchaseTokenPackResponse.png

void OnPurchaseTokenPackResponse(bool bSuccess, FString Message)
On Token Pack Entry Clicked

nd_img_WBP_ModioDefaultTokenPackBrowser_OnTokenPackEntryClicked.png

void OnTokenPackEntryClicked(UObject* ClickContext)
On Token Pack List Object Created Handler

nd_img_WBP_ModioDefaultTokenPackBrowser_OnTokenPackListObjectCreatedHandler.png

void OnTokenPackListObjectCreatedHandler(UWidget* ObjectWidget, UObject* Object)
On Close Button Clicked Handler

nd_img_WBP_ModioDefaultTokenPackBrowser_OnCloseButtonClickedHandler.png

void OnCloseButtonClickedHandler(UObject* ClickContext)
Bind Handlers

nd_img_WBP_ModioDefaultTokenPackBrowser_BindHandlers.png

void BindHandlers()
On Refresh User Entitlements Response

nd_img_WBP_ModioDefaultTokenPackBrowser_OnRefreshUserEntitlementsResponse.png

void OnRefreshUserEntitlementsResponse(bool bSuccess, FString Message)
Variables
FModioTokenPackIDPackToPurchase

WBP_ModioDefaultTokenPackTile

Inheritance Hierarchy

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

Get Token Pack Overlay Button

nd_img_WBP_ModioDefaultTokenPackTile_GetTokenPackOverlayButton.png

void GetTokenPackOverlayButton(TScriptInterface<IModioUIClickableWidget> Widget) const
Get Quantity Text Widget

nd_img_WBP_ModioDefaultTokenPackTile_GetQuantityTextWidget.png

void GetQuantityTextWidget(TScriptInterface<IModioUIHasTextWidget> Widget)
Get Price Text Widget

nd_img_WBP_ModioDefaultTokenPackTile_GetPriceTextWidget.png

void GetPriceTextWidget(TScriptInterface<IModioUIHasTextWidget> Widget)
Update Quantity

nd_img_WBP_ModioDefaultTokenPackTile_UpdateQuantity.png

void UpdateQuantity()
Update Price

nd_img_WBP_ModioDefaultTokenPackTile_UpdatePrice.png

void UpdatePrice()
Bind Handlers

nd_img_WBP_ModioDefaultTokenPackTile_BindHandlers.png

void BindHandlers()
On Token Pack Button Clicked Handler

nd_img_WBP_ModioDefaultTokenPackTile_OnTokenPackButtonClickedHandler.png

void OnTokenPackButtonClickedHandler(UObject* ClickContext)
Deregister Event Listeners

nd_img_WBP_ModioDefaultTokenPackTile_DeregisterEventListeners.png

void DeregisterEventListeners()
Register Event Receivers

nd_img_WBP_ModioDefaultTokenPackTile_RegisterEventReceivers.png

void RegisterEventReceivers()
Debug Data

nd_img_WBP_ModioDefaultTokenPackTile_DebugData.png

void DebugData(FString Fields)
On Set Data Source

nd_img_WBP_ModioDefaultTokenPackTile_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource)
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

On Hovered

nd_img_WBP_ModioFilterCounterButton_OnHovered.png

void OnHovered()
On Unhovered

nd_img_WBP_ModioFilterCounterButton_OnUnhovered.png

void OnUnhovered()
Set Hovered Visual State

nd_img_WBP_ModioFilterCounterButton_SetHoveredVisualState.png

void SetHoveredVisualState()
Set Normal Visual State

nd_img_WBP_ModioFilterCounterButton_SetNormalVisualState.png

void SetNormalVisualState()
Set Selected Visual State

nd_img_WBP_ModioFilterCounterButton_SetSelectedVisualState.png

void SetSelectedVisualState()
On Selection State Changed

nd_img_WBP_ModioFilterCounterButton_OnSelectionStateChanged.png

void OnSelectionStateChanged(bool bNewSelectionState)
Get Background Border

nd_img_WBP_ModioFilterCounterButton_GetBackgroundBorder.png

void GetBackgroundBorder(TScriptInterface<IModioUIHasConfigurableColor> Border) const
Get Highlight Border

nd_img_WBP_ModioFilterCounterButton_GetHighlightBorder.png

void GetHighlightBorder(TScriptInterface<IModioUIHasConfigurableColor> Border) const
Get Label Widget Configurable Color

nd_img_WBP_ModioFilterCounterButton_GetLabelWidget_ConfigurableColor.png

void GetLabelWidget_ConfigurableColor(TScriptInterface<IModioUIHasConfigurableColor> Border) const
On Pre Construct

nd_img_WBP_ModioFilterCounterButton_OnPreConstruct.png

void OnPreConstruct()
Variables
FLinearColorRefNormalColor
FLinearColorRefSelectedColor
FLinearColorRefHoveredColor
FLinearColorRefTextColor
FLinearColorRefSelectedTextColor
FHAlignOverrideHorizontalAlignmentOverride
FLinearColorRefNormalBorderColor

WBP_ModioFilterPanel

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

Inheritance Hierarchy

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

On Clear All Button Clicked

nd_img_WBP_ModioFilterPanel_OnClearAllButtonClicked.png

void OnClearAllButtonClicked(UObject* ClickContext)
Deactivate Panel

nd_img_WBP_ModioFilterPanel_DeactivatePanel.png

void DeactivatePanel(UObject* ClickContext)
Get Filter Panel Background Widget

nd_img_WBP_ModioFilterPanel_GetFilterPanelBackgroundWidget.png

void GetFilterPanelBackgroundWidget(TScriptInterface<IModioUIHasConfigurableColor> Border) const
Get Filter Panel Header Border Widget

nd_img_WBP_ModioFilterPanel_GetFilterPanelHeaderBorderWidget.png

void GetFilterPanelHeaderBorderWidget(TScriptInterface<IModioUIHasConfigurableColor> Border) const
Variables
FLinearColorRefFilterPanelBackgroundColor
FLinearColorRefFilterPanelHeaderColor

WBP_ModioGalleryListEntry

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

Inheritance Hierarchy

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

Get Icon Image

nd_img_WBP_ModioGalleryListEntry_GetIconImage.png

TScriptInterface<IModioUIImageDisplayWidget> GetIconImage() const
Get Icon Image Configurable Color

nd_img_WBP_ModioGalleryListEntry_GetIconImage_ConfigurableColor.png

TScriptInterface<IModioUIHasConfigurableColor> GetIconImage_ConfigurableColor() const
Update Icon Color

nd_img_WBP_ModioGalleryListEntry_UpdateIconColor.png

void UpdateIconColor(bool bIsSelected)
Variables
FLinearColorRefUnselectedColor
FLinearColorRefSelectedColor

WBP_ModioImageGallery

A gallery displaying a collection of images.

Inheritance Hierarchy

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

Display Loading Cog

nd_img_WBP_ModioImageGallery_DisplayLoadingCog.png

void DisplayLoadingCog()
On Image Selection Changed

nd_img_WBP_ModioImageGallery_OnImageSelectionChanged.png

void OnImageSelectionChanged(UObject* SelectedValue)

nd_img_WBP_ModioImageGallery_OnIncrementGallerySelection.png

void OnIncrementGallerySelection(UObject* ClickContext)

nd_img_WBP_ModioImageGallery_OnDecrementGallerySelection.png

void OnDecrementGallerySelection(UObject* ClickContext)
Bind Selector Handlers

nd_img_WBP_ModioImageGallery_BindSelectorHandlers.png

void BindSelectorHandlers()
On Set Data Source

nd_img_WBP_ModioImageGallery_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource)
Variables
FSlateBrushLoadingCog
boolbTouchInteractionActive

WBP_ModioLibraryCategorySelector

Inheritance Hierarchy

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

Get Category Button Widget

nd_img_WBP_ModioLibraryCategorySelector_GetCategoryButtonWidget.png

void GetCategoryButtonWidget(TScriptInterface<IModioUIClickableWidget> ClickableWidget) const
Get Category Icon Widget

nd_img_WBP_ModioLibraryCategorySelector_GetCategoryIconWidget.png

void GetCategoryIconWidget(TScriptInterface<IModioUIImageDisplayWidget> ClickableWidget)
Set Icon Colors

nd_img_WBP_ModioLibraryCategorySelector_SetIconColors.png

void SetIconColors()
Set Visual State

nd_img_WBP_ModioLibraryCategorySelector_SetVisualState.png

void SetVisualState(bool bCollapsed)
On Category Button Clicked

nd_img_WBP_ModioLibraryCategorySelector_OnCategoryButtonClicked.png

void OnCategoryButtonClicked(UObject* ClickContext)
Get All Mods Selector Entry

nd_img_WBP_ModioLibraryCategorySelector_GetAllModsSelectorEntry.png

void GetAllModsSelectorEntry(TScriptInterface<IModioUISelectableWidget> SelectableWidget) const
Get Installed Selector Entry

nd_img_WBP_ModioLibraryCategorySelector_GetInstalledSelectorEntry.png

void GetInstalledSelectorEntry(TScriptInterface<IModioUISelectableWidget> SelectableWidget) const
Get Purchased Selector Entry

nd_img_WBP_ModioLibraryCategorySelector_GetPurchasedSelectorEntry.png

void GetPurchasedSelectorEntry(TScriptInterface<IModioUISelectableWidget> SelectableWidget) const
On All Mods Selection Changed

nd_img_WBP_ModioLibraryCategorySelector_OnAllModsSelectionChanged.png

void OnAllModsSelectionChanged(UObject* SelectionContext, bool bNewSelectedState)
On Purchased Selection Changed

nd_img_WBP_ModioLibraryCategorySelector_OnPurchasedSelectionChanged.png

void OnPurchasedSelectionChanged(UObject* SelectionContext, bool bNewSelectedState)
On Installed Selection Changed

nd_img_WBP_ModioLibraryCategorySelector_OnInstalledSelectionChanged.png

void OnInstalledSelectionChanged(UObject* SelectionContext, bool bNewSelectedState)
Initialize Appearance

nd_img_WBP_ModioLibraryCategorySelector_InitializeAppearance.png

void InitializeAppearance()
Add Handlers

nd_img_WBP_ModioLibraryCategorySelector_AddHandlers.png

void AddHandlers()
Check Default All Mods Selection

nd_img_WBP_ModioLibraryCategorySelector_CheckDefaultAllModsSelection.png

void CheckDefaultAllModsSelection()
Do Navigation from Tag Category Button Down

nd_img_WBP_ModioLibraryCategorySelector_DoNavigationFromTagCategoryButtonDown.png

UWidget* DoNavigationFromTagCategoryButtonDown(EUINavigation Navigation, UWidget* TagList_AsWidget)
Do Navigation to Installed Entry

nd_img_WBP_ModioLibraryCategorySelector_DoNavigationToInstalledEntry.png

UWidget* DoNavigationToInstalledEntry(EUINavigation Navigation)
Do Navigation to All Mods Entry

nd_img_WBP_ModioLibraryCategorySelector_DoNavigationToAllModsEntry.png

UWidget* DoNavigationToAllModsEntry(EUINavigation Navigation)
Do Navigation to Purchased Mods

nd_img_WBP_ModioLibraryCategorySelector_DoNavigationToPurchasedMods.png

UWidget* DoNavigationToPurchasedMods(EUINavigation Navigation)
Do Navigation to Outside Bounds

nd_img_WBP_ModioLibraryCategorySelector_DoNavigationToOutsideBounds.png

UWidget* DoNavigationToOutsideBounds(EUINavigation Navigation)
Get Widget for Value

Retrieves the widget associated with the specified value

nd_img_WBP_ModioLibraryCategorySelector_GetWidgetForValue.png

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

The widget associated with the specified value

Get Single Selection Index

Gets the current selection for the implementing widget by index

nd_img_WBP_ModioLibraryCategorySelector_GetSingleSelectionIndex.png

int32 GetSingleSelectionIndex()
Parameters
TargetWBP_ModioLibraryCategorySelector_C
Returns

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

Get Single Selected Value

Retrieves the selection of the implementing widget

nd_img_WBP_ModioLibraryCategorySelector_GetSingleSelectedValue.png

UObject* GetSingleSelectedValue()
Parameters
TargetWBP_ModioLibraryCategorySelector_C
Returns

UObject associated with the current selection of the implementing widget

Get Selected Values

Retrieves the selected values from the implementing widget

nd_img_WBP_ModioLibraryCategorySelector_GetSelectedValues.png

TArray<UObject*> GetSelectedValues(TArray<UObject*> SelectedValues)
Parameters
TargetWBP_ModioLibraryCategorySelector_C
Returns

Array of UObjects representing the selected values

Get Num Entries

Gets the number of entries in the implementing widget

nd_img_WBP_ModioLibraryCategorySelector_GetNumEntries.png

int32 GetNumEntries()
Parameters
TargetWBP_ModioLibraryCategorySelector_C
Returns

The number of entries in the implementing widget

Get Multi Selection Allowed

Retrieves whether the implementing widget allows multiple selections

nd_img_WBP_ModioLibraryCategorySelector_GetMultiSelectionAllowed.png

bool GetMultiSelectionAllowed()
Parameters
TargetWBP_ModioLibraryCategorySelector_C
Returns

True if multiple selections are allowed

Get Index for Value

Retrieves the index of the specified value

nd_img_WBP_ModioLibraryCategorySelector_GetIndexForValue.png

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

The 0-based index of the specified value

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.

nd_img_WBP_ModioLibraryCategorySelector_GetLastSelectionIndex.png

int32 GetLastSelectionIndex()
Parameters
TargetWBP_ModioLibraryCategorySelector_C
Returns

The 0-based index of the previously selected object

Set Values

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

nd_img_WBP_ModioLibraryCategorySelector_SetValues.png

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

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

nd_img_WBP_ModioLibraryCategorySelector_SetSingleSelectionByValue.png

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

Sets the current selection for the implementing widget by index

nd_img_WBP_ModioLibraryCategorySelector_SetSingleSelectionByIndex.png

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

Sets the selected state for the specified value

nd_img_WBP_ModioLibraryCategorySelector_SetSelectedStateForValue.png

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

Sets the selected state for the specified index

nd_img_WBP_ModioLibraryCategorySelector_SetSelectedStateForIndex.png

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

Sets whether the implementing widget should allow multiple selections

nd_img_WBP_ModioLibraryCategorySelector_SetMultiSelectionAllowed.png

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

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

nd_img_WBP_ModioLibraryCategorySelector_SetListEntryWidgetClass.png

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

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

nd_img_WBP_ModioLibraryCategorySelector_RemoveSelectionChangedHandler.png

void RemoveSelectionChangedHandler(FModioOnObjectSelectionChanged Handler)
Parameters
TargetWBP_ModioLibraryCategorySelector_C
HandlerDelegate that will no longer receive callbacks
Clear Selected Values

Clears the selection state on the implementing widget

nd_img_WBP_ModioLibraryCategorySelector_ClearSelectedValues.png

void ClearSelectedValues()
Parameters
TargetWBP_ModioLibraryCategorySelector_C
Add Selection Changed Handler

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

nd_img_WBP_ModioLibraryCategorySelector_AddSelectionChangedHandler.png

void AddSelectionChangedHandler(FModioOnObjectSelectionChanged Handler)
Parameters
TargetWBP_ModioLibraryCategorySelector_C
HandlerDelegate to invoke on selection state change
Variables
boolbSelectable
boolbSelected
boolbToggleable
FSlateBrushExpandedIconBrush
FSlateBrushClosedIconBrush
FLinearColorRefIconColor
FOnNavigationOutsideBoundsOnNavigationOutsideBounds

WBP_ModioLibraryFilterPanel

Inheritance Hierarchy

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

On Clear All Button Clicked

nd_img_WBP_ModioLibraryFilterPanel_OnClearAllButtonClicked.png

void OnClearAllButtonClicked(UObject* ClickContext)
Deactivate Panel

nd_img_WBP_ModioLibraryFilterPanel_DeactivatePanel.png

void DeactivatePanel(UObject* ClickContext)
Get Library Category Selector Widget

nd_img_WBP_ModioLibraryFilterPanel_GetLibraryCategorySelectorWidget.png

void GetLibraryCategorySelectorWidget(TScriptInterface<IModioUIObjectSelector> LibraryCategorySelector) const
Get Filter Panel Background Border

nd_img_WBP_ModioLibraryFilterPanel_GetFilterPanelBackgroundBorder.png

void GetFilterPanelBackgroundBorder(TScriptInterface<IModioUIHasConfigurableColor> Border) const
Get Filter Panel Header Border

nd_img_WBP_ModioLibraryFilterPanel_GetFilterPanelHeaderBorder.png

void GetFilterPanelHeaderBorder(TScriptInterface<IModioUIHasConfigurableColor> Border) const
Do Navigation to Library Category from Bottom

nd_img_WBP_ModioLibraryFilterPanel_DoNavigationToLibraryCategoryFromBottom.png

UWidget* DoNavigationToLibraryCategoryFromBottom(EUINavigation Navigation)
Get Widget for Value

Retrieves the widget associated with the specified value

nd_img_WBP_ModioLibraryFilterPanel_GetWidgetForValue.png

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

The widget associated with the specified value

Get Single Selection Index

Gets the current selection for the implementing widget by index

nd_img_WBP_ModioLibraryFilterPanel_GetSingleSelectionIndex.png

int32 GetSingleSelectionIndex()
Parameters
TargetWBP_ModioLibraryFilterPanel_C
Returns

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

Get Single Selected Value

Retrieves the selection of the implementing widget

nd_img_WBP_ModioLibraryFilterPanel_GetSingleSelectedValue.png

UObject* GetSingleSelectedValue()
Parameters
TargetWBP_ModioLibraryFilterPanel_C
Returns

UObject associated with the current selection of the implementing widget

Get Selected Values

Retrieves the selected values from the implementing widget

nd_img_WBP_ModioLibraryFilterPanel_GetSelectedValues.png

TArray<UObject*> GetSelectedValues()
Parameters
TargetWBP_ModioLibraryFilterPanel_C
Returns

Array of UObjects representing the selected values

Get Num Entries

Gets the number of entries in the implementing widget

nd_img_WBP_ModioLibraryFilterPanel_GetNumEntries.png

int32 GetNumEntries()
Parameters
TargetWBP_ModioLibraryFilterPanel_C
Returns

The number of entries in the implementing widget

Get Multi Selection Allowed

Retrieves whether the implementing widget allows multiple selections

nd_img_WBP_ModioLibraryFilterPanel_GetMultiSelectionAllowed.png

bool GetMultiSelectionAllowed()
Parameters
TargetWBP_ModioLibraryFilterPanel_C
Returns

True if multiple selections are allowed

Get Index for Value

Retrieves the index of the specified value

nd_img_WBP_ModioLibraryFilterPanel_GetIndexForValue.png

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

The 0-based index of the specified value

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.

nd_img_WBP_ModioLibraryFilterPanel_GetLastSelectionIndex.png

int32 GetLastSelectionIndex()
Parameters
TargetWBP_ModioLibraryFilterPanel_C
Returns

The 0-based index of the previously selected object

Set Values

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

nd_img_WBP_ModioLibraryFilterPanel_SetValues.png

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

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

nd_img_WBP_ModioLibraryFilterPanel_SetSingleSelectionByValue.png

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

Sets the current selection for the implementing widget by index

nd_img_WBP_ModioLibraryFilterPanel_SetSingleSelectionByIndex.png

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

Sets the selected state for the specified value

nd_img_WBP_ModioLibraryFilterPanel_SetSelectedStateForValue.png

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

Sets the selected state for the specified index

nd_img_WBP_ModioLibraryFilterPanel_SetSelectedStateForIndex.png

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

Sets whether the implementing widget should allow multiple selections

nd_img_WBP_ModioLibraryFilterPanel_SetMultiSelectionAllowed.png

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

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

nd_img_WBP_ModioLibraryFilterPanel_SetListEntryWidgetClass.png

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

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

nd_img_WBP_ModioLibraryFilterPanel_RemoveSelectionChangedHandler.png

void RemoveSelectionChangedHandler(FModioOnObjectSelectionChanged Handler)
Parameters
TargetWBP_ModioLibraryFilterPanel_C
HandlerDelegate that will no longer receive callbacks
Clear Selected Values

Clears the selection state on the implementing widget

nd_img_WBP_ModioLibraryFilterPanel_ClearSelectedValues.png

void ClearSelectedValues()
Parameters
TargetWBP_ModioLibraryFilterPanel_C
Add Selection Changed Handler

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

nd_img_WBP_ModioLibraryFilterPanel_AddSelectionChangedHandler.png

void AddSelectionChangedHandler(FModioOnObjectSelectionChanged Handler)
Parameters
TargetWBP_ModioLibraryFilterPanel_C
HandlerDelegate to invoke on selection state change
Variables
FLinearColorRefFilterPanelBackgroundColor
FLinearColorRefFilterPanelHeaderColor

WBP_ModioModBrowser

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

Inheritance Hierarchy

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

Select First List Item

nd_img_WBP_ModioModBrowser_SelectFirstListItem.png

void SelectFirstListItem()
Focus Search Editable Text Box

nd_img_WBP_ModioModBrowser_FocusSearchEditableTextBox.png

void FocusSearchEditableTextBox()
On Clear Search Button Clicked

nd_img_WBP_ModioModBrowser_OnClearSearchButtonClicked.png

void OnClearSearchButtonClicked(UObject* ClickContext)
On Filter Button Clicked

nd_img_WBP_ModioModBrowser_OnFilterButtonClicked.png

void OnFilterButtonClicked(UObject* ClickContext)
On Filter Panel Activation Changed

nd_img_WBP_ModioModBrowser_OnFilterPanelActivationChanged.png

void OnFilterPanelActivationChanged(UObject* ActivationContext, bool bIsActivated)
On Preset Filter Changed

nd_img_WBP_ModioModBrowser_OnPresetFilterChanged.png

void OnPresetFilterChanged(UObject* SelectedValue)
On Subscriptions Filter Button Clicked

nd_img_WBP_ModioModBrowser_OnSubscriptionsFilterButtonClicked.png

void OnSubscriptionsFilterButtonClicked(UObject* ClickContext)
On Purchases Filter Button Clicked

nd_img_WBP_ModioModBrowser_OnPurchasesFilterButtonClicked.png

void OnPurchasesFilterButtonClicked(UObject* ClickContext)
On Preset Filter Tab Right Button Clicked

nd_img_WBP_ModioModBrowser_OnPresetFilterTabRightButtonClicked.png

void OnPresetFilterTabRightButtonClicked(UObject* ClickContext)
Bind Widget Handlers

nd_img_WBP_ModioModBrowser_BindWidgetHandlers.png

void BindWidgetHandlers()
Clear All Search Data

nd_img_WBP_ModioModBrowser_ClearAllSearchData.png

void ClearAllSearchData()
Display Filter Panel

nd_img_WBP_ModioModBrowser_DisplayFilterPanel.png

void DisplayFilterPanel(UWBP_ModioFilterPanel_C* FilterPanelWidget)
Set Filter Params to Default

nd_img_WBP_ModioModBrowser_SetFilterParamsToDefault.png

void SetFilterParamsToDefault(FModioFilterParams Default Filter Params)
Add Revenue Type Filter Param

nd_img_WBP_ModioModBrowser_AddRevenueTypeFilterParam.png

void AddRevenueTypeFilterParam(FModioFilterParams InFilterParams, FModioFilterParams OutFilterParams)
Initialize Library View

nd_img_WBP_ModioModBrowser_InitializeLibraryView.png

void InitializeLibraryView()
Initialize Mods View

nd_img_WBP_ModioModBrowser_InitializeModsView.png

void InitializeModsView()
On Preset Filter Tab Left Button Clicked

nd_img_WBP_ModioModBrowser_OnPresetFilterTabLeftButtonClicked.png

void OnPresetFilterTabLeftButtonClicked(UObject* ClickContext)
On Library View Button Clicked

nd_img_WBP_ModioModBrowser_OnLibraryViewButtonClicked.png

void OnLibraryViewButtonClicked(UObject* ClickContext)
On Search Button Clicked

nd_img_WBP_ModioModBrowser_OnSearchButtonClicked.png

void OnSearchButtonClicked(UObject* ClickContext, UWidget* EditableTextBoxWidget_Local, UWidget* SearchButtonWidget_Local)
On Mod Tile Clicked

nd_img_WBP_ModioModBrowser_OnModTileClicked.png

void OnModTileClicked(UObject* ClickContext)
Error Handler

nd_img_WBP_ModioModBrowser_ErrorHandler.png

void ErrorHandler(FModioErrorCode ErrorCode)
Dialog Display Event Handler

nd_img_WBP_ModioModBrowser_DialogDisplayEventHandler.png

void DialogDisplayEventHandler(EModioUIDialogType DialogRequested, UObject* InDataSource)
Wallet Balance Updated Handler

nd_img_WBP_ModioModBrowser_WalletBalanceUpdatedHandler.png

void WalletBalanceUpdatedHandler(FModioUnsigned64 NewWalletBalance)
Initialize for User

nd_img_WBP_ModioModBrowser_InitializeForUser.png

void InitializeForUser(FModioUser User)
Display Purchase Mod Dialog

nd_img_WBP_ModioModBrowser_DisplayPurchaseModDialog.png

void DisplayPurchaseModDialog(UObject* InDataSource)
Display Mod Details Dialog

nd_img_WBP_ModioModBrowser_DisplayModDetailsDialog.png

void DisplayModDetailsDialog(UObject* InDataSource)
Display Report Mod Dialog

nd_img_WBP_ModioModBrowser_DisplayReportModDialog.png

void DisplayReportModDialog(UObject* InDataSource)
List All Mods Request Complete Handler

nd_img_WBP_ModioModBrowser_ListAllModsRequestCompleteHandler.png

void ListAllModsRequestCompleteHandler(FString RequestIdentifier, FModioErrorCode ErrorCode, FModioOptionalModInfoList List)
On Close Browser Button Clicked

nd_img_WBP_ModioModBrowser_OnCloseBrowserButtonClicked.png

void OnCloseBrowserButtonClicked(UObject* ClickContext)
Get Background Border Widget

nd_img_WBP_ModioModBrowser_GetBackgroundBorderWidget.png

void GetBackgroundBorderWidget(TScriptInterface<IModioUIHasConfigurableColor> BorderWidget)
Set Colors

nd_img_WBP_ModioModBrowser_SetColors.png

void SetColors()
Do Navigation from Left Header to Down

nd_img_WBP_ModioModBrowser_DoNavigationFromLeftHeaderToDown.png

UWidget* DoNavigationFromLeftHeaderToDown(EUINavigation Navigation)
Do Navigation from Mod Tile to Up

nd_img_WBP_ModioModBrowser_DoNavigationFromModTileToUp.png

UWidget* DoNavigationFromModTileToUp(EUINavigation Navigation)
Do Navigation to Mod View

nd_img_WBP_ModioModBrowser_DoNavigationToModView.png

UWidget* DoNavigationToModView(EUINavigation Navigation) const
Do Navigation to Sub Header

nd_img_WBP_ModioModBrowser_DoNavigationToSubHeader.png

UWidget* DoNavigationToSubHeader(EUINavigation Navigation)
Do Navigation from Header to Down

nd_img_WBP_ModioModBrowser_DoNavigationFromHeaderToDown.png

UWidget* DoNavigationFromHeaderToDown(EUINavigation Navigation)

nd_img_WBP_ModioModBrowser_HandleMoreFromCreatorSearch.png

void HandleMoreFromCreatorSearch(FModioOptionalModInfoList OptionalModInfoList, FModioUserID CreatorUserID, FString CreatorUsername)
Search Mods

nd_img_WBP_ModioModBrowser_SearchMods.png

void SearchMods()
On Search Editable Text Box Widget Focus Changed

nd_img_WBP_ModioModBrowser_OnSearchEditableTextBoxWidgetFocusChanged.png

void OnSearchEditableTextBoxWidgetFocusChanged(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused, TScriptInterface<IModioUIBoundActionWidget> SearchBoundActionWidget)
Search Mods Online

nd_img_WBP_ModioModBrowser_SearchModsOnline.png

void SearchModsOnline(FModioFilterParams ParamsToApply, FString RequestIdentifier)
Search Mods Locally

nd_img_WBP_ModioModBrowser_SearchModsLocally.png

void SearchModsLocally()

nd_img_WBP_ModioModBrowser_DoNavigationFromSearch.png

UWidget* DoNavigationFromSearch(EUINavigation Navigation)
Get Mod Tile View Widget Object List

nd_img_WBP_ModioModBrowser_GetModTileViewWidget_ObjectList.png

void GetModTileViewWidget_ObjectList(TScriptInterface<IModioUIObjectListWidget> ModTileViewWidget) const
Get Confirm Search Hidden Button

nd_img_WBP_ModioModBrowser_GetConfirmSearchHiddenButton.png

TScriptInterface<IModioUIClickableWidget> GetConfirmSearchHiddenButton() const
On Confirm Search Button Clicked

nd_img_WBP_ModioModBrowser_OnConfirmSearchButtonClicked.png

void OnConfirmSearchButtonClicked(UObject* ClickContext)
Get Main Content Stack Widget

nd_img_WBP_ModioModBrowser_GetMainContentStackWidget.png

void GetMainContentStackWidget(UCommonActivatableWidgetStack* Stack) const
On Mod Tile Entry Generated

nd_img_WBP_ModioModBrowser_OnModTileEntryGenerated.png

void OnModTileEntryGenerated(UWidget* ObjectWidget, UObject* Object)
On Subscriptions Changed Handler

nd_img_WBP_ModioModBrowser_OnSubscriptionsChangedHandler.png

void OnSubscriptionsChangedHandler(FModioModID ModID, bool NewSubscriptionState, FModioModID Mod, int32 ModIndexToRemove, TArray<FModioModInfo> SearchedMods)
Get Mod Tile View Widget Object Selector

nd_img_WBP_ModioModBrowser_GetModTileViewWidget_ObjectSelector.png

void GetModTileViewWidget_ObjectSelector(TScriptInterface<IModioUIObjectSelector> ModTileViewWidget) const
On Search Editable Text Box Text Committed

nd_img_WBP_ModioModBrowser_OnSearchEditableTextBoxTextCommitted.png

void OnSearchEditableTextBoxTextCommitted(UObject* CommitContext, FText Text, TEnumAsByte<ETextCommit::Type> CommitMethod)
Set Search Text Box Visibility

nd_img_WBP_ModioModBrowser_SetSearchTextBoxVisibility.png

void SetSearchTextBoxVisibility(bool bIsVisible)
Set Search Hover Freeze State

nd_img_WBP_ModioModBrowser_SetSearchHoverFreezeState.png

void SetSearchHoverFreezeState(bool bFreezeEnabled, bool bHovered, FSlateBrush NewLocalVar_0)

nd_img_WBP_ModioModBrowser_DoNavigationToSearch.png

UWidget* DoNavigationToSearch(EUINavigation Navigation)
On Fetch External Updates Done

nd_img_WBP_ModioModBrowser_OnFetchExternalUpdatesDone.png

void OnFetchExternalUpdatesDone(FModioErrorCode ErrorCode)
Toggle Close Button Visibility

nd_img_WBP_ModioModBrowser_ToggleCloseButtonVisibility.png

void ToggleCloseButtonVisibility(bool bVisible)
On Filter Panel Deactivated

nd_img_WBP_ModioModBrowser_OnFilterPanelDeactivated.png

void OnFilterPanelDeactivated()
On Wallet Button Clicked

nd_img_WBP_ModioModBrowser_OnWalletButtonClicked.png

void OnWalletButtonClicked(UObject* ClickContext)
Display Token Pack Store Dialog

nd_img_WBP_ModioModBrowser_DisplayTokenPackStoreDialog.png

void DisplayTokenPackStoreDialog()
On Open Store Result Handler

nd_img_WBP_ModioModBrowser_OnOpenStoreResultHandler.png

void OnOpenStoreResultHandler(bool bResult, FString Message)
Get Wallet Button Visibility

nd_img_WBP_ModioModBrowser_Get_WalletButton_Visibility.png

ESlateVisibility Get_WalletButton_Visibility()
Display Library Filter Panel

nd_img_WBP_ModioModBrowser_DisplayLibraryFilterPanel.png

void DisplayLibraryFilterPanel(UWBP_ModioLibraryFilterPanel_C* LibraryFilterPanelWidget)
Update View Description Header

nd_img_WBP_ModioModBrowser_UpdateViewDescriptionHeader.png

void UpdateViewDescriptionHeader()
Clear All Tag Data

nd_img_WBP_ModioModBrowser_ClearAllTagData.png

void ClearAllTagData()
Get Header Separator Image Widget

nd_img_WBP_ModioModBrowser_GetHeaderSeparatorImageWidget.png

void GetHeaderSeparatorImageWidget(TScriptInterface<IModioUIHasConfigurableColor> BorderWidget)
Display Token Store Dialog

nd_img_WBP_ModioModBrowser_DisplayTokenStoreDialog.png

void DisplayTokenStoreDialog()
On Tab Left Button Clicked

![nd_img_WBP_ModioModBrowser_On Tab Left Button Clicked.png](img/refdocs/nd_img_WBP_ModioModBrowser_On Tab Left Button Clicked.png)

void On Tab Left Button Clicked(UObject* ClickContext)
On Tab Right Button Clicked

![nd_img_WBP_ModioModBrowser_On Tab Right Button Clicked.png](img/refdocs/nd_img_WBP_ModioModBrowser_On Tab Right Button Clicked.png)

void On Tab Right Button Clicked(UObject* ClickContext, int32 CurrentSelectedIndex)

nd_img_WBP_ModioModBrowser_HandleMoreWithTagSearch.png

void HandleMoreWithTagSearch(FModioOptionalModInfoList OptionalModInfoList)
Do Navigation to Preset Filter Selector

nd_img_WBP_ModioModBrowser_DoNavigationToPresetFilterSelector.png

UWidget* DoNavigationToPresetFilterSelector(EUINavigation Navigation)
Do Navigation from Close to Left

nd_img_WBP_ModioModBrowser_DoNavigationFromCloseToLeft.png

UWidget* DoNavigationFromCloseToLeft(EUINavigation Navigation)
Get Search Box Overlay Widget

nd_img_WBP_ModioModBrowser_GetSearchBoxOverlayWidget.png

UWidget* GetSearchBoxOverlayWidget() const
On Search Detection Button Focus Changed

nd_img_WBP_ModioModBrowser_OnSearchDetectionButtonFocusChanged.png

void OnSearchDetectionButtonFocusChanged(UObject* FocusContext, FFocusEvent InFocusEvent, bool bIsFocused)
Get Search Detection Button Widget Focusable

nd_img_WBP_ModioModBrowser_GetSearchDetectionButtonWidget_Focusable.png

TScriptInterface<IModioFocusableWidget> GetSearchDetectionButtonWidget_Focusable() const
Get Search Detection Button Widget Hoverable

nd_img_WBP_ModioModBrowser_GetSearchDetectionButtonWidget_Hoverable.png

TScriptInterface<IModioUIHoverableWidget> GetSearchDetectionButtonWidget_Hoverable() const
On Search Detection Button Hover Changed

nd_img_WBP_ModioModBrowser_OnSearchDetectionButtonHoverChanged.png

void OnSearchDetectionButtonHoverChanged(UObject* HoverContext, bool bHoveredState)
Display Dependency Download Dialog

nd_img_WBP_ModioModBrowser_DisplayDependencyDownloadDialog.png

void DisplayDependencyDownloadDialog(UObject* InDataSource)
Get Secondary Content Stack Widget

nd_img_WBP_ModioModBrowser_GetSecondaryContentStackWidget.png

void GetSecondaryContentStackWidget(UCommonActivatableWidgetStack* Stack) const
Variables
FModioFilterParamsSearchParams
FModioUnsigned64Wallet Balance
FLinearColorRefBackgroundColor
FSlateBrushLibraryIcon
FSlateBrushRecentIcon
FSlateBrushTrendingIcon
int32SelectedLibraryCategoryIndex
FLinearColorRefHeaderSeparatorColor
boolbSearchBoxIsExpanded
FModioFilterParamsPreviouslyApplieedSearchParams

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

On Set Data Source

nd_img_WBP_ModioModDetailsDialog_OnSetDataSource.png

void OnSetDataSource(UObject* InDataSource)
Bind on Clicked Events

nd_img_WBP_ModioModDetailsDialog_BindOnClickedEvents.png

void BindOnClickedEvents()
Update Mod Name

nd_img_WBP_ModioModDetailsDialog_UpdateModName.png

void UpdateModName()
Update Mod Author

nd_img_WBP_ModioModDetailsDialog_UpdateModAuthor.png

void UpdateModAuthor()
Update Mod Summary

nd_img_WBP_ModioModDetailsDialog_UpdateModSummary.png

void UpdateModSummary()
Update Mod Properties

nd_img_WBP_ModioModDetailsDialog_UpdateModProperties.png

void UpdateModProperties()
Update Subscribe Button Label

nd_img_WBP_ModioModDetailsDialog_UpdateSubscribeButtonLabel.png

void UpdateSubscribeButtonLabel(FText SubscribeLabelText, FText UnsubscribeLabelText)
Update Tag Display

nd_img_WBP_ModioModDetailsDialog_UpdateTagDisplay.png

void UpdateTagDisplay()
Update Rate Button Labels and State

nd_img_WBP_ModioModDetailsDialog_UpdateRateButtonLabelsAndState.png

void UpdateRateButtonLabelsAndState(UObject* RateUpButtonLocalRef, UObject* RateDownButtonLocalRef)
Update Mod Dependencies Button

nd_img_WBP_ModioModDetailsDialog_UpdateModDependenciesButton.png

void UpdateModDependenciesButton()
Update Monetization Features

nd_img_WBP_ModioModDetailsDialog_UpdateMonetizationFeatures.png

void UpdateMonetizationFeatures()
On Subscribe Button Clicked

nd_img_WBP_ModioModDetailsDialog_OnSubscribeButtonClicked.png

void OnSubscribeButtonClicked(UObject* ClickContext)
On Rate Up Button Clicked

nd_img_WBP_ModioModDetailsDialog_OnRateUpButtonClicked.png

void OnRateUpButtonClicked(UObject* ClickContext)
On Rate Down Button Clicked

nd_img_WBP_ModioModDetailsDialog_OnRateDownButtonClicked.png

void OnRateDownButtonClicked(UObject* ClickContext)
Do Navigation Down from Expand Description

nd_img_WBP_ModioModDetailsDialog_DoNavigationDownFromExpandDescription.png

UWidget* DoNavigationDownFromExpandDescription(EUINavigation Navigation)
Configure Colors

nd_img_WBP_ModioModDetailsDialog_ConfigureColors.png

void ConfigureColors()
On Expand Description Button Clicked

nd_img_WBP_ModioModDetailsDialog_OnExpandDescriptionButtonClicked.png

void OnExpandDescriptionButtonClicked(UObject* ClickContext)
On Mod Dependencies Button Clicked

nd_img_WBP_ModioModDetailsDialog_OnModDependenciesButtonClicked.png

void OnModDependenciesButtonClicked(UObject* ClickContext)
On Close Dialog Button Clicked

nd_img_WBP_ModioModDetailsDialog_OnCloseDialogButtonClicked.png

void OnCloseDialogButtonClicked(UObject* ClickContext)
On More from Creator Clicked

nd_img_WBP_ModioModDetailsDialog_OnMoreFromCreatorClicked.png

void OnMoreFromCreatorClicked(UObject* ClickContext)
On Purchase Button Clicked

nd_img_WBP_ModioModDetailsDialog_OnPurchaseButtonClicked.png

void OnPurchaseButtonClicked(UObject* ClickContext)
On Rating Change Submitted

![nd_img_WBP_ModioModDetailsDialog_On Rating Change Submitted.png](img/refdocs/nd_img_WBP_ModioModDetailsDialog_On Rating Change Submitted.png)

void On Rating Change Submitted(FModioErrorCode ErrorCode)
Wallet Balance Updated Handler

nd_img_WBP_ModioModDetailsDialog_WalletBalanceUpdatedHandler.png

void WalletBalanceUpdatedHandler(FModioUnsigned64 WalletBalance)
Get Background Border Widget

nd_img_WBP_ModioModDetailsDialog_GetBackgroundBorderWidget.png

void GetBackgroundBorderWidget(TScriptInterface<IModioUIHasConfigurableColor> Border) const
Get Premium Badge Border Widget

nd_img_WBP_ModioModDetailsDialog_GetPremiumBadgeBorderWidget.png

void GetPremiumBadgeBorderWidget(TScriptInterface<IModioUIHasConfigurableColor> Border) const
Get Mod Properties Border Widget

nd_img_WBP_ModioModDetailsDialog_GetModPropertiesBorderWidget.png

void GetModPropertiesBorderWidget(TScriptInterface<IModioUIHasConfigurableColor> Border) const

nd_img_WBP_ModioModDetailsDialog_NavigateUpFromDependencies.png

UWidget* NavigateUpFromDependencies(EUINavigation Navigation)
Do Navigation Up from Subscribe

nd_img_WBP_ModioModDetailsDialog_DoNavigationUpFromSubscribe.png

UWidget* DoNavigationUpFromSubscribe(EUINavigation Navigation)
Do Navigation from Vote to Down

nd_img_WBP_ModioModDetailsDialog_DoNavigationFromVoteToDown.png

UWidget* DoNavigationFromVoteToDown(EUINavigation Navigation)
Do Navigation to Subscribe or Purchase

nd_img_WBP_ModioModDetailsDialog_DoNavigationToSubscribeOrPurchase.png

UWidget* DoNavigationToSubscribeOrPurchase(EUINavigation Navigation)
Get More from Creator Button Widget

nd_img_WBP_ModioModDetailsDialog_GetMoreFromCreatorButtonWidget.png

void GetMoreFromCreatorButtonWidget(TScriptInterface<IModioUIClickableWidget> MoreFromCreatorButton) const
Subscriptions Changed Handler

nd_img_WBP_ModioModDetailsDialog_SubscriptionsChangedHandler.png

void SubscriptionsChangedHandler(FModioModID ModID, bool bNewSubscriptionState)
Mod Management Event Handler

nd_img_WBP_ModioModDetailsDialog_ModManagementEventHandler.png

void ModManagementEventHandler(FModioModManagementEvent Event)
Mod Enabled State Changed Handler

nd_img_WBP_ModioModDetailsDialog_ModEnabledStateChangedHandler.png

void ModEnabledStateChangedHandler(FModioModID ModID, bool NewEnabledState)
Error Handler

nd_img_WBP_ModioModDetailsDialog_ErrorHandler.png

void ErrorHandler(FModioErrorCode Error)
Submit Mod Rating

nd_img_WBP_ModioModDetailsDialog_SubmitModRating.png

void SubmitModRating(EModioRating Rating)
Get Purchase Price Text Block Widget

nd_img_WBP_ModioModDetailsDialog_GetPurchasePriceTextBlockWidget.png

void GetPurchasePriceTextBlockWidget(TScriptInterface<IModioUIHasTextWidget> NewParam) const
Get Mod Description Stack Widget

nd_img_WBP_ModioModDetailsDialog_GetModDescriptionStackWidget.png

void GetModDescriptionStackWidget(UCommonActivatableWidgetStack* WidgetStack) const
Get Subscribe or Purchase Switcher Widget

nd_img_WBP_ModioModDetailsDialog_GetSubscribeOrPurchaseSwitcherWidget.png

void GetSubscribeOrPurchaseSwitcherWidget(UWidgetSwitcher* WidgetSwitcher) const
Get Open Store Button Widget

nd_img_WBP_ModioModDetailsDialog_GetOpenStoreButtonWidget.png

void GetOpenStoreButtonWidget(TScriptInterface<IModioUIClickableWidget> StoreButton) const
On Open Store Button Clicked

nd_img_WBP_ModioModDetailsDialog_OnOpenStoreButtonClicked.png

void OnOpenStoreButtonClicked(UObject* ClickContext)
Open Store Result Handler

nd_img_WBP_ModioModDetailsDialog_OpenStoreResultHandler.png

void OpenStoreResultHandler(bool bResult, FString Message)
Do Navigation from Vote to Tags

nd_img_WBP_ModioModDetailsDialog_DoNavigationFromVoteToTags.png

UWidget* DoNavigationFromVoteToTags(EUINavigation Navigation)
Do Navigation Down from Creator

nd_img_WBP_ModioModDetailsDialog_DoNavigationDownFromCreator.png

UWidget* DoNavigationDownFromCreator(EUINavigation Navigation)
Do Navigation Up from Creator

nd_img_WBP_ModioModDetailsDialog_DoNavigationUpFromCreator.png

UWidget* DoNavigationUpFromCreator(EUINavigation Navigation)
Do Navigation to More Options

nd_img_WBP_ModioModDetailsDialog_DoNavigationToMoreOptions.png

UWidget* DoNavigationToMoreOptions(EUINavigation Navigation)
Variables
FLinearColorRefPremiumBadgeColor
FLinearColorRefBackgroundColor
EModioRatingCurrentModRating
EModioRatingNewRating

WBP_ModioOperationTracker

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

Inheritance Hierarchy

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

On Operation Complete

nd_img_WBP_ModioOperationTracker_OnOperationComplete.png

void OnOperationComplete()
On Preconstruct

nd_img_WBP_ModioOperationTracker_OnPreconstruct.png

void OnPreconstruct()
On Refresh Queue Data

nd_img_WBP_ModioOperationTracker_OnRefreshQueueData.png

void OnRefreshQueueData()
Update Progress Icon by Mod Progress State

nd_img_WBP_ModioOperationTracker_UpdateProgressIconByModProgressState.png

void UpdateProgressIconByModProgressState(EModioModProgressState ModProgressState)
On Operation Begin

nd_img_WBP_ModioOperationTracker_OnOperationBegin.png

void OnOperationBegin(FModioModManagementEvent Event)
Variables
FSlateBrushDownloadingImageBrush
FSlateBrushExtractingImageBrush
FSlateBrushQueueCountImageBrush
FLinearColorRefDownloadingIconColor
FLinearColorRefQueueCountIconColor
FLinearColorRefExtractingIconColor

WBP_ModioStorageTracker

Tracks storage usage and availability for downloaded mods.

Inheritance Hierarchy

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

Variables

WBP_ModioTagCounterIcon

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

Inheritance Hierarchy

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

On Tag Selection Changed

nd_img_WBP_ModioTagCounterIcon_OnTagSelectionChanged.png

void OnTagSelectionChanged()
Get Background Widget

nd_img_WBP_ModioTagCounterIcon_GetBackgroundWidget.png

void GetBackgroundWidget(TScriptInterface<IModioUIHasConfigurableColor> Background)
Variables
FLinearColorRefBackgroundColor

Structs

ModioDefaultCodeInputTextBoxStyle

Inheritance Hierarchy

-> Text Block Style-> Slate Widget Style

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

ModioUICommandAssetEntry

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

Inheritance Hierarchy

-> Table Row Base

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

ModioTextValidationRule

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

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

ModioUIColorEntry

Struct representing a color entry in a data table

Inheritance Hierarchy

-> Table Row Base

Variables
FLinearColorColorThe color to use for the entry

LinearColorRef

Blueprint-compatible truct representing a color reference

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

LinearColorRefOverride

Blueprint-compatible struct representing a color reference override

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

ModioCommonButtonParams

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

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

ClassPathOverride

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

Variables
boolbOverrideWhether the value is overridden
FSoftClassPathValueThe overridden value

TextOverride

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

Variables
boolbOverrideWhether the value is overridden
FTextValueThe overridden value

ModioDialogButtonInfo

Data structure representing a dialog button

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

InputActionOverride

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

Variables
boolbOverrideWhether the value is overridden
FDataTableRowHandleValueThe overridden value

ModioFeaturedCategoryParams

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

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

IntegerOverride

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

Variables
boolbOverrideWhether the value is overridden
int32ValueThe overridden value

FloatOverride

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

Variables
boolbOverrideWhether the value is overridden
floatValueThe overridden value

HAlignOverride

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

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

SlateFontInfoOverride

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

Variables
boolbOverrideWhether the value is overridden
FSlateFontInfoValueThe overridden value

TextTransformOverride

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

Variables
boolbOverrideWhether the value is overridden
ETextTransformPolicyValueThe overridden value

ModioRetryCounter

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

Variables
int32RetriesRemainingNumber of retries remaining

ModioStackedBool

A stack of boolean values


Functions

Get Command Text

Retrieves a specific localized string for the specified command

nd_img_ModioUICommandLibrary_GetCommandText.png

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

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


Get Command Brush

Retrieves a specific brush for the specified command

nd_img_ModioUICommandLibrary_GetCommandBrush.png

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

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


Get Command Asset Entry

Retrieves a data table row for the specified command

nd_img_ModioUICommandLibrary_GetCommandAssetEntry.png

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

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


Validate Using Rule

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

nd_img_ModioUIInputValidationLibrary_ValidateUsingRule.png

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

True when string validation passes, false otherwise


Validate No Whitespace

SConfirm the text provided matches the lack of whitespace rule

nd_img_ModioUIInputValidationLibrary_ValidateNoWhitespace.png

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

True when string validation passes, false otherwise


Validate Not Empty

SConfirm the text provided matches the not-empty rule

nd_img_ModioUIInputValidationLibrary_ValidateNotEmpty.png

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

True when string validation passes, false otherwise


Validate Not Blank

SConfirm the text provided matches the not blank rule

nd_img_ModioUIInputValidationLibrary_ValidateNotBlank.png

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

True when string validation passes, false otherwise


Validate Length

SConfirm the text provided matches the length rule

nd_img_ModioUIInputValidationLibrary_ValidateLength.png

bool ValidateLength(FText TextToValidate, int32 DesiredMaximumLength, int32 DesiredMinimumLength)
Parameters
TextToValidateString to check against the length rule
DesiredMaximumLength
DesiredMinimumLength
Returns

True when string validation passes, false otherwise


Validate Email Address

SConfirm the text provided matches an email address

nd_img_ModioUIInputValidationLibrary_ValidateEmailAddress.png

bool ValidateEmailAddress(FText TextToValidate)
Parameters
TextToValidateString to check against email pattern
Returns

True when string contains a valid email, false otherwise


Validate Alphanumeric

SConfirm the text provided matches the alphanumeric rule

nd_img_ModioUIInputValidationLibrary_ValidateAlphanumeric.png

bool ValidateAlphanumeric(FText TextToValidate)
Parameters
TextToValidateString to check against the alphanumeric rule
Returns

True when string validation passes, false otherwise


Validate All Numeric

SConfirm the text provided matches an all numeric rule

nd_img_ModioUIInputValidationLibrary_ValidateAllNumeric.png

bool ValidateAllNumeric(FText TextToValidate)
Parameters
TextToValidateString to check against all numeric rule
Returns

True when string validation passes, false otherwise


Validate All Letters

SConfirm the text provided matches an all letters rule

nd_img_ModioUIInputValidationLibrary_ValidateAllLetters.png

bool ValidateAllLetters(FText TextToValidate)
Parameters
TextToValidateString to check against all letters rule
Returns

True when string validation passes, false otherwise


Default Validate Text

Helper function that contains the default implementation of ValidateText for widgets implementing IModioUITextValidator. This implmentation is called by default for native classes that implement IModioUITextValidator, but requires an explicit call for classes that implement that interface via Blueprint only

nd_img_ModioUIInputValidationLibrary_DefaultValidateText.png

bool DefaultValidateText(TScriptInterface<IModioUITextValidator> TargetObject, FText InputText, FText ValidationMessageText)
Parameters
TargetObjectObject that implements IModioUITextValidator and will receive GetTextValidationRules and SetValidationError interface calls as necessary
InputTextThe text to validate
Validation Message TextFText that will be initialized by this function to an appropriate error message if validation fails
Returns

True if validation succeeded, false if it failed


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
TargetFLinearColorRefOverride
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
TargetFLinearColorRefOverride
Override SetTrue if the color reference was overridden, false if the fallback color was used
Returns

The resolved color value


Resolve

Resolves a color reference to a color value

nd_img_LinearColorRefLibrary_Resolve.png

FLinearColor Resolve(FLinearColorRef Target, bool bResolved)
Parameters
TargetFLinearColorRef
ResolvedTrue if the color reference was resolved, false if the fallback color was used
Returns

The resolved color value


Remove Color Change Handler

Removes a handler from the list of handlers to be called when the color table changes

nd_img_LinearColorRefLibrary_RemoveColorChangeHandler.png

void RemoveColorChangeHandler(FLinearColorRefColorChangeHandler Handler)
Parameters
HandlerThe handler to remove

Get Valid Color Keys

Gets the list of valid color keys

nd_img_LinearColorRefLibrary_GetValidColorKeys.png

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

nd_img_LinearColorRefLibrary_AddColorChangeHandler.png

void AddColorChangeHandler(FLinearColorRefColorChangeHandler Handler)
Parameters
HandlerThe handler to add

Do Filter Params Include User Id

nd_img_ModioModBrowser_DoFilterParamsIncludeUserId.png

bool DoFilterParamsIncludeUserId(FModioFilterParams Params)

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
TargetFTextTransformOverride
Returns

The resolved text transform policy value, or ETextTransformPolicy::ToUpper if no override is set.


Get Override Value(TextTransform)

Resolve a text transform policy override value.

nd_img_PropertyOverridesLibrary_ResolveTextTransformOverride.png

ETextTransformPolicy ResolveTextTransformOverride(FTextTransformOverride Target, bool bOverrideSet)
Parameters
TargetFTextTransformOverride
Override SetWhether the override is set.
Returns

The resolved text transform policy value, or ETextTransformPolicy::ToUpper if no override is set.


Get Override Value(Text) As Exec

Resolve a text override value, with an exec pin for flow control.

nd_img_PropertyOverridesLibrary_ResolveTextOverrideAsExec.png

FText ResolveTextOverrideAsExec(FTextOverride Target, bool bOverrideSet)
Parameters
TargetFTextOverride
Returns

The resolved text value, or an empty text if no override is set.


Get Override Value(Text)

Resolve a text override value.

nd_img_PropertyOverridesLibrary_ResolveTextOverride.png

FText ResolveTextOverride(FTextOverride Target, bool bOverrideSet)
Parameters
TargetFTextOverride
Override SetWhether the override is set.
Returns

The resolved text value, or an empty text if no override is set.


Get Override Value(Integer) As Exec

Resolve an integer override value, with an exec pin for flow control.

nd_img_PropertyOverridesLibrary_ResolveIntOverrideAsExec.png

int32 ResolveIntOverrideAsExec(FIntegerOverride Target, bool bOverrideSet)
Parameters
TargetFIntegerOverride
Returns

The resolved integer value, or 0 if no override is set.


Get Override Value(Integer)

Resolve an integer override value.

nd_img_PropertyOverridesLibrary_ResolveIntOverride.png

int32 ResolveIntOverride(FIntegerOverride Target, bool bOverrideSet)
Parameters
TargetFIntegerOverride
Override SetWhether the override is set.
Returns

The resolved integer value, or 0 if no override is set.


Get Override Value(InputAction) As Exec

Resolve an input action override value, with an exec pin for flow control.

nd_img_PropertyOverridesLibrary_ResolveInputActionOverrideAsExec.png

FDataTableRowHandle ResolveInputActionOverrideAsExec(FInputActionOverride Target, bool bOverrideSet)
Parameters
TargetFInputActionOverride
Returns

The resolved input action row handle, or an empty handle if no override is set.


Get Override Value(InputAction)

Resolve an input action override value.

nd_img_PropertyOverridesLibrary_ResolveInputActionOverride.png

FDataTableRowHandle ResolveInputActionOverride(FInputActionOverride Target, bool bOverrideSet)
Parameters
TargetFInputActionOverride
Override SetWhether the override is set.
Returns

The resolved input action row handle, or an empty handle if no override is set.


Get Override Value(HAlign) As Exec

Resolve a horizontal alignment override value, with an exec pin for flow control.

nd_img_PropertyOverridesLibrary_ResolveHAlignOverrideAsExec.png

TEnumAsByte<EHorizontalAlignment> ResolveHAlignOverrideAsExec(FHAlignOverride Target, bool bOverrideSet)
Parameters
TargetFHAlignOverride
Returns

The resolved horizontal alignment value, or empty if no override is set.


Get Override Value(HAlign)

Resolve a horizontal alignment override value.

nd_img_PropertyOverridesLibrary_ResolveHAlignOverride.png

TEnumAsByte<EHorizontalAlignment> ResolveHAlignOverride(FHAlignOverride Target, bool bOverrideSet)
Parameters
TargetFHAlignOverride
Override SetWhether the override is set.
Returns

The resolved horizontal alignment value, or empty if no override is set.


Get Override Value(FSlateFontInfo) As Exec

Resolve a font info override value, with an exec pin for flow control.

nd_img_PropertyOverridesLibrary_ResolveFontInfoOverrideAsExec.png

FSlateFontInfo ResolveFontInfoOverrideAsExec(FSlateFontInfoOverride Target, bool bOverrideSet)
Parameters
TargetFSlateFontInfoOverride
Returns

The resolved font info value, or an empty font info if no override is set.


Get Override Value(FSlateFontInfo)

Resolve a font info override value.

nd_img_PropertyOverridesLibrary_ResolveFontInfoOverride.png

FSlateFontInfo ResolveFontInfoOverride(FSlateFontInfoOverride Target, bool bOverrideSet)
Parameters
TargetFSlateFontInfoOverride
Override SetWhether the override is set.
Returns

The resolved font info value, or an empty font info if no override is set.


Get Override Value(Float) As Exec

Resolve a float override value, with an exec pin for flow control.

nd_img_PropertyOverridesLibrary_ResolveFloatOverrideAsExec.png

float ResolveFloatOverrideAsExec(FFloatOverride Target, bool bOverrideSet)
Parameters
TargetFFloatOverride
Returns

The resolved float value, or 0.0 if no override is set.


Get Override Value(Float)

Resolve a float override value.

nd_img_PropertyOverridesLibrary_ResolveFloatOverride.png

float ResolveFloatOverride(FFloatOverride Target, bool bOverrideSet)
Parameters
TargetFFloatOverride
Override SetWhether the override is set.
Returns

The resolved float value, or 0.0 if no override is set.


Get and Load Override Value(ClassPath) As Exec

Resolve a class path override value, casting it to a specific class, with an exec pin for flow control.

nd_img_PropertyOverridesLibrary_ResolveClassPathOverrideAsExec_Casted.png

UClass* ResolveClassPathOverrideAsExec_Casted(FClassPathOverride Target, TSubclassOf<UObject>  BaseClass, bool bOverrideSet)
Parameters
TargetFClassPathOverride
BaseClassThe base class to check the loaded class against.
Returns

The loaded class if it matches the BaseClass, otherwise nullptr.


Get Override Value(ClassPath) As Exec

Resolve a class path override value, with an exec pin for flow control.

nd_img_PropertyOverridesLibrary_ResolveClassPathOverrideAsExec.png

FSoftClassPath ResolveClassPathOverrideAsExec(FClassPathOverride Target, bool bOverrideSet)
Parameters
TargetFClassPathOverride
Returns

The resolved class path value, or an empty path if no override is set.


Get and Load Override Value(ClassPath)

Resolve a class path override value, casting it to a specific class.

nd_img_PropertyOverridesLibrary_ResolveClassPathOverride_Casted.png

UClass* ResolveClassPathOverride_Casted(FClassPathOverride Target, TSubclassOf<UObject>  BaseClass, bool bOverrideSet)
Parameters
TargetFClassPathOverride
BaseClassThe base class to check the loaded class against.
Override SetWhether the override is set.
Returns

The loaded class if it matches the BaseClass, otherwise nullptr.


Get Override Value(ClassPath)

Resolve a class path override value.

nd_img_PropertyOverridesLibrary_ResolveClassPathOverride.png

FSoftClassPath ResolveClassPathOverride(FClassPathOverride Target, bool bOverrideSet)
Parameters
TargetFClassPathOverride
Override SetWhether the override is set.
Returns

The resolved class path value, or an empty path if no override is set.


Apply Override to Value(TextTransform)

Apply a text transform policy override value.

nd_img_PropertyOverridesLibrary_ApplyTextTransformOverride.png

ETextTransformPolicy ApplyTextTransformOverride(FTextTransformOverride Target, ETextTransformPolicy DefaultValue)
Parameters
TargetFTextTransformOverride
DefaultValueThe default value to use if no override is set.
Returns

The overridden text transform policy value or the default value.


Apply Override to Value(Text)

Apply a text override value.

nd_img_PropertyOverridesLibrary_ApplyTextOverride.png

FText ApplyTextOverride(FTextOverride Target, FText DefaultValue)
Parameters
TargetFTextOverride
DefaultValueThe default value to use if no override is set.
Returns

The overridden text value or the default value.


Apply Override to Value(Integer)

nd_img_PropertyOverridesLibrary_ApplyIntOverride.png

int32 ApplyIntOverride(FIntegerOverride Target, int32 DefaultValue)
Parameters
TargetFIntegerOverride
DefaultValueThe default value to use if no override is set.
Returns

The overridden integer value or the default value.


Apply Override to Value(InputAction)

Apply an input action override value.

nd_img_PropertyOverridesLibrary_ApplyInputActionOverride.png

FDataTableRowHandle ApplyInputActionOverride(FInputActionOverride Target, FDataTableRowHandle DefaultValue)
Parameters
TargetFInputActionOverride
DefaultValueThe default value to use if no override is set.
Returns

The overridden input action row handle or the default value.


Apply Override to Value(HAlign)

Apply a horizontal alignment override value.

nd_img_PropertyOverridesLibrary_ApplyHAlignOverride.png

TEnumAsByte<EHorizontalAlignment> ApplyHAlignOverride(FHAlignOverride Target, TEnumAsByte<EHorizontalAlignment> DefaultValue)
Parameters
TargetFHAlignOverride
DefaultValueThe default value to use if no override is set.
Returns

The overridden horizontal alignment value or the default value.


Apply Override to Value(FSlateFontInfo)

Apply a font info override value.

nd_img_PropertyOverridesLibrary_ApplyFontInfoOverride.png

FSlateFontInfo ApplyFontInfoOverride(FSlateFontInfoOverride Target, FSlateFontInfo DefaultValue)
Parameters
TargetFSlateFontInfoOverride
DefaultValueThe default value to use if no override is set.
Returns

The overridden font info value or the default value.


Apply Override to Value(Float)

Apply a float override value.

nd_img_PropertyOverridesLibrary_ApplyFloatOverride.png

float ApplyFloatOverride(FFloatOverride Target, float DefaultValue)
Parameters
TargetFFloatOverride
DefaultValueThe default value to use if no override is set.
Returns

The overridden float value or the default value.


Apply and Load Override to Value(ClassPath)

Apply a class path override value, casting it to a specific class.

nd_img_PropertyOverridesLibrary_ApplyClassPathOverride_Casted.png

UClass* ApplyClassPathOverride_Casted(FClassPathOverride Target, TSubclassOf<UObject>  BaseClass, UClass* DefaultValue)
Parameters
TargetFClassPathOverride
BaseClassThe base class to check the loaded class against.
DefaultValueThe default value to use if no override is set.
Returns

The overridden class if it matches the BaseClass, otherwise the default value.


Apply Override to Value(ClassPath)

Apply a class path override value.

nd_img_PropertyOverridesLibrary_ApplyClassPathOverride.png

FSoftClassPath ApplyClassPathOverride(FClassPathOverride Target, FSoftClassPath DefaultValue)
Parameters
TargetFClassPathOverride
DefaultValueThe default value to use if no override is set.
Returns

The overridden class path value or the default value.


Retry

Attempts to retry the operation, decrementing the retry counter if successful

nd_img_ModioRetryLibrary_Retry.png

bool Retry(FModioRetryCounter Target)
Parameters
TargetFModioRetryCounter
Returns

True if the operation should be retried


Reset Retry Count

Resets the retry counter

nd_img_ModioRetryLibrary_ResetRetryCountPure.png

FModioRetryCounter ResetRetryCountPure(FModioRetryCounter Target)
Parameters
TargetFModioRetryCounter
Returns

The reset retry counter


Reset Retry Count

Resets the retry counter

nd_img_ModioRetryLibrary_ResetRetryCount.png

void ResetRetryCount(FModioRetryCounter Target)
Parameters
TargetFModioRetryCounter

Can Retry as Exec

Checks if the retry counter has retries remaining, returning an exec enum

nd_img_ModioRetryLibrary_CanRetryAsExec.png

bool CanRetryAsExec(FModioRetryCounter Target)
Parameters
TargetFModioRetryCounter
Returns

True if the retry counter has retries remaining


Can Retry

Checks if the retry counter has retries remaining

nd_img_ModioRetryLibrary_CanRetry.png

bool CanRetry(FModioRetryCounter Target)
Parameters
TargetFModioRetryCounter
Returns

True if the retry counter has retries remaining


Push Value on Stack(bool)

Pushes a new value onto the stack

nd_img_ModioStackedBoolLibrary_PushBoolValue.png

void PushBoolValue(FModioStackedBool Target, bool bNewValue)
Parameters
TargetFModioStackedBool
bNewValueThe value to push onto the stack

Pop Value from Stack(bool)

Pops a value from the stack

nd_img_ModioStackedBoolLibrary_PopBoolValue.png

bool PopBoolValue(FModioStackedBool Target, bool bDidPopSuccessfully)
Parameters
TargetFModioStackedBool
Did Pop SuccessfullyTrue if the pop was successful
Returns

The popped value


Peek Value from Stack(bool)

Peeks at the top value of the stack

nd_img_ModioStackedBoolLibrary_PeekBoolValue.png

bool PeekBoolValue(FModioStackedBool Target, bool bDidPeekSuccessfully)
Parameters
TargetFModioStackedBool
Did Peek SuccessfullyTrue if the peek was successful
Returns

The peeked value


Validate Widget

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 //

nd_img_ModioUICommonFunctionLibrary_MapValueIntoRangeIndex.png

bool MapValueIntoRangeIndex(TArray<FInt32Range> ValueRanges, int32 Value, int32 OutIndex)
Parameters
ValueRangesThe ranges to search through
ValueThe value to locate
Out IndexThe index of the first range that contains Value
Returns

True if the value was located


Is Design Time as Exec

Returns true if the widget is currently being viewed in the UMG editor //

nd_img_ModioUICommonFunctionLibrary_IsDesignTimeAsExec.png

bool IsDesignTimeAsExec(UWidget* Target)
Parameters
TargetUWidget*
Returns

True if Target has design-time flags set


Is Design Time

Returns true if the widget is currently being viewed in the UMG editor //

nd_img_ModioUICommonFunctionLibrary_IsDesignTime.png

bool IsDesignTime(UWidget* Target)
Parameters
TargetUWidget*
Returns

True if Target has design-time flags set


Get Modio Text

Utility method to dynamically resolve an FText from the primary mod.io string table //

nd_img_ModioUICommonFunctionLibrary_GetModioText.png

FText GetModioText(FName StringKey)
Parameters
StringKeyName of the text to retrieve
Returns

The resolved FText or empty FText if not found


Get Localized Tag Value

Localizes the specified tag value //

nd_img_ModioUICommonFunctionLibrary_GetLocalizedTagValue.png

FText GetLocalizedTagValue(FModioModTagLocalizationData InTagLocalizationData)
Parameters
InTagLocalizationDataThe tag localization data from which to localize the tag value
Returns

The localized tag value


Get Localized Tag Category

Localizes the specified tag category //

nd_img_ModioUICommonFunctionLibrary_GetLocalizedTagCategory.png

FText GetLocalizedTagCategory(FModioModTagInfo InTagInfo)
Parameters
InTagInfoThe tag info from which to localize the category
Returns

The localized category name


Format Timespan

Formats the provided timespan to text based on the specified resolution and specified format texts. This /// function passes positional values to the format text in the following order: Years, Months, Days, Hours, /// Minutes. //

nd_img_ModioUICommonFunctionLibrary_FormatTimespan.png

FText FormatTimespan(FTimespan Timespan, FText YearFormat, FText MonthFormat, FText DaysFormat, FText TodayFormat)
Parameters
TimespanThe timespan to format
YearFormatFormat text to use if the timespan is > 1 year
MonthFormatFormat text to use if the timespan is > 1 month
DaysFormatFormat text to use if the timespan is > 1 day
TodayFormatFormat text to use if the time is today
Returns

The formatted text


Format Number with SIUnit

Localizes the specified value using the supplied formatting options and format string. Will calculate the /// appropriate SI unit and pass a character indicating that unit to the format call. //

nd_img_ModioUICommonFunctionLibrary_FormatNumberWithSIUnit.png

FText FormatNumberWithSIUnit(int64 Value, FText FormatText)
Parameters
ValueThe raw value to localize
FormatTextFText specifying the formatted output pattern. This will be passed the value as placeholder 0 and the units as placeholder 1
Returns

The formatted text


Create Bindable User

//

nd_img_ModioUICommonFunctionLibrary_CreateBindableUser.png

UModioUserUI* CreateBindableUser(FModioUser InRawUser)
Parameters
InRawUser
Returns

Create Bindable Report Type Enum Array

//

nd_img_ModioUICommonFunctionLibrary_CreateBindableReportTypeEnumArray.png

TArray<UModioEnumEntryUI*> CreateBindableReportTypeEnumArray()
Parameters
Returns

Create Bindable Mod Tag Raw Value

Creates a data-bindable UObject wrapper around a mod tag sourced from a FModioModInfo //

nd_img_ModioUICommonFunctionLibrary_CreateBindableModTagRawValue.png

UModioModTagUI* CreateBindableModTagRawValue(FModioModTag InTag)
Parameters
InTagThe tag to make bindable
Returns

UObject suitable for use as a DataSource


Create Bindable Mod Tag Options

Creates a data-bindable UObject wrapper around a FModioModTagOptions struct, including child UObjects /// that are data-bindable wrappers for individual tag categories and tags //

nd_img_ModioUICommonFunctionLibrary_CreateBindableModTagOptions.png

UModioModTagOptionsUI* CreateBindableModTagOptions(FModioModTagOptions InRawOptions)
Parameters
InRawOptionsThe struct containing tag data to bind to
Returns

UObject wrapper suitable for use as a DataSource


Create Bindable Mod Tag Info

Creates a data-bindable UObject wrapper around a FModioModTagInfo struct (aka a tag category), including /// child UObjects that are data-bindable wrappers for individual tags //

nd_img_ModioUICommonFunctionLibrary_CreateBindableModTagInfo.png

UModioModTagInfoUI* CreateBindableModTagInfo(FModioModTagInfo InRawTagInfo)
Parameters
InRawTagInfoThe struct containing tag data to bind to
Returns

UObject wrapper suitable for use as a DataSource


Create Bindable Mod Tag Array

Creates an array of data-bindable UObject wrappers around mod tags coming from a FModioModInfo, ie for /// display on the mod details //

nd_img_ModioUICommonFunctionLibrary_CreateBindableModTagArray.png

TArray<UModioModTagUI*> CreateBindableModTagArray(TArray<FModioModTag> InTags)
Parameters
InTagsThe array of tags to make bindable
Returns

Array of UObjects suitable for use as a DataSource


Create Bindable Mod Tag

Creates a data-bindable UObject wrapper around an individual mod tag value //

nd_img_ModioUICommonFunctionLibrary_CreateBindableModTag.png

UModioModTagUI* CreateBindableModTag(FModioModTagLocalizationData InTagLocalizationData)
Parameters
InTagLocalizationDataThe tag value to make bindable
Returns

UObject suitable for use as a DataSource


Create Bindable Mod Dependency Array from List

Creates an array of data-bindable UObject wrappers around mod dependencies coming from a FModioModDependencyList //

nd_img_ModioUICommonFunctionLibrary_CreateBindableModDependencyArrayFromList.png

TArray<UModioModDependencyUI*> CreateBindableModDependencyArrayFromList(FModioModDependencyList InModDependencyList)
Parameters
InModDependencyListThe array of tags to make bindable
Returns

Array of UObjects suitable for use as a DataSource


Create Bindable Mod Dependency Array from Array

Creates an array of data-bindable UObject wrappers around mod dependencies coming from an array //

nd_img_ModioUICommonFunctionLibrary_CreateBindableModDependencyArrayFromArray.png

TArray<UModioModDependencyUI*> CreateBindableModDependencyArrayFromArray(TArray<FModioModDependency> InModDependencyArray)
Parameters
InModDependencyArrayThe array of tags to make bindable
Returns

Array of UObjects suitable for use as a DataSource


Create Bindable Mod Dependency

Creates a data-bindable UObject wrapper around an individual mod dependency value //

nd_img_ModioUICommonFunctionLibrary_CreateBindableModDependency.png

UModioModDependencyUI* CreateBindableModDependency(FModioModDependency InModDependency)
Parameters
InModDependencyThe raw string value of the tag
Returns

UObject suitable for use as a DataSource


Create Bindable Enum

//

nd_img_ModioUICommonFunctionLibrary_CreateBindableEnum.png

UModioEnumEntryUI* CreateBindableEnum(uint8 InValue, FText InText)
Parameters
InValue
InText
Returns

Check Logo Download Event for Data Source

Utility method to validate if a logo download event is relevant for the given data source and requested /// size //

nd_img_ModioUICommonFunctionLibrary_CheckLogoDownloadEventForDataSource.png

bool CheckLogoDownloadEventForDataSource(FModioModID EventModID, EModioLogoSize EventLogoSize, UObject* DataSource, EModioLogoSize RequestedSize)
Parameters
EventModIDThe event's associated mod ID
EventLogoSizeThe event's associated download size
DataSourceThe data source containing the relevant mod ID
RequestedSizethe size that the widget requested
Returns

Check Logo Download Event

Utility method to validate if a logo download event is relevant for the given mod ID and requested size //

nd_img_ModioUICommonFunctionLibrary_CheckLogoDownloadEvent.png

bool CheckLogoDownloadEvent(FModioModID EventModID, EModioLogoSize EventLogoSize, FModioModID RequestedModID, EModioLogoSize RequestedSize)
Parameters
EventModIDThe event's associated mod ID
EventLogoSizeThe event's associated download size
RequestedModIDThe relevant mod ID for the widget that is making the check
RequestedSizeThe relevant size for the widget that is making the check
Returns

As Object Array

Converts an array of Interface references to an array of UObjects //

nd_img_ModioUICommonFunctionLibrary_AsObjectArray.png

TArray<UObject*> AsObjectArray(TArray<int32> TargetArray)
Parameters
TargetArrayThe array containing Interface references
Returns

Array of UObject


Apply Text Property Overrides Helper

nd_img_ModioUICommonFunctionLibrary_ApplyTextPropertyOverridesHelper.png

void ApplyTextPropertyOverridesHelper(FSlateFontInfoOverride FontPropertiesOverride, FHAlignOverride TextJustificationOverride, FTextTransformOverride TextTransformOverride, UObject* Target)

Get Metadata for Component

nd_img_ModioUIComponentStatics_GetMetadataForComponent.png

FModioUIComponentMetadata GetMetadataForComponent(EModioUIComponentID ComponentType, bool bComponentTypeFound)

Get All Component Metadata

nd_img_ModioUIComponentStatics_GetAllComponentMetadata.png

TMap<EModioUIComponentID,FModioUIComponentMetadata> GetAllComponentMetadata()

Enums

EModioUILoadState

NotLoaded
Loading
Loaded
Errored

EModioModInstallationStatus

NotInstalledNot installed by any user on the current system
ErrorMod has encountered an error during processing
EnabledInstalled and enabled by the current user
DisabledInstalled but disabled by the current user
PurchasedPurchased by the current user, but not installed by any user on the current system
SystemInstallInstalled by another user on the current system. This status takes precedence over Purchased.
QueuedMod is queued for processing
InitializingBeginning a new mod processing state
DownloadingMod is currently downloading
ExtractingMod is currently extracting
UploadingMod is currently uploading
UploadedMod upload has completed

EModioUIDialogType

Enum for specific dialog types, can be extended if there are additional dialog types added

ModDetails
ReportMod
EnableDisableManagement
PurchaseMod
StoreUi
ConfirmDependencyDownloadDialog to inform users that the mod they want to download has dependencies, which will be downloaded automatically along with the selected mod

EModioUIMediaDownloadEventType

Enumerator with different events when an image is downloaded

ModGalleryImagesDownloading gallery images *
ModCreatorAvatarImageDownloading an avatar *
ModLogoDownloading a logo *

EModioUIModInfoEventType

Enumerator of the information envents

ListAllModsEvent to list all mods *
GetModInfoEvent to retrieve the mod information *

EModioTextValidationRule

Enumeration for the possible validation rules ScriptName meta specifier suppresses a duplicate name LogPython warning

ETVR_ValidateEmailAddressValidate as an email *
ETVR_ValidateAllLettersValidate that every character is a letter *
ETVR_ValidateAllNumericValidate that every character is a number *
ETVR_ValidateAlphanumericValidate characters as numbers or letters *
ETVR_ValidateLengthValidate the length of the stream *
ETVR_ValidateNotEmptyValidate that has some content *
ETVR_ValidateNoWhitespaceValidate the lack of spaces *
ETVR_ValidateNotBlankValidate that there is not only whitespace *

EModioUITokenPackEventType

Enumerator of the information envents

ListAllTokenPacksEvent to list all token packs *
GetTokenPackEvent to retrieve the token pack information *

EModioModBrowserState

ModsView
LibraryView

EModioUIComponentID

Button
StaticText
EditableText
MultilineEditableText
CodeInputText
EnumSelector
PresetFilterSelector
ModTile
ModalDialog
Image
ProgressWidget
CheckBox
ModList
TagDisplay
ObjectList
EnumSelectorEntry
CommandMenu
FilterSelectorEntry
ModPropertyCollection
UserDisplay
ObjectSelector

EModioUIFeatureFlags

ModEnableDisable
Monetization
ModDownvote