api.contextMenu

ContextMenuApi

Items in the right-click menus of the map and the terrain palette.

Members

add(surface: ContextSurface, item: ContextItemSpec): Disposable;

Declarations only this group names.

type ContextSurface = "viewport" | "terrainPalette";

interface ContextMenuContext

`surface: ContextSurface`
`tile: { x: number; y: number; } \| null`	The tile under the pointer (viewport only).
`point: { px: number; py: number; } \| null`	The map pixel under the pointer (viewport only).
`layer: EditorLayer`
`terrainMode: TerrainMode`
`terrain: number`	The palette's active terrain id.
`markedArea: Rect \| null`

interface ContextItemSpec

`label: string \| ((ctx: ContextMenuContext) => string)`
`enabled?: (ctx: ContextMenuContext) => boolean`
`visible?: (ctx: ContextMenuContext) => boolean`
`run?: (ctx: ContextMenuContext) => void`	Give this or `command` (which is run with the context as its argument).
`command?: string`