astro.Function.sectorNameFromGridPosition

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

Function: sectorNameFromGridPosition()

sectorNameFromGridPosition(position): string

Defined in: src/astro/sector-name.ts:754

The procedural sector name for a grid position.

Parameters

position

SectorGridPosition

Integer sector position on the galaxy grid. Each axis must be an integer in 0–127 (the 7-bit sector grid); the packed offset would otherwise bleed one axis into the next and produce a wrong or empty name.

Returns

string

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

Throws

If any axis is not an integer in 0–127, or if the grid slot is outside the procedural generator's assigned name range.

Example

import { sectorNameFromGridPosition } from '@elite-dangerous-almanac/core/astro/sector-name';

sectorNameFromGridPosition({ sectorX: 39, sectorY: 30, sectorZ: 20 }); // -> a procedural name