IMenuComponent

A stable id for this component, unique within its menu.

string Id { get; }

Whether the selection can land on this component.

bool IsFocusable { get; }

How many lines this component draws.

int LineCount { get; }

Used to decide how much of the body fits on one page, without rendering components that will not be shown. It must match what IMenuComponentRenderContext) produces: a MenuBlankNode costs its Lines, a MenuStackNode costs the sum of its children, and everything else costs one. A component that returns a stack has to override this, otherwise it is budgeted as a single line and the page overflows.

Whether activating this component plays the menu's selection sound.

bool PlaySound { get; }

Produces the hint shown while this component holds the selection.

string? GetHint(IMenuSession session)

Use this for a per-entry explanation, or to advertise keys the component takes over through MenuActionContext).

Offers an action to this component before the menu handles it.

ValueTask<bool> HandleActionAsync(MenuActionContext context)

Only the focused component is offered actions. Returning true is how a component takes over a key that would otherwise navigate or close the menu.

Whether this component can be interacted with by a player.

bool IsEnabled(IMenuSession session)

Whether this component is shown to a player.

bool IsVisible(IMenuSession session)

Whether this component needs a new frame even though nothing invalidated the session.

bool NeedsRedraw(IMenuSession session, DateTime now)

Asked once per tick for every visible component of an otherwise clean session, so keep the check cheap. Animated text and live values are what this exists for.

Produces this component's renderer-agnostic output.

MenuNode Render(IMenuComponentRenderContext context)