astro.Function.boxelCodeToLetters

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

Function: boxelCodeToLetters()

boxelCodeToLetters(boxelCode): BoxelLetters

Defined in: src/astro/system-name.ts:119

Unpack a base-26 boxel code into its (l1, l2, l3, n1) letter code — the inverse of lettersToBoxelCode.

Parameters

boxelCode

number

The packed base-26 boxel code, as decodeSystemAddress returns. Must be a non-negative integer lettersToBoxelCode could have packed.

Returns

BoxelLetters

The three letter indices (0–25 each) and the boxel number n1.

Throws

If boxelCode is not an integer between 0 and the largest exactly packable code — no such code can be packed, and a negative one would yield letters outside 0–25.

Example

import { boxelCodeToLetters, lettersToBoxelCode } from '@elite-dangerous-almanac/core/astro/system-name';

boxelCodeToLetters(lettersToBoxelCode(4, 13, 7, 11)); // -> { l1: 4, l2: 13, l3: 7, n1: 11 }