@fboes/aerofly-custom-missions 1.2.2 → 1.2.3

package/types/AeroflyMissionCheckpoint.d.ts

@@ -0,0 +1,140 @@
+/**
+ * @class
+ * A single way point for the given flight plan
+ *
+ * The purpose of this class is to collect data needed for Aerofly FS4's
+ * `custom_missions_user.tmc` flight plan file format, and export the structure
+ * for this file via the `toString()` method.
+ */
+export declare class AeroflyMissionCheckpoint {
+    /**
+     * @property {"origin"|"departure_runway"|"departure"|"waypoint"|"arrival"|"approach"|"destination_runway"|"destination"} type of checkpoint, like "departure_runway"
+     */
+    type: AeroflyMissionCheckpointType;
+    /**
+     * @property {string} name ICAO code for airport, runway designator, navaid
+     *    designator, fix name, or custom name
+     */
+    name: string;
+    /**
+     * @property {number} longitude easting, using the World Geodetic
+     *    System 1984 (WGS 84) [WGS84] datum, with longitude and latitude units
+     *    of decimal degrees; -180..180
+     */
+    longitude: number;
+    /**
+     * @property {number} latitude northing, using the World Geodetic
+     *    System 1984 (WGS 84) [WGS84] datum, with longitude and latitude units
+     *    of decimal degrees; -90..90
+     */
+    latitude: number;
+    /**
+     * @property {number} altitude The height in meters above or below the WGS
+     *    84 reference ellipsoid
+     */
+    altitude: number;
+    /**
+     * @property {?boolean} altitudeConstraint The altitude given in `altitude`
+     *    will be interpreted as mandatory flight plan altitude instead of
+     *    suggestion.
+     */
+    altitudeConstraint: boolean | null;
+    /**
+     * @property {?number} direction of runway, in degree
+     */
+    direction: number | null;
+    /**
+     * @property {?number} slope of runway
+     */
+    slope: number | null;
+    /**
+     * @property {?number} length of runway, in meters
+     */
+    length: number | null;
+    /**
+     * @property {?number} frequency of runways or navigational aids, in Hz; multiply by 1000 for kHz, 1_000_000 for MHz
+     */
+    frequency: number | null;
+    /**
+     * @property {?boolean} flyOver if waypoint is meant to be flown over
+     */
+    flyOver: boolean | null;
+    /**
+     * @param {string} name ICAO code for airport, runway designator, navaid
+     *    designator, fix name, or custom name
+     * @param {"origin"|"departure_runway"|"departure"|"waypoint"|"arrival"|"approach"|"destination_runway"|"destination"} type Type of checkpoint, like "departure_runway"
+     * @param {number} longitude easting, using the World Geodetic
+     *    System 1984 (WGS 84) [WGS84] datum, with longitude and latitude units
+     *    of decimal degrees; -180..180
+     * @param {number} latitude northing, using the World Geodetic
+     *    System 1984 (WGS 84) [WGS84] datum, with longitude and latitude units
+     *    of decimal degrees; -90..90
+     * @param {object} additionalAttributes allows to set additional attributes on creation
+     * @param {number} [additionalAttributes.altitude] The height in meters above or below the WGS
+     *    84 reference ellipsoid
+     * @param {?number} [additionalAttributes.altitude_feet] The height in feet above or below the WGS
+     *    84 reference ellipsoid. Will overwrite altitude
+     * @param {number} [additionalAttributes.altitudeConstraint] The altitude given in `altitude`
+     *    will be interpreted as mandatory flight plan altitude instead of
+     *    suggestion.
+     * @param {boolean} [additionalAttributes.direction] of runway, in degree
+     * @param {?number} [additionalAttributes.slope] of runway
+     * @param {?number} [additionalAttributes.length] of runway, in meters
+     * @param {?number} [additionalAttributes.length_feet] of runway, in feet. Will overwrite length
+     * @param {?number} [additionalAttributes.frequency] of runways or navigational aids, in Hz; multiply by 1000 for kHz, 1_000_000 for MHz
+     * @param {?boolean} [additionalAttributes.flyOver] if waypoint is meant to be flown over
+     */
+    constructor(
+        name: string,
+        type: AeroflyMissionCheckpointType,
+        longitude: number,
+        latitude: number,
+        {
+            altitude,
+            altitude_feet,
+            altitudeConstraint,
+            direction,
+            slope,
+            length,
+            length_feet,
+            frequency,
+            flyOver,
+        }?: {
+            altitude?: number;
+            altitude_feet?: number | null;
+            altitudeConstraint?: boolean | null;
+            direction?: number | null;
+            slope?: number | null;
+            length?: number | null;
+            length_feet?: number | null;
+            frequency?: number | null;
+            flyOver?: boolean | null;
+        },
+    );
+    /**
+     * @param {number} altitude_feet
+     */
+    set altitude_feet(altitude_feet: number);
+    /**
+     * @returns {number} altitude_feet
+     */
+    get altitude_feet(): number;
+    /**
+     * @param {number} length_feet
+     */
+    set length_feet(length_feet: number);
+    /**
+     * @returns {number} length_feet
+     */
+    get length_feet(): number;
+    /**
+     * @returns {string}
+     */
+    get frequency_string(): string;
+    /**
+     * @param {number} index if used in an array will se the array index
+     * @returns {string} to use in Aerofly FS4's `custom_missions_user.tmc`
+     */
+    toString(index?: number): string;
+}
+//# sourceMappingURL=AeroflyMissionCheckpoint.d.ts.map

