diff options
Diffstat (limited to 'src/SMAPI/IContentHelper.cs')
| -rw-r--r-- | src/SMAPI/IContentHelper.cs | 18 |
1 files changed, 13 insertions, 5 deletions
diff --git a/src/SMAPI/IContentHelper.cs b/src/SMAPI/IContentHelper.cs index 2936ecfb..2cd0c1fc 100644 --- a/src/SMAPI/IContentHelper.cs +++ b/src/SMAPI/IContentHelper.cs @@ -3,21 +3,25 @@ using System.Collections.Generic; using System.Diagnostics.Contracts; using Microsoft.Xna.Framework.Content; using Microsoft.Xna.Framework.Graphics; +using StardewModdingAPI.Events; using StardewValley; 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 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 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> @@ -31,17 +35,19 @@ namespace StardewModdingAPI ** Public methods *********/ /// <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"/>, and dictionaries; other types may be supported by the game's content pipeline.</typeparam> + /// <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> /// <param name="source">Where to search for a matching content asset.</param> /// <exception cref="ArgumentException">The <paramref name="key"/> is empty or contains invalid characters.</exception> /// <exception cref="ContentLoadException">The content asset couldn't be loaded (e.g. because it doesn't exist).</exception> - T Load<T>(string key, ContentSource source = ContentSource.ModFolder); + T Load<T>(string key, ContentSource source = ContentSource.ModFolder) + where T : notnull; /// <summary>Normalize an asset name so it's consistent with those generated by the game. This is mainly useful for string comparisons like <see cref="string.StartsWith(string)"/> on generated asset names, and isn't necessary when passing asset names into other content helper methods.</summary> /// <param name="assetName">The asset key.</param> + /// <exception cref="ContentLoadException">The asset key is empty or contains invalid characters.</exception> [Pure] - string NormalizeAssetName(string assetName); + string NormalizeAssetName(string? assetName); /// <summary>Get the underlying key in the game's content cache for an asset. This can be used to load custom map tilesheets, but should be avoided when you can use the content API instead. This does not validate whether the asset exists.</summary> /// <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> @@ -58,7 +64,8 @@ namespace StardewModdingAPI /// <summary>Remove all assets of the given type from the cache so they're reloaded on the next request. <b>This can be a very expensive operation and should only be used in very specific cases.</b> This will reload core game assets if needed, but references to the former assets will still show the previous content.</summary> /// <typeparam name="T">The asset type to remove from the cache.</typeparam> /// <returns>Returns whether any assets were invalidated.</returns> - bool InvalidateCache<T>(); + bool InvalidateCache<T>() + where T : notnull; /// <summary>Remove matching assets from the content cache so they're reloaded on the next request. This will reload core game assets if needed, but references to the former asset will still show the previous content.</summary> /// <param name="predicate">A predicate matching the assets to invalidate.</param> @@ -69,6 +76,7 @@ namespace StardewModdingAPI /// <typeparam name="T">The data type.</typeparam> /// <param name="data">The asset data.</param> /// <param name="assetName">The asset name. This is only used for tracking purposes and has no effect on the patch helper.</param> - IAssetData GetPatchHelper<T>(T data, string assetName = null); + IAssetData GetPatchHelper<T>(T data, string? assetName = null) + where T : notnull; } } |