MinimapOptions
import type { MinimapOptions } from 'pixi-silk/ui/minimap';Options of Minimap.
Properties#
| Property | Type | Description | Defined in |
|---|---|---|---|
background? | boolean | Draw a card behind the map. Off inside a panel, which has its own. Default true. | ui/panels/Minimap.ts:96 |
camera | Camera | The camera whose world the minimap shows and moves. | ui/panels/Minimap.ts:75 |
content? | Container<ContainerChild> | What to show. Default camera.content. | ui/panels/Minimap.ts:77 |
height? | number | Map height in local units. Default 130. | ui/panels/Minimap.ts:81 |
interval? | number | Seconds between thumbnail and bounds updates. Default 0.5. | ui/panels/Minimap.ts:90 |
items? | () => Iterable<WorldRect> | The rectangles bounds draws. Default the bounds of the objects in content, up to three groups deep. | ui/panels/Minimap.ts:92 |
mode? | "texture" | "bounds" | bounds (default) draws the outline of each top object, crisp and cheap. texture renders the content into a small texture now and then, for a real thumbnail. It needs renderer. | ui/panels/Minimap.ts:86 |
padding? | number | Space around the content inside the map. Default 10. | ui/panels/Minimap.ts:94 |
renderer? | Renderer | The renderer, for texture. Without it texture mode draws nothing for the content. | ui/panels/Minimap.ts:88 |
theme? | Partial<PanelTheme> | Colours. Default the dark panel theme. | ui/panels/Minimap.ts:98 |
ticker? | Ticker | null | Ticker driving updates and motion. Default Ticker.shared. null for manual Minimap.tick. | ui/panels/Minimap.ts:100 |
width? | number | Map width in local units. Default 200. | ui/panels/Minimap.ts:79 |