@fboes/aerofly-custom-missions 1.2.2 → 1.3.0

package/types/dto/AeroflyMissionConditions.d.ts

@@ -0,0 +1,102 @@
+import { AeroflyConfigurationNode } from "../node/AeroflyConfigurationNode.js";
+import { AeroflyMissionConditionsCloud } from "./AeroflyMissionConditionsCloud.js";
+/**
+ * Weather data for wind
+ * @property {number} direction in degree
+ * @property {number} speed in kts
+ * @property {number} gusts in kts
+ */
+export type AeroflyMissionConditionsWind = {
+    direction: number;
+    speed: number;
+    gusts: number;
+};
+/**
+ * @class
+ * Time and weather data 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 AeroflyMissionConditions {
+    /**
+     * @property {Date} time of flight plan. Relevant is the UTC part, so
+     *    consider setting this date in UTC.
+     */
+    time: Date;
+    /**
+     * @property {object} wind state
+     */
+    wind: AeroflyMissionConditionsWind;
+    /**
+     * @property {number} turbulenceStrength 0..1, percentage
+     */
+    turbulenceStrength: number;
+    /**
+     * @property {number} thermalStrength 0..1, percentage
+     */
+    thermalStrength: number;
+    /**
+     * @property {number} visibility in meters
+     */
+    visibility: number;
+    /**
+     * @property {AeroflyMissionConditionsCloud[]} clouds for the whole flight
+     */
+    clouds: AeroflyMissionConditionsCloud[];
+    /**
+     * @param {object} additionalAttributes allows to set additional attributes on creation
+     * @param {Date} [additionalAttributes.time]  of flight plan. Relevant is the UTC part, so
+     *    consider setting this date in UTC.
+     * @param {{direction: number, speed: number, gusts: number}} [additionalAttributes.wind] state
+     * @param {number} [additionalAttributes.turbulenceStrength] 0..1, percentage
+     * @param {number} [additionalAttributes.thermalStrength] 0..1, percentage
+     * @param {number} [additionalAttributes.visibility] in meters
+     * @param {?number} [additionalAttributes.visibility_sm] in statute miles, will overwrite visibility
+     * @param {?number} [additionalAttributes.temperature] in °C, will overwrite thermalStrength
+     * @param {AeroflyMissionConditionsCloud[]} [additionalAttributes.clouds] for the whole flight
+     */
+    constructor({ time, wind, turbulenceStrength, thermalStrength, visibility, visibility_sm, temperature, clouds, }?: Partial<AeroflyMissionConditions> & {
+        visibility_sm?: number;
+        temperature?: number;
+    });
+    /**
+     * @returns {number} the Aerofly value for UTC hours + minutes/60 + seconds/3600. Ignores milliseconds ;)
+     */
+    get time_hours(): number;
+    /**
+     * @returns {string} Time representation like "20:15:00"
+     */
+    get time_presentational(): string;
+    /**
+     * @param {number} visibility_sm `this.visibility` in statute miles instead of meters
+     */
+    set visibility_sm(visibility_sm: number);
+    /**
+     * @returns {number} `this.visibility` in statute miles instead of meters
+     */
+    get visibility_sm(): number;
+    /**
+     * Will set `this.thermalStrength`
+     * @param {number} temperature in °C
+     */
+    set temperature(temperature: number);
+    /**
+     * @returns {number} in °C
+     */
+    get temperature(): number;
+    /**
+     * @returns {AeroflyConfigurationNode[]} cloud elements
+     */
+    getCloudElements(): AeroflyConfigurationNode[];
+    /**
+     * @returns {string} to use in Aerofly FS4's `custom_missions_user.tmc`
+     */
+    getElement(): AeroflyConfigurationNode;
+    /**
+     * @returns {string} to use in Aerofly FS4's `custom_missions_user.tmc`
+     */
+    toString(): string;
+}
+//# sourceMappingURL=AeroflyMissionConditions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AeroflyMissionConditions.d.ts","sourceRoot":"","sources":["../../src/dto/AeroflyMissionConditions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAC;AAE/E,OAAO,EAAE,6BAA6B,EAAE,MAAM,oCAAoC,CAAC;AAEnF;;;;;GAKG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACvC,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;;;;GAOG;AACH,qBAAa,wBAAwB;IACjC;;;OAGG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,4BAA4B,CAAC;IAEnC;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,6BAA6B,EAAE,CAAM;IAE7C;;;;;;;;;;;OAWG;gBACS,EACR,IAAiB,EACjB,IAIC,EACD,kBAAsB,EACtB,eAAmB,EACnB,UAAmB,EACnB,aAAiB,EACjB,WAAe,EACf,MAAW,GACd,GAAE,OAAO,CAAC,wBAAwB,CAAC,GAAG;QACnC,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,WAAW,CAAC,EAAE,MAAM,CAAC;KACnB;IAgBN;;OAEG;IACH,IAAI,UAAU,IAAI,MAAM,CAEvB;IAED;;OAEG;IACH,IAAI,mBAAmB,IAAI,MAAM,CAMhC;IAED;;OAEG;IACH,IAAI,aAAa,CAAC,aAAa,EAAE,MAAM,EAEtC;IAED;;OAEG;IACH,IAAI,aAAa,IAAI,MAAM,CAE1B;IAED;;;OAGG;IACH,IAAI,WAAW,CAAC,WAAW,EAAE,MAAM,EAGlC;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,MAAM,CAExB;IAED;;OAEG;IACH,gBAAgB,IAAI,wBAAwB,EAAE;IAM9C;;OAEG;IACH,UAAU,IAAI,wBAAwB;IAsBtC;;OAEG;IACH,QAAQ,IAAI,MAAM;CAGrB"}

