blob: c30211441a813f39e16fecd819731118cf4ab1b7 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
using System;
namespace StardewModdingAPI
{
/// <summary>Generic metadata and methods for a content asset being loaded.</summary>
/// <typeparam name="TValue">The expected data type.</typeparam>
public interface IAssetData<TValue> : IAssetInfo
{
/*********
** Accessors
*********/
/// <summary>The content data being read.</summary>
TValue Data { get; }
/*********
** Public methods
*********/
/// <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>
/// <exception cref="InvalidCastException">The <paramref name="value"/>'s type is not compatible with the loaded asset's type.</exception>
void ReplaceWith(TValue value);
}
/// <summary>Generic metadata and methods for a content asset being loaded.</summary>
public interface IAssetData : IAssetData<object>
{
/*********
** Public methods
*********/
/// <summary>Get a helper to manipulate the data as a dictionary.</summary>
/// <typeparam name="TKey">The expected dictionary key.</typeparam>
/// <typeparam name="TValue">The expected dictionary value.</typeparam>
/// <exception cref="InvalidOperationException">The content being read isn't a dictionary.</exception>
IAssetDataForDictionary<TKey, TValue> AsDictionary<TKey, TValue>();
/// <summary>Get a helper to manipulate the data as an image.</summary>
/// <exception cref="InvalidOperationException">The content being read isn't an image.</exception>
IAssetDataForImage AsImage();
/// <summary>Get the data as a given type.</summary>
/// <typeparam name="TData">The expected data type.</typeparam>
/// <exception cref="InvalidCastException">The data can't be converted to <typeparamref name="TData"/>.</exception>
TData GetData<TData>();
}
}
|