package/types/AeroflyMissionTargetPlane.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @class
+ * A target plane which the aircraft needs to cross.
+ */
+export declare class AeroflyMissionTargetPlane {
+    /**
+     * @property {number} longitude easting, using the World Geodetic
+     *    System 1984 (WGS 84) [WGS84] datum, with longitude and latitude units
+     *    of decimal degrees; -180..180
+     */
+    longitude: number;
+    /**
+     * @property {number} latitude northing, using the World Geodetic
+     *    System 1984 (WGS 84) [WGS84] datum, with longitude and latitude units
+     *    of decimal degrees; -90..90
+     */
+    latitude: number;
+    /**
+     * @property {number} dir in degree
+     */
+    dir: number;
+    /**
+     * @property {string} name of property
+     */
+    name: string;
+    /**
+     *
+     * @param {number} longitude easting, using the World Geodetic
+     *    System 1984 (WGS 84) [WGS84] datum, with longitude and latitude units
+     *    of decimal degrees; -180..180
+     * @param {number}latitude northing, using the World Geodetic
+     *    System 1984 (WGS 84) [WGS84] datum, with longitude and latitude units
+     *    of decimal degrees; -90..90
+     * @param {number} dir in degree
+     * @param {string} name of property
+     */
+    constructor(longitude: number, latitude: number, dir: number, name?: string);
+    toString(): string;
+}
+//# sourceMappingURL=AeroflyMissionTargetPlane.d.ts.map

package/types/dto/AeroflyConfigFileSet.d.ts

@@ -0,0 +1,10 @@
+export declare class AeroflyConfigFileSet {
+    #private;
+    elements: string[];
+    constructor(indent: number, type: string, name: string, value?: string);
+    get indent(): string;
+    push(type: string, name: string, value: string | number | string[] | number[] | boolean, comment?: string): this;
+    pushRaw(s: string): this;
+    toString(): string;
+}
+//# sourceMappingURL=AeroflyConfigFileSet.d.ts.map

package/types/dto/AeroflyConfigFileSet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AeroflyConfigFileSet.d.ts","sourceRoot":"","sources":["../../src/dto/AeroflyConfigFileSet.ts"],"names":[],"mappings":"AAAA,qBAAa,oBAAoB;;IAE7B,QAAQ,EAAE,MAAM,EAAE,CAAC;gBAEP,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW;IAK1E,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,OAAO,EAAE,OAAO,GAAE,MAAW;IAa7G,OAAO,CAAC,CAAC,EAAE,MAAM;IAKjB,QAAQ;CAGX"}

package/types/dto/AeroflyLocalizedText.d.ts

