astro.Function.decodeSystemAddress

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

Function: decodeSystemAddress()

decodeSystemAddress(id64): DecodedAddress

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

Decode a system address into its geometric components.

Parameters

id64

SystemAddressInput

The 64-bit system address, as a bigint, a normally parsed journal number, or a decimal string (see SystemAddressInput).

Returns

DecodedAddress

The decoded size class, sector, boxel code, sequence and absolute boxel.

Throws

If id64 is not a usable address representation (a non-integer, or a number so large it has already been rounded).

Throws

If id64 is negative or does not fit in 64 bits.

Example

import { decodeSystemAddress } from '@elite-dangerous-almanac/core/astro/system-address';
declare const event: { SystemAddress: number }; // an `FSDJump` line, parsed

decodeSystemAddress(3309179996515n);
// -> { sizeClass: 3, sectorGridPosition: { sectorX: 39, sectorY: 31, sectorZ: 18 }, … }

decodeSystemAddress(event.SystemAddress); // a journal number works too