@kayahr/ed-journal/src/main/events/travel/NavRoute.ts

Typescript library to read/watch the player journal of Frontier's game Elite Dangerous

/*
 * Copyright (C) 2022 Klaus Reimer <k@ailis.de>
 * See LICENSE.md for licensing information.
 */

import type { JournalEvent } from "../../JournalEvent.ts";
import type { ID } from "../types/ID.ts";
import type { StarType } from "../types/StarType.ts";

/**
 * When plotting a multi-star route, the file “NavRoute.json” is written in the same directory as the journal, with a
 * list of stars along that route.
 */
export interface NavRoute extends JournalEvent<"NavRoute"> {}

/**
 * Extended nav route data written to separate 'NavRoute.json' file.
 */
export interface ExtendedNavRoute extends JournalEvent<"NavRoute" | "NavRouteClear"> {
    Route: Array<{
        StarSystem: string;
        SystemAddress: ID;
        StarPos: [ number, number, number ];
        StarClass: StarType;
    }>;
}