diff options
| author | Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com> | 2022-03-27 13:42:14 -0400 |
|---|---|---|
| committer | Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com> | 2022-03-27 13:42:14 -0400 |
| commit | 1d3c99cc25f6c0d504fd5e43ea71ef327b6e9066 (patch) | |
| tree | a436d2e6abeeeae94df93fb4bf400664ca740b89 /src/SMAPI/IContentHelper.cs | |
| parent | d864f2ed775dfd5843b9e1cdd1da96ade5dd1068 (diff) | |
| download | SMAPI-1d3c99cc25f6c0d504fd5e43ea71ef327b6e9066.tar.gz SMAPI-1d3c99cc25f6c0d504fd5e43ea71ef327b6e9066.tar.bz2 SMAPI-1d3c99cc25f6c0d504fd5e43ea71ef327b6e9066.zip | |
split helper.Content API into game/mod content APIs
Diffstat (limited to 'src/SMAPI/IContentHelper.cs')
| -rw-r--r-- | src/SMAPI/IContentHelper.cs | 10 |
1 files changed, 3 insertions, 7 deletions
diff --git a/src/SMAPI/IContentHelper.cs b/src/SMAPI/IContentHelper.cs index 1d36abff..48f6bfd8 100644 --- a/src/SMAPI/IContentHelper.cs +++ b/src/SMAPI/IContentHelper.cs @@ -10,17 +10,18 @@ using xTile; namespace StardewModdingAPI { /// <summary>Provides an API for loading content assets.</summary> + [Obsolete($"Use {nameof(IMod.Helper)}.{nameof(IModHelper.GameContent)} or {nameof(IMod.Helper)}.{nameof(IModHelper.ModContent)} instead. This interface will be removed in SMAPI 4.0.0.")] public interface IContentHelper : IModLinked { /********* ** Accessors *********/ /// <summary>Interceptors which provide the initial versions of matching content assets.</summary> - [Obsolete($"Use {nameof(IMod.Helper)}.{nameof(IModHelper.Events)}.{nameof(IModEvents.Content)} instead. This interface will be removed in SMAPI 4.0.0.")] + [Obsolete($"Use {nameof(IMod.Helper)}.{nameof(IModHelper.Events)}.{nameof(IModEvents.Content)} instead. This property will be removed in SMAPI 4.0.0.")] IList<IAssetLoader> AssetLoaders { get; } /// <summary>Interceptors which edit matching content assets after they're loaded.</summary> - [Obsolete($"Use {nameof(IMod.Helper)}.{nameof(IModHelper.Events)}.{nameof(IModEvents.Content)} instead. This interface will be removed in SMAPI 4.0.0.")] + [Obsolete($"Use {nameof(IMod.Helper)}.{nameof(IModHelper.Events)}.{nameof(IModEvents.Content)} instead. This property will be removed in SMAPI 4.0.0.")] IList<IAssetEditor> AssetEditors { get; } /// <summary>The game's current locale code (like <c>pt-BR</c>).</summary> @@ -33,11 +34,6 @@ namespace StardewModdingAPI /********* ** Public methods *********/ - /// <summary>Parse a raw asset name.</summary> - /// <param name="rawName">The raw asset name to parse.</param> - /// <exception cref="ArgumentException">The <paramref name="rawName"/> is null or empty.</exception> - IAssetName ParseAssetName(string rawName); - /// <summary>Load content from the game folder or mod folder (if not already cached), and return it. When loading a <c>.png</c> file, this must be called outside the game's draw loop.</summary> /// <typeparam name="T">The expected data type. The main supported types are <see cref="Map"/>, <see cref="Texture2D"/>, dictionaries, and lists; other types may be supported by the game's content pipeline.</typeparam> /// <param name="key">The asset key to fetch (if the <paramref name="source"/> is <see cref="ContentSource.GameContent"/>), or the local path to a content file relative to the mod folder.</param> |