@@ -0,0 +1,54 @@
+/**
+ * @class
+ * A translation for the mission title and description.
+ */
+export declare class AeroflyLocalizedText {
+    /**
+     * @property {string} language ISO 639-1 like
+     * - br
+     * - cn
+     * - de
+     * - es
+     * - fr
+     * - id
+     * - it
+     * - jp
+     * - kr
+     * - pl
+     * - sv
+     * - tr
+     */
+    language: string;
+    /**
+     * @property {string} title of this flight plan
+     */
+    title: string;
+    /**
+     * @property {string} description text, mission briefing, etc
+     */
+    description: string;
+    /**
+     * @param {string} language ISO 639-1 like
+     * - br
+     * - cn
+     * - de
+     * - es
+     * - fr
+     * - id
+     * - it
+     * - jp
+     * - kr
+     * - pl
+     * - sv
+     * - tr
+     * @param {string} title of this flight plan
+     * @param {string} description text, mission briefing, etc
+     */
+    constructor(language: string, title: string, description: string);
+    /**
+     * @param {number} index if used in an array will se the array index
+     * @returns {string} to use in Aerofly FS4's `custom_missions_user.tmc`
+     */
+    toString(index?: number): string;
+}
+//# sourceMappingURL=AeroflyLocalizedText.d.ts.map

package/types/dto/AeroflyLocalizedText.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AeroflyLocalizedText.d.ts","sourceRoot":"","sources":["../../src/dto/AeroflyLocalizedText.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,qBAAa,oBAAoB;IAC7B;;;;;;;;;;;;;;OAcG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;;;;;;;OAgBG;gBACS,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;IAMhE;;;OAGG;IACH,QAAQ,CAAC,KAAK,GAAE,MAAU,GAAG,MAAM;CAOtC"}

package/types/dto/AeroflyMission.d.ts

