summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI/IContentEventHelperForImage.cs
diff options
context:
space:
mode:
Diffstat (limited to 'src/StardewModdingAPI/IContentEventHelperForImage.cs')
-rw-r--r--src/StardewModdingAPI/IContentEventHelperForImage.cs24
1 files changed, 1 insertions, 23 deletions
diff --git a/src/StardewModdingAPI/IContentEventHelperForImage.cs b/src/StardewModdingAPI/IContentEventHelperForImage.cs
index 14bc23a4..1158c868 100644
--- a/src/StardewModdingAPI/IContentEventHelperForImage.cs
+++ b/src/StardewModdingAPI/IContentEventHelperForImage.cs
@@ -5,28 +5,11 @@ using Microsoft.Xna.Framework.Graphics;
namespace StardewModdingAPI
{
/// <summary>Encapsulates access and changes to dictionary content being read from a data file.</summary>
- public interface IContentEventHelperForImage
+ public interface IContentEventHelperForImage : IContentEventData<Texture2D>
{
/*********
- ** 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="IsAssetName"/> to compare with a known path.</summary>
- string AssetName { get; }
-
- /// <summary>The content data being read.</summary>
- Texture2D Data { 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 IsAssetName(string path);
-
/// <summary>Overwrite part of the image.</summary>
/// <param name="source">The image to patch into the content.</param>
/// <param name="sourceArea">The part of the <paramref name="source"/> to copy (or <c>null</c> to take the whole texture). This must be within the bounds of the <paramref name="source"/> texture.</param>
@@ -36,10 +19,5 @@ namespace StardewModdingAPI
/// <exception cref="ArgumentOutOfRangeException">The <paramref name="targetArea"/> is outside the bounds of the spritesheet.</exception>
/// <exception cref="InvalidOperationException">The content being read isn't an image.</exception>
void PatchImage(Texture2D source, Rectangle? sourceArea = null, Rectangle? targetArea = null, PatchMode patchMode = PatchMode.Replace);
-
- /// <summary>Replace the entire content value with the given value. This is generally not recommended, since it may break compatibility with other mods or different versions of the game.</summary>
- /// <param name="value">The new content value.</param>
- /// <exception cref="ArgumentNullException">The <paramref name="value"/> is null.</exception>
- void ReplaceWith(Texture2D value);
}
}