astro.Function.boxelCodeToAbsoluteBoxel

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

Function: boxelCodeToAbsoluteBoxel()

boxelCodeToAbsoluteBoxel(sizeClass, boxelCode, origin): AbsoluteBoxel

Defined in: src/astro/system-address.ts:109

Absolute boxel indices of a name's boxel code, relative to the galaxy origin.

This is the inverse of the decode split: it turns the base-26 boxel code back into a grid position by adding the region origin (snapped down to the boxel grid). It throws rather than emit a wrong address when the origin has a negative coordinate, when N1 overflows the code, when the boxel code falls outside the region, or when the resulting sector cannot be represented by the address bits.

Parameters

sizeClass

number

Size class 0–7 (mass code a–h).

boxelCode

number

The base-26 boxel code (lettersToBoxelCode).

origin

NamingRegionOrigin

The resolved region origin (internal units, 32 per light-year).

Returns

AbsoluteBoxel

The boxel's absolute indices on the per-size-class boxel grid, measured from the galaxy corner.

Throws

If sizeClass is outside 0–7, the origin has a negative coordinate, or the code or the resulting sector is out of range.