New IDEVersion struct in GeneralInfo

Author: BioTomateDE

UndertaleModLib/Models/UndertaleGeneralInfo.cs

@@ -182,7 +182,58 @@ public enum FunctionClassification : ulong
         Steam = 0x2000000000000000UL,
         UNUSED5 = 2310346608841064448UL,
         Shaders = 0x4000000000000000UL,
-        VertexBuffers = 9223372036854775808UL
+        VertexBuffers = 0x8000000000000000UL
+    }
+
+    /// <summary>
+    /// The GameMaker IDE Version this game was made in.
+    /// </summary>
+    /// <remarks>
+    /// UTMT also uses this to track the data file format for games made in 
+    /// GMS2 since the version stored in GEN8 is no longer being updated.
+    /// </remarks>
+    public struct IDEVersion
+    {
+        /// <summary>
+        /// The most significant version part.
+        /// 
+        /// This can be 1, 2 or a year after 2021.
+        /// </summary>
+        /// <remarks>
+        /// If greater than 1, serialization produces "2.0.0.0" due to the flag no longer updating in data.win
+        /// </remarks>
+        public uint Major = 1;
+
+        /// <summary>
+        /// The second-most significant version part.
+        /// </summary>
+        public uint Minor = 0;
+
+        /// <summary>
+        /// The third-most significant version part.
+        /// </summary>
+        public uint Release = 0;
+
+        /// <summary>
+        /// The fourth-most (least) significant version part.
+        /// </summary>
+        public uint Build = 1337;
+
+        /// <summary>
+        /// The GameMaker release branch of the data file. May be set to <see cref="BranchType.Post2022_0"/> when features exempted from LTS are detected.
+        /// </summary>
+        public BranchType Branch = BranchType.Pre2022_0;
+    }
+
+    /// <summary>
+    /// Different GameMaker release branches. LTS has some but not all features of equivalent newer versions.
+    /// </summary>
+    // TODO: implement LTS 2026
+    public enum BranchType
+    {
+        Pre2022_0,
+        LTS2022_0,
+        Post2022_0
     }
 
     /// <summary>
@@ -191,13 +242,18 @@ public enum FunctionClassification : ulong
     public bool IsDebuggerDisabled { get; set; } = true;
 
     /// <summary>
-    /// The bytecode version of the data file.
+    /// The bytecode version of the data file, (theoretically) indicating the data file format version.
     /// </summary>
+    /// <remarks>
+    /// It's theoretical because this is stuck on 17 since GMS2 and this library uses 
+    /// the IDE version (via version checks) for those modern versions instead.
+    /// </remarks>
     public byte BytecodeVersion { get; set; } = 0x10;
 
     /// <summary>
     /// Likely padding, IsDebuggerDisabled and BytecodeVersion are written together as a 32-bit integer
     /// </summary>
+    // TODO: this can probably be removed
     public ushort Padding { get; set; } = 0;
 
     /// <summary>
@@ -211,17 +267,17 @@ public enum FunctionClassification : ulong
     public UndertaleString Config { get; set; }
 
     /// <summary>
-    /// The last object id of the data file.
+    /// The last object ID of the data file.
     /// </summary>
     public uint LastObj { get; set; } = 100000;
 
     /// <summary>
-    /// The last tile id of the data file.
+    /// The last tile ID of the data file.
     /// </summary>
     public uint LastTile { get; set; } = 10000000;
 
     /// <summary>
-    /// The game id of the data file.
+    /// The game ID of the data file.
     /// </summary>
     public uint GameID { get; set; } = 13371337;
 
@@ -237,40 +293,35 @@ public enum FunctionClassification : ulong
     public UndertaleString Name { get; set; }
 
     /// <summary>
-    /// Different GameMaker release branches. LTS has some but not all features of equivalent newer versions.
-    /// </summary>
-    public enum BranchType
-    {
-        Pre2022_0,
-        LTS2022_0,
-        Post2022_0
-    }
-
-    /// <summary>
-    /// The GameMaker release branch of the data file. May be set to <see cref="BranchType.Post2022_0"/> when features exempted from LTS are detected.
+    /// The GameMaker IDE Version this game was made in.
     /// </summary>
-    public BranchType Branch = BranchType.Pre2022_0;
+    public IDEVersion Version;
 
     /// <summary>
     /// The major version of the data file.
     /// If greater than 1, serialization produces "2.0.0.0" due to the flag no longer updating in data.win
     /// </summary>
-    public uint Major { get; set; } = 1;
+    public uint Major { get => Version.Major; set { Version.Major = value; } }
 
     /// <summary>
     /// The minor version of the data file.
     /// </summary>
-    public uint Minor { get; set; } = 0;
+    public uint Minor { get => Version.Minor; set { Version.Minor = value; } }
 
     /// <summary>
     /// The Release version of the data file.
     /// </summary>
-    public uint Release { get; set; } = 0;
+    public uint Release { get => Version.Release; set { Version.Release = value; } }
 
     /// <summary>
     /// The build version of the data file.
     /// </summary>
-    public uint Build { get; set; } = 1337;
+    public uint Build { get => Version.Build; set { Version.Build = value; } }
+
+    /// <summary>
+    /// The GameMaker release branch of the data file. May be set to <see cref="BranchType.Post2022_0"/> when features exempted from LTS are detected.
+    /// </summary>
+    public BranchType Branch { get => Version.Branch; set { Version.Branch = value; } }
 
     /// <summary>
     /// The default window width of the game.