IMenuSession

The focused component, or null when the menu has nothing focusable.

IMenuComponent? FocusedComponent { get; }

The index of the focused component within the visible focusable body components.

int FocusedIndex { get; }

Whether this session is still open.

bool IsOpen { get; }

The menu being viewed.

IMenu Menu { get; }

The player viewing the menu.

IPlayer Player { get; }

Routes this player's next chat messages to a handler instead of the chat.

IDisposable CaptureChat(Func<string, bool> onMessage)

Only one capture is active per session; starting a second one replaces the first. The capture is dropped automatically when the menu closes or the player disconnects, so a component only needs to dispose the handle when it finishes early.

Closes this session, returning the player to the parent menu when there is one.

void Close()

Gets this player's state for a component, creating it on first use.

TState GetState<TState>(IMenuComponent component) where TState : class, new()

Marks this session as needing a redraw on the next tick.

void Invalidate()

Call this after changing anything that affects what the player sees. Frames are only sent when a session is invalidated, so forgetting this leaves the display stale.

Moves the selection by a number of entries, wrapping at both ends.

bool MoveFocus(int delta)

Moves the selection to a specific entry.

bool SetFocus(int index)

Replaces this player's state for a component.

void SetState<TState>(IMenuComponent component, TState state) where TState : class