Interface IAddon
Definition
Namespace: StardewUI.Framework.Addons
Assembly: StardewUI.dll
Entry point for a UI add-on.
Remarks
Add-ons are a plugin-like system that allow mods to extend the UI capabilities through new views, tags, converters, and other features. All add-ons must be registered via RegisterAddon(IAddon).
Members
Properties
| Name | Description |
|---|---|
| BehaviorFactory | Provides user-defined behavior extensions that run on existing view types. |
| Dependencies | List of dependencies, each corresponding to another Id, required by this addon. |
| Id | Unique ID for this addon. |
| ValueConverterFactory | Provides user-defined type conversions in addition to the standard conversions. |
| ViewFactory | Provides user-defined view types and enables them to be used with custom markup tags. |
Details
Properties
BehaviorFactory
Provides user-defined behavior extensions that run on existing view types.
Property Value
Remarks
All user-defined behaviors have lower priority than the built-in behaviors; a UI add-on is not allowed to remap an existing behavior name to its own implementation. Within the set of user-defined behaviors, the priority is based on inverted load order; the last add-on to associate a particular name with some behavior type will be the one to always handle that name, as long as it is not a standard behavior name.
Dependencies
List of dependencies, each corresponding to another Id, required by this addon.
Property Value
Remarks
Dependencies will always be loaded first. If any dependencies are missing, or if a cycle is detected (e.g. addon A depends on B which depends on A again) then the addon will be prevented from loading.
Id
Unique ID for this addon.
Property Value
Remarks
Prevents two copies of the same addon from trying to run at the same time, and allows other addons to depend on the features of this one by adding it to their Dependencies.
ValueConverterFactory
Provides user-defined type conversions in addition to the standard conversions.
Property Value
Remarks
All user-defined converters have lower priority than the built-in converters, except for the duck-type converters and StringConverterFactory which are always considered last. Within the set of user-defined converters, the priority is based on inverted load order; the last add-on that registered a converter able to handle a particular type conversion will be the one chosen, as long as none of the standard conversions can apply.
ViewFactory
Provides user-defined view types and enables them to be used with custom markup tags.
Property Value
Remarks
All user-defined views have lower priority than the built-in views; a UI add-on is not allowed to replace the behavior of a standard tag such as <label> or <lane>. Within the set of user-defined views, the priority is based on inverted load order; the last add-on to associate a particular tag with some view type will be the one to always handle that tag, as long as it is not a standard tag.