astro.TypeAlias.PermitLock - Elite-Dangerous-Almanac/Almanac-Core GitHub Wiki

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

Type Alias: PermitLock

PermitLock = { id64: bigint; kind: "system"; name: string; } | { kind: "region"; name: string; }

Defined in: src/astro/permit-locks.ts:78

Why a system needs a permit: because that exact system is locked (kind: 'system'), or because it lies inside a locked region (kind: 'region').

Union Members

Type Literal

{ id64: bigint; kind: "system"; name: string; }

id64

readonly id64: bigint

That system's 64-bit system address.

kind

readonly kind: "system"

The system itself is on the permit-locked list.

name

readonly name: string

The canonically-cased system name, e.g. "Shinrarta Dezhra".


Type Literal

{ kind: "region"; name: string; }

kind

readonly kind: "region"

The system lies inside a permit-locked region.

name

readonly name: string

The region's name, e.g. "Col 70 Sector". Also a HAND_AUTHORED_REGIONS entry name, so you can look its spheres up by it (see ./hand-authored-regions). No id64 — a region is not a system.

⚠️ **GitHub.com Fallback** ⚠️