Skip to content

astro.codex region lookup.Interface.CodexRegionPoint

github-actions[bot] edited this page Aug 26, 2026 · 73 revisions

@elite-dangerous-almanac/core / astro/codex-region-lookup / CodexRegionPoint

Interface: CodexRegionPoint

Defined in: src/astro/codex-region-lookup.ts:142

A point to resolve a region at: a GalacticPlanePosition, or a full GalacticPosition — from the journal, EDSM, Spansh or ProceduralSystem.position — passed straight through, whether it comes from a variable or is written out inline.

Example

import { findCodexRegionAt } from '@elite-dangerous-almanac/core/astro/codex-region-lookup';

findCodexRegionAt({ x: 0, z: 0 });        // the plane position the map is indexed by
findCodexRegionAt({ x: 0, y: 0, z: 0 });  // a full position, `y` and all

Extends

Properties

x

readonly x: number

Defined in: src/astro/codex-region.ts:41

Galactic X coordinate, in light-years.

Inherited from

GalacticPlanePosition.x


y?

readonly optional y?: number

Defined in: src/astro/codex-region-lookup.ts:147

Galactic Y, in light-years. Accepted and ignored: the region map is a flat X/Z projection, so a region has no vertical extent to test against.


z

readonly z: number

Defined in: src/astro/codex-region.ts:43

Galactic Z coordinate, in light-years.

Inherited from

GalacticPlanePosition.z

API

Guides
astro
Classes (1)
ProceduralSystem

Properties

Accessors

Methods

Interfaces (16)
Type Aliases (3)
Variables (11)
Functions (37)
Subpath modules (3)
commodities
Interfaces (1)
Type Aliases (1)
Variables (3)
Functions (3)
equipment
Interfaces (6)
Type Aliases (8)
Variables (3)
Functions (10)
Subpath modules (2)
i18n
Interfaces (1)
Type Aliases (1)
Functions (17)
materials
Enumerations (2)
Interfaces (2)
Type Aliases (2)
Variables (9)
Functions (9)
ships
Classes (3)
BuildMetrics

Methods

LoadoutEditError

Constructors

Properties

Methods

ShipLoadout

Accessors

Methods

Interfaces (125)
Type Aliases (44)
Variables (10)
Functions (85)
Subpath modules (8)

Clone this wiki locally