wc3maptranslator 3.0.3 → 4.0.1

package/lib/translators/SoundsTranslator.ts

@@ -1,15 +1,17 @@
 import { HexBuffer } from '../HexBuffer';
 import { W3Buffer } from '../W3Buffer';
+import { WarResult, JsonResult } from '../CommonInterfaces'
 
 interface Sound {
     name: string;
+    variableName: string;
     path: string;
-    eax?: EAXEffect;
+    eax: string;
     flags: SoundFlags;
     fadeRate: FadeRate;
     volume: number;
     pitch: number;
-    channel: SoundChannel;
+    channel: number;
     distance: Distance;
 }
 
@@ -31,65 +33,35 @@ interface Distance {
     cutoff: number;
 }
 
-enum EAXEffect {
-    Default = 'DefaultEAXON',
-    Combat = 'CombatSoundsEAX',
-    Drums = 'KotoDrumsEAX',
-    Spells = 'SpellsEAX',
-    Missiles = 'MissilesEAX',
-    HeroSpeech = 'HeroAcksEAX',
-    Doodads = 'DoodadsEAX'
-}
-
-enum SoundChannel {
-    General = 0,
-    UnitSelection,
-    UnitAcknowledgement,
-    UnitMovement,
-    UnitReady,
-    Combat,
-    Error,
-    Music,
-    UserInterface,
-    LoopingMovement,
-    LoopingAmbient,
-    Animations,
-    Constructions,
-    Birth,
-    Fire
-}
-
-export class SoundsTranslator {
-
-    private _outBufferToWar: HexBuffer;
-    private _outBufferToJSON: W3Buffer;
-
-    constructor() { }
+export abstract class SoundsTranslator {
 
-    public jsonToWar(soundsJson: Sound[]) {
-        this._outBufferToWar = new HexBuffer();
+    public static jsonToWar(soundsJson: Sound[]): WarResult {
+        const outBufferToWar = new HexBuffer();
 
         /*
          * Header
          */
-        this._outBufferToWar.addInt(1); // file version
-        this._outBufferToWar.addInt(soundsJson.length); // number of sounds
+        outBufferToWar.addInt(3); // file version
+        outBufferToWar.addInt(soundsJson.length); // number of sounds
 
         /*
          * Body
          */
         soundsJson.forEach((sound) => {
-            // Name with null terminator (e.g. gg_snd_HumanGlueScreenLoop1)
-            this._outBufferToWar.addString(sound.name);
-            this._outBufferToWar.addNullTerminator();
-
-            // Path with null terminator (e.g. Sound\Ambient\HumanGlueScreenLoop1.wav)
-            this._outBufferToWar.addString(sound.path);
-            this._outBufferToWar.addNullTerminator();
-
-            // EAX effects enum
-            this._outBufferToWar.addString(sound.eax || EAXEffect.Default); // defaults to "DefaultEAXON"
-            this._outBufferToWar.addNullTerminator();
+            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)
             let flags = 0;
@@ -99,57 +71,88 @@ export class SoundsTranslator {
                 if (sound.flags.stopOutOfRange) flags |= 0x4;
                 if (sound.flags.music) flags |= 0x8;
             }
-            this._outBufferToWar.addInt(flags);
+            outBufferToWar.addInt(flags);
 
             // Fade in and out rate (optional)
-            this._outBufferToWar.addInt(sound.fadeRate ? sound.fadeRate.in || 10 : 10); // default to 10
-            this._outBufferToWar.addInt(sound.fadeRate ? sound.fadeRate.out || 10 : 10); // default to 10
+            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)
-            this._outBufferToWar.addInt(sound.volume || -1); // default to -1 (for normal volume)
+            outBufferToWar.addInt(sound.volume || -1); // default to -1 (for normal volume)
 
             // Pitch (optional)
-            this._outBufferToWar.addFloat(sound.pitch || 1.0); // default to 1.0 for normal pitch
+            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
-            this._outBufferToWar.addFloat(0);
-            this._outBufferToWar.addInt(8); // or -1?
-
-            // Sound channel from SoundChannel enum
-            this._outBufferToWar.addInt(sound.channel || SoundChannel.General); // default to "General" sound channel (0)
+            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
-            this._outBufferToWar.addFloat(sound.distance.min);
-            this._outBufferToWar.addFloat(sound.distance.max);
-            this._outBufferToWar.addFloat(sound.distance.cutoff);
+            outBufferToWar.addFloat(sound.distance.min);
+            outBufferToWar.addFloat(sound.distance.max);
+            outBufferToWar.addFloat(sound.distance.cutoff);
 
             // More mystery numbers...
-            this._outBufferToWar.addFloat(0);
-            this._outBufferToWar.addFloat(0);
-            this._outBufferToWar.addFloat(127); // or -1?
-            this._outBufferToWar.addFloat(0);
-            this._outBufferToWar.addFloat(0);
-            this._outBufferToWar.addFloat(0);
+            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.addString(sound.path);
+
+            // More unknowns
+            outBufferToWar.addFloat(0);
+            outBufferToWar.addByte(0);
+            outBufferToWar.addFloat(0);
+            outBufferToWar.addFloat(0);
+            outBufferToWar.addFloat(0);
+            outBufferToWar.addByte(0);
+            outBufferToWar.addFloat(0);
         });
 
         return {
             errors: [],
-            buffer: this._outBufferToWar.getBuffer()
+            buffer: outBufferToWar.getBuffer()
         };
     }
 
-    public warToJson(buffer: Buffer) {
+    public static warToJson(buffer: Buffer): JsonResult<Sound[]> {
         const result = [];
-        this._outBufferToJSON = new W3Buffer(buffer);
+        const outBufferToJSON = new W3Buffer(buffer);
 
-        const fileVersion = this._outBufferToJSON.readInt(), // File version
-            numSounds = this._outBufferToJSON.readInt(); // # of sounds
+        const fileVersion = outBufferToJSON.readInt(), // File version
+            numSounds = outBufferToJSON.readInt(); // # of sounds
 
         for (let i = 0; i < numSounds; i++) {
             const sound: Sound = {
                 name: '',
+                variableName: '',
                 path: '',
-                eax: EAXEffect.Default,
+                eax: '',
                 volume: 0,
                 pitch: 0,
                 channel: 0,
@@ -170,11 +173,11 @@ export class SoundsTranslator {
                 }
             };
 
-            sound.name = this._outBufferToJSON.readString();
-            sound.path = this._outBufferToJSON.readString();
-            sound.eax = EAXEffect[this._outBufferToJSON.readString()];
+            sound.name = outBufferToJSON.readString();
+            sound.path = outBufferToJSON.readString();
+            sound.eax = outBufferToJSON.readString();
 
-            const flags = this._outBufferToJSON.readInt();
+            const flags = outBufferToJSON.readInt();
             sound.flags = {
                 'looping': !!(flags & 0b1),    // 0x00000001=looping
                 '3dSound': !!(flags & 0b10),   // 0x00000002=3D sound
@@ -183,32 +186,45 @@ export class SoundsTranslator {
             };
 
             sound.fadeRate = {
-                in: this._outBufferToJSON.readInt(),
-                out: this._outBufferToJSON.readInt()
+                in: outBufferToJSON.readInt(),
+                out: outBufferToJSON.readInt()
             };
 
-            sound.volume = this._outBufferToJSON.readInt();
-            sound.pitch = this._outBufferToJSON.readFloat();
+            sound.volume = outBufferToJSON.readInt();
+            sound.pitch = outBufferToJSON.readFloat();
 
             // Unknown values
-            this._outBufferToJSON.readFloat();
-            this._outBufferToJSON.readInt();
+            outBufferToJSON.readFloat();
+            outBufferToJSON.readInt();
 
-            sound.channel = this._outBufferToJSON.readInt();
+            sound.channel = outBufferToJSON.readInt();
 
             sound.distance = {
-                min: this._outBufferToJSON.readFloat(),
-                max: this._outBufferToJSON.readFloat(),
-                cutoff: this._outBufferToJSON.readFloat()
+                min: outBufferToJSON.readFloat(),
+                max: outBufferToJSON.readFloat(),
+                cutoff: outBufferToJSON.readFloat()
             };
 
             // Unknown values
-            this._outBufferToJSON.readFloat();
-            this._outBufferToJSON.readFloat();
-            this._outBufferToJSON.readFloat();
-            this._outBufferToJSON.readFloat();
-            this._outBufferToJSON.readFloat();
-            this._outBufferToJSON.readFloat();
+            outBufferToJSON.readFloat();
+            outBufferToJSON.readFloat();
+            outBufferToJSON.readFloat();
+            outBufferToJSON.readFloat();
+            outBufferToJSON.readFloat();
+            outBufferToJSON.readFloat();
+
+            sound.variableName = outBufferToJSON.readString();
+
+            // Unknown values
+            outBufferToJSON.readString();
+            outBufferToJSON.readString();
+            outBufferToJSON.readChars(4);
+            outBufferToJSON.readChars(1);
+            outBufferToJSON.readChars(4);
+            outBufferToJSON.readChars(4);
+            outBufferToJSON.readChars(4);
+            outBufferToJSON.readChars(1);
+            outBufferToJSON.readChars(4);
 
             result.push(sound);
         }

package/lib/translators/StringsTranslator.ts

@@ -1,70 +1,44 @@
 import { HexBuffer } from '../HexBuffer';
+import { WarResult, JsonResult } from '../CommonInterfaces'
 
-interface StringDefinition {
-    id: number;
-    text: string;
-    comment?: string;
-}
-
-export class StringsTranslator {
-    private _outBufferToWar: HexBuffer;
-
-    constructor() { }
+export abstract class StringsTranslator {
 
-    public jsonToWar(stringsJson: StringDefinition[]) {
-        this._outBufferToWar = new HexBuffer();
-
-        // Add UTF8 byte-order mark (BOM), which is in the .wts file generated by World Editor
-        // You can see the BOM when printing the buffer of the .wts file
-        this._outBufferToWar.addBytes([0xef, 0xbb, 0xbf]); // see: https://en.wikipedia.org/wiki/Byte_order_mark#UTF-8
+    public static jsonToWar(stringsJson: object): WarResult {
+        const outBufferToWar = new HexBuffer();
 
         /*
          * Strings
          */
-        for (const strDef of stringsJson) {
-            this._outBufferToWar.addString('STRING ' + strDef.id);
-            this._outBufferToWar.addNewLine();
-
-            if (strDef.comment) { // Comment can be empty, in which case skip this party
-                this._outBufferToWar.addString(strDef.comment);
-                this._outBufferToWar.addNewLine();
-            }
+        Object.keys(stringsJson).forEach((key) => {
+            outBufferToWar.addChars('STRING ' + key);
+            outBufferToWar.addNewLine();
+            outBufferToWar.addChars('{');
+            outBufferToWar.addNewLine();
+            outBufferToWar.addChars(stringsJson[key]);
+            outBufferToWar.addNewLine();
+            outBufferToWar.addChars('}');
+            outBufferToWar.addNewLine();
+            outBufferToWar.addNewLine();
+        });
 
-            this._outBufferToWar.addString('{');
-            this._outBufferToWar.addNewLine();
-
-            this._outBufferToWar.addString(strDef.text);
-            this._outBufferToWar.addNewLine();
-
-            this._outBufferToWar.addString('}');
-            this._outBufferToWar.addNewLine();
-
-            this._outBufferToWar.addNewLine();
-        }
         return {
             errors: [],
-            buffer: this._outBufferToWar.getBuffer()
+            buffer: outBufferToWar.getBuffer()
         };
     }
 
-    public warToJson(buffer: Buffer) {
+    public static warToJson(buffer: Buffer): JsonResult<object> {
         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/4r6m0
+            matchStringDefinitionBlock = new RegExp('STRING ([0-9]+)\n?(?:.*\n)?\{\n((?:.|\n)*?)\n}', 'g'); // see: https://regexr.com/3r572
 
-        const result: StringDefinition[] = []; // stores the json form of strings file
-        let match: RegExpExecArray; // stores individual matches as input is read
+        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 = parseInt(match[1], 10),
-                comment = match[2]?.replace(/\n/gi, ''), // if the comment is present, the regex from above will have pulled out the newline, which needs to be stripped out
-                body = match[3];
-
-            result.push({
-                id: num,
-                text: body,
-                comment
-            });
+            const num = match[1],
+                body = match[2];
+            result[num] = body;
         }
 
         return {