wc3maptranslator 3.0.3 → 4.0.1

package/lib/translators/{object/ObjectsTranslator.ts → ObjectsTranslator.ts}

@@ -1,5 +1,6 @@
-import { HexBuffer } from '../../HexBuffer';
-import { W3Buffer } from '../../W3Buffer';
+import { HexBuffer } from '../HexBuffer';
+import { W3Buffer } from '../W3Buffer';
+import { WarResult, JsonResult } from '../CommonInterfaces'
 
 enum TableType {
     original = 'original',
@@ -13,6 +14,26 @@ enum ModificationType {
     string = 'string'
 }
 
+enum FileTypeExtension { // (*) - uses the two optional ints after variable type
+    units = 'w3u',
+    items = 'w3t',
+    destructables = 'w3b',
+    doodads = 'w3d', // (*)
+    abilities = 'w3a', // (*)
+    buffs = 'w3h',
+    upgrades = 'w3q' // (*)
+};
+
+enum ObjectType {
+    Units = 'units',
+    Items = 'items',
+    Destructables = 'destructables',
+    Doodads = 'doodads',
+    Abilities = 'abilities',
+    Buffs = 'buffs',
+    Upgrades = 'upgrades'
+};
+
 interface Modification {
     id: string;
     type: ModificationType; // 'int' | 'real' | 'unreal' | 'string',
@@ -26,54 +47,36 @@ interface Modification {
     variation?: number;
 }
 
-export class ObjectsTranslator {
+interface ObjectModificationTable {
+    original: object,
+    custom: object
+}
 
-    public ObjectType = {
-        Units: 'units',
-        Items: 'items',
-        Destructables: 'destructables',
-        Doodads: 'doodads',
-        Abilities: 'abilities',
-        Buffs: 'buffs',
-        Upgrades: 'upgrades'
+export abstract class ObjectsTranslator {
+
+    // Expose the ObjectType enum as part of this abstract class
+    // The enum could be "export"ed , but it wouldn't be accessible
+    // via `ObjectsTranslator.ObjectType`, which is preferable.
+    public static readonly ObjectType = ObjectType;
+
+    private static varTypes = {
+        int: 0,
+        real: 1,
+        unreal: 2,
+        string: 3,
+        0: 'int',
+        1: 'real',
+        2: 'unreal',
+        3: 'string'
     };
 
-    public varTypes: any;
-    public fileTypeExt: any;
-
-    private _outBufferToWar: HexBuffer;
-    private _outBufferToJSON: W3Buffer;
-
-    constructor() {
-        this.varTypes = {
-            int: 0,
-            real: 1,
-            unreal: 2,
-            string: 3,
-            0: 'int',
-            1: 'real',
-            2: 'unreal',
-            3: 'string'
-        };
-
-        this.fileTypeExt = { // (*) - uses the two optional ints after variable type
-            units: 'w3u',
-            items: 'w3t',
-            destructables: 'w3b',
-            doodads: 'w3d', // (*)
-            abilities: 'w3a', // (*)
-            buffs: 'w3h',
-            upgrades: 'w3q' // (*)
-        };
-    }
-
-    public jsonToWar(type: string, json) {
-        this._outBufferToWar = new HexBuffer();
+    public static jsonToWar(type: string, json): WarResult {
+        const outBufferToWar = new HexBuffer();
 
         /*
          * Header
          */
-        this._outBufferToWar.addInt(2); // file version
+        outBufferToWar.addInt(2); // file version
 
         const generateTableFromJson = (tableType: TableType, tableData) => { // create "original" or "custom" table
             Object.keys(tableData).forEach((defKey) => {
@@ -81,22 +84,22 @@ export class ObjectsTranslator {
 
                 // Original and new object ids
                 if (tableType === TableType.original) {
-                    this._outBufferToWar.addString(defKey);
-                    this._outBufferToWar.addByte(0); this._outBufferToWar.addByte(0); this._outBufferToWar.addByte(0); this._outBufferToWar.addByte(0); // no new Id is assigned
+                    outBufferToWar.addChars(defKey);
+                    outBufferToWar.addByte(0); outBufferToWar.addByte(0); outBufferToWar.addByte(0); outBufferToWar.addByte(0); // no new Id is assigned
                 } else {
                     // e.g. "h000:hfoo"
-                    this._outBufferToWar.addString(defKey.substring(5, 9)); // original id
-                    this._outBufferToWar.addString(defKey.substring(0, 4)); // custom id
+                    outBufferToWar.addChars(defKey.substring(5, 9)); // original id
+                    outBufferToWar.addChars(defKey.substring(0, 4)); // custom id
                 }
 
                 // Number of modifications made to this object
-                this._outBufferToWar.addInt(obj.length);
+                outBufferToWar.addInt(obj.length);
 
                 obj.forEach((mod: Modification) => {
                     let modType;
 
                     // Modification id (e.g. unam = name; reference MetaData lookups)
-                    this._outBufferToWar.addString(mod.id);
+                    outBufferToWar.addChars(mod.id);
 
                     // Determine what type of field the mod is (int, real, unreal, string)
                     if (mod.type) { // if a type is specified, use it
@@ -111,43 +114,42 @@ export class ObjectsTranslator {
                         }
                     }
 
-                    this._outBufferToWar.addInt(modType);
+                    outBufferToWar.addInt(modType);
 
                     // Addl integers
                     // Required for: doodads, abilities, upgrades
-                    if (type === this.ObjectType.Doodads || type === this.ObjectType.Abilities || type === this.ObjectType.Upgrades) {
+                    if (type === ObjectType.Doodads || type === ObjectType.Abilities || type === ObjectType.Upgrades) {
 
                         // Level or variation
                         // We need to check if hasOwnProperty because these could be explititly
                         // set to 0, but JavaScript's truthiness evaluates to false to it was defaulting
-                        this._outBufferToWar.addInt(mod.level || mod.variation || 0); // defaults to 0
+                        outBufferToWar.addInt(mod.level || mod.variation || 0); // defaults to 0
 
-                        this._outBufferToWar.addInt(mod.column || 0); // E.g DataA1 is 1 because of col A; refer to the xyzData.slk files for Data fields
+                        outBufferToWar.addInt(mod.column || 0); // E.g DataA1 is 1 because of col A; refer to the xyzData.slk files for Data fields
                     }
 
                     // Write mod value
                     if (modType === this.varTypes.int) {
-                        this._outBufferToWar.addInt(mod.value);
+                        outBufferToWar.addInt(mod.value);
                     } else if (modType === this.varTypes.real || modType === this.varTypes.unreal) {
                         // Follow-up: check if unreal values are same hex format as real
-                        this._outBufferToWar.addFloat(mod.value);
+                        outBufferToWar.addFloat(mod.value);
                     } else if (modType === this.varTypes.string) {
                         // Note that World Editor normally creates a TRIGSTR_000 for these string
                         // values - WC3MapTranslator just writes the string directly to file
-                        this._outBufferToWar.addString(mod.value);
-                        this._outBufferToWar.addNullTerminator();
+                        outBufferToWar.addString(mod.value);
                     }
 
                     // End of struct
                     if (tableType === TableType.original) {
                         // Original objects are ended with their base id (e.g. hfoo)
-                        this._outBufferToWar.addString(defKey);
+                        outBufferToWar.addChars(defKey);
                     } else {
                         // Custom objects are ended with 0000 bytes
-                        this._outBufferToWar.addByte(0);
-                        this._outBufferToWar.addByte(0);
-                        this._outBufferToWar.addByte(0);
-                        this._outBufferToWar.addByte(0);
+                        outBufferToWar.addByte(0);
+                        outBufferToWar.addByte(0);
+                        outBufferToWar.addByte(0);
+                        outBufferToWar.addByte(0);
                     }
                 });
             });
@@ -156,36 +158,36 @@ export class ObjectsTranslator {
         /*
          * Original table
          */
-        this._outBufferToWar.addInt(Object.keys(json.original).length);
+        outBufferToWar.addInt(Object.keys(json.original).length);
         generateTableFromJson(TableType.original, json.original);
 
         /*
          * Custom table
          */
-        this._outBufferToWar.addInt(Object.keys(json.custom).length); // # entry modifications
+        outBufferToWar.addInt(Object.keys(json.custom).length); // # entry modifications
         generateTableFromJson(TableType.custom, json.custom);
 
         return {
             errors: [],
-            buffer: this._outBufferToWar.getBuffer()
+            buffer: outBufferToWar.getBuffer()
         };
     }
 
-    public warToJson(type: string, buffer: Buffer) {
+    public static warToJson(type: string, buffer: Buffer): JsonResult<ObjectModificationTable> {
         const result = { original: {}, custom: {} };
-        this._outBufferToJSON = new W3Buffer(buffer);
+        const outBufferToJSON = new W3Buffer(buffer);
 
-        const fileVersion = this._outBufferToJSON.readInt();
+        const fileVersion = outBufferToJSON.readInt();
 
         const readModificationTable = (isOriginalTable: boolean) => {
-            const numTableModifications = this._outBufferToJSON.readInt();
+            const numTableModifications = outBufferToJSON.readInt();
 
             for (let i = 0; i < numTableModifications; i++) {
                 const objectDefinition = []; // object definition will store one or more modification objects
 
-                const originalId = this._outBufferToJSON.readChars(4),
-                    customId = this._outBufferToJSON.readChars(4),
-                    modificationCount = this._outBufferToJSON.readInt();
+                const originalId = outBufferToJSON.readChars(4),
+                    customId = outBufferToJSON.readChars(4),
+                    modificationCount = outBufferToJSON.readInt();
 
                 for (let j = 0; j < modificationCount; j++) {
                     const modification: Modification = {
@@ -196,26 +198,26 @@ export class ObjectsTranslator {
                         value: {}
                     };
 
-                    modification.id = this._outBufferToJSON.readChars(4);
-                    modification.type = this.varTypes[this._outBufferToJSON.readInt()]; // 'int' | 'real' | 'unreal' | 'string',
+                    modification.id = outBufferToJSON.readChars(4);
+                    modification.type = this.varTypes[outBufferToJSON.readInt()]; // 'int' | 'real' | 'unreal' | 'string',
 
-                    if (type === this.ObjectType.Doodads || type === this.ObjectType.Abilities || type === this.ObjectType.Upgrades) {
-                        modification.level = this._outBufferToJSON.readInt();
-                        modification.column = this._outBufferToJSON.readInt();
+                    if (type === ObjectType.Doodads || type === ObjectType.Abilities || type === ObjectType.Upgrades) {
+                        modification.level = outBufferToJSON.readInt();
+                        modification.column = outBufferToJSON.readInt();
                     }
 
                     if (modification.type === 'int') {
-                        modification.value = this._outBufferToJSON.readInt();
+                        modification.value = outBufferToJSON.readInt();
                     } else if (modification.type === 'real' || modification.type === 'unreal') {
-                        modification.value = this._outBufferToJSON.readFloat();
+                        modification.value = outBufferToJSON.readFloat();
                     } else { // modification.type === 'string'
-                        modification.value = this._outBufferToJSON.readString();
+                        modification.value = outBufferToJSON.readString();
                     }
 
                     if (isOriginalTable) {
-                        this._outBufferToJSON.readInt(); // should be 0 for original objects
+                        outBufferToJSON.readInt(); // should be 0 for original objects
                     } else {
-                        this._outBufferToJSON.readChars(4); // should be object ID for custom objects
+                        outBufferToJSON.readChars(4); // should be object ID for custom objects
                     }
 
                     objectDefinition.push(modification);

package/lib/translators/RegionsTranslator.ts

@@ -1,5 +1,6 @@
 import { HexBuffer } from '../HexBuffer';
 import { W3Buffer } from '../W3Buffer';
+import { WarResult, JsonResult } from '../CommonInterfaces'
 
 interface Region {
     position: Rect;
@@ -17,21 +18,16 @@ interface Rect {
     top: number;
 }
 
-export class RegionsTranslator {
+export abstract class RegionsTranslator {
 
-    private _outBufferToWar: HexBuffer;
-    private _outBufferToJSON: W3Buffer;
-
-    constructor() { }
-
-    public jsonToWar(regionsJson: Region[]) {
-        this._outBufferToWar = new HexBuffer();
+    public static jsonToWar(regionsJson: Region[]): WarResult {
+        const outBufferToWar = new HexBuffer();
 
         /*
          * Header
          */
-        this._outBufferToWar.addInt(5); // file version
-        this._outBufferToWar.addInt(regionsJson.length); // number of regions
+        outBufferToWar.addInt(5); // file version
+        outBufferToWar.addInt(regionsJson.length); // number of regions
 
         /*
          * Body
@@ -39,59 +35,51 @@ export class RegionsTranslator {
         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
-            this._outBufferToWar.addFloat(region.position.left);
-            this._outBufferToWar.addFloat(region.position.bottom);
-            this._outBufferToWar.addFloat(region.position.right);
-            this._outBufferToWar.addFloat(region.position.top);
+            outBufferToWar.addFloat(region.position.left);
+            outBufferToWar.addFloat(region.position.bottom);
+            outBufferToWar.addFloat(region.position.right);
+            outBufferToWar.addFloat(region.position.top);
 
-            // Region name - must be null terminated
-            this._outBufferToWar.addString(region.name);
-            this._outBufferToWar.addNullTerminator();
-
-            // Region id
-            this._outBufferToWar.addInt(region.id);
+            outBufferToWar.addString(region.name);
+            outBufferToWar.addInt(region.id);
 
             // Weather effect name - lookup necessary: char[4]
             if (region.weatherEffect) {
-                this._outBufferToWar.addString(region.weatherEffect);
+                outBufferToWar.addChars(region.weatherEffect); // Weather effect is optional - defaults to 0000 for "none"
             } else {
-                // Weather effect is optional - defaults to 0000 for "none"
-                this._outBufferToWar.addBytes([0, 0, 0, 0]);
+                // 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
-            this._outBufferToWar.addString(region.ambientSound || ''); // May be empty string
-            this._outBufferToWar.addNullTerminator();
+            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]
-            if (!region.color || region.color.length !== 3) {
-                this._outBufferToWar.addByte(0);   // blue
-                this._outBufferToWar.addByte(0);   // green
-                this._outBufferToWar.addByte(0);   // red
-            } else {
-                this._outBufferToWar.addByte(region.color[2]);   // blue
-                this._outBufferToWar.addByte(region.color[1]);   // green
-                this._outBufferToWar.addByte(region.color[0]);   // red
-            }
+            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
-            this._outBufferToWar.addByte(0xff);
+            outBufferToWar.addByte(0xff);
         });
 
         return {
             errors: [],
-            buffer: this._outBufferToWar.getBuffer()
+            buffer: outBufferToWar.getBuffer()
         };
     }
 
-    public warToJson(buffer: Buffer) {
+    public static warToJson(buffer: Buffer): JsonResult<Region[]> {
         const result = [];
-        this._outBufferToJSON = new W3Buffer(buffer);
+        const outBufferToJSON = new W3Buffer(buffer);
 
-        const fileVersion = this._outBufferToJSON.readInt(), // File version
-            numRegions = this._outBufferToJSON.readInt(); // # of regions
+        const fileVersion = outBufferToJSON.readInt(), // File version
+            numRegions = outBufferToJSON.readInt(); // # of regions
 
         for (let i = 0; i < numRegions; i++) {
             const region: Region = {
@@ -108,27 +96,21 @@ export class RegionsTranslator {
                 }
             };
 
-            region.position.left = this._outBufferToJSON.readFloat();
-            region.position.bottom = this._outBufferToJSON.readFloat();
-            region.position.right = this._outBufferToJSON.readFloat();
-            region.position.top = this._outBufferToJSON.readFloat();
-            region.name = this._outBufferToJSON.readString();
-            region.id = this._outBufferToJSON.readInt();
-
-            // Weather effect is specified by 4 characters (e.g. MEds is Dalaran Shield)
-            // war3map uses "0000" as literal characters to indicate no weather effect, but
-            // for the JSON format we use an empty string for this purpose, hence the check
-            region.weatherEffect = this._outBufferToJSON.readChars(4);
-            if (region.weatherEffect === '0000') region.weatherEffect = '';
-
-            region.ambientSound = this._outBufferToJSON.readString();
+            region.position.left = outBufferToJSON.readFloat();
+            region.position.bottom = outBufferToJSON.readFloat();
+            region.position.right = outBufferToJSON.readFloat();
+            region.position.top = outBufferToJSON.readFloat();
+            region.name = outBufferToJSON.readString();
+            region.id = outBufferToJSON.readInt();
+            region.weatherEffect = outBufferToJSON.readChars(4);
+            region.ambientSound = outBufferToJSON.readString();
             region.color = [
-                this._outBufferToJSON.readByte(), // red
-                this._outBufferToJSON.readByte(), // green
-                this._outBufferToJSON.readByte() // blue
+                outBufferToJSON.readByte(), // red
+                outBufferToJSON.readByte(), // green
+                outBufferToJSON.readByte() // blue
             ];
             region.color.reverse(); // json wants it in RGB, but .w3r file stores it as BB GG RR
-            this._outBufferToJSON.readByte(); // end of region structure
+            outBufferToJSON.readByte(); // end of region structure
 
             result.push(region);
         }