wc3maptranslator 4.0.3 → 5.0.0

package/dist/src/translators/RegionsTranslator.js

@@ -1,60 +1,44 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RegionsTranslator = void 0;
 const HexBuffer_1 = require("../HexBuffer");
 const W3Buffer_1 = require("../W3Buffer");
-class RegionsTranslator {
+const CommonInterfaces_1 = require("../CommonInterfaces");
+class RegionsTranslator extends CommonInterfaces_1.ITranslator {
     static jsonToWar(regionsJson) {
         const outBufferToWar = new HexBuffer_1.HexBuffer();
-        /*
-         * Header
-         */
-        outBufferToWar.addInt(5); // file version
-        outBufferToWar.addInt(regionsJson.length); // number of regions
-        /*
-         * Body
-         */
-        regionsJson.forEach((region) => {
-            // Position
-            // Note that the .w3x guide has these coords wrong - the guide swaps bottom and right, but this is incorrect; bottom should be written before right
+        outBufferToWar.addInt(5);
+        outBufferToWar.addInt(regionsJson.length);
+        for (const region of regionsJson) {
             outBufferToWar.addFloat(region.position.left);
             outBufferToWar.addFloat(region.position.bottom);
             outBufferToWar.addFloat(region.position.right);
             outBufferToWar.addFloat(region.position.top);
             outBufferToWar.addString(region.name);
             outBufferToWar.addInt(region.id);
-            // Weather effect name - lookup necessary: char[4]
             if (region.weatherEffect) {
-                outBufferToWar.addChars(region.weatherEffect); // Weather effect is optional - defaults to 0000 for "none"
+                outBufferToWar.addChars(region.weatherEffect);
             }
             else {
-                // We can't put a string "0000", because ASCII 0's differ from 0x0 bytes
                 outBufferToWar.addByte(0);
                 outBufferToWar.addByte(0);
                 outBufferToWar.addByte(0);
                 outBufferToWar.addByte(0);
             }
-            // Ambient sound - refer to names defined in .w3s file
-            outBufferToWar.addString(region.ambientSound || ''); // May be empty string
-            // Color of region used by editor
-            // Careful! The order in .w3r is BB GG RR, whereas the JSON spec order is [RR, GG, BB]
-            outBufferToWar.addByte(region.color[2]); // blue
-            outBufferToWar.addByte(region.color[1]); // green
-            outBufferToWar.addByte(region.color[0]); // red
-            // End of structure - for some reason the .w3r needs this here;
-            // Value is set to 0xff based on observing the .w3r file, but not sure if it could be something else
+            outBufferToWar.addString(region.ambientSound || '');
+            outBufferToWar.addByte(region.color[2]);
+            outBufferToWar.addByte(region.color[1]);
+            outBufferToWar.addByte(region.color[0]);
             outBufferToWar.addByte(0xff);
-        });
+        }
         return {
-            errors: [],
             buffer: outBufferToWar.getBuffer()
         };
     }
     static warToJson(buffer) {
         const result = [];
         const outBufferToJSON = new W3Buffer_1.W3Buffer(buffer);
-        const fileVersion = outBufferToJSON.readInt(), // File version
-        numRegions = outBufferToJSON.readInt(); // # of regions
+        (0, CommonInterfaces_1.expectVersion)(5, outBufferToJSON.readInt());
+        const numRegions = outBufferToJSON.readInt();
         for (let i = 0; i < numRegions; i++) {
             const region = {
                 name: '',
@@ -75,22 +59,21 @@ class RegionsTranslator {
             region.position.top = outBufferToJSON.readFloat();
             region.name = outBufferToJSON.readString();
             region.id = outBufferToJSON.readInt();
-            region.weatherEffect = outBufferToJSON.readChars(4);
+            region.weatherEffect = outBufferToJSON.readChars(4, true);
             region.ambientSound = outBufferToJSON.readString();
             region.color = [
                 outBufferToJSON.readByte(),
                 outBufferToJSON.readByte(),
-                outBufferToJSON.readByte() // blue
+                outBufferToJSON.readByte()
             ];
-            region.color.reverse(); // json wants it in RGB, but .w3r file stores it as BB GG RR
-            outBufferToJSON.readByte(); // end of region structure
+            region.color.reverse();
+            outBufferToJSON.readByte();
             result.push(region);
         }
         return {
-            errors: [],
             json: result
         };
     }
 }
-exports.RegionsTranslator = RegionsTranslator;
+exports.default = RegionsTranslator;
 //# sourceMappingURL=RegionsTranslator.js.map

package/dist/src/translators/RegionsTranslator.js.map

@@ -1 +1 @@
-{"version":3,"file":"RegionsTranslator.js","sourceRoot":"","sources":["../../../src/translators/RegionsTranslator.ts"],"names":[],"mappings":";;;AAAA,4CAAyC;AACzC,0CAAuC;AAmBvC,MAAsB,iBAAiB;IAE5B,MAAM,CAAC,SAAS,CAAC,WAAqB;QACzC,MAAM,cAAc,GAAG,IAAI,qBAAS,EAAE,CAAC;QAEvC;;WAEG;QACH,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,eAAe;QACzC,cAAc,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,oBAAoB;QAE/D;;WAEG;QACH,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAC3B,WAAW;YACX,mJAAmJ;YACnJ,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC9C,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAChD,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC/C,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAE7C,cAAc,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACtC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAEjC,kDAAkD;YAClD,IAAI,MAAM,CAAC,aAAa,EAAE;gBACtB,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,2DAA2D;aAC7G;iBAAM;gBACH,wEAAwE;gBACxE,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;gBAC1B,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;gBAC1B,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;gBAC1B,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;aAC7B;YAED,sDAAsD;YACtD,cAAc,CAAC,SAAS,CAAC,MAAM,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC,CAAC,sBAAsB;YAE3E,iCAAiC;YACjC,sFAAsF;YACtF,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO;YAChD,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ;YACjD,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM;YAE/C,+DAA+D;YAC/D,oGAAoG;YACpG,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,OAAO;YACH,MAAM,EAAE,EAAE;YACV,MAAM,EAAE,cAAc,CAAC,SAAS,EAAE;SACrC,CAAC;IACN,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,MAAc;QAClC,MAAM,MAAM,GAAG,EAAE,CAAC;QAClB,MAAM,eAAe,GAAG,IAAI,mBAAQ,CAAC,MAAM,CAAC,CAAC;QAE7C,MAAM,WAAW,GAAG,eAAe,CAAC,OAAO,EAAE,EAAE,eAAe;QAC1D,UAAU,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC,CAAC,eAAe;QAE3D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,EAAE,CAAC,EAAE,EAAE;YACjC,MAAM,MAAM,GAAW;gBACnB,IAAI,EAAE,EAAE;gBACR,EAAE,EAAE,CAAC;gBACL,aAAa,EAAE,EAAE;gBACjB,YAAY,EAAE,EAAE;gBAChB,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;gBAChB,QAAQ,EAAE;oBACN,IAAI,EAAE,CAAC;oBACP,MAAM,EAAE,CAAC;oBACT,KAAK,EAAE,CAAC;oBACR,GAAG,EAAE,CAAC;iBACT;aACJ,CAAC;YAEF,MAAM,CAAC,QAAQ,CAAC,IAAI,GAAG,eAAe,CAAC,SAAS,EAAE,CAAC;YACnD,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,eAAe,CAAC,SAAS,EAAE,CAAC;YACrD,MAAM,CAAC,QAAQ,CAAC,KAAK,GAAG,eAAe,CAAC,SAAS,EAAE,CAAC;YACpD,MAAM,CAAC,QAAQ,CAAC,GAAG,GAAG,eAAe,CAAC,SAAS,EAAE,CAAC;YAClD,MAAM,CAAC,IAAI,GAAG,eAAe,CAAC,UAAU,EAAE,CAAC;YAC3C,MAAM,CAAC,EAAE,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC;YACtC,MAAM,CAAC,aAAa,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACpD,MAAM,CAAC,YAAY,GAAG,eAAe,CAAC,UAAU,EAAE,CAAC;YACnD,MAAM,CAAC,KAAK,GAAG;gBACX,eAAe,CAAC,QAAQ,EAAE;gBAC1B,eAAe,CAAC,QAAQ,EAAE;gBAC1B,eAAe,CAAC,QAAQ,EAAE,CAAC,OAAO;aACrC,CAAC;YACF,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,4DAA4D;YACpF,eAAe,CAAC,QAAQ,EAAE,CAAC,CAAC,0BAA0B;YAEtD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACvB;QAED,OAAO;YACH,MAAM,EAAE,EAAE;YACV,IAAI,EAAE,MAAM;SACf,CAAC;IACN,CAAC;CACJ;AAtGD,8CAsGC"}
+{"version":3,"file":"RegionsTranslator.js","sourceRoot":"","sources":["../../../src/translators/RegionsTranslator.ts"],"names":[],"mappings":";;AAAA,4CAAyC;AACzC,0CAAuC;AACvC,0DAAwF;AAkBxF,MAA8B,iBAAkB,SAAQ,8BAAW;IACxD,MAAM,CAAC,SAAS,CAAC,WAAqB;QACzC,MAAM,cAAc,GAAG,IAAI,qBAAS,EAAE,CAAC;QAKvC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAKzB,cAAc,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC1C,KAAK,MAAM,MAAM,IAAI,WAAW,EAAE;YAC9B,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC9C,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAChD,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC/C,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAE7C,cAAc,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACtC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAGjC,IAAI,MAAM,CAAC,aAAa,EAAE;gBACtB,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;aACjD;iBAAM;gBACH,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;gBAC1B,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;gBAC1B,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;gBAC1B,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;aAC7B;YAGD,cAAc,CAAC,SAAS,CAAC,MAAM,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC;YAIpD,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACxC,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACxC,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAGxC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SAChC;QAED,OAAO;YACH,MAAM,EAAE,cAAc,CAAC,SAAS,EAAE;SACrC,CAAC;IACN,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,MAAc;QAClC,MAAM,MAAM,GAAG,EAAE,CAAC;QAClB,MAAM,eAAe,GAAG,IAAI,mBAAQ,CAAC,MAAM,CAAC,CAAC;QAC7C,IAAA,gCAAa,EAAC,CAAC,EAAE,eAAe,CAAC,OAAO,EAAE,CAAC,CAAC;QAE5C,MAAM,UAAU,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC;QAC7C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,EAAE,CAAC,EAAE,EAAE;YACjC,MAAM,MAAM,GAAW;gBACnB,IAAI,EAAE,EAAE;gBACR,EAAE,EAAE,CAAC;gBACL,aAAa,EAAE,EAAE;gBACjB,YAAY,EAAE,EAAE;gBAChB,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;gBAChB,QAAQ,EAAE;oBACN,IAAI,EAAE,CAAC;oBACP,MAAM,EAAE,CAAC;oBACT,KAAK,EAAE,CAAC;oBACR,GAAG,EAAE,CAAC;iBACT;aACJ,CAAC;YAEF,MAAM,CAAC,QAAQ,CAAC,IAAI,GAAG,eAAe,CAAC,SAAS,EAAE,CAAC;YACnD,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,eAAe,CAAC,SAAS,EAAE,CAAC;YACrD,MAAM,CAAC,QAAQ,CAAC,KAAK,GAAG,eAAe,CAAC,SAAS,EAAE,CAAC;YACpD,MAAM,CAAC,QAAQ,CAAC,GAAG,GAAG,eAAe,CAAC,SAAS,EAAE,CAAC;YAClD,MAAM,CAAC,IAAI,GAAG,eAAe,CAAC,UAAU,EAAE,CAAC;YAC3C,MAAM,CAAC,EAAE,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC;YACtC,MAAM,CAAC,aAAa,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YAC1D,MAAM,CAAC,YAAY,GAAG,eAAe,CAAC,UAAU,EAAE,CAAC;YACnD,MAAM,CAAC,KAAK,GAAG;gBACX,eAAe,CAAC,QAAQ,EAAE;gBAC1B,eAAe,CAAC,QAAQ,EAAE;gBAC1B,eAAe,CAAC,QAAQ,EAAE;aAC7B,CAAC;YACF,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACvB,eAAe,CAAC,QAAQ,EAAE,CAAC;YAE3B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACvB;QAED,OAAO;YACH,IAAI,EAAE,MAAM;SACf,CAAC;IACN,CAAC;CACJ;AA9FD,oCA8FC"}

package/dist/src/translators/SoundsTranslator.d.ts

@@ -1,16 +1,53 @@
 /// <reference types="node" />
-import { WarResult, JsonResult } from '../CommonInterfaces';
+/// <reference types="node" />
+import { WarResult, JsonResult, ITranslator } from '../CommonInterfaces';
+declare enum EffectType {
+    Default = "DefaultEAXON",
+    Combat = "CombatSoundsEAX",
+    Drums = "KotoDrumsEAX",
+    Spells = "SpellsEAX",
+    Missiles = "MissilesEAX",
+    HeroSpeech = "HeroAcksEAX",
+    Doodads = "DoodadsEAX"
+}
+declare enum Channel {
+    General = 0,
+    UnitSelection = 1,
+    UnitAcknowledgement = 2,
+    UnitMovement = 3,
+    UnitReady = 4,
+    Combat = 5,
+    Error = 6,
+    Music = 7,
+    UserInterface = 8,
+    LoopingMovement = 9,
+    LoopingAmbient = 10,
+    Animations = 11,
+    Constructions = 12,
+    Birth = 13,
+    Fire = 14,
+    LegacyMidi = 15,
+    CinematicGeneral = 16,
+    CinematicAmbient = 17,
+    CinematicMusic = 18,
+    CinematicDialog = 19,
+    CinematicSFX1 = 20,
+    CinematicSFX2 = 21,
+    CinematicSFX3 = 22
+}
 interface Sound {
-    name: string;
     variableName: string;
+    internalName: string;
     path: string;
-    eax: string;
+    effect?: EffectType;
     flags: SoundFlags;
     fadeRate: FadeRate;
-    volume: number;
+    volume?: number;
     pitch: number;
-    channel: number;
+    channel?: number;
     distance: Distance;
+    pitchVariance?: number;
+    priority?: number;
 }
 interface FadeRate {
     in: number;
@@ -21,13 +58,16 @@ interface SoundFlags {
     '3dSound': boolean;
     stopOutOfRange: boolean;
     music: boolean;
+    imported: boolean;
 }
 interface Distance {
     min: number;
     max: number;
     cutoff: number;
 }
-export declare abstract class SoundsTranslator {
+export default abstract class SoundsTranslator extends ITranslator {
+    static readonly EffectType: typeof EffectType;
+    static readonly Channel: typeof Channel;
     static jsonToWar(soundsJson: Sound[]): WarResult;
     static warToJson(buffer: Buffer): JsonResult<Sound[]>;
 }

package/dist/src/translators/SoundsTranslator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SoundsTranslator.d.ts","sourceRoot":"","sources":["../../../src/translators/SoundsTranslator.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AAE3D,UAAU,KAAK;IACX,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,UAAU,CAAC;IAClB,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,QAAQ,CAAC;CACtB;AAED,UAAU,QAAQ;IACd,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;CACf;AAED,UAAU,UAAU;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IACnB,cAAc,EAAE,OAAO,CAAC;IACxB,KAAK,EAAE,OAAO,CAAC;CAClB;AAED,UAAU,QAAQ;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,8BAAsB,gBAAgB;WAEpB,SAAS,CAAC,UAAU,EAAE,KAAK,EAAE,GAAG,SAAS;WAyGzC,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,CAAC,KAAK,EAAE,CAAC;CA8F/D"}
+{"version":3,"file":"SoundsTranslator.d.ts","sourceRoot":"","sources":["../../../src/translators/SoundsTranslator.ts"],"names":[],"mappings":";;AAEA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,EAAiB,MAAM,qBAAqB,CAAC;AAExF,aAAK,UAAU;IACX,OAAO,iBAAiB;IACxB,MAAM,oBAAoB;IAC1B,KAAK,iBAAiB;IACtB,MAAM,cAAc;IACpB,QAAQ,gBAAgB;IACxB,UAAU,gBAAgB;IAC1B,OAAO,eAAe;CACzB;AAED,aAAK,OAAO;IACR,OAAO,IAAI;IACX,aAAa,IAAA;IACb,mBAAmB,IAAA;IACnB,YAAY,IAAA;IACZ,SAAS,IAAA;IACT,MAAM,IAAA;IACN,KAAK,IAAA;IACL,KAAK,IAAA;IACL,aAAa,IAAA;IACb,eAAe,IAAA;IACf,cAAc,KAAA;IACd,UAAU,KAAA;IACV,aAAa,KAAA;IACb,KAAK,KAAA;IACL,IAAI,KAAA;IACJ,UAAU,KAAA;IACV,gBAAgB,KAAA;IAChB,gBAAgB,KAAA;IAChB,cAAc,KAAA;IACd,eAAe,KAAA;IACf,aAAa,KAAA;IACb,aAAa,KAAA;IACb,aAAa,KAAA;CAChB;AAED,UAAU,KAAK;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,KAAK,EAAE,UAAU,CAAC;IAClB,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,UAAU,QAAQ;IACd,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;CACf;AAED,UAAU,UAAU;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IACnB,cAAc,EAAE,OAAO,CAAC;IACxB,KAAK,EAAE,OAAO,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED,UAAU,QAAQ;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;CAClB;AAkBD,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,gBAAiB,SAAQ,WAAW;IAC9D,gBAAuB,UAAU,oBAAc;IAC/C,gBAAuB,OAAO,iBAAW;WAE3B,SAAS,CAAC,UAAU,EAAE,KAAK,EAAE,GAAG,SAAS;WAwFzC,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,CAAC,KAAK,EAAE,CAAC;CAmG/D"}

package/dist/src/translators/SoundsTranslator.js

@@ -1,34 +1,66 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SoundsTranslator = void 0;
 const HexBuffer_1 = require("../HexBuffer");
 const W3Buffer_1 = require("../W3Buffer");
-class SoundsTranslator {
+const CommonInterfaces_1 = require("../CommonInterfaces");
+var EffectType;
+(function (EffectType) {
+    EffectType["Default"] = "DefaultEAXON";
+    EffectType["Combat"] = "CombatSoundsEAX";
+    EffectType["Drums"] = "KotoDrumsEAX";
+    EffectType["Spells"] = "SpellsEAX";
+    EffectType["Missiles"] = "MissilesEAX";
+    EffectType["HeroSpeech"] = "HeroAcksEAX";
+    EffectType["Doodads"] = "DoodadsEAX";
+})(EffectType || (EffectType = {}));
+var Channel;
+(function (Channel) {
+    Channel[Channel["General"] = 0] = "General";
+    Channel[Channel["UnitSelection"] = 1] = "UnitSelection";
+    Channel[Channel["UnitAcknowledgement"] = 2] = "UnitAcknowledgement";
+    Channel[Channel["UnitMovement"] = 3] = "UnitMovement";
+    Channel[Channel["UnitReady"] = 4] = "UnitReady";
+    Channel[Channel["Combat"] = 5] = "Combat";
+    Channel[Channel["Error"] = 6] = "Error";
+    Channel[Channel["Music"] = 7] = "Music";
+    Channel[Channel["UserInterface"] = 8] = "UserInterface";
+    Channel[Channel["LoopingMovement"] = 9] = "LoopingMovement";
+    Channel[Channel["LoopingAmbient"] = 10] = "LoopingAmbient";
+    Channel[Channel["Animations"] = 11] = "Animations";
+    Channel[Channel["Constructions"] = 12] = "Constructions";
+    Channel[Channel["Birth"] = 13] = "Birth";
+    Channel[Channel["Fire"] = 14] = "Fire";
+    Channel[Channel["LegacyMidi"] = 15] = "LegacyMidi";
+    Channel[Channel["CinematicGeneral"] = 16] = "CinematicGeneral";
+    Channel[Channel["CinematicAmbient"] = 17] = "CinematicAmbient";
+    Channel[Channel["CinematicMusic"] = 18] = "CinematicMusic";
+    Channel[Channel["CinematicDialog"] = 19] = "CinematicDialog";
+    Channel[Channel["CinematicSFX1"] = 20] = "CinematicSFX1";
+    Channel[Channel["CinematicSFX2"] = 21] = "CinematicSFX2";
+    Channel[Channel["CinematicSFX3"] = 22] = "CinematicSFX3";
+})(Channel || (Channel = {}));
+const effectTypeLookup = {
+    [EffectType.Combat]: EffectType.Combat,
+    [EffectType.Default]: EffectType.Default,
+    [EffectType.Doodads]: EffectType.Doodads,
+    [EffectType.Drums]: EffectType.Drums,
+    [EffectType.HeroSpeech]: EffectType.HeroSpeech,
+    [EffectType.Missiles]: EffectType.Missiles,
+    [EffectType.Spells]: EffectType.Spells
+};
+const MYSTERY_NUM_1 = 1333788672;
+const MYSTERY_NUM_2 = -1;
+class SoundsTranslator extends CommonInterfaces_1.ITranslator {
     static jsonToWar(soundsJson) {
+        var _a, _b;
         const outBufferToWar = new HexBuffer_1.HexBuffer();
-        /*
-         * Header
-         */
-        outBufferToWar.addInt(3); // file version
-        outBufferToWar.addInt(soundsJson.length); // number of sounds
-        /*
-         * Body
-         */
-        soundsJson.forEach((sound) => {
-            outBufferToWar.addString(sound.name); // e.g. gg_snd_HumanGlueScreenLoop1
-            outBufferToWar.addString(sound.path); // e.g. Sound\Ambient\HumanGlueScreenLoop1.wav
-            // EAX effects enum (e.g. missiles, speech, etc)
-            /*
-                default = DefaultEAXON
-                combat = CombatSoundsEAX
-                drums = KotoDrumsEAX
-                spells = SpellsEAX
-                missiles = MissilesEAX
-                hero speech = HeroAcksEAX
-                doodads = DoodadsEAX
-            */
-            outBufferToWar.addString(sound.eax || 'DefaultEAXON'); // defaults to "DefaultEAXON"
-            // Flags, if present (optional)
+        outBufferToWar.addInt(3);
+        outBufferToWar.addInt(soundsJson.length);
+        for (const sound of soundsJson) {
+            const isImportedSound = sound.path.startsWith('war3mapImported/');
+            outBufferToWar.addString('gg_snd_' + sound.variableName);
+            outBufferToWar.addString(sound.path);
+            outBufferToWar.addString(sound.effect || EffectType.Default);
             let flags = 0;
             if (sound.flags) {
                 if (sound.flags.looping)
@@ -39,84 +71,71 @@ class SoundsTranslator {
                     flags |= 0x4;
                 if (sound.flags.music)
                     flags |= 0x8;
+                if (sound.flags.imported)
+                    flags |= 0x10;
             }
             outBufferToWar.addInt(flags);
-            // Fade in and out rate (optional)
-            outBufferToWar.addInt(sound.fadeRate ? sound.fadeRate.in || 10 : 10); // default to 10
-            outBufferToWar.addInt(sound.fadeRate ? sound.fadeRate.out || 10 : 10); // default to 10
-            // Volume (optional)
-            outBufferToWar.addInt(sound.volume || -1); // default to -1 (for normal volume)
-            // Pitch (optional)
-            outBufferToWar.addFloat(sound.pitch || 1.0); // default to 1.0 for normal pitch
-            // Mystery numbers... their use is unknown by the w3x documentation, but they must be present
-            outBufferToWar.addFloat(0);
-            outBufferToWar.addInt(8); // or -1?
-            // Which channel to use? Use the lookup table for more details (optional)
-            /*
-                0=General
-                1=Unit Selection
-                2=Unit Acknowledgement
-                3=Unit Movement
-                4=Unit Ready
-                5=Combat
-                6=Error
-                7=Music
-                8=User Interface
-                9=Looping Movement
-                10=Looping Ambient
-                11=Animations
-                12=Constructions
-                13=Birth
-                14=Fire
-            */
-            outBufferToWar.addInt(sound.channel || 0); // default to 0
-            // Distance fields
-            outBufferToWar.addFloat(sound.distance.min);
-            outBufferToWar.addFloat(sound.distance.max);
-            outBufferToWar.addFloat(sound.distance.cutoff);
-            // More mystery numbers...
-            outBufferToWar.addFloat(0);
-            outBufferToWar.addFloat(0);
-            outBufferToWar.addFloat(127); // or -1?
-            outBufferToWar.addFloat(0);
-            outBufferToWar.addFloat(0);
-            outBufferToWar.addFloat(0);
-            outBufferToWar.addString(sound.variableName);
-            outBufferToWar.addString('');
+            outBufferToWar.addInt(((_a = sound.fadeRate) === null || _a === void 0 ? void 0 : _a.in) || 0);
+            outBufferToWar.addInt(((_b = sound.fadeRate) === null || _b === void 0 ? void 0 : _b.out) || 0);
+            outBufferToWar.addInt(sound.volume || 127);
+            if (isImportedSound || sound.pitch !== 1.0) {
+                outBufferToWar.addFloat(sound.pitch);
+            }
+            else {
+                outBufferToWar.addInt(MYSTERY_NUM_1);
+            }
+            if (sound.pitchVariance && sound.pitchVariance === 4294967296) {
+                outBufferToWar.addInt(MYSTERY_NUM_1);
+            }
+            else {
+                outBufferToWar.addFloat(sound.pitchVariance || 0);
+            }
+            outBufferToWar.addInt(sound.priority || 100);
+            outBufferToWar.addInt(sound.channel || Channel.General);
+            outBufferToWar.addInt(sound.distance.min);
+            outBufferToWar.addInt(sound.distance.max);
+            outBufferToWar.addInt(sound.distance.cutoff);
+            outBufferToWar.addInt(isImportedSound ? 0 : MYSTERY_NUM_1);
+            outBufferToWar.addInt(isImportedSound ? 0 : MYSTERY_NUM_1);
+            outBufferToWar.addInt(isImportedSound ? 127 : MYSTERY_NUM_2);
+            outBufferToWar.addInt(isImportedSound ? 0 : MYSTERY_NUM_1);
+            outBufferToWar.addInt(isImportedSound ? 0 : MYSTERY_NUM_1);
+            outBufferToWar.addInt(isImportedSound ? 0 : MYSTERY_NUM_1);
+            outBufferToWar.addString('gg_snd_' + sound.variableName);
+            outBufferToWar.addString(sound.internalName);
             outBufferToWar.addString(sound.path);
-            // More unknowns
-            outBufferToWar.addFloat(0);
+            outBufferToWar.addInt(MYSTERY_NUM_2);
             outBufferToWar.addByte(0);
-            outBufferToWar.addFloat(0);
-            outBufferToWar.addFloat(0);
-            outBufferToWar.addFloat(0);
+            outBufferToWar.addInt(MYSTERY_NUM_2);
+            outBufferToWar.addInt(0);
+            outBufferToWar.addInt(0);
             outBufferToWar.addByte(0);
-            outBufferToWar.addFloat(0);
-        });
+            outBufferToWar.addInt(1);
+        }
         return {
-            errors: [],
             buffer: outBufferToWar.getBuffer()
         };
     }
     static warToJson(buffer) {
         const result = [];
         const outBufferToJSON = new W3Buffer_1.W3Buffer(buffer);
-        const fileVersion = outBufferToJSON.readInt(), // File version
-        numSounds = outBufferToJSON.readInt(); // # of sounds
+        (0, CommonInterfaces_1.expectVersion)(3, outBufferToJSON.readInt());
+        const numSounds = outBufferToJSON.readInt();
         for (let i = 0; i < numSounds; i++) {
             const sound = {
-                name: '',
                 variableName: '',
+                internalName: '',
                 path: '',
-                eax: '',
                 volume: 0,
                 pitch: 0,
-                channel: 0,
+                pitchVariance: 0,
+                priority: 100,
                 flags: {
-                    'looping': true,
+                    looping: true,
                     '3dSound': true,
-                    'stopOutOfRange': true,
-                    'music': true // 0x00000008=music},
+                    stopOutOfRange: true,
+                    music: true,
+                    imported: false
                 },
                 fadeRate: {
                     in: 0,
@@ -128,41 +147,40 @@ class SoundsTranslator {
                     cutoff: 0
                 }
             };
-            sound.name = outBufferToJSON.readString();
+            sound.variableName = outBufferToJSON.readString().replace('gg_snd_', '');
             sound.path = outBufferToJSON.readString();
-            sound.eax = outBufferToJSON.readString();
+            sound.effect = effectTypeLookup[outBufferToJSON.readString()];
             const flags = outBufferToJSON.readInt();
             sound.flags = {
-                'looping': !!(flags & 0b1),
-                '3dSound': !!(flags & 0b10),
-                'stopOutOfRange': !!(flags & 0b100),
-                'music': !!(flags & 0b1000) // 0x00000008=music
+                looping: !!(flags & 0x1),
+                '3dSound': !!(flags & 0x2),
+                stopOutOfRange: !!(flags & 0x4),
+                music: !!(flags & 0x8),
+                imported: !!(flags & 0x10)
             };
             sound.fadeRate = {
                 in: outBufferToJSON.readInt(),
                 out: outBufferToJSON.readInt()
             };
             sound.volume = outBufferToJSON.readInt();
-            sound.pitch = outBufferToJSON.readFloat();
-            // Unknown values
-            outBufferToJSON.readFloat();
-            outBufferToJSON.readInt();
+            const pitch = outBufferToJSON.readFloat();
+            sound.pitch = pitch === 4294967296 ? 1.0 : pitch;
+            sound.pitchVariance = outBufferToJSON.readFloat();
+            sound.priority = outBufferToJSON.readInt();
             sound.channel = outBufferToJSON.readInt();
             sound.distance = {
-                min: outBufferToJSON.readFloat(),
-                max: outBufferToJSON.readFloat(),
-                cutoff: outBufferToJSON.readFloat()
+                min: outBufferToJSON.readInt(),
+                max: outBufferToJSON.readInt(),
+                cutoff: outBufferToJSON.readInt()
             };
-            // Unknown values
-            outBufferToJSON.readFloat();
-            outBufferToJSON.readFloat();
-            outBufferToJSON.readFloat();
-            outBufferToJSON.readFloat();
-            outBufferToJSON.readFloat();
-            outBufferToJSON.readFloat();
-            sound.variableName = outBufferToJSON.readString();
-            // Unknown values
+            outBufferToJSON.readInt();
+            outBufferToJSON.readInt();
+            outBufferToJSON.readInt();
+            outBufferToJSON.readInt();
+            outBufferToJSON.readInt();
+            outBufferToJSON.readInt();
             outBufferToJSON.readString();
+            sound.internalName = outBufferToJSON.readString();
             outBufferToJSON.readString();
             outBufferToJSON.readChars(4);
             outBufferToJSON.readChars(1);
@@ -170,14 +188,15 @@ class SoundsTranslator {
             outBufferToJSON.readChars(4);
             outBufferToJSON.readChars(4);
             outBufferToJSON.readChars(1);
-            outBufferToJSON.readChars(4);
+            outBufferToJSON.readInt();
             result.push(sound);
         }
         return {
-            errors: [],
             json: result
         };
     }
 }
-exports.SoundsTranslator = SoundsTranslator;
+exports.default = SoundsTranslator;
+SoundsTranslator.EffectType = EffectType;
+SoundsTranslator.Channel = Channel;
 //# sourceMappingURL=SoundsTranslator.js.map

package/dist/src/translators/SoundsTranslator.js.map

@@ -1 +1 @@
-{"version":3,"file":"SoundsTranslator.js","sourceRoot":"","sources":["../../../src/translators/SoundsTranslator.ts"],"names":[],"mappings":";;;AAAA,4CAAyC;AACzC,0CAAuC;AAkCvC,MAAsB,gBAAgB;IAE3B,MAAM,CAAC,SAAS,CAAC,UAAmB;QACvC,MAAM,cAAc,GAAG,IAAI,qBAAS,EAAE,CAAC;QAEvC;;WAEG;QACH,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,eAAe;QACzC,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,mBAAmB;QAE7D;;WAEG;QACH,UAAU,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YACzB,cAAc,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,mCAAmC;YACzE,cAAc,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,8CAA8C;YAEpF,gDAAgD;YAChD;;;;;;;;cAQE;YACF,cAAc,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,IAAI,cAAc,CAAC,CAAC,CAAC,6BAA6B;YAEpF,+BAA+B;YAC/B,IAAI,KAAK,GAAG,CAAC,CAAC;YACd,IAAI,KAAK,CAAC,KAAK,EAAE;gBACb,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO;oBAAE,KAAK,IAAI,GAAG,CAAC;gBACtC,IAAI,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC;oBAAE,KAAK,IAAI,GAAG,CAAC;gBACzC,IAAI,KAAK,CAAC,KAAK,CAAC,cAAc;oBAAE,KAAK,IAAI,GAAG,CAAC;gBAC7C,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK;oBAAE,KAAK,IAAI,GAAG,CAAC;aACvC;YACD,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAE7B,kCAAkC;YAClC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB;YACtF,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB;YAEvF,oBAAoB;YACpB,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,oCAAoC;YAE/E,mBAAmB;YACnB,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,IAAI,GAAG,CAAC,CAAC,CAAC,kCAAkC;YAE/E,6FAA6F;YAC7F,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YAC3B,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;YAEnC,yEAAyE;YACzE;;;;;;;;;;;;;;;;cAgBE;YACF,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe;YAE1D,kBAAkB;YAClB,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC5C,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC5C,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAE/C,0BAA0B;YAC1B,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YAC3B,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YAC3B,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS;YACvC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YAC3B,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YAC3B,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YAE3B,cAAc,CAAC,SAAS,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YAC7C,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;YAC7B,cAAc,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAErC,gBAAgB;YAChB,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YAC3B,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YAC1B,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YAC3B,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YAC3B,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YAC3B,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YAC1B,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,OAAO;YACH,MAAM,EAAE,EAAE;YACV,MAAM,EAAE,cAAc,CAAC,SAAS,EAAE;SACrC,CAAC;IACN,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,MAAc;QAClC,MAAM,MAAM,GAAG,EAAE,CAAC;QAClB,MAAM,eAAe,GAAG,IAAI,mBAAQ,CAAC,MAAM,CAAC,CAAC;QAE7C,MAAM,WAAW,GAAG,eAAe,CAAC,OAAO,EAAE,EAAE,eAAe;QAC1D,SAAS,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC,CAAC,cAAc;QAEzD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,CAAC,EAAE,EAAE;YAChC,MAAM,KAAK,GAAU;gBACjB,IAAI,EAAE,EAAE;gBACR,YAAY,EAAE,EAAE;gBAChB,IAAI,EAAE,EAAE;gBACR,GAAG,EAAE,EAAE;gBACP,MAAM,EAAE,CAAC;gBACT,KAAK,EAAE,CAAC;gBACR,OAAO,EAAE,CAAC;gBACV,KAAK,EAAE;oBACH,SAAS,EAAE,IAAI;oBACf,SAAS,EAAE,IAAI;oBACf,gBAAgB,EAAE,IAAI;oBACtB,OAAO,EAAE,IAAI,CAAE,qBAAqB;iBACvC;gBACD,QAAQ,EAAE;oBACN,EAAE,EAAE,CAAC;oBACL,GAAG,EAAE,CAAC;iBACT;gBACD,QAAQ,EAAE;oBACN,GAAG,EAAE,CAAC;oBACN,GAAG,EAAE,CAAC;oBACN,MAAM,EAAE,CAAC;iBACZ;aACJ,CAAC;YAEF,KAAK,CAAC,IAAI,GAAG,eAAe,CAAC,UAAU,EAAE,CAAC;YAC1C,KAAK,CAAC,IAAI,GAAG,eAAe,CAAC,UAAU,EAAE,CAAC;YAC1C,KAAK,CAAC,GAAG,GAAG,eAAe,CAAC,UAAU,EAAE,CAAC;YAEzC,MAAM,KAAK,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC;YACxC,KAAK,CAAC,KAAK,GAAG;gBACV,SAAS,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC;gBAC1B,SAAS,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC;gBAC3B,gBAAgB,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,KAAK,CAAC;gBACnC,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC,CAAE,mBAAmB;aACnD,CAAC;YAEF,KAAK,CAAC,QAAQ,GAAG;gBACb,EAAE,EAAE,eAAe,CAAC,OAAO,EAAE;gBAC7B,GAAG,EAAE,eAAe,CAAC,OAAO,EAAE;aACjC,CAAC;YAEF,KAAK,CAAC,MAAM,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC;YACzC,KAAK,CAAC,KAAK,GAAG,eAAe,CAAC,SAAS,EAAE,CAAC;YAE1C,iBAAiB;YACjB,eAAe,CAAC,SAAS,EAAE,CAAC;YAC5B,eAAe,CAAC,OAAO,EAAE,CAAC;YAE1B,KAAK,CAAC,OAAO,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC;YAE1C,KAAK,CAAC,QAAQ,GAAG;gBACb,GAAG,EAAE,eAAe,CAAC,SAAS,EAAE;gBAChC,GAAG,EAAE,eAAe,CAAC,SAAS,EAAE;gBAChC,MAAM,EAAE,eAAe,CAAC,SAAS,EAAE;aACtC,CAAC;YAEF,iBAAiB;YACjB,eAAe,CAAC,SAAS,EAAE,CAAC;YAC5B,eAAe,CAAC,SAAS,EAAE,CAAC;YAC5B,eAAe,CAAC,SAAS,EAAE,CAAC;YAC5B,eAAe,CAAC,SAAS,EAAE,CAAC;YAC5B,eAAe,CAAC,SAAS,EAAE,CAAC;YAC5B,eAAe,CAAC,SAAS,EAAE,CAAC;YAE5B,KAAK,CAAC,YAAY,GAAG,eAAe,CAAC,UAAU,EAAE,CAAC;YAElD,iBAAiB;YACjB,eAAe,CAAC,UAAU,EAAE,CAAC;YAC7B,eAAe,CAAC,UAAU,EAAE,CAAC;YAC7B,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAC7B,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAC7B,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAC7B,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAC7B,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAC7B,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAC7B,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAE7B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACtB;QAED,OAAO;YACH,MAAM,EAAE,EAAE;YACV,IAAI,EAAE,MAAM;SACf,CAAC;IACN,CAAC;CACJ;AAzMD,4CAyMC"}
+{"version":3,"file":"SoundsTranslator.js","sourceRoot":"","sources":["../../../src/translators/SoundsTranslator.ts"],"names":[],"mappings":";;AAAA,4CAAyC;AACzC,0CAAuC;AACvC,0DAAwF;AAExF,IAAK,UAQJ;AARD,WAAK,UAAU;IACX,sCAAwB,CAAA;IACxB,wCAA0B,CAAA;IAC1B,oCAAsB,CAAA;IACtB,kCAAoB,CAAA;IACpB,sCAAwB,CAAA;IACxB,wCAA0B,CAAA;IAC1B,oCAAsB,CAAA;AAC1B,CAAC,EARI,UAAU,KAAV,UAAU,QAQd;AAED,IAAK,OAwBJ;AAxBD,WAAK,OAAO;IACR,2CAAW,CAAA;IACX,uDAAa,CAAA;IACb,mEAAmB,CAAA;IACnB,qDAAY,CAAA;IACZ,+CAAS,CAAA;IACT,yCAAM,CAAA;IACN,uCAAK,CAAA;IACL,uCAAK,CAAA;IACL,uDAAa,CAAA;IACb,2DAAe,CAAA;IACf,0DAAc,CAAA;IACd,kDAAU,CAAA;IACV,wDAAa,CAAA;IACb,wCAAK,CAAA;IACL,sCAAI,CAAA;IACJ,kDAAU,CAAA;IACV,8DAAgB,CAAA;IAChB,8DAAgB,CAAA;IAChB,0DAAc,CAAA;IACd,4DAAe,CAAA;IACf,wDAAa,CAAA;IACb,wDAAa,CAAA;IACb,wDAAa,CAAA;AACjB,CAAC,EAxBI,OAAO,KAAP,OAAO,QAwBX;AAuCD,MAAM,gBAAgB,GAA+B;IACjD,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM;IACtC,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO;IACxC,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO;IACxC,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC,KAAK;IACpC,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC,UAAU;IAC9C,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ;IAC1C,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM;CACzC,CAAC;AAEF,MAAM,aAAa,GAAG,UAAU,CAAC;AACjC,MAAM,aAAa,GAAG,CAAC,CAAC,CAAC;AAEzB,MAA8B,gBAAiB,SAAQ,8BAAW;IAIvD,MAAM,CAAC,SAAS,CAAC,UAAmB;;QACvC,MAAM,cAAc,GAAG,IAAI,qBAAS,EAAE,CAAC;QAIvC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAKzB,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACzC,KAAK,MAAM,KAAK,IAAI,UAAU,EAAE;YAC5B,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC;YAElE,cAAc,CAAC,SAAS,CAAC,SAAS,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;YACzD,cAAc,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAErC,cAAc,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;YAG7D,IAAI,KAAK,GAAG,CAAC,CAAC;YACd,IAAI,KAAK,CAAC,KAAK,EAAE;gBACb,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO;oBAAE,KAAK,IAAI,GAAG,CAAC;gBACtC,IAAI,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC;oBAAE,KAAK,IAAI,GAAG,CAAC;gBACzC,IAAI,KAAK,CAAC,KAAK,CAAC,cAAc;oBAAE,KAAK,IAAI,GAAG,CAAC;gBAC7C,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK;oBAAE,KAAK,IAAI,GAAG,CAAC;gBACpC,IAAI,KAAK,CAAC,KAAK,CAAC,QAAQ;oBAAE,KAAK,IAAI,IAAI,CAAC;aAC3C;YACD,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAG7B,cAAc,CAAC,MAAM,CAAC,CAAA,MAAA,KAAK,CAAC,QAAQ,0CAAE,EAAE,KAAI,CAAC,CAAC,CAAC;YAC/C,cAAc,CAAC,MAAM,CAAC,CAAA,MAAA,KAAK,CAAC,QAAQ,0CAAE,GAAG,KAAI,CAAC,CAAC,CAAC;YAEhD,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,IAAI,GAAG,CAAC,CAAC;YAI3C,IAAI,eAAe,IAAI,KAAK,CAAC,KAAK,KAAK,GAAG,EAAE;gBACxC,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;aACxC;iBAAM;gBACH,cAAc,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;aACxC;YAGD,IAAI,KAAK,CAAC,aAAa,IAAI,KAAK,CAAC,aAAa,KAAK,UAAU,EAAE;gBAE3D,cAAc,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;aACxC;iBAAM;gBACH,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,aAAa,IAAI,CAAC,CAAC,CAAC;aACrD;YAED,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,IAAI,GAAG,CAAC,CAAC;YAE7C,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;YAGxD,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC1C,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC1C,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAG7C,cAAc,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;YAC3D,cAAc,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;YAC3D,cAAc,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;YAC7D,cAAc,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;YAC3D,cAAc,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;YAC3D,cAAc,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;YAE3D,cAAc,CAAC,SAAS,CAAC,SAAS,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;YACzD,cAAc,CAAC,SAAS,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YAC7C,cAAc,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAGrC,cAAc,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;YACrC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YAC1B,cAAc,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;YACrC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACzB,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACzB,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YAC1B,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;SAC5B;QAED,OAAO;YACH,MAAM,EAAE,cAAc,CAAC,SAAS,EAAE;SACrC,CAAC;IACN,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,MAAc;QAClC,MAAM,MAAM,GAAG,EAAE,CAAC;QAClB,MAAM,eAAe,GAAG,IAAI,mBAAQ,CAAC,MAAM,CAAC,CAAC;QAE7C,IAAA,gCAAa,EAAC,CAAC,EAAE,eAAe,CAAC,OAAO,EAAE,CAAC,CAAC;QAE5C,MAAM,SAAS,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC;QAC5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,CAAC,EAAE,EAAE;YAChC,MAAM,KAAK,GAAU;gBACjB,YAAY,EAAE,EAAE;gBAChB,YAAY,EAAE,EAAE;gBAChB,IAAI,EAAE,EAAE;gBACR,MAAM,EAAE,CAAC;gBACT,KAAK,EAAE,CAAC;gBACR,aAAa,EAAE,CAAC;gBAChB,QAAQ,EAAE,GAAG;gBACb,KAAK,EAAE;oBACH,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE,IAAI;oBACf,cAAc,EAAE,IAAI;oBACpB,KAAK,EAAE,IAAI;oBACX,QAAQ,EAAE,KAAK;iBAClB;gBACD,QAAQ,EAAE;oBACN,EAAE,EAAE,CAAC;oBACL,GAAG,EAAE,CAAC;iBACT;gBACD,QAAQ,EAAE;oBACN,GAAG,EAAE,CAAC;oBACN,GAAG,EAAE,CAAC;oBACN,MAAM,EAAE,CAAC;iBACZ;aACJ,CAAC;YAEF,KAAK,CAAC,YAAY,GAAG,eAAe,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YACzE,KAAK,CAAC,IAAI,GAAG,eAAe,CAAC,UAAU,EAAE,CAAC;YAE1C,KAAK,CAAC,MAAM,GAAG,gBAAgB,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC,CAAC;YAE9D,MAAM,KAAK,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC;YACxC,KAAK,CAAC,KAAK,GAAG;gBACV,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC;gBACxB,SAAS,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC;gBAC1B,cAAc,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC;gBAC/B,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC;gBACtB,QAAQ,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC;aAC7B,CAAC;YAEF,KAAK,CAAC,QAAQ,GAAG;gBACb,EAAE,EAAE,eAAe,CAAC,OAAO,EAAE;gBAC7B,GAAG,EAAE,eAAe,CAAC,OAAO,EAAE;aACjC,CAAC;YAEF,KAAK,CAAC,MAAM,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC;YAGzC,MAAM,KAAK,GAAG,eAAe,CAAC,SAAS,EAAE,CAAC;YAC1C,KAAK,CAAC,KAAK,GAAG,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC;YAEjD,KAAK,CAAC,aAAa,GAAG,eAAe,CAAC,SAAS,EAAE,CAAC;YAElD,KAAK,CAAC,QAAQ,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC;YAE3C,KAAK,CAAC,OAAO,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC;YAE1C,KAAK,CAAC,QAAQ,GAAG;gBACb,GAAG,EAAE,eAAe,CAAC,OAAO,EAAE;gBAC9B,GAAG,EAAE,eAAe,CAAC,OAAO,EAAE;gBAC9B,MAAM,EAAE,eAAe,CAAC,OAAO,EAAE;aACpC,CAAC;YAGF,eAAe,CAAC,OAAO,EAAE,CAAC;YAC1B,eAAe,CAAC,OAAO,EAAE,CAAC;YAC1B,eAAe,CAAC,OAAO,EAAE,CAAC;YAC1B,eAAe,CAAC,OAAO,EAAE,CAAC;YAC1B,eAAe,CAAC,OAAO,EAAE,CAAC;YAC1B,eAAe,CAAC,OAAO,EAAE,CAAC;YAE1B,eAAe,CAAC,UAAU,EAAE,CAAC;YAC7B,KAAK,CAAC,YAAY,GAAG,eAAe,CAAC,UAAU,EAAE,CAAC;YAClD,eAAe,CAAC,UAAU,EAAE,CAAC;YAG7B,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAC7B,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAC7B,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAC7B,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAC7B,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAC7B,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAC7B,eAAe,CAAC,OAAO,EAAE,CAAC;YAE1B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACtB;QAED,OAAO;YACH,IAAI,EAAE,MAAM;SACf,CAAC;IACN,CAAC;;AA9LL,mCA+LC;AA9L0B,2BAAU,GAAG,UAAU,CAAC;AACxB,wBAAO,GAAG,OAAO,CAAC"}

package/dist/src/translators/StringsTranslator.d.ts

@@ -1,7 +1,13 @@
 /// <reference types="node" />
-import { WarResult, JsonResult } from '../CommonInterfaces';
-export declare abstract class StringsTranslator {
-    static jsonToWar(stringsJson: object): WarResult;
-    static warToJson(buffer: Buffer): JsonResult<object>;
+/// <reference types="node" />
+import { WarResult, JsonResult, ITranslator } from '../CommonInterfaces';
+interface StringRecord {
+    comment?: string;
+    value: string;
+}
+export default abstract class StringsTranslator extends ITranslator {
+    static jsonToWar(stringsJson: Record<string, StringRecord>): WarResult;
+    static warToJson(buffer: Buffer): JsonResult<Record<string, StringRecord>>;
 }
+export {};
 //# sourceMappingURL=StringsTranslator.d.ts.map

package/dist/src/translators/StringsTranslator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StringsTranslator.d.ts","sourceRoot":"","sources":["../../../src/translators/StringsTranslator.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AAE3D,8BAAsB,iBAAiB;WAErB,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS;WAwBzC,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;CAmB9D"}
+{"version":3,"file":"StringsTranslator.d.ts","sourceRoot":"","sources":["../../../src/translators/StringsTranslator.ts"],"names":[],"mappings":";;AACA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAEzE,UAAU,YAAY;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACjB;AAID,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,iBAAkB,SAAQ,WAAW;WACjD,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,SAAS;WA4B/D,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;CAcpF"}

package/dist/src/translators/StringsTranslator.js

@@ -1,44 +1,43 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StringsTranslator = void 0;
 const HexBuffer_1 = require("../HexBuffer");
-class StringsTranslator {
+const CommonInterfaces_1 = require("../CommonInterfaces");
+const matchStringDefinitionBlock = /STRING ([0-9]+)\r?\n?(\/\/.*\r?\n?)?{\r?\n((?:.|\r?\n)*?)\r?\n}/g;
+class StringsTranslator extends CommonInterfaces_1.ITranslator {
     static jsonToWar(stringsJson) {
         const outBufferToWar = new HexBuffer_1.HexBuffer();
-        /*
-         * Strings
-         */
-        Object.keys(stringsJson).forEach((key) => {
-            outBufferToWar.addChars('STRING ' + key);
+        for (const stringId of Object.keys(stringsJson)) {
+            const w3String = stringsJson[stringId];
+            outBufferToWar.addChars('STRING ' + stringId);
             outBufferToWar.addNewLine();
+            if (w3String.comment) {
+                outBufferToWar.addChars(w3String.comment);
+            }
             outBufferToWar.addChars('{');
             outBufferToWar.addNewLine();
-            outBufferToWar.addChars(stringsJson[key]);
+            outBufferToWar.addChars(w3String.value);
             outBufferToWar.addNewLine();
             outBufferToWar.addChars('}');
             outBufferToWar.addNewLine();
             outBufferToWar.addNewLine();
-        });
+        }
         return {
-            errors: [],
             buffer: outBufferToWar.getBuffer()
         };
     }
     static warToJson(buffer) {
-        const wts = buffer.toString().replace(/\r\n/g, '\n'), // may contain Windows linebreaks (\r\n), but below regex just assumes \n
-        matchStringDefinitionBlock = new RegExp('STRING ([0-9]+)\n?(?:.*\n)?\{\n((?:.|\n)*?)\n}', 'g'); // see: https://regexr.com/3r572
-        const result = {}; // stores the json form of strings file
-        let match; // stores individual matches as input is read
-        // tslint:disable-next-line: no-conditional-assignment
-        while ((match = matchStringDefinitionBlock.exec(wts)) !== null) {
-            const num = match[1], body = match[2];
-            result[num] = body;
+        const result = {};
+        let match;
+        while ((match = matchStringDefinitionBlock.exec(buffer.toString('utf8'))) !== null) {
+            const [, num, comment, value] = match;
+            result[num] = { value };
+            if (comment)
+                result[num].comment = comment;
         }
         return {
-            errors: [],
             json: result
         };
     }
 }
-exports.StringsTranslator = StringsTranslator;
+exports.default = StringsTranslator;
 //# sourceMappingURL=StringsTranslator.js.map