summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI/IAssetInfo.cs
diff options
context:
space:
mode:
Diffstat (limited to 'src/StardewModdingAPI/IAssetInfo.cs')
-rw-r--r--src/StardewModdingAPI/IAssetInfo.cs28
1 files changed, 28 insertions, 0 deletions
diff --git a/src/StardewModdingAPI/IAssetInfo.cs b/src/StardewModdingAPI/IAssetInfo.cs
new file mode 100644
index 00000000..5dd58e2e
--- /dev/null
+++ b/src/StardewModdingAPI/IAssetInfo.cs
@@ -0,0 +1,28 @@
+using System;
+
+namespace StardewModdingAPI
+{
+ /// <summary>Basic metadata for a content asset.</summary>
+ public interface IAssetInfo
+ {
+ /*********
+ ** Accessors
+ *********/
+ /// <summary>The content's locale code, if the content is localised.</summary>
+ string Locale { get; }
+
+ /// <summary>The normalised asset name being read. The format may change between platforms; see <see cref="AssetNameEquals"/> to compare with a known path.</summary>
+ string AssetName { get; }
+
+ /// <summary>The content data type.</summary>
+ Type DataType { get; }
+
+
+ /*********
+ ** Public methods
+ *********/
+ /// <summary>Get whether the asset name being loaded matches a given name after normalisation.</summary>
+ /// <param name="path">The expected asset path, relative to the game's content folder and without the .xnb extension or locale suffix (like 'Data\ObjectInformation').</param>
+ bool AssetNameEquals(string path);
+ }
+}