astro.Interface.CodexRegion - Elite-Dangerous-Almanac/Almanac-Core GitHub Wiki
@elite-dangerous-almanac/core / astro / CodexRegion
Defined in: src/astro/codex-region.ts:89
A single Elite Dangerous galactic codex region.
Footprint fields (CodexRegion.areaLy2, CodexRegion.bounds, CodexRegion.centroid) are approximations derived from the ≈49.35 ly region grid, not survey-precise figures.
import { getCodexRegionByName } from '@elite-dangerous-almanac/core/astro/codex-region';
import type { CodexRegion } from '@elite-dangerous-almanac/core/astro/codex-region';
const innerOrionSpur: CodexRegion | null = getCodexRegionByName('Inner Orion Spur');
readonlyareaLy2:number
Defined in: src/astro/codex-region.ts:107
Approximate footprint area on the galactic plane, in square light-years.
readonlybounds:CodexRegionBounds
Defined in: src/astro/codex-region.ts:109
Axis-aligned bounds on the galactic plane, in light-years.
readonlycellCount:number
Defined in: src/astro/codex-region.ts:105
Number of grid cells the region occupies (each cell ≈49.35 ly square).
readonlycentroid:GalacticPlanePosition
Defined in: src/astro/codex-region.ts:111
Cell-weighted centroid on the galactic plane, in light-years.
readonlygrayscale:number
Defined in: src/astro/codex-region.ts:103
Grayscale value this region has in the upstream RegionMap.png
(0xA8 for region 1, decreasing by 4 per id). Useful when cross-referencing
the source image.
readonlyid:number
Defined in: src/astro/codex-region.ts:91
Region id, 1–42. Stable across releases; matches the codex region ordering.
readonlyname:string
Defined in: src/astro/codex-region.ts:97
Human-readable region name, e.g. "Inner Orion Spur". This is the canonical
English name. For a player's own language, pass the id to getCodexRegionName
in i18n/codex-regions, which reads a separate catalogue.