package/types/dto/AeroflyMissionConditionsCloud.d.ts

@@ -0,0 +1,57 @@
+import { AeroflyConfigurationNode } from "../node/AeroflyConfigurationNode.js";
+/**
+ * Cloud coverage codes
+ */
+export type AeroflyMissionConditionsCloudCoverCode = "CLR" | "FEW" | "SCT" | "BKN" | "OVC";
+/**
+ * @class
+ * A cloud layer for the current flight plan's weather data
+ *
+ * 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 AeroflyMissionConditionsCloud {
+    /**
+     * @property {number} cover 0..1, percentage
+     */
+    cover: number;
+    /**
+     * @property {number} base altitude in meters AGL
+     */
+    base: number;
+    /**
+     * @param {number} cover 0..1, percentage
+     * @param {number} base altitude in meters AGL
+     */
+    constructor(cover: number, base: number);
+    /**
+     * @param {number} cover 0..1, percentage
+     * @param {number} base_feet altitude, but in feet AGL instead of meters AGL
+     * @returns {AeroflyMissionConditionsCloud} self
+     */
+    static createInFeet(cover: number, base_feet: number): AeroflyMissionConditionsCloud;
+    /**
+     * @param {number} base_feet `this.base` in feet instead of meters
+     */
+    set base_feet(base_feet: number);
+    /**
+     * @returns {number} `this.base` in feet instead of meters
+     */
+    get base_feet(): number;
+    /**
+     * @returns {string} Cloud coverage as text representation like "OVC" for `this.cover`
+     */
+    get cover_code(): AeroflyMissionConditionsCloudCoverCode;
+    /**
+     * @param {number} index if used in an array will set the array index
+     * @returns {AeroflyConfigurationNode[]} to use in Aerofly FS4's `custom_missions_user.tmc`
+     */
+    getElements(index?: number): AeroflyConfigurationNode[];
+    /**
+     * @param {number} index if used in an array will set the array index
+     * @returns {string} to use in Aerofly FS4's `custom_missions_user.tmc`
+     */
+    toString(index?: number): string;
+}
+//# sourceMappingURL=AeroflyMissionConditionsCloud.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AeroflyMissionConditionsCloud.d.ts","sourceRoot":"","sources":["../../src/dto/AeroflyMissionConditionsCloud.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAC;AAG/E;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;AAE3F;;;;;;;GAOG;AACH,qBAAa,6BAA6B;IACtC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;gBACS,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAKvC;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,6BAA6B;IAIpF;;OAEG;IACH,IAAI,SAAS,CAAC,SAAS,EAAE,MAAM,EAE9B;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,sCAAsC,CAWvD;IAED;;;OAGG;IACH,WAAW,CAAC,KAAK,GAAE,MAAU,GAAG,wBAAwB,EAAE;IAsB1D;;;OAGG;IACH,QAAQ,CAAC,KAAK,GAAE,MAAU,GAAG,MAAM;CAKtC"}

package/types/dto/AeroflyMissionTargetPlane.d.ts

@@ -0,0 +1,45 @@
+import { AeroflyConfigurationNode } from "../node/AeroflyConfigurationNode.js";
+/**
+ * @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);
+    getElement(): AeroflyConfigurationNode;
+    /**
+     * @returns {string} to use in Aerofly FS4's `custom_missions_user.tmc`
+     */
+    toString(): string;
+}
+//# sourceMappingURL=AeroflyMissionTargetPlane.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AeroflyMissionTargetPlane.d.ts","sourceRoot":"","sources":["../../src/dto/AeroflyMissionTargetPlane.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAC;AAE/E;;;GAGG;AACH,qBAAa,yBAAyB;IAClC;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;;;OAUG;gBACS,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,GAAE,MAAiB;IAOrF,UAAU,IAAI,wBAAwB;IAMtC;;OAEG;IACH,QAAQ,IAAI,MAAM;CAGrB"}

package/types/dto/AeroflyMissionsList.d.ts

@@ -0,0 +1,30 @@
+import { AeroflyConfigurationNode } from "../node/AeroflyConfigurationNode.js";
+import { AeroflyMission } from "./AeroflyMission.js";
+/**
+ * @class
+ * A list of flight plans.
+ *
+ * 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 AeroflyMissionsList {
+    /**
+     * @property {AeroflyMission[]} missions in this mission list
+     */
+    missions: AeroflyMission[];
+    /**
+     * @param {AeroflyMission[]} missions in this mission list
+     */
+    constructor(missions?: AeroflyMission[]);
+    getElement(): AeroflyConfigurationNode;
+    /**
+     * @returns {string} to use in Aerofly FS4's `custom_missions_user.tmc`
+     */
+    toString(): string;
+    /**
+     * @returns {string} XML represenation of this mission list
+     */
+    toXmlString(): string;
+}
+//# sourceMappingURL=AeroflyMissionsList.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AeroflyMissionsList.d.ts","sourceRoot":"","sources":["../../src/dto/AeroflyMissionsList.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAC;AAC/E,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD;;;;;;;GAOG;AACH,qBAAa,mBAAmB;IAC5B;;OAEG;IACH,QAAQ,EAAE,cAAc,EAAE,CAAC;IAE3B;;OAEG;gBACS,QAAQ,GAAE,cAAc,EAAO;IAI3C,UAAU,IAAI,wBAAwB;IActC;;OAEG;IACH,QAAQ,IAAI,MAAM;IAIlB;;OAEG;IACH,WAAW,IAAI,MAAM;CAGxB"}

package/types/dto/basicTypes.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=basicTypes.d.ts.map