astro.Function.decodeModSystemAddress - Elite-Dangerous-Almanac/Almanac-Core GitHub Wiki
@elite-dangerous-almanac/core / astro / decodeModSystemAddress
decodeModSystemAddress(
id64):DecodedAddress
Defined in: src/astro/system-address.ts:305
Decode a modulated system address into its geometric components.
The 64-bit modulated system address, as a bigint, a safe-integer
number, or a decimal string (see SystemAddressInput). A modulated
address packs the sector into the high bits, so it routinely exceeds 2^53;
those values must be supplied as a bigint or string because a JS number has
already lost precision.
The decoded components (same shape as decodeSystemAddress).
The modulated form is an alternative bit-layout of the same system, used by
some community tools and data dumps. If you have a normal id64 (the usual
case — journal, EDSM, EDDN, Spansh all use it), reach for
decodeSystemAddress instead; use this only when a source specifically
hands you a modulated address.
If id64 is not a usable address representation.
If id64 is negative or does not fit in 64 bits.
import { decodeModSystemAddress } from '@elite-dangerous-almanac/core/astro/system-address';
declare const modAddressFromSomeTool: bigint;
decodeModSystemAddress(modAddressFromSomeTool).sectorGridPosition;
// -> { sectorX, sectorY, sectorZ }