Merge pull request #912 from Miepee/models

Comment more models

UndertaleModLib/Models/UndertaleEmbeddedTexture.cs

@@ -27,11 +27,15 @@ public class UndertaleEmbeddedTexture : UndertaleNamedResource
     public uint Scaled { get; set; }
 
     /// <summary>
-    /// The amount of generated mipmap levels.
+    /// The amount of generated mipmap levels. <br/>
+    /// GameMaker Studio: 2 only.
     /// </summary>
     public uint GeneratedMips { get; set; }
 
-
+    /// <summary>
+    /// TODO: something. <br/>
+    /// GameMaker: Studio 2 only.
+    /// </summary>
     public uint TextureBlockSize { get; set; }
 
     /// <summary>

UndertaleModLib/Models/UndertaleExtension.cs

@@ -15,17 +15,23 @@ public enum UndertaleExtensionKind : uint
     /// <summary>
     /// A DLL extension.
     /// </summary>
-    DLL = 1,
+    Dll = 1,
     /// <summary>
     /// A GML extension.
     /// </summary>
     GML = 2,
+    /// <summary>
+    /// TODO: unknown
+    /// </summary>
     ActionLib = 3,
+    /// <summary>
+    /// TODO: unknown
+    /// </summary>
     Generic = 4,
     /// <summary>
     /// A JavaScript extension.
     /// </summary>
-    JS = 5
+    Js = 5
 }
 
 /// <summary>

UndertaleModLib/Models/UndertaleFilterEffect.cs

@@ -1,7 +1,7 @@
 namespace UndertaleModLib.Models;
 
 /// <summary>
-/// A filter effect as it's used in a GameMaker data file.
+/// A filter effect as it's used in a GameMaker data file. These are GameMaker: Studio 2.3.6+ only.
 /// </summary>
 [PropertyChanged.AddINotifyPropertyChangedInterface]
 public class UndertaleFilterEffect : UndertaleNamedResource
@@ -10,6 +10,10 @@ public class UndertaleFilterEffect : UndertaleNamedResource
     /// The name of the <see cref="UndertaleFilterEffect"/>.
     /// </summary>
     public UndertaleString Name { get; set; }
+
+    /// <summary>
+    /// TODO: fill this out please
+    /// </summary>
     public UndertaleString Value { get; set; }
 
     /// <inheritdoc />

UndertaleModLib/Models/UndertaleFont.cs

@@ -44,7 +44,7 @@ public class UndertaleFont : UndertaleNamedResource
     public ushort RangeStart { get; set; }
 
     /// <summary>
-    /// TODO: Currently unknown value.
+    /// TODO: Currently unknown value. Possibly related to ranges? (aka normal, ascii, digits, letters)
     /// </summary>
     public byte Charset { get; set; }
 
@@ -75,7 +75,7 @@ public class UndertaleFont : UndertaleNamedResource
     public float ScaleY { get; set; }
 
     /// <summary>
-    /// TODO: currently unknown, needs investigation.
+    /// TODO: currently unknown, needs investigation. GMS2022.2 specific?
     /// </summary>
     public uint Ascender { get; set; }
 
@@ -122,10 +122,19 @@ public class Glyph : UndertaleObject
         public ushort SourceHeight { get; set; }
 
 
-        //TODO: From here on out is some kerning related stuff I don't know.
+        /// <summary>
+        /// TODO: something kerning related
+        /// </summary>
         public short Shift { get; set; }
+
+        /// <summary>
+        /// TODO: something kerning related.
+        /// </summary>
         public short Offset { get; set; }
 
+        /// <summary>
+        /// The kerning for each glyph.
+        /// </summary>
         public UndertaleSimpleListShort<GlyphKerning> Kerning { get; set; } = new UndertaleSimpleListShort<GlyphKerning>();
 
         /// <inheritdoc />
@@ -154,9 +163,19 @@ public void Unserialize(UndertaleReader reader)
             Kerning = reader.ReadUndertaleObject<UndertaleSimpleListShort<GlyphKerning>>();
         }
 
