madden-franchise 3.0.6 → 3.1.1

package/FranchiseFile.js

@@ -117,7 +117,7 @@ class FranchiseFile extends EventEmitter {
 
         const tableData = this.unpackedFileContents.slice(currentTable, nextTable);
 
-        const newFranchiseTable = new FranchiseFileTable(tableData, currentTable, this._gameYear, this.strategy);
+        const newFranchiseTable = new FranchiseFileTable(tableData, currentTable, this._gameYear, this.strategy, this.settings);
         newFranchiseTable.index = i;
         this.tables.push(newFranchiseTable);
 

package/FranchiseFileSettings.js

@@ -3,7 +3,8 @@ class FranchiseFileSettings {
     this.saveOnChange = settings && settings.saveOnChange ? settings.saveOnChange : false;
     this.schemaOverride = settings && settings.schemaOverride ? settings.schemaOverride: false;
     this.schemaDirectory = settings && settings.schemaDirectory ? settings.schemaDirectory : false;
-    this.autoParse = settings && (settings.autoParse !== null && settings.autoParse !== undefined) ? settings.autoParse : true
+    this.autoParse = settings && (settings.autoParse !== null && settings.autoParse !== undefined) ? settings.autoParse : true;
+    this.autoUnempty = settings && (settings.autoUnempty !== null && settings.autoUnempty !== undefined) ? settings.autoUnempty : false;
   }
 };
 

package/FranchiseFileTable.js

