Can read TR3 Script

ChangeLog.md

 
     [ 20140807 ]
     * Script parser successfully loading level scripts
+    * Can also read TR3 script now
 
     [ 20140806 ]
     * Improved Script reader and its Unit Test

include/Script.h

     } ScriptLanguage;
 
     typedef enum {
-        OP_PICTURE        = 0,  //!< Unused in TR2. Or PSX?
+        OP_PICTURE        = 0,  //!< Unused in TR2. Or PSX? Used in TR3.
         OP_PSX_TRACK      = 1,  //!< Does not compile. PSX?
         OP_PSX_FMV        = 2,  //!< Does not compile. PSX?
         OP_FMV            = 3,  //!< Display FMV
         OP_END            = 9,  //!< Closes script sequence
         OP_TRACK          = 10, //!< Play soundtrack (precedes level opcode)
         OP_SUNSET         = 11, //!< Unknown, nothing changes in TR2.
-        OP_LOAD_PIC       = 12, //!< Does not compile. PSX or TR3?
+        OP_LOAD_PIC       = 12, //!< Does not compile. PSX? Used in TR3.
         OP_DEADLY_WATER   = 13, //!< Unknown, nothing changes in TR2.
         OP_REMOVE_WEAPONS = 14, //!< Start level without weapons
-        OP_GAMECOMPLETE   = 15, //!< End of game. Show stats, start credits sequence, music ID 52.
+        OP_GAMECOMPLETE   = 15, //!< End of game. Show stats, start credits sequence, music ID 52 in TR2.
         OP_CUTANGLE       = 16, //!< Match N-S orientation of Room and animated characters.
         OP_NOFLOOR        = 17, //!< Lara dies when her feet reach given depth.
         OP_STARTINV       = 18, //!< Items given to Lara at level start (+1000), or at all secrets found (+0)
 
     // Items for all-secrets-found go from 0 to 26,
     // for start-inventory add 1000, so 1000 - 1026
+    // Atleast in TR2
     typedef enum {
         OP_WEAPON_PISTOLS     = 0,  //!< Add standard pistols (2)
         OP_WEAPON_SHOTGUN     = 1,  //!< Add shotgun (1)
     } ScriptFlag;
 
     void readStringPackage(BinaryFile &f, std::vector<std::string> &v, unsigned int n);
+    void readScriptPackage(BinaryFile &f, std::vector<std::vector<uint16_t>> &v, unsigned int n);
 
     const bool opcodeHasOperand[OP_UNKNOWN] {
         true, true, true, true, true, true,
     std::vector<std::string> cutsceneFilenames; // numCutscenes
     std::vector<std::vector<uint16_t>> script; // numLevels + 1
     uint16_t numGameStrings;
-    std::vector<std::string> gameStrings; // numGameStrings, 89
+    std::vector<std::string> gameStrings; // numGameStrings
     std::vector<std::string> pcStrings; // 41
     std::vector<std::vector<std::string>> puzzles; // 4 * numLevels
     std::vector<std::vector<std::string>> pickups; // 2 * numLevels

src/Script.cpp

     titleReplace = f.read32();
     onDeathDemoMode = f.readU32();
     onDeathInGame = f.readU32();
-    noInputTime = f.readU32();
+    noInputTime = f.readU32(); // Scaled *100 in TR3
     onDemoInterrupt = f.readU32();
     onDemoEnd = f.readU32();
 
 
     cypherCode = f.readU8();
     language = f.readU8();
-    secretTrack = f.readU16();
+    secretTrack = f.readU16(); // Zero in TR3, Part of filler or real number?
 
     // Filler 4 (4 bytes)
     f.seek(f.tell() + 4);
     readStringPackage(f, levelFilenames, numLevels);
     readStringPackage(f, cutsceneFilenames, numCutscenes);
 
-    // Script Package
-    uint16_t *offset = new uint16_t[numLevels + 1];
-    for (unsigned int i = 0; i < (numLevels + 1); i++) {
-        offset[i] = f.readU16();
-        assertEqual(offset[i] % 2, 0);
-    }
-
-    uint16_t numBytes = f.readU16() + 6; // Offset TR2 specific?!
-    assertEqual(numBytes % 2, 0); // 16 bit opcodes and operands
-
-    uint16_t *list = new uint16_t[numBytes / 2];
-    for (uint16_t i = 0; i < (numBytes / 2); i++) {
-        list[i] = f.readU16();
-    }
-
-    for (unsigned int i = 0; i < (numLevels + 1); i++) {
-        unsigned int end = offset[i] / 2;
-
-        bool readingOperand = false;
-        while (readingOperand || (list[end] != OP_END)) {
-            if (readingOperand) {
-                readingOperand = false;
-                end++;
-            } else {
-                if (opcodeHasOperand[list[end]]) {
-                    readingOperand = true;
-                }
-                end++;
-            }
-        }
-        end++;
+    // Level Scripts
+    readScriptPackage(f, script, numLevels + 1);
 
-        std::vector<uint16_t> tmp;
-        for (unsigned int a = (offset[i] / 2); a < end; a++)
-            tmp.push_back(list[a]);
-
-        script.push_back(tmp);
-    }
-
-    delete [] list;
-    delete [] offset;
-
-    // Engine expects 89 game strings!
     numGameStrings = f.readU16();
-    assertEqual(numGameStrings, 89);
 
     // More strings...
     readStringPackage(f, gameStrings, numGameStrings);
     delete [] offset;
 }
 
+void Script::readScriptPackage(BinaryFile &f, std::vector<std::vector<uint16_t>> &v, unsigned int n) {
+    uint16_t *offset = new uint16_t[n];
+    for (unsigned int i = 0; i < n; i++) {
+        offset[i] = f.readU16();
+        assertEqual(offset[i] % 2, 0);
+    }
+
+    uint16_t numBytes = f.readU16();
+    assertEqual(numBytes % 2, 0); // 16 bit opcodes and operands
+
+    // Only TR2, not TR3, has 6 "filler bytes" hex 13 00 14 00 15 00 here
+    // We need to skip these
+    uint16_t hack1 = f.readU16();
+    uint16_t hack2 = f.readU16();
+    uint16_t hack3 = f.readU16();
+    uint16_t hackStart = 0;
+    uint16_t *list = new uint16_t[(numBytes + 6) / 2];
+    if ((hack1 == 19) && (hack2 == 20) && (hack3 == 21)) {
+        numBytes += 6;
+    } else {
+        list[0] = hack1;
+        list[1] = hack2;
+        list[2] = hack3;
+        hackStart = 3;
+    }
+
+    for (uint16_t i = hackStart; i < (numBytes / 2); i++) {
+        list[i] = f.readU16();
+    }
+
+    for (unsigned int i = 0; i < n; i++) {
+        unsigned int end = offset[i] / 2;
+
+        bool readingOperand = false;
+        while (readingOperand || (list[end] != OP_END)) {
+            if (readingOperand) {
+                readingOperand = false;
+                end++;
+            } else {
+                if (opcodeHasOperand[list[end]]) {
+                    readingOperand = true;
+                }
+                end++;
+            }
+        }
+        end++;
+
+        std::vector<uint16_t> tmp;
+        for (unsigned int a = (offset[i] / 2); a < end; a++)
+            tmp.push_back(list[a]);
+
+        v.push_back(tmp);
+    }
+
+    delete [] list;
+    delete [] offset;
+}
+
 unsigned int Script::levelCount() {
     return numLevels;
 }

test/Script.cpp

     int error = test(f, !((argc > 1) && (argv[1][0] == 's')));
     delete [] f;
 
+    if (error != 0)
+        return error;
+
+    f = fullPath("~/.OpenRaider/paks/tr3/TOMBPC.DAT", 0);
+    error = test(f, !((argc > 1) && (argv[1][0] == 's')));
+    delete [] f;
+
     return error;
 }