From bad2043e4cb41587754016fa286cd36068f1b647 Mon Sep 17 00:00:00 2001
From: miku-666 <74728189+NessieHax@users.noreply.github.com>
Date: Mon, 8 Aug 2022 22:57:37 +0200
Subject: [PATCH] Add Doc strings to PCKFile class and add `TryGetFile`

---
 .../Classes/FileTypes/PCKFile.cs              | 27 +++++++++++++------
 1 file changed, 19 insertions(+), 8 deletions(-)

diff --git a/MinecraftUSkinEditor/Classes/FileTypes/PCKFile.cs b/MinecraftUSkinEditor/Classes/FileTypes/PCKFile.cs
index b212c407..4b82fd5c 100644
--- a/MinecraftUSkinEditor/Classes/FileTypes/PCKFile.cs
+++ b/MinecraftUSkinEditor/Classes/FileTypes/PCKFile.cs
@@ -12,7 +12,6 @@ namespace PckStudio.Classes.FileTypes
 
         public class FileData
         {
-            // only apllys when the PCKFile is type 3
             public enum EDLCType : int
             {
                 DLCSkinFile         = 0,  // *.png
@@ -24,7 +23,7 @@ namespace PckStudio.Classes.FileTypes
                 /// </summary>
                 DLCInfoFile         = 4,
                 /// <summary>
-                /// (x16|x32|...)Info.pck
+                /// (x16|x32|x64)Info.pck
                 /// </summary>
                 DLCTexturePackInfoFile = 5,
                 /// <summary>
@@ -49,7 +48,6 @@ namespace PckStudio.Classes.FileTypes
                 DLCGameRulesHeader  = 10,
                 /// <summary>
                 /// Skins.pck
-                /// made up name  - Miku
                 /// </summary>
                 DLCSkinDataFile     = 11,
                 /// <summary>
@@ -122,18 +120,31 @@ namespace PckStudio.Classes.FileTypes
         /// Checks wether a file with <paramref name="filepath"/> and <paramref name="type"/> exists
         /// </summary>
         /// <param name="filepath">Path to the file in the pck</param>
-        /// <param name="type">Type of the file to check</param>
-        /// <returns> when file exists, otherwise false </returns>
+        /// <param name="type">Type of the file <see cref="FileData.EDLCType"/></param>
+        /// <returns>True when file exists, otherwise false </returns>
         public bool HasFile(string filepath, int type)
         {
-            return GetFile(filepath, type) != null;
+            return GetFile(filepath, type) is FileData;
+        }
+
+        /// <summary>
+        /// Tries to get a file with <paramref name="filepath"/> and <paramref name="type"/>.
+        /// </summary>
+        /// <param name="filepath">Path to the file in the pck</param>
+        /// <param name="type">Type of the file <see cref="FileData.EDLCType"/></param>
+        /// <param name="file"></param>
+        /// <returns></returns>
+        public bool TryGetFile(string filepath, int type, out FileData file)
+        {
+            file = GetFile(filepath, type);
+            return file is FileData;
         }
 
         /// <summary>
         /// Gets the first file that Equals <paramref name="filepath"/> and <paramref name="type"/>
         /// </summary>
-        /// <param name="filepath">file path of the file</param>
-        /// <param name="type">Type of the file</param>
+        /// <param name="filepath">Path to the file in the pck</param>
+        /// <param name="type">Type of the file <see cref="FileData.EDLCType"/></param>
         /// <returns>FileData if found, otherwise null</returns>
         public FileData GetFile(string filepath, int type)
         {