astro.Function.sectorNameFromGalacticPosition

@elite-dangerous-almanac/core / astro / sectorNameFromGalacticPosition

Function: sectorNameFromGalacticPosition()

sectorNameFromGalacticPosition(position): string

Defined in: src/astro/galaxy-grid.ts:105

The procedural sector name for a galactic position.

The one-call form of sectorGridPositionFromGalacticPosition followed by sectorNameFromGridPosition — "which sector is this point in?".

Parameters

position

GalacticPosition

Galactic position in light-years, Sol at the origin.

Returns

string

The canonically-cased procedural sector name (e.g. Synuefe, Blae Eock).

Throws

If the position lies outside the sector grid, or the grid slot has no procedurally assigned name.

Remarks

This is always the procedural sector. A system inside a hand-authored region (Pleiades, Coalsack, …) is named after that region instead — resolve those with findHandAuthoredRegionAt from ./hand-authored-regions.

Example

import { sectorNameFromGalacticPosition } from '@elite-dangerous-almanac/core/astro/galaxy-grid';

sectorNameFromGalacticPosition({ x: 751, y: -179, z: -91 }); // -> 'Synuefe'