@@ -0,0 +1,208 @@
+import { AeroflyLocalizedText } from "./AeroflyLocalizedText.js";
+import { AeroflyMissionCheckpoint } from "./AeroflyMissionCheckpoint.js";
+import { AeroflyMissionConditions } from "./AeroflyMissionConditions.js";
+import { AeroflyMissionTargetPlane } from "./AeroflyMissionTargetPlane.js";
+export declare const feetPerMeter = 3.28084;
+export declare const meterPerStatuteMile = 1609.344;
+/**
+ * Data for the aircraft to use on this mission
+ * @property name lowercase Aerofly aircraft ID
+ * @property icao ICAO aircraft code
+ * @property livery (not used yet)
+ */
+export type AeroflyMissionAircraft = {
+    name: string;
+    icao: string;
+    livery: string;
+};
+/**
+ * State of aircraft systems. Configures power settings, flap positions etc
+ */
+export type AeroflyMissionSetting =
+    | "cold_and_dark"
+    | "before_start"
+    | "taxi"
+    | "takeoff"
+    | "cruise"
+    | "approach"
+    | "landing"
+    | "winch_launch"
+    | "aerotow"
+    | "pushback";
+/**
+ * Represents origin or destination conditions for flight
+ * @property icao uppercase ICAO airport ID
+ * @property longitude easting, using the World Geodetic
+ *    System 1984 (WGS 84) [WGS84] datum, with longitude and latitude units
+ *    of decimal degrees; -180..180
+ * @property latitude northing, using the World Geodetic
+ *    System 1984 (WGS 84) [WGS84] datum, with longitude and latitude units
+ *    of decimal degrees; -90..90
+ * @property dir in degree
+ * @property alt the height in meters above or below the WGS
+ *    84 reference ellipsoid
+ */
+export type AeroflyMissionPosition = {
+    icao: string;
+    longitude: number;
+    latitude: number;
+    dir: number;
+    alt: number;
+};
+/**
+ * @class
+ * A single flighplan, containing aircraft and weather data as well.
+ *
+ * The purpose of this class is to collect data needed for Aerofly FS4's
+ * `custom_missions_user.tmc` flight plan file format, and export the structure
+ * for this file via the `toString()` method.
+ */
+export declare class AeroflyMission {
+    /**
+     * @property {?string} tutorialName will create a link to a tutorial page at https://www.aerofly.com/aircraft-tutorials/
+     */
+    tutorialName: string | null;
+    /**
+     * @property {string} title of this flight plan
+     */
+    title: string;
+    /**
+     * @property {string} description text, mission briefing, etc
+     */
+    description: string;
+    /**
+     * @property {AeroflyLocalizedText[]} localizedTexts for title and description
+     */
+    localizedTexts: AeroflyLocalizedText[];
+    /**
+     * @property {string[]} tags
+     */
+    tags: string[];
+    /**
+     * @property {?boolean} isFeatured makes this mission pop up in "Challenges"
+     */
+    isFeatured: boolean | null;
+    /**
+     * @property {?number} difficulty values between 0.00 and 2.00 have been encountered, but they seem to be without limit
+     */
+    difficulty: number | null;
+    /**
+     * @property {"cold_and_dark"|"before_start"|"taxi"|"takeoff"|"cruise"|"approach"|"landing"|"winch_launch"|"aerotow"|"pushback"} flightSetting of aircraft, like "taxi", "cruise"
+     */
+    flightSetting: AeroflyMissionSetting;
+    /**
+     * @property {object} aircraft for this mission
+     */
+    aircraft: AeroflyMissionAircraft;
+    /**
+     * @property {string} callsign of aircraft, uppercased
+     */
+    callsign: string;
+    /**
+     * @property {object} origin position of aircraft, as well as name of starting airport. Position does not have match airport.
+     */
+    origin: AeroflyMissionPosition;
+    /**
+     * @property {object} destination position of aircraft, as well as name of destination airport. Position does not have match airport.
+     */
+    destination: AeroflyMissionPosition;
+    /**
+     * @property {?number} distance in meters
+     */
+    distance: number | null;
+    /**
+     * @property {?number} duration in seconds
+     */
+    duration: number | null;
+    /**
+     * @property {?boolean} isScheduled marks this flight as "Scheduled flight".
+     */
+    isScheduled: boolean | null;
+    /**
+     * @property {?AeroflyMissionTargetPlane} finish as finish condition
+     */
+    finish: AeroflyMissionTargetPlane | null;
+    /**
+     * @property {AeroflyMissionConditions} conditions like time and weather for mission
+     */
+    conditions: AeroflyMissionConditions;
+    /**
+     * @property {AeroflyMissionConditions} checkpoints form the actual flight plan
+     */
+    checkpoints: AeroflyMissionCheckpoint[];
+    /**
+     * @param {string} title of this flight plan
+     * @param {object} [additionalAttributes] allows to set additional attributes on creation
+     * @param {string} [additionalAttributes.description] text, mission briefing, etc
+     * @param {AeroflyLocalizedText[]} [additionalAttributes.localizedTexts] translations for title and description
+     * @param {?string} [additionalAttributes.tutorialName] will create a link to a tutorial page at https://www.aerofly.com/aircraft-tutorials/
+     * @param {string[]} [additionalAttributes.tags]
+     * @param {?boolean} [additionalAttributes.isFeatured] makes this mission pop up in "Challenges"
+     * @param {?number} [additionalAttributes.difficulty] values between 0.00 and 2.00 have been encountered, but they seem to be without limit
+     * @param {"cold_and_dark"|"before_start"|"taxi"|"takeoff"|"cruise"|"approach"|"landing"|"winch_launch"|"aerotow"|"pushback"} [additionalAttributes.flightSetting] of aircraft, like "taxi", "cruise"
+     * @param {{name:string,livery:string,icao:string}} [additionalAttributes.aircraft] for this mission
+     * @param {string} [additionalAttributes.callsign] of aircraft, uppercased
+     * @param {object} [additionalAttributes.origin] position of aircraft, as well as name of starting airport. Position does not have match airport.
+     * @param {object} [additionalAttributes.destination] position of aircraft, as well as name of destination airport. Position does not have match airport.
+     * @param {?number} [additionalAttributes.distance] in meters
+     * @param {?number} [additionalAttributes.duration] in seconds
+     * @param {?boolean} [additionalAttributes.isScheduled] marks this flight as "Scheduled flight".
+     * @param {?AeroflyMissionTargetPlane} [additionalAttributes.finish] as finish condition
+     * @param {AeroflyMissionConditions} [additionalAttributes.conditions] like time and weather for mission
+     * @param {AeroflyMissionCheckpoint[]} [additionalAttributes.checkpoints] form the actual flight plan
+     */
+    constructor(
+        title: string,
+        {
+            tutorialName,
+            description,
+            localizedTexts,
+            tags,
+            isFeatured,
+            difficulty,
+            flightSetting,
+            aircraft,
+            callsign,
+            origin,
+            destination,
+            distance,
+            duration,
+            isScheduled,
+            finish,
+            conditions,
+            checkpoints,
+        }?: {
+            tutorialName?: string | null;
+            description?: string;
+            localizedTexts?: AeroflyLocalizedText[];
+            tags?: string[];
+            isFeatured?: boolean | null;
+            difficulty?: number | null;
+            flightSetting?: AeroflyMissionSetting;
+            aircraft?: AeroflyMissionAircraft;
+            callsign?: string;
+            origin?: AeroflyMissionPosition;
+            destination?: AeroflyMissionPosition;
+            distance?: number | null;
+            duration?: number | null;
+            isScheduled?: boolean | null;
+            finish?: AeroflyMissionTargetPlane | null;
+            conditions?: AeroflyMissionConditions;
+            checkpoints?: AeroflyMissionCheckpoint[];
+        },
+    );
+    /**
+     * @returns {string} indexed checkpoints
+     */
+    getCheckpointsString(): string;
+    /**
+     * @returns {string} indexed checkpoints
+     */
+    getLocalizedTextsString(): string;
+    /**
+     * @throws {Error} on missing waypoints
+     * @returns {string} to use in Aerofly FS4's `custom_missions_user.tmc`
+     */
+    toString(): string;
+}
+//# sourceMappingURL=AeroflyMission.d.ts.map