@@ -4,7 +4,7 @@ const FranchiseFileRecord = require('./FranchiseFileRecord');
 const FranchiseFileTable2Field = require('./FranchiseFileTable2Field');
 
 class FranchiseFileTable extends EventEmitter {
-  constructor(data, offset, gameYear, strategy) {
+  constructor(data, offset, gameYear, strategy, settings) {
     super();
     this.index = -1;
     this.data = data;
@@ -23,6 +23,7 @@ class FranchiseFileTable extends EventEmitter {
     this.table2Records = [];
     this.arraySizes = [];
     this.emptyRecords = new Map();
+    this._settings = settings;
   };
 
   get hexData () {
@@ -426,10 +427,8 @@ class FranchiseFileTable extends EventEmitter {
           const emptyRecordReference = this.emptyRecords.get(object.index);
           const changedRecordWasEmpty = emptyRecordReference !== null && emptyRecordReference !== undefined;
 
+          // Automatically un-empty the row if the setting is enabled and the changed record was empty.
           if (changedRecordWasEmpty) {
-            // 1/5/23: Assume all changes to a field make the record not empty. Leaving comments
-            // below if this needs to be reverted in the future.
-            
 
               // Check if the record's first four bytes still have a reference to the 0th table.
               // If so, then the record is still considered empty.
@@ -442,7 +441,7 @@ class FranchiseFileTable extends EventEmitter {
               // if the changed field isn't included in the first 32 bits, zero out the first 32 bits. 
               // Otherwise, it's not necessary to zero out.
               const changedFieldsInFirst4Bytes = object.fieldsArray.filter((field) => { return field.isChanged && field.offset.indexOffset < 32; });
-              if (changedFieldsInFirst4Bytes.length === 0) {
+              if (this._settings.autoUnempty && changedFieldsInFirst4Bytes.length === 0) {
                 // set first 4 bytes to 0
                 this._changeRecordBuffers(object.index, 0);
 
@@ -452,53 +451,57 @@ class FranchiseFileTable extends EventEmitter {
                   field.clearCachedValues();
                 });
               }
+              
+              // If autoUnempty is disabled, only un-empty the row if a field in the first 4 bytes changed.
+              // If autoUnempty is enabled, un-empty the row if ANY field changed.
+              if (this._settings.autoUnempty || changedFieldsInFirst4Bytes.length > 0) {
+                // if the record contains any string values, point the string values to
+                // their correct offsets
+                this.strategy.recalculateStringOffsets(this, object);
+
+                // Delete the empty record entry because it is no longer empty
+                this.emptyRecords.delete(object.index);
+
+                // Set the isEmpty back to false because it's no longer empty
+                object.isEmpty = false;
+
+                // Check if there is a previous empty record
+                const previousEmptyReference = this.emptyRecords.get(emptyRecordReference.previous);
+
+                if (previousEmptyReference) {
+                  // Set the previous empty record to point to the old reference's next node
+                  this.emptyRecords.set(emptyRecordReference.previous, {
+                    previous: this.emptyRecords.get(emptyRecordReference.previous).previous,
+                    next: emptyRecordReference.next
+                  });
+
+                  // change the table buffer and record buffer to reflect object change
+                  this._changeRecordBuffers(emptyRecordReference.previous, emptyRecordReference.next);
+                }
 
-              // if the record contains any string values, point the string values to
-              // their correct offsets
-              this.strategy.recalculateStringOffsets(this, object);
-
-              // Delete the empty record entry because it is no longer empty
-              this.emptyRecords.delete(object.index);
-
-              // Set the isEmpty back to false because it's no longer empty
-              object.isEmpty = false;
-
-              // Check if there is a previous empty record
-              const previousEmptyReference = this.emptyRecords.get(emptyRecordReference.previous);
-
-              if (previousEmptyReference) {
-                // Set the previous empty record to point to the old reference's next node
-                this.emptyRecords.set(emptyRecordReference.previous, {
-                  previous: this.emptyRecords.get(emptyRecordReference.previous).previous,
-                  next: emptyRecordReference.next
-                });
-
-                // change the table buffer and record buffer to reflect object change
-                this._changeRecordBuffers(emptyRecordReference.previous, emptyRecordReference.next);
-              }
-
-              // If there is a next empty reference, update the previous value accordingly to now point
-              // to the current record's previous index.
-              const nextEmptyReference = this.emptyRecords.get(emptyRecordReference.next);
-
-              if (nextEmptyReference) {
-                this.emptyRecords.set(emptyRecordReference.next, {
-                  previous: emptyRecordReference.previous,
-                  next: this.emptyRecords.get(emptyRecordReference.next).next
-                });
-
-                if (!previousEmptyReference) {
-                  // If no previous empty record exists and a next record exists, we need to update the header to
-                  // point to object record as the next record to use.
-                  this.setNextRecordToUse(emptyRecordReference.next);
+                // If there is a next empty reference, update the previous value accordingly to now point
+                // to the current record's previous index.
+                const nextEmptyReference = this.emptyRecords.get(emptyRecordReference.next);
+
+                if (nextEmptyReference) {
+                  this.emptyRecords.set(emptyRecordReference.next, {
+                    previous: emptyRecordReference.previous,
+                    next: this.emptyRecords.get(emptyRecordReference.next).next
+                  });
+
+                  if (!previousEmptyReference) {
+                    // If no previous empty record exists and a next record exists, we need to update the header to
+                    // point to object record as the next record to use.
+                    this.setNextRecordToUse(emptyRecordReference.next);
+                  }
                 }
-              }
 
-              // If there are no previous or next empty references
-              // Then there are no more empty references in the table
-              // Update the table header nextRecordToUse back to the table record capacity
-              if (!previousEmptyReference && !nextEmptyReference) {
-                this.setNextRecordToUse(this.header.recordCapacity);
+                // If there are no previous or next empty references
+                // Then there are no more empty references in the table
+                // Update the table header nextRecordToUse back to the table record capacity
+                if (!previousEmptyReference && !nextEmptyReference) {
+                  this.setNextRecordToUse(this.header.recordCapacity);
+                }
               }
             // }
           }

package/README.md

@@ -49,6 +49,10 @@ Franchise file settings
 
       // AUTO PARSE - specify if you want the system to automatically parse all tables in the file, or if you want to explicity call file.parse()
       'autoParse': true/false [default: true]
+
+      // AUTO UNEMPTY - specify if you want the system to automatically determine if an empty field should become un-empty once you edit it.
+      // Warning: may have unintended side-effects if you batch import. Enable with caution.
+      'autoUnempty': true/false [default: false]
     }
 
 #### fields

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "madden-franchise",
-  "version": "3.0.6",
+  "version": "3.1.1",
   "description": "Tools to read a madden franchise file and get data from it",
   "main": "FranchiseFile.js",
   "scripts": {