astro.codex region lookup.Interface.CodexRegionPoint - Elite-Dangerous-Almanac/Almanac-Core GitHub Wiki

@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

⚠️ **GitHub.com Fallback** ⚠️