package/types/dto/AeroflyMission.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AeroflyMission.d.ts","sourceRoot":"","sources":["../../src/dto/AeroflyMission.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAE3E,eAAO,MAAM,YAAY,UAAU,CAAC;AACpC,eAAO,MAAM,mBAAmB,WAAW,CAAC;AAE5C;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAC3B,eAAe,GACf,cAAc,GACd,MAAM,GACN,SAAS,GACT,QAAQ,GACR,UAAU,GACV,SAAS,GACT,cAAc,GACd,SAAS,GACT,UAAU,CAAC;AAEjB;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;;;GAOG;AACH,qBAAa,cAAc;IACvB;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,EAAE,oBAAoB,EAAE,CAAC;IAEvC;;OAEG;IACH,IAAI,EAAE,MAAM,EAAE,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,aAAa,EAAE,qBAAqB,CAAC;IAErC;;OAEG;IACH,QAAQ,EAAE,sBAAsB,CAAC;IAEjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC;IAE/B;;OAEG;IACH,WAAW,EAAE,sBAAsB,CAAC;IAEpC;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,yBAAyB,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,UAAU,EAAE,wBAAwB,CAAC;IAErC;;OAEG;IACH,WAAW,EAAE,wBAAwB,EAAE,CAAC;IAExC;;;;;;;;;;;;;;;;;;;;OAoBG;gBAEC,KAAK,EAAE,MAAM,EACb,EACI,YAAmB,EACnB,WAAgB,EAChB,cAAmB,EACnB,IAAS,EACT,UAAiB,EACjB,UAAiB,EACjB,aAAsB,EACtB,QAIC,EACD,QAAa,EACb,MAMC,EACD,WAMC,EACD,QAAe,EACf,QAAe,EACf,WAAkB,EAClB,MAAa,EACb,UAA2C,EAC3C,WAAgB,GACnB,GAAE;QACC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,cAAc,CAAC,EAAE,oBAAoB,EAAE,CAAC;QACxC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;QAChB,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAC5B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,aAAa,CAAC,EAAE,qBAAqB,CAAC;QACtC,QAAQ,CAAC,EAAE,sBAAsB,CAAC;QAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,sBAAsB,CAAC;QAChC,WAAW,CAAC,EAAE,sBAAsB,CAAC;QACrC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAC7B,MAAM,CAAC,EAAE,yBAAyB,GAAG,IAAI,CAAC;QAC1C,UAAU,CAAC,EAAE,wBAAwB,CAAC;QACtC,WAAW,CAAC,EAAE,wBAAwB,EAAE,CAAC;KACvC;IAsBV;;OAEG;IACH,oBAAoB,IAAI,MAAM;IAQ9B;;OAEG;IACH,uBAAuB,IAAI,MAAM;IAQjC;;;OAGG;IACH,QAAQ,IAAI,MAAM;CAiGrB"}

