Update header documentation

crschnick · Nov 11, 2022 · 8621151 · 8621151
1 parent 4fa95e7
commit 8621151
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/pdxu-io/src/main/java/com/crschnick/pdxu/io/savegame/ModernHeader.java b/pdxu-io/src/main/java/com/crschnick/pdxu/io/savegame/ModernHeader.java
@@ -20,7 +20,8 @@
  * 0: Uncompressed + Plaintext
  * <p>
  * meta data size:
- * Length of meta data block at the beginning of the file in bytes.
+ * Length of meta data block at the beginning of the file in bytes, or alternatively the amount of bytes to skip until gamestate data is read.
+ * If the meta data is contained in a separate file, i.e. not embedded into the gamestate file, this value will be zero.
  */
 public record ModernHeader(boolean unknown, int compressionType, boolean binary, long randomness, long metaLength) {