Class UI
Definition
Namespace: StardewUI
Assembly: StardewUI.dll
Entry point for Stardew UI. Must be called from Entry(IModHelper).
Inheritance
Object ⇦ UI
Members
Methods
| Name | Description |
|---|---|
| Initialize(IModHelper, IMonitor) | Initialize the framework. |
| RegisterAddon(IAddon) | Registers a UI add-on (mod extension). |
Details
Methods
Initialize(IModHelper, IMonitor)
Initialize the framework.
public static void Initialize(StardewModdingAPI.IModHelper helper, StardewModdingAPI.IMonitor monitor);
Parameters
helper IModHelper
Helper for the calling mod.
monitor IMonitor
SMAPI logging helper.
RegisterAddon(IAddon)
Registers a UI add-on (mod extension).
Parameters
addon IAddon
The add-on definition.
Remarks
Add-ons are resolved in the game's GameLaunched event. Therefore, mods providing add-ons must register them as early as possible, typically in their Entry(IModHelper) method, but if that is too early, then in a GameLaunched handler of their own with a high EventPriority.
Types provided by add-ons (views, converters, etc.) will not actually be used until a UI is created, so add-ons may employ lazy/deferred loading if they need to postpone some critical operations until after the game is fully loaded, other APIs are initialized, etc.