swiftlys2/docs/api/ai/
API Reference › Menu

IMenuInputMethodSource

Interface
Namespace: SwiftlyS2.Shared.Menu · Assembly: SwiftlyS2.CS2.dll
public interface IMenuInputMethodSource

Supplies input method overrides for menus.

Sources are consulted in descending Priority order and the first one that answers wins, so a server-wide configuration can enforce an input method over whatever a plugin requested in code. Implement this to bind input method choices from any store.

View source

Properties

Priority

The resolution priority. Higher values are consulted first.

int Priority { get; }
Property Value

Methods

TryGetInputMethod(string, out MenuInputMethod)

Attempts to resolve the input method to use for a menu.

bool TryGetInputMethod(string menuId, out MenuInputMethod inputMethod)
Parameters
  • menuIdstringThe menu to resolve.
  • inputMethodMenuInputMethodThe input method, when this source overrides the menu.
Returns
true when this source overrides the menu.