Skip to main content

Action

An action represents an invokable operation that performs a specific task.

Actions define a custom handler function that is automatically invoked by MoBro whenever the action is triggered by the user via the dashboard. These handlers can contain any custom logic and perform a wide range of operations, such as interacting with external software, launching applications, or executing system commands.

Actions are highly configurable and can expose individual settings following the same available options and restrictions as plugin settings.

See also: Registering Items

info

Actions can already be defined and registered by plugins but are not yet enabled within MoBro itself.
Full support for actions will be added to MoBro in the near future.

Properties

The following table outlines the properties of an action:

PropertyTypeDescription
IdstringThe unique identifier of the action.
LabelstringThe textual name representing the action.
Descriptionstring?An optional textual description providing additional details about the action.
CategoryIdstringThe category this action belongs to (corresponds to the ID of a registered Category).
GroupIdstring?An optional group the action is associated with (corresponds to the ID of a registered Group).
MetricIdstring?An optional metric that represents the value this action adjusts or influences (corresponds to the ID of a registered Metric).
HandlerFunc<IMoBroSettings, Task>The handler function that will be executed whenever this action is invoked.
SettingsIEnumerable<SettingsFieldBase>Settings exposed by this specific action.