LauncherEntry record
A plugin (or the framework) entry shown in the Stellar launcher menu. Title doubles as the stable identity used to persist the entry’s pinned state, so keep it unique and stable across sessions. IconPng (raw PNG bytes) is the preferred icon — it rasterises to a native-looking sprite; IconKey is the font-glyph fallback. OnOpen runs when the user clicks the tile.
public record LauncherEntryPublic Members
Section titled “Public Members”| name | description |
|---|---|
| LauncherEntry(…) | A plugin (or the framework) entry shown in the Stellar launcher menu. Title doubles as the stable identity used to persist the entry’s pinned state, so keep it unique and stable across sessions. IconPng (raw PNG bytes) is the preferred icon — it rasterises to a native-looking sprite; IconKey is the font-glyph fallback. OnOpen runs when the user clicks the tile. |
| DisplayTitle { get; } | The title the launcher DISPLAYS: TitleProvider if set (live-localized), otherwise Title. Identity/pinning still keys on Title. |
| Group { get; set; } | Full-mode section. Plugins default to Plugin. |
| IconKey { get; set; } | |
| IconPng { get; set; } | |
| OnOpen { get; set; } | |
| ShouldShow { get; set; } | Optional phase/state gate for the tile’s visibility in the launcher menu, evaluated live each time the menu draws (a pull, like ShouldRender). null (the default) means the tile is shown in every phase. Return false to hide it — e.g. ShouldShow = () => services.ClientState.Phase == GamePhase.World for a gameplay-only tool. Applies only to the plugin tile; the framework’s own ⚙ Settings entry is always shown. |
| Title { get; set; } | |
| TitleProvider { get; set; } | Optional live-localized DISPLAY title, evaluated each time the menu draws so the tile re-localizes immediately when the language changes (Title is a captured string and does not). null (the default) shows Title. Set it to () => services.Localization.T("your.title.key"). Title stays the stable pinned-state identity, so keep it language-independent if you rely on pin persistence. |
See Also
Section titled “See Also”- namespace Stellar.Abstractions.Services