Modules

Docs / API / Modules / menu

A slot-based interactive menu. Add items, wire Menu.onSelect/Menu.onCancel, then Menu.display to a player slot. The model paginates automatically (7 items per chat page) and picks a renderer by Menu.style, falling back to Chat when the style's renderer is unregistered. Only one menu is active per slot; displaying a new one supersedes the old (MenuCancelReason.NewMenu).

import { Menu, MenuStyle } from "@s2script/sdk/menu";
const m = new Menu("s2script Menu Demo");
m.style = MenuStyle.Center;
m.addItem("hp", "Heal to 100");
m.addItem("noclip", "Toggle Noclip");
m.onSelect(e => { console.log(`picked ${e.info} (slot ${e.slot})`); });
m.display(slot, 30);

freezePlayer: boolean

— When true, a renderer that supports it may freeze the player's movement while the menu is open and restore it on close. Default false. The CS2 center renderer currently ignores this and does not freeze movement — freezing is disabled until the menu surface can guarantee it is interactive. The chat renderer also ignores it.

registerRenderer(name: string, renderer: MenuRenderer): MenuRenderer | undefined

— Register a display backend under a MenuStyle value (used by the CS2 center renderer). Returns the previous renderer, or undefined if none was registered, so a replacement can delegate to the previous backend when its own display is unavailable.

interface

MenuSession

A live display of one menu to one slot, passed to a MenuRenderer. Owns the page/cursor state and exposes the input verbs a renderer drives.

readonly slot: number

— 0-based player slot this session is displayed to.

view(): { title: string; lines: MenuLine[]; page: number; pageCount: number; exit: boolean }

— The resolved snapshot the renderer paints: heading, per-line state, and 0-based page position.

pickNumber(n: number): void

— Chat idiom: apply a number-key press against the current view (1..7 select, 8=Back, 9=Next, 0=Exit).

moveUp(): void

— Center idiom: move the cursor up over the current page's nav targets (items + Back/Next/Exit), wrapping.

moveDown(): void

— Center idiom: move the cursor down over the current page's nav targets, wrapping.

confirm(): void

— Center idiom: activate the current cursor target (select an item, paginate, or exit).

cancel(): void

— Close this session with an MenuCancelReason.Exit.

interface

MenuLine

One rendered line of a MenuSession view.

text: string

— The line's visible text.

key: string | null

— The chat number key ("1".."0") that picks this line, or null for an unselectable/disabled line.

selectable: boolean

— True if this line is a selectable item.

cursor?: boolean

— True if the center cursor is currently on this line (the renderer highlights it).

control?: string

— For a control line, which control it is: "back", "next", or "exit" (absent on item lines).

index?: number

— For an item line, its 0-based index into the menu's item list (absent on control lines).

interface

MenuRenderer

A display backend for Menu — registered via Menu.registerRenderer, driven with a MenuSession.

open(session: MenuSession): void

— Show the session for the first time (the menu just opened).

update(session: MenuSession): void

— Re-paint the session after a page/cursor change.

close(slot: number): void

— Tear down the display for slot (the menu closed).

Back to modules All packages

Menu

Import

API reference