+        /// <summary>
+        /// A class representing kerning for a glyph.
+        /// </summary>
         public class GlyphKerning : UndertaleObject
         {
+            /// <summary>
+            /// TODO: unknown?
+            /// </summary>
             public short Other;
+
+            /// <summary>
+            /// TODO: unknown?
+            /// </summary>
             public short Amount;
 
             /// <inheritdoc />

UndertaleModLib/Models/UndertaleFunction.cs

@@ -5,13 +5,27 @@
 
 namespace UndertaleModLib.Models;
 
+/// <summary>
+/// A function entry as it's used in a GameMaker data file.
+/// </summary>
 [PropertyChanged.AddINotifyPropertyChangedInterface]
 public class UndertaleFunction : UndertaleNamedResource, UndertaleInstruction.ReferencedObject
 {
     public FunctionClassification Classification { get; set; }
+
+    /// <summary>
+    /// The name of the <see cref="UndertaleFunction"/>.
+    /// </summary>
     public UndertaleString Name { get; set; }
+
+    /// <summary>
+    /// The index of <see cref="Name"/> in <see cref="UndertaleData.Strings"/>.
+    /// </summary>
     public int NameStringID { get; set; }
 
+    /// <summary>
+    /// How often this <see cref="UndertaleFunction"/> is referenced in code.
+    /// </summary>
     public uint Occurrences { get; set; }
     public UndertaleInstruction FirstAddress { get; set; }
 

UndertaleModLib/Models/UndertaleGameObject.cs

@@ -52,17 +52,17 @@ public class UndertaleGameObject : UndertaleNamedResource, INotifyPropertyChange
     /// <summary>
     /// Whether the game object is solid.
     /// </summary>
-    public bool Solid { get; set; } = false;
+    public bool Solid { get; set; }
 
     /// <summary>
     /// The depth level of the game object.
     /// </summary>
-    public int Depth { get; set; } = 0;
+    public int Depth { get; set; }
 
     /// <summary>
     /// Whether the game object is persistent.
     /// </summary>
-    public bool Persistent { get; set; } = false;
+    public bool Persistent { get; set; }
 
     /// <summary>
     /// The parent game object this is inheriting from.
@@ -78,12 +78,12 @@ public class UndertaleGameObject : UndertaleNamedResource, INotifyPropertyChange
     /// <summary>
     /// Whether this object uses Game Maker physics.
     /// </summary>
-    public bool UsesPhysics { get; set; } = false;
+    public bool UsesPhysics { get; set; }
 
     /// <summary>
     /// Whether this game object should act as a sensor fixture.
     /// </summary>
-    public bool IsSensor { get; set; } = false;
+    public bool IsSensor { get; set; }
 
     /// <summary>
     /// The collision shape the game object should use.
@@ -103,7 +103,7 @@ public class UndertaleGameObject : UndertaleNamedResource, INotifyPropertyChange
     /// <summary>
     /// The physics collision group this game object belongs to.
     /// </summary>
-    public uint Group { get; set; } = 0;
+    public uint Group { get; set; }
 
     /// <summary>
     /// The physics linear damping this game object uses.
@@ -123,12 +123,12 @@ public class UndertaleGameObject : UndertaleNamedResource, INotifyPropertyChange
     /// <summary>
     /// Whether this game object should start awake in the physics simulation.
     /// </summary>
-    public bool Awake { get; set; } = false;
+    public bool Awake { get; set; }
 
     /// <summary>
     /// Whether this game object is kinematic.
     /// </summary>
-    public bool Kinematic { get; set; } = false;
+    public bool Kinematic { get; set; }
 
     /// <summary>
     /// The vertices used for a <see cref="CollisionShape"/> of type <see cref="CollisionShapeFlags.Custom"/>.
@@ -145,6 +145,9 @@ public class UndertaleGameObject : UndertaleNamedResource, INotifyPropertyChange
     /// <inheritdoc />
     public event PropertyChangedEventHandler PropertyChanged;
 
+    /// <summary>
+    /// Initialized an instance of <see cref="UndertaleGameObject"/>.
+    /// </summary>
     public UndertaleGameObject()
     {
         for (int i = 0; i < Enum.GetValues(typeof(EventType)).Length; i++)
@@ -163,7 +166,7 @@ public void Serialize(UndertaleWriter writer)
         // This apparently has a different notation than everything else...
         if (_ParentId.Resource == null)
         {
-            writer.Write((int)-100);
+            writer.Write(-100);
         }
         else
         {
@@ -372,7 +375,7 @@ public class Event : UndertaleObject
         /// <remarks>This seems to always have 1 entry, it would need testing if maybe the games using drag-and-drop code are different</remarks>
         public UndertalePointerList<EventAction> Actions { get; private set; } = new UndertalePointerList<EventAction>();
 
-        //TODO: not used, condense.
+        //TODO: not used, condense. Also UMT specific.
         public EventSubtypeKey EventSubtypeKey
         {
             get => (EventSubtypeKey)EventSubtype;