diff options
Diffstat (limited to 'src/SMAPI.Toolkit/Utilities/PathLookups/IFilePathLookup.cs')
-rw-r--r-- | src/SMAPI.Toolkit/Utilities/PathLookups/IFilePathLookup.cs | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/src/SMAPI.Toolkit/Utilities/PathLookups/IFilePathLookup.cs b/src/SMAPI.Toolkit/Utilities/PathLookups/IFilePathLookup.cs new file mode 100644 index 00000000..678e1383 --- /dev/null +++ b/src/SMAPI.Toolkit/Utilities/PathLookups/IFilePathLookup.cs @@ -0,0 +1,20 @@ +namespace StardewModdingAPI.Toolkit.Utilities.PathLookups +{ + /// <summary>An API for relative path lookups within a root directory.</summary> + internal interface IFilePathLookup + { + /// <summary>Get the actual path for a given relative file path.</summary> + /// <param name="relativePath">The relative path.</param> + /// <remarks>Returns the resolved path in file path format, else the normalized <paramref name="relativePath"/>.</remarks> + string GetFilePath(string relativePath); + + /// <summary>Get the actual path for a given asset name.</summary> + /// <param name="relativePath">The relative path.</param> + /// <remarks>Returns the resolved path in asset name format, else the normalized <paramref name="relativePath"/>.</remarks> + string GetAssetName(string relativePath); + + /// <summary>Add a relative path that was just created by a SMAPI API.</summary> + /// <param name="relativePath">The relative path. This must already be normalized in asset name or file path format.</param> + void Add(string relativePath); + } +} |