package/types/dto/AeroflyMissionCheckpoint.d.ts

@@ -0,0 +1,152 @@
+/**
+ * Types of checkpoints. Required are usually "origin", "departure_runway" at the start and "destination_runway", "destination" at the end.
+ */
+export type AeroflyMissionCheckpointType =
+    | "origin"
+    | "departure_runway"
+    | "departure"
+    | "waypoint"
+    | "arrival"
+    | "approach"
+    | "destination_runway"
+    | "destination";
+/**
+ * @class
+ * A single way point for the given flight plan
+ *
+ * The purpose of this class is to collect data needed for Aerofly FS4's
+ * `custom_missions_user.tmc` flight plan file format, and export the structure
+ * for this file via the `toString()` method.
+ */
+export declare class AeroflyMissionCheckpoint {
+    /**
+     * @property {"origin"|"departure_runway"|"departure"|"waypoint"|"arrival"|"approach"|"destination_runway"|"destination"} type of checkpoint, like "departure_runway"
+     */
+    type: AeroflyMissionCheckpointType;
+    /**
+     * @property {string} name ICAO code for airport, runway designator, navaid
+     *    designator, fix name, or custom name
+     */
+    name: string;
+    /**
+     * @property {number} longitude easting, using the World Geodetic
+     *    System 1984 (WGS 84) [WGS84] datum, with longitude and latitude units
+     *    of decimal degrees; -180..180
+     */
+    longitude: number;
+    /**
+     * @property {number} latitude northing, using the World Geodetic
+     *    System 1984 (WGS 84) [WGS84] datum, with longitude and latitude units
+     *    of decimal degrees; -90..90
+     */
+    latitude: number;
+    /**
+     * @property {number} altitude The height in meters above or below the WGS
+     *    84 reference ellipsoid
+     */
+    altitude: number;
+    /**
+     * @property {?boolean} altitudeConstraint The altitude given in `altitude`
+     *    will be interpreted as mandatory flight plan altitude instead of
+     *    suggestion.
+     */
+    altitudeConstraint: boolean | null;
+    /**
+     * @property {?number} direction of runway, in degree
+     */
+    direction: number | null;
+    /**
+     * @property {?number} slope of runway
+     */
+    slope: number | null;
+    /**
+     * @property {?number} length of runway, in meters
+     */
+    length: number | null;
+    /**
+     * @property {?number} frequency of runways or navigational aids, in Hz; multiply by 1000 for kHz, 1_000_000 for MHz
+     */
+    frequency: number | null;
+    /**
+     * @property {?boolean} flyOver if waypoint is meant to be flown over
+     */
+    flyOver: boolean | null;
+    /**
+     * @param {string} name ICAO code for airport, runway designator, navaid
+     *    designator, fix name, or custom name
+     * @param {"origin"|"departure_runway"|"departure"|"waypoint"|"arrival"|"approach"|"destination_runway"|"destination"} type Type of checkpoint, like "departure_runway"
+     * @param {number} longitude easting, using the World Geodetic
+     *    System 1984 (WGS 84) [WGS84] datum, with longitude and latitude units
+     *    of decimal degrees; -180..180
+     * @param {number} latitude northing, using the World Geodetic
+     *    System 1984 (WGS 84) [WGS84] datum, with longitude and latitude units
+     *    of decimal degrees; -90..90
+     * @param {object} additionalAttributes allows to set additional attributes on creation
+     * @param {number} [additionalAttributes.altitude] The height in meters above or below the WGS
+     *    84 reference ellipsoid
+     * @param {?number} [additionalAttributes.altitude_feet] The height in feet above or below the WGS
+     *    84 reference ellipsoid. Will overwrite altitude
+     * @param {number} [additionalAttributes.altitudeConstraint] The altitude given in `altitude`
+     *    will be interpreted as mandatory flight plan altitude instead of
+     *    suggestion.
+     * @param {boolean} [additionalAttributes.direction] of runway, in degree
+     * @param {?number} [additionalAttributes.slope] of runway
+     * @param {?number} [additionalAttributes.length] of runway, in meters
+     * @param {?number} [additionalAttributes.length_feet] of runway, in feet. Will overwrite length
+     * @param {?number} [additionalAttributes.frequency] of runways or navigational aids, in Hz; multiply by 1000 for kHz, 1_000_000 for MHz
+     * @param {?boolean} [additionalAttributes.flyOver] if waypoint is meant to be flown over
+     */
+    constructor(
+        name: string,
+        type: AeroflyMissionCheckpointType,
+        longitude: number,
+        latitude: number,
+        {
+            altitude,
+            altitude_feet,
+            altitudeConstraint,
+            direction,
+            slope,
+            length,
+            length_feet,
+            frequency,
+            flyOver,
+        }?: {
+            altitude?: number;
+            altitude_feet?: number | null;
+            altitudeConstraint?: boolean | null;
+            direction?: number | null;
+            slope?: number | null;
+            length?: number | null;
+            length_feet?: number | null;
+            frequency?: number | null;
+            flyOver?: boolean | null;
+        },
+    );
+    /**
+     * @param {number} altitude_feet
+     */
+    set altitude_feet(altitude_feet: number);
+    /**
+     * @returns {number} altitude_feet
+     */
+    get altitude_feet(): number;
+    /**
+     * @param {number} length_feet
+     */
+    set length_feet(length_feet: number);
+    /**
+     * @returns {number} length_feet
+     */
+    get length_feet(): number;
+    /**
+     * @returns {string}
+     */
+    get frequency_string(): string;
+    /**
+     * @param {number} index if used in an array will se the array index
+     * @returns {string} to use in Aerofly FS4's `custom_missions_user.tmc`
+     */
+    toString(index?: number): string;
+}
+//# sourceMappingURL=AeroflyMissionCheckpoint.d.ts.map

