api.menu

MenuApi

Items in the editor's menu bar. A path whose last segment names no submenu makes one.

Members

add

add(path: MenuPath, item: MenuItemSpec): Disposable;

Items in the editor's menu bar.

api.menu.add("Tools", {
  label: "Count units\u2026",
  icon: "plugin",
  run: () => api.ui.alert(`Player 1 has ${api.query.unitsOf(0).length} units.`),
});

// A path whose last segment names no submenu makes one, at the end of that menu.
api.menu.add("Tools/My plugin", { label: "Settings\u2026", command: "settings" });

Types

Declarations only this group names.

PluginIcontype

type PluginIcon = {
	kind: "text";
	text: string;
} | {
	kind: "image";
	url: string;
};

A manifest icon after resolution: a glyph to print, or an image to show.

TopMenutype

type TopMenu = "File" | "Edit" | "View" | "Layer" | "Scenario" | "Triggers" | "Tools" | "Plugins" | "Help";

MenuPathtype

type MenuPath = TopMenu | `${TopMenu}/${string}`;

A top-level menu, or a submenu by label: "File/Import". A last segment that names no submenu gets one of the plugin's own, at the end of the menu ("Tools/AI").

MenuItemSpecinterface

interface MenuItemSpec

`label: string`
`shortcut?: string`	Display only — bind the key with `hotkeys.add`.
`icon?: "plugin" \| PluginIcon`	A mark in front of the label: `"plugin"` for the plugin's own icon (the manifest's), or any `PluginIcon`. Use it when the item does something a built-in never would — reach a network, say — so the user can tell at a glance.
`after?: string`	Where in the menu: the label of the built-in item or submenu to sit directly under (`"Open Recent"`). Without it, or when nothing has that label, the item goes to the end of the menu after a separator.
`separator?: boolean`	A separator line above this item — for grouping the items of a submenu of your own.
`enabled?: () => boolean`
`run?: () => void`	What the item does. Give this or `command`.
`command?: string`	A registered command's id, instead of a `run` of its own.