LegacyConsole/PCK-Studio
3
0
Fork 0
mirror of https://git.huckle.dev/Huckles-Minecraft-Archive/PCK-Studio.git synced 2026-06-07 00:44:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add Doc strings to PCKFile class and add TryGetFile

Browse Source
This commit is contained in:
miku-666
2022-08-08 22:57:37 +02:00
parent fb3a45cf92
commit bad2043e4c
1 changed files with 19 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
MinecraftUSkinEditor/Classes/FileTypes/PCKFile.cs
View File

@@ -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)
{