package/types/dto/AeroflyMissionCheckpoint.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AeroflyMissionCheckpoint.d.ts","sourceRoot":"","sources":["../../src/dto/AeroflyMissionCheckpoint.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAClC,QAAQ,GACR,kBAAkB,GAClB,WAAW,GACX,UAAU,GACV,SAAS,GACT,UAAU,GACV,oBAAoB,GACpB,aAAa,CAAC;AAEpB;;;;;;;GAOG;AAEH,qBAAa,wBAAwB;IACjC;;OAEG;IACH,IAAI,EAAE,4BAA4B,CAAC;IAEnC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,kBAAkB,EAAE,OAAO,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;gBAEC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,4BAA4B,EAClC,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,EACI,QAAY,EACZ,aAAoB,EACpB,kBAAyB,EACzB,SAAgB,EAChB,KAAY,EACZ,MAAa,EACb,WAAkB,EAClB,SAAgB,EAChB,OAAc,GACjB,GAAE;QACC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC9B,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QACpC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC1B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACtB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC5B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC1B,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;KACvB;IAsBV;;OAEG;IACH,IAAI,aAAa,CAAC,aAAa,EAAE,MAAM,EAEtC;IAED;;OAEG;IACH,IAAI,aAAa,IAAI,MAAM,CAE1B;IAED;;OAEG;IACH,IAAI,WAAW,CAAC,WAAW,EAAE,MAAM,EAElC;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,MAAM,CAExB;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,MAAM,CAY7B;IAED;;;OAGG;IACH,QAAQ,CAAC,KAAK,GAAE,MAAU,GAAG,MAAM;CAwBtC"}