CategoryInput

Interface: CategoryInput

Imported from @elite-dangerous-almanac/galaxy-map.

What a host passes to addCategories. The type states the contract and the reader holds it: every field is still checked at run time, because the data comes from a file or a network call the compiler does not see.

The index signature lets a record carry fields the reader drops, so a caller does not have to strip a dump record first.

Indexable

[field: string]: unknown

A field the reader drops.

Properties

color

readonly color: readonly [number, number, number]

Red, green and blue, each from 0 to 255.

---

description?

readonly optional description?: string

What the HUD shows about the category.

---

markerStyle?

readonly optional markerStyle?: MarkerStyle

The shape the markers of the category draw in. The default is glow.

---

maxDrawRange?

readonly optional maxDrawRange?: number

How far the camera comes from a system before its marker stops, in light years.

---

name

readonly name: string

The identity of the category.